Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::ROCKETMQ5::InstanceThe , which resource type creates 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
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

internet_info^Required

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

Property internetInfo: Public network configuration information.

product_info^Required

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

Property productInfo: Instance specification information.

series_code^Required

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

Property seriesCode: The primary series code of the instance.

sub_series_code^Required

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

Property subSeriesCode: The sub series code of the instance.

vpc_info^Required

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

Property vpcInfo: Private network configuration information.

auto_renew^Optional

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

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

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

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

payment_type^Optional

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

Property paymentType: The sub series code of the instance.

period^Optional

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

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

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

remark^Optional

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

Property remark: The remark of instance.

resource_group_id^Optional

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

Property resourceGroupId: Resource group ID.

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_rocketmq5
ros_cdk_rocketmq5.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_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: Instance ID created.

attr_instance_name^Required

attr_instance_name: typing.Union[str, IResolvable]

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

Attribute InstanceName: Instance name.

attr_internet_endpoint^Required

attr_internet_endpoint: typing.Union[str, IResolvable]

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

Attribute InternetEndpoint: Internet endpoint.

attr_vpc_endpoint^Required

attr_vpc_endpoint: typing.Union[str, IResolvable]

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

Attribute VpcEndpoint: VPC endpoint.

props^Required

props: InstanceProps

• Type: InstanceProps