Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::AMQP::Instance.

Initializers

import ros_cdk_amqp
ros_cdk_amqp.Instance(
  scope: Construct,
  id: str,
  instance_name: typing.Union[str, IResolvable] = None,
  instance_type: typing.Union[str, IResolvable] = None,
  max_eip_tps: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_tps: typing.Union[typing.Union[int, float], IResolvable] = None,
  order_num: typing.Union[typing.Union[int, float], IResolvable] = None,
  pay_type: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  queue_capacity: typing.Union[typing.Union[int, float], IResolvable] = None,
  storage_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  support_eip: typing.Union[str, IResolvable] = None,
  support_tracing: typing.Union[str, IResolvable] = None,
  tracing_storage_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

instance_name^Optional

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

Property instanceName: The name of the instance.

The name can be up to 64 characters long.

instance_type^Optional

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

Property instanceType: The instance type.

This parameter is required for subscription instances. Valid values:

• professional: Professional Edition
• enterprise: Enterprise Edition
• vip: Platinum Edition You do not need to specify this parameter for serverless instances.

max_eip_tps^Optional

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

Property maxEipTps: The max eip tps.

It is valid when support_eip is true. The minimum value is 128, with the step size 128.

max_tps^Optional

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

Property maxTps: If instance type is professional, the valid value is [1000, 1500, 2000, 2500, 3000, 4000, 5000].

If instance type is enterprise, the valid value is [3000, 5000, 8000, 10000, 15000, 20000, 3000040000, 50000, 80000, 10000]. If instance type is vip, the valid value is [8000, 15000, 25000, 40000, 50000, 100000, 200000, 300000, 500000, 800000, 1000000].

order_num^Optional

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

Property orderNum: Set the number of instances to be created.

pay_type^Optional

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

Property payType: The billing method of the instance.

The Message Queue RabbitMQ version does not support new pay-as-you-go instances. Valid values: PrePaid: subscription

period^Optional

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

Property period: The period.

Valid values: 1, 2, 3, 6, 12, 24, 36.

period_unit^Optional

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

queue_capacity^Optional

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

Property queueCapacity: The queue capacity.

If instance type is professional, the valid value is [50, 1000] with the step size 5. If instance type is enterprise, the valid value is [200, 6000] with the step size 100 If instance type is vip, the valid value is [200, 80000] with the step size 100

storage_size^Optional

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

Property storageSize: The storage size.

It is valid when instance_type is vip. If instance type is professional or enterprise, the valid value is 0.If instance type is vip, the valid value is [700, 2800] with the step size 100

support_eip^Optional

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

Property supportEip: Specifies whether to enable access over the public network.

Valid values:

• true: Enables access over the public network.
• false: Disables access over the public network.

support_tracing^Optional

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

Property supportTracing: Specifies whether to enable the message trace feature.

Valid values:

• true: Enables the message trace feature.
• false: Disables the message trace feature.

• The message trace feature is included for 15 days at no charge on Platinum Edition instances. For these instances, you must enable this feature and set the retention period to 15 days.

• For other instance types, you can enable or disable this feature.

tracing_storage_time^Optional

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

Property tracingStorageTime: The retention period of message traces.

Unit: days. Valid values:

• 3
• 7
• 15 This parameter is required if you set SupportTracing to true.

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_amqp
ros_cdk_amqp.Instance.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_classic_endpoint^Required

attr_classic_endpoint: typing.Union[str, IResolvable]

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

Attribute ClassicEndpoint: The classic endpoint of the instance.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: The ID of the instance.

attr_private_endpoint^Required

attr_private_endpoint: typing.Union[str, IResolvable]

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

Attribute PrivateEndpoint: The private endpoint of the instance.

attr_public_endpoint^Required

attr_public_endpoint: typing.Union[str, IResolvable]

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

Attribute PublicEndpoint: The public endpoint of the instance.

props^Required

props: InstanceProps

• Type: InstanceProps