Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::AMQP::Instance.

Initializers

import com.aliyun.ros.cdk.amqp.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .instanceType(java.lang.String)
//  .instanceType(IResolvable)
//  .maxEipTps(java.lang.Number)
//  .maxEipTps(IResolvable)
//  .maxTps(java.lang.Number)
//  .maxTps(IResolvable)
//  .orderNum(java.lang.Number)
//  .orderNum(IResolvable)
//  .payType(java.lang.String)
//  .payType(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .queueCapacity(java.lang.Number)
//  .queueCapacity(IResolvable)
//  .storageSize(java.lang.Number)
//  .storageSize(IResolvable)
//  .supportEip(java.lang.String)
//  .supportEip(IResolvable)
//  .supportTracing(java.lang.String)
//  .supportTracing(IResolvable)
//  .tracingStorageTime(java.lang.Number)
//  .tracingStorageTime(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

instanceName^Optional

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

Property instanceName: The name of the instance.

The name can be up to 64 characters long.

instanceType^Optional

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

Property instanceType: The instance type.

This parameter is required for subscription instances. Valid values:

• professional: Professional Edition
• enterprise: Enterprise Edition
• vip: Platinum Edition You do not need to specify this parameter for serverless instances.

maxEipTps^Optional

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

Property maxEipTps: The max eip tps.

It is valid when support_eip is true. The minimum value is 128, with the step size 128.

maxTps^Optional

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

Property maxTps: If instance type is professional, the valid value is [1000, 1500, 2000, 2500, 3000, 4000, 5000].

If instance type is enterprise, the valid value is [3000, 5000, 8000, 10000, 15000, 20000, 3000040000, 50000, 80000, 10000]. If instance type is vip, the valid value is [8000, 15000, 25000, 40000, 50000, 100000, 200000, 300000, 500000, 800000, 1000000].

orderNum^Optional

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

Property orderNum: Set the number of instances to be created.

payType^Optional

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

Property payType: The billing method of the instance.

The Message Queue RabbitMQ version does not support new pay-as-you-go instances. Valid values: PrePaid: subscription

period^Optional

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

Property period: The period.

Valid values: 1, 2, 3, 6, 12, 24, 36.

periodUnit^Optional

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

queueCapacity^Optional

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

Property queueCapacity: The queue capacity.

If instance type is professional, the valid value is [50, 1000] with the step size 5. If instance type is enterprise, the valid value is [200, 6000] with the step size 100 If instance type is vip, the valid value is [200, 80000] with the step size 100

storageSize^Optional

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

Property storageSize: The storage size.

It is valid when instance_type is vip. If instance type is professional or enterprise, the valid value is 0.If instance type is vip, the valid value is [700, 2800] with the step size 100

supportEip^Optional

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

Property supportEip: Specifies whether to enable access over the public network.

Valid values:

• true: Enables access over the public network.
• false: Disables access over the public network.

supportTracing^Optional

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

Property supportTracing: Specifies whether to enable the message trace feature.

Valid values:

• true: Enables the message trace feature.
• false: Disables the message trace feature.

• The message trace feature is included for 15 days at no charge on Platinum Edition instances. For these instances, you must enable this feature and set the retention period to 15 days.

• For other instance types, you can enable or disable this feature.

tracingStorageTime^Optional

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

Property tracingStorageTime: The retention period of message traces.

Unit: days. Valid values:

• 3
• 7
• 15 This parameter is required if you set SupportTracing to true.

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

attrClassicEndpoint^Required

public java.lang.Object getAttrClassicEndpoint();

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

Attribute ClassicEndpoint: The classic endpoint of the instance.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: The ID of the instance.

attrPrivateEndpoint^Required

public java.lang.Object getAttrPrivateEndpoint();

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

Attribute PrivateEndpoint: The private endpoint of the instance.

attrPublicEndpoint^Required

public java.lang.Object getAttrPublicEndpoint();

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

Attribute PublicEndpoint: The public endpoint of the instance.

props^Required

public InstanceProps getProps();

• Type: InstanceProps