Skip to content

Instance

This class encapsulates and extends the ROS resource type DATASOURCE::KMS::Instance.

Initializers 

import com.aliyun.ros.cdk.kms.datasource.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The ID of the KMS instance.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

instanceIdRequired

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

Property instanceId: The ID of the KMS instance.

refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.kms.datasource.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.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The time when the KMS instance is created.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: The ID of the KMS instance.
attrInstanceName com.aliyun.ros.cdk.core.IResolvable Attribute InstanceName: The name of the KMS instance.
attrKeyNum com.aliyun.ros.cdk.core.IResolvable Attribute KeyNum: The number of keys that can be created for the KMS instance.
attrSecretNum com.aliyun.ros.cdk.core.IResolvable Attribute SecretNum: The number of secrets that can be created for the KMS instance.
attrSpec com.aliyun.ros.cdk.core.IResolvable Attribute Spec: The computation performance level of the KMS instance.
attrVpcId com.aliyun.ros.cdk.core.IResolvable Attribute VpcId: The virtual private cloud (VPC) with which the KMS instance is associated..
attrVpcNum com.aliyun.ros.cdk.core.IResolvable Attribute VpcNum: The number of managed accesses.
attrVswitchIds com.aliyun.ros.cdk.core.IResolvable Attribute VswitchIds: The VSwitch in the VPC.
attrZoneIds com.aliyun.ros.cdk.core.IResolvable Attribute ZoneIds: The zone with which the KMS instance is associated.

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

attrCreateTimeRequired 

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

Attribute CreateTime: The time when the KMS instance is created.

attrInstanceIdRequired 

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

Attribute InstanceId: The ID of the KMS instance.

attrInstanceNameRequired 

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

Attribute InstanceName: The name of the KMS instance.

attrKeyNumRequired 

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

Attribute KeyNum: The number of keys that can be created for the KMS instance.

attrSecretNumRequired 

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

Attribute SecretNum: The number of secrets that can be created for the KMS instance.

attrSpecRequired 

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

Attribute Spec: The computation performance level of the KMS instance.

attrVpcIdRequired 

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

Attribute VpcId: The virtual private cloud (VPC) with which the KMS instance is associated..

attrVpcNumRequired 

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

Attribute VpcNum: The number of managed accesses.

The maximum number of VPCs that can access this KMS instance.

attrVswitchIdsRequired 

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

Attribute VswitchIds: The VSwitch in the VPC.

attrZoneIdsRequired 

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

Attribute ZoneIds: The zone with which the KMS instance is associated.