Application

• Implements: IApplication

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::Application.

Initializers

import ros_cdk_polardb
ros_cdk_polardb.Application(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

application_type^Required

• 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.

architecture^Required

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

Property architecture: The architecture of the application.

This parameter is required.

db_cluster_id^Required

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

Property dbClusterId: The ID of the database cluster.

auto_create_polar_fs^Optional

• 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.

components^Optional

• 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.

description^Optional

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

Property description: The description of the application.

pay_type^Optional

• 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

period^Optional

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

Property period: The subscription period type.

polar_fs_instance_id^Optional

• 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_id^Optional

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

Property securityGroupId: The ID of the security group.

security_ip_list^Optional

• 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_id^Optional

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

Property vpcId: The ID of the VPC.

v_switch_id^Optional

• 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_id^Optional

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

Property zoneId: The zone.

The default value is the primary zone of the instance.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_polardb
ros_cdk_polardb.Application.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_application_id^Required

attr_application_id: typing.Union[str, IResolvable]

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

Attribute ApplicationId: The ID of the application.

props^Required

props: ApplicationProps

• Type: ApplicationProps