Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::SWAS::Instance, which is used to create a subscription simple application server.

Initializers 

import com.aliyun.ros.cdk.swas.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .imageId(java.lang.String)
    .imageId(IResolvable)
    .period(java.lang.Number)
    .period(IResolvable)
    .planId(java.lang.String)
    .planId(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .dataDiskSize(java.lang.Number)
//  .dataDiskSize(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.
imageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageId: The image ID.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The subscription period of the servers.
planId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property planId: The plan ID.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Specifies whether to enable auto-renewal.
autoRenewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property autoRenewPeriod: The auto-renewal period.
dataDiskSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dataDiskSize: The size of the data disk that is attached to the server.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

imageIdRequired

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

Property imageId: The image ID.

You can call the ListImages operation to query the available images in the specified region.

periodRequired

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

Property period: The subscription period of the servers.

Unit: months. Valid values: 1, 3, 6, 12, 24, and 36.

planIdRequired

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

Property planId: The plan ID.

You can call the ListPlans operation to query all plans provided by Simple Application Server in the specified region.

autoRenewOptional

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

Property autoRenew: Specifies whether to enable auto-renewal.

Valid values: true false Default value: false.

autoRenewPeriodOptional

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

Property autoRenewPeriod: The auto-renewal period.

This parameter is required only when you set AutoRenew to true. Unit: months. Valid values: 1, 3, 6, 12, 24, and 36.

dataDiskSizeOptional

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

Property dataDiskSize: The size of the data disk that is attached to the server.

Unit: GB. Valid values: 0 to 16380. The value must be an integral multiple of 20. A value of 0 indicates that no data disk is attached. If the disk included in the specified plan is a standard SSD, the data disk must be 20 GB or larger in size. Default value: 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.swas.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.
attrInnerIpAddress com.aliyun.ros.cdk.core.IResolvable Attribute InnerIpAddress: The inner IP address of simple application server.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the simple application server.
attrPublicIpAddress com.aliyun.ros.cdk.core.IResolvable Attribute PublicIpAddress: The public IP address of simple application server.

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

attrInnerIpAddressRequired 

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

Attribute InnerIpAddress: The inner IP address of simple application server.

attrInstanceIdRequired 

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

Attribute InstanceId: The ID of the simple application server.

attrPublicIpAddressRequired 

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

Attribute PublicIpAddress: The public IP address of simple application server.