HiTSDBInstance

• Implements: IHiTSDBInstance

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();

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 storage capacity of the instance.

Unit: GB.

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 ID of the request.

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 ID of the VPC in which the instances reside.

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

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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 java.lang.Object getAttrConnectionString();

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

Attribute ConnectionString: Connection string of the instance.

attrEngineType^Required

public java.lang.Object getAttrEngineType();

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

Attribute EngineType: Engine type of the instance.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: The ID of the instance.

attrOrderId^Required

public java.lang.Object getAttrOrderId();

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

Attribute OrderId: Order id of created instance.

attrPublicConnectionString^Required

public java.lang.Object getAttrPublicConnectionString();

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

Attribute PublicConnectionString: Public connection string of the instance.

attrReverseVpcIp^Required

public java.lang.Object getAttrReverseVpcIp();

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

Attribute ReverseVpcIp: Reverse vpc ip of the instance.

attrReverseVpcPort^Required

public java.lang.Object getAttrReverseVpcPort();

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

Attribute ReverseVpcPort: Reverse vpc port of the instance.

props^Required

public HiTSDBInstanceProps getProps();

• Type: HiTSDBInstanceProps