HiTSDBInstance

This class encapsulates and extends the ROS resource type ALIYUN::TSDB::HiTSDBInstance, which is used to create a Time Series Database (TSDB) instance.

Initializers

import com.aliyun.ros.cdk.tsdb.HiTSDBInstance;
HiTSDBInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceClass(java.lang.String)
    .instanceClass(IResolvable)
    .instanceStorage(java.lang.Number)
    .instanceStorage(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .diskCategory(java.lang.String)
//  .diskCategory(IResolvable)
//  .duration(java.lang.Number)
//  .duration(IResolvable)
//  .instanceAlias(java.lang.String)
//  .instanceAlias(IResolvable)
//  .payType(java.lang.String)
//  .payType(IResolvable)
//  .pricingCycle(java.lang.String)
//  .pricingCycle(IResolvable)
//  .securityIpList(IResolvable)
//  .securityIpList(java.util.List<java.lang.String)
//  .securityIpList(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.
`instanceClass`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property instanceClass: The type of the instance.
`instanceStorage`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property instanceStorage: The storage capacity of the instance.
`vpcId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property vpcId: The ID of the virtual private cloud (VPC) that is connected to the instance.
`vSwitchId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property vSwitchId: The ID of the VSwitch in the specified VPC.
`zoneId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property zoneId: The zone ID of the instance.
`diskCategory`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property diskCategory: The category of disk.
`duration`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property duration: The validity period of the instance.
`instanceAlias`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property instanceAlias: The alias of the instance.
`payType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property payType: The billing method.
`pricingCycle`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property pricingCycle: The unit of the validity period.
`securityIpList`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.List`	Property securityIpList: List of the IP patterns.For example, ["127.0.0.1", "192.168.0.1\/24"].

`scope`^Required

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

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`instanceClass`^Required

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

Property instanceClass: The type of the instance.

`instanceStorage`^Required

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

Property instanceStorage: The storage capacity of the instance.

Unit: GB. For example, the value 50 indicates 50 GB.

`vpcId`^Required

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

Property vpcId: The ID of the virtual private cloud (VPC) that is connected to the instance.

`vSwitchId`^Required

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

Property vSwitchId: The ID of the VSwitch in the specified VPC.

`zoneId`^Required

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

Property zoneId: The zone ID of the instance.

`diskCategory`^Optional

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

Property diskCategory: The category of disk.

`duration`^Optional

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

Property duration: The validity period of the instance.

This parameter is valid only when the PayType parameter is set to PREPAY. Default value: 1.

`instanceAlias`^Optional

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

Property instanceAlias: The alias of the instance.

`payType`^Optional

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

Property payType: The billing method.

Valid values:

prepay: The prepay value indicates the subscription method.

`pricingCycle`^Optional

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

Property pricingCycle: The unit of the validity period.

This parameter is valid only when the PayType parameter is set to PREPAY. Default value: Month.

`securityIpList`^Optional

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

Property securityIpList: List of the IP patterns.For example, ["127.0.0.1", "192.168.0.1\/24"].

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.

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

`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

Name	Description
`isConstruct`	Return whether the given object is a Construct.

`isConstruct`

import com.aliyun.ros.cdk.tsdb.HiTSDBInstance;
HiTSDBInstance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

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.
`attrConnectionString`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ConnectionString: Connection string of the instance.
`attrEngineType`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute EngineType: Engine type of the instance.
`attrInstanceId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute InstanceId: The ID of the instance.
`attrOrderId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute OrderId: Order id of created instance.
`attrPublicConnectionString`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute PublicConnectionString: Public connection string of the instance.
`attrReverseVpcIp`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ReverseVpcIp: Reverse vpc ip of the instance.
`attrReverseVpcPort`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ReverseVpcPort: Reverse vpc port of the instance.

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`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

`attrConnectionString`^Required

public IResolvable getAttrConnectionString();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionString: Connection string of the instance.

`attrEngineType`^Required

public IResolvable getAttrEngineType();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EngineType: Engine type of the instance.

`attrInstanceId`^Required

public IResolvable getAttrInstanceId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the instance.

`attrOrderId`^Required

public IResolvable getAttrOrderId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: Order id of created instance.

`attrPublicConnectionString`^Required

public IResolvable getAttrPublicConnectionString();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PublicConnectionString: Public connection string of the instance.

`attrReverseVpcIp`^Required

public IResolvable getAttrReverseVpcIp();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ReverseVpcIp: Reverse vpc ip of the instance.

`attrReverseVpcPort`^Required

public IResolvable getAttrReverseVpcPort();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ReverseVpcPort: Reverse vpc port of the instance.

HiTSDBInstance

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

instanceClassRequired

instanceStorageRequired

vpcIdRequired

vSwitchIdRequired

zoneIdRequired

diskCategoryOptional

durationOptional

instanceAliasOptional

payTypeOptional

pricingCycleOptional

securityIpListOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata