Skip to content

ApplicationProps

Properties for defining a Application.

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

Initializer

import ros_cdk_polardb
ros_cdk_polardb.ApplicationProps(
  application_type: typing.Union[str, IResolvable],
  architecture: typing.Union[str, IResolvable],
  db_cluster_id: typing.Union[str, IResolvable],
  auto_create_polar_fs: typing.Union[bool, IResolvable] = None,
  components: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ComponentsProperty]]] = None,
  description: typing.Union[str, IResolvable] = None,
  pay_type: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  polar_fs_instance_id: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  security_ip_list: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
application_type typing.Union[str, ros_cdk_core.IResolvable] Property applicationType: The type of the application.
architecture typing.Union[str, ros_cdk_core.IResolvable] Property architecture: The architecture of the application.
db_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property dbClusterId: The ID of the database cluster.
auto_create_polar_fs typing.Union[bool, ros_cdk_core.IResolvable] Property autoCreatePolarFs: Specifies whether to automatically create a PolarFS cold storage instance.
components typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ComponentsProperty]]] Property components: A list of custom child components for the application.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the application.
pay_type typing.Union[str, ros_cdk_core.IResolvable] Property payType: The billing method of the cluster.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The subscription period type.
polar_fs_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property polarFsInstanceId: The ID of the PolarFileSystem (PolarFS) cold storage or high-performance instance.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: The ID of the security group.
security_ip_list typing.Union[str, ros_cdk_core.IResolvable] Property securityIpList: The IP address whitelist.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The vSwitch.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone.

application_typeRequired

application_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

architecture: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property architecture: The architecture of the application.

This parameter is required.


db_cluster_idRequired

db_cluster_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbClusterId: The ID of the database cluster.


auto_create_polar_fsOptional

auto_create_polar_fs: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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

components: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ComponentsProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ComponentsProperty]]]

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


descriptionOptional

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the application.


pay_typeOptional

pay_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property payType: The billing method of the cluster.

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


periodOptional

period: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property period: The subscription period type.


polar_fs_instance_idOptional

polar_fs_instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

security_group_idOptional

security_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property securityGroupId: The ID of the security group.


security_ip_listOptional

security_ip_list: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


vpc_idOptional

vpc_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: The ID of the VPC.


v_switch_idOptional

v_switch_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vSwitchId: The vSwitch.

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


zone_idOptional

zone_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property zoneId: The zone.

The default value is the primary zone of the instance.