Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::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();

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.

Unit: month. The value must be an integral multiple of 12.

This parameter is required if you create a subscription instance.

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: The auto-renewal period.

Unit: month.

This parameter is required if the RenewalStatus parameter is set to AutoRenewal.

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

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.kms.Instance;
Instance.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

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.

props^Required

public InstanceProps getProps();

• Type: InstanceProps