Skip to content

Instance

This class encapsulates and extends the ROS resource type DATASOURCE::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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The ID of the RocketMQ instance.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

instanceIdRequired

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

Property instanceId: The ID of the RocketMQ instance.

refreshOptionsOptional

  • 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

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 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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

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

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAccountInfoRequired 

public IResolvable getAttrAccountInfo();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AccountInfo: The account information.

attrAclInfoRequired 

public IResolvable getAttrAclInfo();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AclInfo: The information about access control.

attrCommodityCodeRequired 

public IResolvable getAttrCommodityCode();
  • Type: 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.

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The time when the instance was created.

attrExpireTimeRequired 

public IResolvable getAttrExpireTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ExpireTime: The time when the instance expires.

attrGroupCountRequired 

public IResolvable getAttrGroupCount();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute GroupCount: The number of groups.

attrInstanceIdRequired 

public IResolvable getAttrInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the RocketMQ instance.

attrInstanceNameRequired 

public IResolvable getAttrInstanceName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceName: The name of instance.

attrInstanceQuotasRequired 

public IResolvable getAttrInstanceQuotas();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceQuotas: The instance quotas.

attrNetworkInfoRequired 

public IResolvable getAttrNetworkInfo();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute NetworkInfo: Instance network configuration information.

attrPaymentTypeRequired 

public IResolvable getAttrPaymentType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: The billing method of the instance.

attrProductInfoRequired 

public IResolvable getAttrProductInfo();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ProductInfo: The extended configurations of the instance.

attrReleaseTimeRequired 

public IResolvable getAttrReleaseTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ReleaseTime: The time when the instance was released.

attrRemarkRequired 

public IResolvable getAttrRemark();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Remark: The description of the instance.

attrResourceGroupIdRequired 

public IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrSeriesCodeRequired 

public IResolvable getAttrSeriesCode();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SeriesCode: The primary edition of the instance.

attrServiceCodeRequired 

public IResolvable getAttrServiceCode();
  • Type: 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.

attrSoftwareRequired 

public IResolvable getAttrSoftware();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Software: The instance software information.

attrStartTimeRequired 

public IResolvable getAttrStartTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StartTime: The time when the instance was started.

attrSubSeriesCodeRequired 

public IResolvable getAttrSubSeriesCode();
  • Type: 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.

attrTagsRequired 

public IResolvable getAttrTags();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The tags of the RocketMQ instance.

attrTopicCountRequired 

public IResolvable getAttrTopicCount();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TopicCount: The number of topics.

attrUpdateTimeRequired 

public IResolvable getAttrUpdateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrUserIdRequired 

public IResolvable getAttrUserId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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