Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::AMQP::Instance, which is used to create an ApsaraMQ for RabbitMQ 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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: The instance name.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: The Instance Type.
maxEipTps java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxEipTps: The max eip tps.
maxTps 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].
orderNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property orderNum: Set the number of instances to be created.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: The billing method of the instance.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The period.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: The unit of the subscription duration.
queueCapacity java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property queueCapacity: The queue capacity.
storageSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property storageSize: The storage size.
supportEip java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property supportEip: Whether to support EIP.
supportTracing java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property supportTracing: Whether to support tracing.
tracingStorageTime java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property tracingStorageTime: The retention period of message traces was set.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

instanceNameOptional

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

Property instanceName: The instance name.

instanceTypeOptional

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

Property instanceType: The Instance Type.

Valid values: professional, enterprise, vip.

maxEipTpsOptional

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

maxTpsOptional

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

orderNumOptional

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

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

payTypeOptional

  • 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

periodOptional

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

Property period: The period.

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

periodUnitOptional

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

queueCapacityOptional

  • 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

storageSizeOptional

  • 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

supportEipOptional

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

Property supportEip: Whether to support EIP.

Valid values: true, false.

supportTracingOptional

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

Property supportTracing: Whether to support tracing.

Valid values: true, false.

tracingStorageTimeOptional

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

Property tracingStorageTime: The retention period of message traces was set.

Valid values: 3, 7, 15. If instance_type=vip, the valid values is 15. If instance_type!=vip, the valid values is 3, 7, 15. If support_tracing == tracing_false, the valid values is 0.

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.amqp.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.
attrClassicEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute ClassicEndpoint: The classic endpoint of the instance.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the instance.
attrPrivateEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute PrivateEndpoint: The private endpoint of the instance.
attrPublicEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute PublicEndpoint: The public endpoint of 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

attrClassicEndpointRequired 

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

Attribute ClassicEndpoint: The classic endpoint of the instance.

attrInstanceIdRequired 

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

Attribute InstanceId: The ID of the instance.

attrPrivateEndpointRequired 

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

Attribute PrivateEndpoint: The private endpoint of the instance.

attrPublicEndpointRequired 

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

Attribute PublicEndpoint: The public endpoint of the instance.