Skip to content

Instances

This class encapsulates and extends the ROS resource type ALIYUN::SWAS::Instances, which is used to create subscription simple application servers.

Initializers 

import ros_cdk_swas
ros_cdk_swas.Instances(
  scope: Construct,
  id: str,
  image_id: typing.Union[str, IResolvable],
  period: typing.Union[typing.Union[int, float], IResolvable],
  plan_id: typing.Union[str, IResolvable],
  amount: typing.Union[typing.Union[int, float], IResolvable] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  data_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
image_id typing.Union[str, ros_cdk_core.IResolvable] Property imageId: The image ID.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The subscription period of the servers.
plan_id typing.Union[str, ros_cdk_core.IResolvable] Property planId: The plan ID.
amount typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property amount: The number of simple application servers that you want to create.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] Property autoRenew: Specifies whether to enable auto-renewal.
auto_renew_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property autoRenewPeriod: The auto-renewal period.
data_disk_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property dataDiskSize: The size of the data disk that is attached to the server.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

image_idRequired

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

Property imageId: The image ID.

You can call the ListImages operation to query the available images in the specified region.

periodRequired

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

Property period: The subscription period of the servers.

Unit: months. Valid values: 1, 3, 6, 12, 24, and 36.

plan_idRequired

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

Property planId: The plan ID.

You can call the ListPlans operation to query all plans provided by Simple Application Server in the specified region.

amountOptional

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

Property amount: The number of simple application servers that you want to create.

Valid values: 1 to 20. Default value: 1.

auto_renewOptional

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

Property autoRenew: Specifies whether to enable auto-renewal.

Valid values: true false Default value: false.

auto_renew_periodOptional

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

Property autoRenewPeriod: The auto-renewal period.

This parameter is required only when you set AutoRenew to true. Unit: months. Valid values: 1, 3, 6, 12, 24, and 36.

data_disk_sizeOptional

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

Property dataDiskSize: The size of the data disk that is attached to the server.

Unit: GB. Valid values: 0 to 16380. The value must be an integral multiple of 20. A value of 0 indicates that no data disk is attached. If the disk included in the specified plan is a standard SSD, the data disk must be 20 GB or larger in size. Default value: 0.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_swas
ros_cdk_swas.Instances.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_inner_ip_addresses ros_cdk_core.IResolvable Attribute InnerIpAddresses: The inner IP addresses of simple application servers.
attr_instance_ids ros_cdk_core.IResolvable Attribute InstanceIds: The IDs of the simple application servers.
attr_public_ip_addresses ros_cdk_core.IResolvable Attribute PublicIpAddresses: The public IP addresses of simple application servers.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_inner_ip_addressesRequired 

attr_inner_ip_addresses: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InnerIpAddresses: The inner IP addresses of simple application servers.

attr_instance_idsRequired 

attr_instance_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceIds: The IDs of the simple application servers.

attr_public_ip_addressesRequired 

attr_public_ip_addresses: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PublicIpAddresses: The public IP addresses of simple application servers.