Instance

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

Initializers

import { datasource } from '@alicloud/ros-cdk-kms'
new datasource.Instance(scope: Construct, id: string, props: InstanceProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	InstanceProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: InstanceProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { datasource } from '@alicloud/ros-cdk-kms'
datasource.Instance.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrCreateTime	@alicloud/ros-cdk-core.IResolvable	Attribute CreateTime: The time when the KMS instance is created.
attrInstanceId	@alicloud/ros-cdk-core.IResolvable	Attribute InstanceId: The ID of the KMS instance.
attrInstanceName	@alicloud/ros-cdk-core.IResolvable	Attribute InstanceName: The name of the KMS instance.
attrKeyNum	@alicloud/ros-cdk-core.IResolvable	Attribute KeyNum: The number of keys that can be created for the KMS instance.
attrSecretNum	@alicloud/ros-cdk-core.IResolvable	Attribute SecretNum: The number of secrets that can be created for the KMS instance.
attrSpec	@alicloud/ros-cdk-core.IResolvable	Attribute Spec: The computation performance level of the KMS instance.
attrVpcId	@alicloud/ros-cdk-core.IResolvable	Attribute VpcId: The virtual private cloud (VPC) with which the KMS instance is associated..
attrVpcNum	@alicloud/ros-cdk-core.IResolvable	Attribute VpcNum: The number of managed accesses.
attrVswitchIds	@alicloud/ros-cdk-core.IResolvable	Attribute VswitchIds: The VSwitch in the VPC.
attrZoneIds	@alicloud/ros-cdk-core.IResolvable	Attribute ZoneIds: The zone with which the KMS instance is associated.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrCreateTime^Required

public readonly attrCreateTime: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrInstanceId^Required

public readonly attrInstanceId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: The ID of the KMS instance.

---

attrInstanceName^Required

public readonly attrInstanceName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceName: The name of the KMS instance.

---

attrKeyNum^Required

public readonly attrKeyNum: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrSecretNum^Required

public readonly attrSecretNum: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrSpec^Required

public readonly attrSpec: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrVpcId^Required

public readonly attrVpcId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrVpcNum^Required

public readonly attrVpcNum: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcNum: The number of managed accesses.

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

---

attrVswitchIds^Required

public readonly attrVswitchIds: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute VswitchIds: The VSwitch in the VPC.

---

attrZoneIds^Required

public readonly attrZoneIds: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---