Instance

• Implements: @alicloud/ros-cdk-rocketmq.datasource.IInstance

This class encapsulates and extends the ROS resource type DATASOURCE::ROCKETMQ::Instance, which is used to query the details of an ApsaraMQ for RocketMQ instance.

Initializers

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

scope^Required

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

id^Required

• Type: string

props^Required

• Type: InstanceProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrAccountInfo^Required

public readonly attrAccountInfo: string | IResolvable;

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

Attribute AccountInfo: The account information.

attrAclInfo^Required

public readonly attrAclInfo: string | IResolvable;

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

Attribute AclInfo: The information about access control.

attrCommodityCode^Required

public readonly attrCommodityCode: string | IResolvable;

• Type: string | @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.

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

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

Attribute CreateTime: The time when the instance was created.

attrExpireTime^Required

public readonly attrExpireTime: string | IResolvable;

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

Attribute ExpireTime: The time when the instance expires.

attrGroupCount^Required

public readonly attrGroupCount: string | IResolvable;

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

Attribute GroupCount: The number of groups.

attrInstanceId^Required

public readonly attrInstanceId: string | IResolvable;

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

Attribute InstanceId: The ID of the RocketMQ instance.

attrInstanceName^Required

public readonly attrInstanceName: string | IResolvable;

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

Attribute InstanceName: The name of instance.

attrInstanceQuotas^Required

public readonly attrInstanceQuotas: string | IResolvable;

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

Attribute InstanceQuotas: The instance quotas.

attrNetworkInfo^Required

public readonly attrNetworkInfo: string | IResolvable;

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

Attribute NetworkInfo: Instance network configuration information.

attrPaymentType^Required

public readonly attrPaymentType: string | IResolvable;

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

Attribute PaymentType: The billing method of the instance.

attrProductInfo^Required

public readonly attrProductInfo: string | IResolvable;

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

Attribute ProductInfo: The extended configurations of the instance.

attrReleaseTime^Required

public readonly attrReleaseTime: string | IResolvable;

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

Attribute ReleaseTime: The time when the instance was released.

attrRemark^Required

public readonly attrRemark: string | IResolvable;

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

Attribute Remark: The description of the instance.

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

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

Attribute ResourceGroupId: The ID of the resource group.

attrSeriesCode^Required

public readonly attrSeriesCode: string | IResolvable;

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

Attribute SeriesCode: The primary edition of the instance.

attrServiceCode^Required

public readonly attrServiceCode: string | IResolvable;

• Type: string | @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.

attrSoftware^Required

public readonly attrSoftware: string | IResolvable;

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

Attribute Software: The instance software information.

attrStartTime^Required

public readonly attrStartTime: string | IResolvable;

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

Attribute StartTime: The time when the instance was started.

attrSubSeriesCode^Required

public readonly attrSubSeriesCode: string | IResolvable;

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

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

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

attrTags^Required

public readonly attrTags: string | IResolvable;

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

Attribute Tags: The tags of the RocketMQ instance.

attrTopicCount^Required

public readonly attrTopicCount: string | IResolvable;

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

Attribute TopicCount: The number of topics.

attrUpdateTime^Required

public readonly attrUpdateTime: string | IResolvable;

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

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

attrUserId^Required

public readonly attrUserId: string | IResolvable;

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

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

props^Required

public readonly props: InstanceProps;

• Type: InstanceProps