Policy

This class encapsulates and extends the ROS resource type ALIYUN::KMS::Policy.

Initializers

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

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

---

scope^Required

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

---

id^Required

• Type: string

---

props^Required

• Type: PolicyProps

---

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 { Policy } from '@alicloud/ros-cdk-kms'
Policy.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.
attrAccessControlRules	@alicloud/ros-cdk-core.IResolvable	Attribute AccessControlRules: Network Rules info.
attrDescription	@alicloud/ros-cdk-core.IResolvable	Attribute Description: Description.
attrKmsInstanceId	@alicloud/ros-cdk-core.IResolvable	Attribute KmsInstanceId: The scope of the permission policy.
attrPermissions	@alicloud/ros-cdk-core.IResolvable	Attribute Permissions: RbacPermission Template, support RbacPermission/Template/CryptoServiceKeyUser and RbacPermission/Template/CryptoServiceSecretUser.
attrPolicyName	@alicloud/ros-cdk-core.IResolvable	Attribute PolicyName: The name of the permission policy.
attrResources	@alicloud/ros-cdk-core.IResolvable	Attribute Resources: Resources that allowed access by this policy.

---

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

---

attrAccessControlRules^Required

public readonly attrAccessControlRules: IResolvable;

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

Attribute AccessControlRules: Network Rules info.

---

attrDescription^Required

public readonly attrDescription: IResolvable;

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

Attribute Description: Description.

---

attrKmsInstanceId^Required

public readonly attrKmsInstanceId: IResolvable;

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

Attribute KmsInstanceId: The scope of the permission policy.

You need to specify the KMS instance that you want to access.

---

attrPermissions^Required

public readonly attrPermissions: IResolvable;

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

Attribute Permissions: RbacPermission Template, support RbacPermission/Template/CryptoServiceKeyUser and RbacPermission/Template/CryptoServiceSecretUser.

---

attrPolicyName^Required

public readonly attrPolicyName: IResolvable;

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

Attribute PolicyName: The name of the permission policy.

---

attrResources^Required

public readonly attrResources: IResolvable;

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

Attribute Resources: Resources that allowed access by this policy.

---