Skip to content

Instance

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

Initializers 

import { datasource } from '@alicloud/ros-cdk-rocketmq'
new datasource.Instance(scope: Construct, id: string, props: InstanceProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props InstanceProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import { datasource } from '@alicloud/ros-cdk-rocketmq'
datasource.Instance.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrAccountInfo @alicloud/ros-cdk-core.IResolvable Attribute AccountInfo: The account information.
attrAclInfo @alicloud/ros-cdk-core.IResolvable Attribute AclInfo: The information about access control.
attrCommodityCode @alicloud/ros-cdk-core.IResolvable Attribute CommodityCode: The commodity code of the instance.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The time when the instance was created.
attrExpireTime @alicloud/ros-cdk-core.IResolvable Attribute ExpireTime: The time when the instance expires.
attrGroupCount @alicloud/ros-cdk-core.IResolvable Attribute GroupCount: The number of groups.
attrInstanceId @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: The ID of the RocketMQ instance.
attrInstanceName @alicloud/ros-cdk-core.IResolvable Attribute InstanceName: The name of instance.
attrInstanceQuotas @alicloud/ros-cdk-core.IResolvable Attribute InstanceQuotas: The instance quotas.
attrNetworkInfo @alicloud/ros-cdk-core.IResolvable Attribute NetworkInfo: Instance network configuration information.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The billing method of the instance.
attrProductInfo @alicloud/ros-cdk-core.IResolvable Attribute ProductInfo: The extended configurations of the instance.
attrReleaseTime @alicloud/ros-cdk-core.IResolvable Attribute ReleaseTime: The time when the instance was released.
attrRemark @alicloud/ros-cdk-core.IResolvable Attribute Remark: The description of the instance.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrSeriesCode @alicloud/ros-cdk-core.IResolvable Attribute SeriesCode: The primary edition of the instance.
attrServiceCode @alicloud/ros-cdk-core.IResolvable Attribute ServiceCode: The code of the service to which the instance belongs.
attrSoftware @alicloud/ros-cdk-core.IResolvable Attribute Software: The instance software information.
attrStartTime @alicloud/ros-cdk-core.IResolvable Attribute StartTime: The time when the instance was started.
attrSubSeriesCode @alicloud/ros-cdk-core.IResolvable Attribute SubSeriesCode: The sub-category edition of the instance.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tags of the RocketMQ instance.
attrTopicCount @alicloud/ros-cdk-core.IResolvable Attribute TopicCount: The number of topics.
attrUpdateTime @alicloud/ros-cdk-core.IResolvable Attribute UpdateTime: The time when the instance was last modified.
attrUserId @alicloud/ros-cdk-core.IResolvable Attribute UserId: The ID of the user who owns the instance.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAccountInfoRequired 

public readonly attrAccountInfo: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AccountInfo: The account information.

attrAclInfoRequired 

public readonly attrAclInfo: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AclInfo: The information about access control.

attrCommodityCodeRequired 

public readonly attrCommodityCode: IResolvable;
  • Type: @alicloud/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.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The time when the instance was created.

attrExpireTimeRequired 

public readonly attrExpireTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExpireTime: The time when the instance expires.

attrGroupCountRequired 

public readonly attrGroupCount: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute GroupCount: The number of groups.

attrInstanceIdRequired 

public readonly attrInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: The ID of the RocketMQ instance.

attrInstanceNameRequired 

public readonly attrInstanceName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceName: The name of instance.

attrInstanceQuotasRequired 

public readonly attrInstanceQuotas: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceQuotas: The instance quotas.

attrNetworkInfoRequired 

public readonly attrNetworkInfo: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute NetworkInfo: Instance network configuration information.

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The billing method of the instance.

attrProductInfoRequired 

public readonly attrProductInfo: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ProductInfo: The extended configurations of the instance.

attrReleaseTimeRequired 

public readonly attrReleaseTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ReleaseTime: The time when the instance was released.

attrRemarkRequired 

public readonly attrRemark: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Remark: The description of the instance.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrSeriesCodeRequired 

public readonly attrSeriesCode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SeriesCode: The primary edition of the instance.

attrServiceCodeRequired 

public readonly attrServiceCode: IResolvable;
  • Type: @alicloud/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.

attrSoftwareRequired 

public readonly attrSoftware: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Software: The instance software information.

attrStartTimeRequired 

public readonly attrStartTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute StartTime: The time when the instance was started.

attrSubSeriesCodeRequired 

public readonly attrSubSeriesCode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

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

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tags of the RocketMQ instance.

attrTopicCountRequired 

public readonly attrTopicCount: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute TopicCount: The number of topics.

attrUpdateTimeRequired 

public readonly attrUpdateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrUserIdRequired 

public readonly attrUserId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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