Instance

• Implements: com.aliyun.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 com.aliyun.ros.cdk.rocketmq.datasource.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

instanceId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceId: The ID of the RocketMQ instance.

refreshOptions^Optional

• Type: java.lang.String OR com.aliyun.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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.rocketmq.datasource.Instance;
Instance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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 java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrAccountInfo^Required

public java.lang.Object getAttrAccountInfo();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AccountInfo: The account information.

attrAclInfo^Required

public java.lang.Object getAttrAclInfo();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AclInfo: The information about access control.

attrCommodityCode^Required

public java.lang.Object getAttrCommodityCode();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrCreateTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The time when the instance was created.

attrExpireTime^Required

public java.lang.Object getAttrExpireTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ExpireTime: The time when the instance expires.

attrGroupCount^Required

public java.lang.Object getAttrGroupCount();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute GroupCount: The number of groups.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the RocketMQ instance.

attrInstanceName^Required

public java.lang.Object getAttrInstanceName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceName: The name of instance.

attrInstanceQuotas^Required

public java.lang.Object getAttrInstanceQuotas();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceQuotas: The instance quotas.

attrNetworkInfo^Required

public java.lang.Object getAttrNetworkInfo();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NetworkInfo: Instance network configuration information.

attrPaymentType^Required

public java.lang.Object getAttrPaymentType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: The billing method of the instance.

attrProductInfo^Required

public java.lang.Object getAttrProductInfo();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ProductInfo: The extended configurations of the instance.

attrReleaseTime^Required

public java.lang.Object getAttrReleaseTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReleaseTime: The time when the instance was released.

attrRemark^Required

public java.lang.Object getAttrRemark();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Remark: The description of the instance.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrSeriesCode^Required

public java.lang.Object getAttrSeriesCode();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SeriesCode: The primary edition of the instance.

attrServiceCode^Required

public java.lang.Object getAttrServiceCode();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrSoftware();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Software: The instance software information.

attrStartTime^Required

public java.lang.Object getAttrStartTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute StartTime: The time when the instance was started.

attrSubSeriesCode^Required

public java.lang.Object getAttrSubSeriesCode();

• Type: java.lang.String OR com.aliyun.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 java.lang.Object getAttrTags();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The tags of the RocketMQ instance.

attrTopicCount^Required

public java.lang.Object getAttrTopicCount();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TopicCount: The number of topics.

attrUpdateTime^Required

public java.lang.Object getAttrUpdateTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrUserId^Required

public java.lang.Object getAttrUserId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

props^Required

public InstanceProps getProps();

• Type: InstanceProps