Skip to content

Instance

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

Initializers 

import com.aliyun.ros.cdk.lindorm.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .diskCategory(java.lang.String)
    .diskCategory(IResolvable)
    .instanceName(java.lang.String)
    .instanceName(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
//  .coldStorage(java.lang.Number)
//  .coldStorage(IResolvable)
//  .coreSpec(java.lang.String)
//  .coreSpec(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .filestoreNum(java.lang.Number)
//  .filestoreNum(IResolvable)
//  .filestoreSpec(java.lang.String)
//  .filestoreSpec(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .instanceStorage(java.lang.Number)
//  .instanceStorage(IResolvable)
//  .lindormNum(java.lang.Number)
//  .lindormNum(IResolvable)
//  .lindormSpec(java.lang.String)
//  .lindormSpec(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .securityIpList(IResolvable)
//  .securityIpList(java.util.List<java.lang.String)
//  .securityIpList(IResolvable>)
//  .solrNum(java.lang.Number)
//  .solrNum(IResolvable)
//  .solrSpec(java.lang.String)
//  .solrSpec(IResolvable)
//  .streamNum(java.lang.Number)
//  .streamNum(IResolvable)
//  .streamSpec(java.lang.String)
//  .streamSpec(IResolvable)
//  .tsdbNum(java.lang.Number)
//  .tsdbNum(IResolvable)
//  .tsdbSpec(java.lang.String)
//  .tsdbSpec(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(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.
diskCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property diskCategory: The storage type of the instance.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: The name of the instance that you want to create.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The ID of the VPC in which you want to create the instance.
coldStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property coldStorage: The cold storage capacity of the instance.
coreSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property coreSpec: The specification of the nodes in the instance if you set DiskCategory to local_ssd_pro or local_hdd_pro.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionProtection: Specifies whether to enable the release protection feature for the instance.
filestoreNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property filestoreNum: The number of LindormDFS nodes in the instance.
filestoreSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property filestoreSpec: The specification of LindormDFS nodes in the instance.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceChargeType: The billing method of the instance you want to create.
instanceStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property instanceStorage: The storage capacity of the instance you want to create.
lindormNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property lindormNum: The number of LindormTable nodes in the instance.
lindormSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property lindormSpec: The specification of LindormTable nodes in the instance.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The subscription period of the instance.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: The period based on which you are charged for the instance.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which the Lindorm instance belongs.
securityIpList com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property securityIpList: The ip white list of instance.
solrNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property solrNum: The number of LindormSearch nodes in the instance.
solrSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property solrSpec: The specification of the LindormSearch nodes in the instance.
streamNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property streamNum: The number of LindormStream nodes in the instance.
streamSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property streamSpec: The specification of LindormStream nodes in the instance.
tsdbNum java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property tsdbNum: The number of the LindormTSDB nodes in the instance.
tsdbSpec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property tsdbSpec: The specification of the LindormTSDB nodes in the instance.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of the vSwitch to which you want the instance to connect.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The ID of the zone in which you want to create the instance.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

diskCategoryRequired

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

Property diskCategory: The storage type of the instance.

Valid values: cloud_efficiency: This instance uses the Standard type of storage. cloud_ssd: This instance uses the Performance type of storage. capacity_cloud_storage: This instance uses the Capacity type of storage. local_ssd_pro: This instance uses local SSDs. local_hdd_pro: This instance uses local HDDs.

instanceNameRequired

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

Property instanceName: The name of the instance that you want to create.

vpcIdRequired

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

Property vpcId: The ID of the VPC in which you want to create the instance.

coldStorageOptional

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

Property coldStorage: The cold storage capacity of the instance.

By default, if you leave this parameter unspecified, cold storage is not enabled for the instance. Unit: GB. Valid values: 800 to 1000000.

coreSpecOptional

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

Property coreSpec: The specification of the nodes in the instance if you set DiskCategory to local_ssd_pro or local_hdd_pro.

When DiskCategory is set to local_ssd_pro, you can set this parameter to the following values: lindorm.i2.xlarge: Each node has 4 dedicated CPU cores and 32 GB of dedicated memory. lindorm.i2.2xlarge: Each node has 8 dedicated CPU cores and 64 GB of dedicated memory. lindorm.i2.4xlarge: Each node has 16 dedicated CPU cores and 128 GB of dedicated memory. lindorm.i2.8xlarge: Each node has 32 dedicated CPU cores and 256 GB of dedicated memory. When DiskCategory is set to local_hdd_pro, you can set this parameter to the following values: lindorm.d1.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.d1.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.d1.6xlarge: Each node has 24 dedicated CPU cores and 96 GB of dedicated memory.

deletionProtectionOptional

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

Property deletionProtection: Specifies whether to enable the release protection feature for the instance.

Default is false.

filestoreNumOptional

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

Property filestoreNum: The number of LindormDFS nodes in the instance.

The valid values of this parameter depend on the value of the PayType parameter. If the PayType parameter is set to PREPAY, set this parameter to an integer that ranges from 0 to 60. If the PayType parameter is set to POSTPAY, set this parameter to an integer that ranges from 0 to 8.

filestoreSpecOptional

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

Property filestoreSpec: The specification of LindormDFS nodes in the instance.

Set the value of this parameter to lindorm.c.xlarge, which indicates that each node has 4 dedicated CPU cores and 8 GB of dedicated memory.

instanceChargeTypeOptional

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

Property instanceChargeType: The billing method of the instance you want to create.

Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go. Default value: POSTPAY

instanceStorageOptional

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

Property instanceStorage: The storage capacity of the instance you want to create.

Unit: GB.

lindormNumOptional

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

Property lindormNum: The number of LindormTable nodes in the instance.

The valid values of this parameter depend on the value of the PayType parameter. If the PayType parameter is set to PREPAY, set this parameter to an integer that ranges from 0 to 90. If the PayType parameter is set to POSTPAY, set this parameter to an integer that ranges from 0 to 400. ** This parameter is required if you want to create a multi-zone instance. ** The valid values of this parameter range from 4 to 400 if you want to create a multi-zone instance.

lindormSpecOptional

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

Property lindormSpec: The specification of LindormTable nodes in the instance.

Valid values: lindorm.g.xlarge: Each node has 4 dedicated CPU cores and 16 GB of dedicated memory. lindorm.g.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.g.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.g.8xlarge: Each node has 32 dedicated CPU cores and 128 GB of dedicated memory. lindorm.c.xlarge: Each node has 4 dedicated CPU cores and 8 GB of dedicated memory. lindorm.c.2xlarge: Each node has 8 dedicated CPU cores and 16 GB of dedicated memory. lindorm.c.4xlarge: Each node has 16 dedicated CPU cores and 32 GB of dedicated memory. lindorm.c.8xlarge: Each node has 32 dedicated CPU cores and 64 GB of dedicated memory.

periodOptional

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

Property period: The subscription period of the instance.

The valid values of this parameter depend on the value of the PeriodUnit parameter. If PeriodUnit is set to Month, Valid values are 1,2,3,4,5,6,7,8,9,12,24,36. If PeriodUnit is set to Year, set this parameter to an integer that ranges from 1 to 3. NoteThis parameter is available and required when the PayType parameter is set to PREPAY.

periodUnitOptional

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

Property periodUnit: The period based on which you are charged for the instance.

Valid values: Month: You are charged for the instance on a monthly basis. Year: You are charged for the instance on a yearly basis. NoteThis parameter is available and required when the PayType parameter is set to PREPAY.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group to which the Lindorm instance belongs.

securityIpListOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property securityIpList: The ip white list of instance.

solrNumOptional

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

Property solrNum: The number of LindormSearch nodes in the instance.

Valid values: integers from 0 to 60.

solrSpecOptional

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

Property solrSpec: The specification of the LindormSearch nodes in the instance.

Valid values: lindorm.g.xlarge: Each node has 4 dedicated CPU cores and 16 GB of dedicated memory. lindorm.g.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.g.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.g.8xlarge: Each node has 32 dedicated CPU cores and 128 GB of dedicated memory.

streamNumOptional

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

Property streamNum: The number of LindormStream nodes in the instance.

Valid values: integers from 0 to 90.

streamSpecOptional

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

Property streamSpec: The specification of LindormStream nodes in the instance.

Valid values: lindorm.g.xlarge: Each node has 4 dedicated CPU cores and 16 GB of dedicated memory. lindorm.g.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.g.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.g.8xlarge: Each node has 32 dedicated CPU cores and 128 GB of dedicated memory. lindorm.c.xlarge: Each node has 4 dedicated CPU cores and 8 GB of dedicated memory. lindorm.c.2xlarge: Each node has 8 dedicated CPU cores and 16 GB of dedicated memory. lindorm.c.4xlarge: Each node has 16 dedicated CPU cores and 32 GB of dedicated memory. lindorm.c.8xlarge: Each node has 32 dedicated CPU cores and 64 GB of dedicated memory.

tsdbNumOptional

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

Property tsdbNum: The number of the LindormTSDB nodes in the instance.

The valid values of this parameter depend on the value of the PayType parameter. If the PayType parameter is set to PREPAY, set this parameter to an integer that ranges from 0 to 24. If the PayType parameter is set to POSTPAY, set this parameter to an integer that ranges from 0 to 32.

tsdbSpecOptional

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

Property tsdbSpec: The specification of the LindormTSDB nodes in the instance.

Valid values: lindorm.g.xlarge: Each node has 4 dedicated CPU cores and 16 GB of dedicated memory. lindorm.g.2xlarge: Each node has 8 dedicated CPU cores and 32 GB of dedicated memory. lindorm.g.4xlarge: Each node has 16 dedicated CPU cores and 64 GB of dedicated memory. lindorm.g.8xlarge: Each node has 32 dedicated CPU cores and 128 GB of dedicated memory.

vSwitchIdOptional

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

Property vSwitchId: The ID of the vSwitch to which you want the instance to connect.

zoneIdOptional

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

Property zoneId: The ID of the zone in which you want to create the instance.

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.lindorm.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.
attrAuthInfos com.aliyun.ros.cdk.core.IResolvable Attribute AuthInfos: The list of the Lindorm instance auth infos.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the Lindorm instance that is created.
attrJdbcUrlList com.aliyun.ros.cdk.core.IResolvable Attribute JdbcUrlList: The list of the jdbc connection address.

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

attrAuthInfosRequired 

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

Attribute AuthInfos: The list of the Lindorm instance auth infos.

attrInstanceIdRequired 

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

Attribute InstanceId: The ID of the Lindorm instance that is created.

attrJdbcUrlListRequired 

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

Attribute JdbcUrlList: The list of the jdbc connection address.