Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::ROCKETMQ5::Instance, which is used to create an ApsaraMQ for RocketMQ 5.0 instance.

Initializers 

import ros_cdk_rocketmq5
ros_cdk_rocketmq5.Instance(
  scope: Construct,
  id: str,
  internet_info: typing.Union[IResolvable, InternetInfoProperty],
  product_info: typing.Union[IResolvable, ProductInfoProperty],
  series_code: typing.Union[str, IResolvable],
  sub_series_code: typing.Union[str, IResolvable],
  vpc_info: typing.Union[IResolvable, VpcInfoProperty],
  auto_renew: typing.Union[bool, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  payment_type: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  remark: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
internet_info typing.Union[ros_cdk_core.IResolvable, InternetInfoProperty] Property internetInfo: Public network configuration information.
product_info typing.Union[ros_cdk_core.IResolvable, ProductInfoProperty] Property productInfo: Instance specification information.
series_code typing.Union[str, ros_cdk_core.IResolvable] Property seriesCode: The primary series code of the instance.
sub_series_code typing.Union[str, ros_cdk_core.IResolvable] Property subSeriesCode: The sub series code of the instance.
vpc_info typing.Union[ros_cdk_core.IResolvable, VpcInfoProperty] Property vpcInfo: Private network configuration information.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] Property autoRenew: Whether to auto-renew.
auto_renew_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property autoRenewPeriod: Automatic renewal period.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The name of the instance to be created.
payment_type typing.Union[str, ros_cdk_core.IResolvable] Property paymentType: The sub series code of the instance.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The subscription duration.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The period unit for the duration of the instance.
remark typing.Union[str, ros_cdk_core.IResolvable] Property remark: The remark of instance.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group ID.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

internet_infoRequired

Property internetInfo: Public network configuration information.

product_infoRequired

Property productInfo: Instance specification information.

series_codeRequired

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

Property seriesCode: The primary series code of the instance.

sub_series_codeRequired

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

Property subSeriesCode: The sub series code of the instance.

vpc_infoRequired

Property vpcInfo: Private network configuration information.

auto_renewOptional

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

Property autoRenew: Whether to auto-renew.

This parameter takes effect only when the PaymentType=Subscription.

auto_renew_periodOptional

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

Property autoRenewPeriod: Automatic renewal period.

This parameter is valid only when automatic renewal is enabled. Unit: Month.

instance_nameOptional

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

Property instanceName: The name of the instance to be created.

payment_typeOptional

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

Property paymentType: The sub series code of the instance.

periodOptional

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

Property period: The subscription duration.

Valid values: When Period is Month, it could be from 1 to 6, 12, 24, 36. When Period is Year, it could be from 1 to 3.

period_unitOptional

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

Property periodUnit: The period unit for the duration of the instance.

remarkOptional

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

Property remark: The remark of instance.

resource_group_idOptional

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

Property resourceGroupId: Resource group ID.

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_rocketmq5
ros_cdk_rocketmq5.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_instance_id ros_cdk_core.IResolvable Attribute InstanceId: Instance ID created.
attr_instance_name ros_cdk_core.IResolvable Attribute InstanceName: Instance name.
attr_internet_endpoint ros_cdk_core.IResolvable Attribute InternetEndpoint: Internet endpoint.
attr_vpc_endpoint ros_cdk_core.IResolvable Attribute VpcEndpoint: VPC endpoint.

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_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: Instance ID created.

attr_instance_nameRequired 

attr_instance_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceName: Instance name.

attr_internet_endpointRequired 

attr_internet_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InternetEndpoint: Internet endpoint.

attr_vpc_endpointRequired 

attr_vpc_endpoint: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcEndpoint: VPC endpoint.