Instance

This class encapsulates and extends the ROS resource type ALIYUN::KMS::Instance, which is used to create a Key Management Service (KMS) instance.

Initializers

import com.aliyun.ros.cdk.kms.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .productVersion(java.lang.String)
    .productVersion(IResolvable)
//  .connection(IResolvable)
//  .connection(ConnectionProperty)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .keyNum(java.lang.Number)
//  .keyNum(IResolvable)
//  .log(java.lang.Boolean)
//  .log(IResolvable)
//  .logStorage(java.lang.Number)
//  .logStorage(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .renewPeriod(java.lang.Number)
//  .renewPeriod(IResolvable)
//  .renewStatus(java.lang.String)
//  .renewStatus(IResolvable)
//  .secretNum(java.lang.Number)
//  .secretNum(IResolvable)
//  .spec(java.lang.Number)
//  .spec(IResolvable)
//  .vpcNum(java.lang.Number)
//  .vpcNum(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.
productVersion	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property productVersion: KMS Instance commodity type (software\/software-small\/hardware\/hardware-small).
connection	com.aliyun.ros.cdk.core.IResolvable OR ConnectionProperty	Property connection:.
instanceChargeType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property instanceChargeType: Billing method of the KMS instance, default to Subscription.
keyNum	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property keyNum: Maximum number of stored keys.
log	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property log: Whether to enable log.
logStorage	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property logStorage: Log storage.
period	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property period: The subscription duration of the KMS instance.
periodUnit	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property periodUnit: The unit of the subscription duration.
renewPeriod	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property renewPeriod: Automatic renewal period, in months.
renewStatus	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property renewStatus: Renewal options (manual renewal, automatic renewal, no renewal).
secretNum	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property secretNum: Maximum number of secrets.
spec	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property spec: The computation performance level of the KMS instance.
vpcNum	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property vpcNum: The number of managed accesses.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

productVersion^Required

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

Property productVersion: KMS Instance commodity type (software\/software-small\/hardware\/hardware-small).

---

connection^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR ConnectionProperty

Property connection:.

---

instanceChargeType^Optional

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

Property instanceChargeType: Billing method of the KMS instance, default to Subscription.

---

keyNum^Optional

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

Property keyNum: Maximum number of stored keys.

It is required when the InstanceCharge is Subscription.

---

log^Optional

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

Property log: Whether to enable log.

---

logStorage^Optional

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

Property logStorage: Log storage.

---

period^Optional

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

Property period: The subscription duration of the KMS instance.

If PeriodUnit is Month, the valid range is 1, 2, 3, 6, 12, 24, 36 If PeriodUnit is Year, the valid range is 1, 2, 3

---

periodUnit^Optional

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

---

renewPeriod^Optional

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

Property renewPeriod: Automatic renewal period, in months.

---

renewStatus^Optional

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

Property renewStatus: Renewal options (manual renewal, automatic renewal, no renewal).

---

secretNum^Optional

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

Property secretNum: Maximum number of secrets.

It is required when the InstanceCharge is Subscription.

---

spec^Optional

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

Property spec: The computation performance level of the KMS instance.

---

vpcNum^Optional

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

Property vpcNum: The number of managed accesses.

The maximum number of VPCs that can access this KMS instance. It is required when the InstanceCharge is Subscription.

---

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.kms.Instance;
Instance.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.
attrInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute InstanceId: The ID 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

---

attrInstanceId^Required

public IResolvable getAttrInstanceId();

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

Attribute InstanceId: The ID of the instance.

---