Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::AMQP::Instance, which is used to create an ApsaraMQ for RabbitMQ 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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The instance name.
instance_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceType: The Instance Type.
max_eip_tps typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxEipTps: The max eip tps.
max_tps 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].
order_num typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property orderNum: Set the number of instances to be created.
pay_type typing.Union[str, ros_cdk_core.IResolvable] Property payType: The billing method of the instance.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The period.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The unit of the subscription duration.
queue_capacity typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property queueCapacity: The queue capacity.
storage_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property storageSize: The storage size.
support_eip typing.Union[str, ros_cdk_core.IResolvable] Property supportEip: Whether to support EIP.
support_tracing typing.Union[str, ros_cdk_core.IResolvable] Property supportTracing: Whether to support tracing.
tracing_storage_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property tracingStorageTime: The retention period of message traces was set.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

instance_nameOptional

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

Property instanceName: The instance name.

instance_typeOptional

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

Property instanceType: The Instance Type.

Valid values: professional, enterprise, vip.

max_eip_tpsOptional

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

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

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

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

pay_typeOptional

  • 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

periodOptional

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

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

queue_capacityOptional

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

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

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

Property supportEip: Whether to support EIP.

Valid values: true, false.

support_tracingOptional

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

Property supportTracing: Whether to support tracing.

Valid values: true, false.

tracing_storage_timeOptional

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

Property tracingStorageTime: The retention period of message traces was set.

Valid values: 3, 7, 15. If instance_type=vip, the valid values is 15. If instance_type!=vip, the valid values is 3, 7, 15. If support_tracing == tracing_false, the valid values is 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_amqp
ros_cdk_amqp.Instance.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_classic_endpoint ros_cdk_core.IResolvable Attribute ClassicEndpoint: The classic endpoint of the instance.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of the instance.
attr_private_endpoint ros_cdk_core.IResolvable Attribute PrivateEndpoint: The private endpoint of the instance.
attr_public_endpoint ros_cdk_core.IResolvable Attribute PublicEndpoint: The public endpoint of the instance.

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_classic_endpointRequired 

attr_classic_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ClassicEndpoint: The classic endpoint of the instance.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the instance.

attr_private_endpointRequired 

attr_private_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PrivateEndpoint: The private endpoint of the instance.

attr_public_endpointRequired 

attr_public_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PublicEndpoint: The public endpoint of the instance.