Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::OTS::Instance, which is used to create a Tablestore instance.

Initializers 

import com.aliyun.ros.cdk.ots.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceName(java.lang.String)
    .instanceName(IResolvable)
//  .clusterType(java.lang.String)
//  .clusterType(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .network(java.lang.String)
//  .network(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .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 name of the instance.
clusterType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property clusterType: Cluster type, the default is SSD.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Instance description.
network java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property network: Instance network type, default is NORMAL.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

instanceNameRequired

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

Property instanceName: The name of the instance.

clusterTypeOptional

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

Property clusterType: Cluster type, the default is SSD.

This parameter specifies the specification of the ots instance. When the value is SSD, the ots instance is a high-performance instance. When the value is Hybid, the ots instance is a capacity instance

descriptionOptional

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

Property description: Instance description.

networkOptional

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

Property network: Instance network type, default is NORMAL.

tagsOptional

Property tags: Tags to attach to instance.

Max support 5 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

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.ots.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.
attrInstanceName com.aliyun.ros.cdk.core.IResolvable Attribute InstanceName: Instance name.
attrPrivateEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute PrivateEndpoint: Private endpoint.
attrPublicEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute PublicEndpoint: Public endpoint.
attrVpcEndpoint com.aliyun.ros.cdk.core.IResolvable Attribute VpcEndpoint: Vpc endpoint.

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

attrInstanceNameRequired 

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

Attribute InstanceName: Instance name.

attrPrivateEndpointRequired 

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

Attribute PrivateEndpoint: Private endpoint.

attrPublicEndpointRequired 

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

Attribute PublicEndpoint: Public endpoint.

attrVpcEndpointRequired 

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

Attribute VpcEndpoint: Vpc endpoint.