Skip to content

ApplicationProps

Properties for defining a Application.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-polardb-application

Initializer

import { ApplicationProps } from '@alicloud/ros-cdk-polardb'
const applicationProps: ApplicationProps = { ... }

Properties

Name Type Description
applicationType string | @alicloud/ros-cdk-core.IResolvable Property applicationType: The type of the application.
architecture string | @alicloud/ros-cdk-core.IResolvable Property architecture: The architecture of the application.
dbClusterId string | @alicloud/ros-cdk-core.IResolvable Property dbClusterId: The ID of the database cluster.
autoCreatePolarFs boolean | @alicloud/ros-cdk-core.IResolvable Property autoCreatePolarFs: Specifies whether to automatically create a PolarFS cold storage instance.
components @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ComponentsProperty[] Property components: A list of custom child components for the application.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the application.
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: The billing method of the cluster.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The subscription period type.
polarFsInstanceId string | @alicloud/ros-cdk-core.IResolvable Property polarFsInstanceId: The ID of the PolarFileSystem (PolarFS) cold storage or high-performance instance.
securityGroupId string | @alicloud/ros-cdk-core.IResolvable Property securityGroupId: The ID of the security group.
securityIpList string | @alicloud/ros-cdk-core.IResolvable Property securityIpList: The IP address whitelist.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the VPC.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The vSwitch.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The zone.

applicationTypeRequired

public readonly applicationType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property applicationType: The type of the application.

Valid values: - supabase: Creates a managed Supabase application. - raycluster: Creates a managed Ray Cluster application. - polarclaw: Creates a managed PolarClaw application.


architectureRequired

public readonly architecture: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property architecture: The architecture of the application.

This parameter is required.


dbClusterIdRequired

public readonly dbClusterId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbClusterId: The ID of the database cluster.


autoCreatePolarFsOptional

public readonly autoCreatePolarFs: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoCreatePolarFs: Specifies whether to automatically create a PolarFS cold storage instance.

Valid values: - false (default): Does not automatically create the instance. - true: Automatically creates the instance.


componentsOptional

public readonly components: IResolvable | IResolvable | ComponentsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | ComponentsProperty[]

Property components: A list of custom child components for the application.


descriptionOptional

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the application.


payTypeOptional

public readonly payType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property payType: The billing method of the cluster.

Valid values: Postpaid: pay-as-you-go Prepaid: subscription


periodOptional

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: The subscription period type.


polarFsInstanceIdOptional

public readonly polarFsInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property polarFsInstanceId: The ID of the PolarFileSystem (PolarFS) cold storage or high-performance instance.

This parameter is empty by default. If you specify this parameter, the corresponding storage is mounted to the application. This feature is currently supported only by the following applications: - supabase - raycluster


securityGroupIdOptional

public readonly securityGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property securityGroupId: The ID of the security group.


securityIpListOptional

public readonly securityIpList: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property securityIpList: The IP address whitelist.

If you do not specify this parameter, the default value 127.0.0.1 is used.


vpcIdOptional

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The ID of the VPC.


vSwitchIdOptional

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The vSwitch.

The default value is the current vSwitch in the primary zone of the instance.


zoneIdOptional

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: The zone.

The default value is the primary zone of the instance.