Skip to content

Instance

This class encapsulates and extends the ROS resource type DATASOURCE::ROCKETMQ::Instance.

Initializers 

from ros_cdk_rocketmq import datasource
datasource.Instance(
  scope: Construct,
  id: str,
  instance_id: typing.Union[str, IResolvable],
  refresh_options: 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.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The ID of the RocketMQ instance.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

instance_idRequired

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

Property instanceId: The ID of the RocketMQ instance.

refresh_optionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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 

from ros_cdk_rocketmq import datasource
datasource.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_account_info ros_cdk_core.IResolvable Attribute AccountInfo: The account information.
attr_acl_info ros_cdk_core.IResolvable Attribute AclInfo: The information about access control.
attr_commodity_code ros_cdk_core.IResolvable Attribute CommodityCode: The commodity code of the instance.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The time when the instance was created.
attr_expire_time ros_cdk_core.IResolvable Attribute ExpireTime: The time when the instance expires.
attr_group_count ros_cdk_core.IResolvable Attribute GroupCount: The number of groups.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of the RocketMQ instance.
attr_instance_name ros_cdk_core.IResolvable Attribute InstanceName: The name of instance.
attr_instance_quotas ros_cdk_core.IResolvable Attribute InstanceQuotas: The instance quotas.
attr_network_info ros_cdk_core.IResolvable Attribute NetworkInfo: Instance network configuration information.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: The billing method of the instance.
attr_product_info ros_cdk_core.IResolvable Attribute ProductInfo: The extended configurations of the instance.
attr_release_time ros_cdk_core.IResolvable Attribute ReleaseTime: The time when the instance was released.
attr_remark ros_cdk_core.IResolvable Attribute Remark: The description of the instance.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attr_series_code ros_cdk_core.IResolvable Attribute SeriesCode: The primary edition of the instance.
attr_service_code ros_cdk_core.IResolvable Attribute ServiceCode: The code of the service to which the instance belongs.
attr_software ros_cdk_core.IResolvable Attribute Software: The instance software information.
attr_start_time ros_cdk_core.IResolvable Attribute StartTime: The time when the instance was started.
attr_sub_series_code ros_cdk_core.IResolvable Attribute SubSeriesCode: The sub-category edition of the instance.
attr_tags ros_cdk_core.IResolvable Attribute Tags: The tags of the RocketMQ instance.
attr_topic_count ros_cdk_core.IResolvable Attribute TopicCount: The number of topics.
attr_update_time ros_cdk_core.IResolvable Attribute UpdateTime: The time when the instance was last modified.
attr_user_id ros_cdk_core.IResolvable Attribute UserId: The ID of the user who owns 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_account_infoRequired 

attr_account_info: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AccountInfo: The account information.

attr_acl_infoRequired 

attr_acl_info: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AclInfo: The information about access control.

attr_commodity_codeRequired 

attr_commodity_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CommodityCode: The commodity code of the instance.

The commodity code of a ApsaraMQ for RocketMQ 5.0 instance has a similar format as ons_rmqsub_public_cn.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the instance was created.

attr_expire_timeRequired 

attr_expire_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExpireTime: The time when the instance expires.

attr_group_countRequired 

attr_group_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute GroupCount: The number of groups.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the RocketMQ instance.

attr_instance_nameRequired 

attr_instance_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceName: The name of instance.

attr_instance_quotasRequired 

attr_instance_quotas: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceQuotas: The instance quotas.

attr_network_infoRequired 

attr_network_info: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NetworkInfo: Instance network configuration information.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: The billing method of the instance.

attr_product_infoRequired 

attr_product_info: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ProductInfo: The extended configurations of the instance.

attr_release_timeRequired 

attr_release_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ReleaseTime: The time when the instance was released.

attr_remarkRequired 

attr_remark: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Remark: The description of the instance.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attr_series_codeRequired 

attr_series_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SeriesCode: The primary edition of the instance.

attr_service_codeRequired 

attr_service_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ServiceCode: The code of the service to which the instance belongs.

The service code of ApsaraMQ for RocketMQ is rmq.

attr_softwareRequired 

attr_software: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Software: The instance software information.

attr_start_timeRequired 

attr_start_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute StartTime: The time when the instance was started.

attr_sub_series_codeRequired 

attr_sub_series_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SubSeriesCode: The sub-category edition of the instance.

For information about the differences between sub-category edition instances.

attr_tagsRequired 

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: The tags of the RocketMQ instance.

attr_topic_countRequired 

attr_topic_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TopicCount: The number of topics.

attr_update_timeRequired 

attr_update_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UpdateTime: The time when the instance was last modified.

attr_user_idRequired 

attr_user_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UserId: The ID of the user who owns the instance.