Policy
- Implements: @alicloud/ros-cdk-kms.datasource.IPolicy
This class encapsulates and extends the ROS resource type DATASOURCE::KMS::Policy.
Initializers
import { datasource } from '@alicloud/ros-cdk-kms'
new datasource.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. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: PolicyProps
enableResourcePropertyConstraintOptional
- 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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { datasource } from '@alicloud/ros-cdk-kms'
datasource.Policy.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: The policy description. |
attrKmsInstanceId | string | @alicloud/ros-cdk-core.IResolvable | Attribute KmsInstanceId: KMS instance accessed by this policy. |
attrNetworkRules | string | @alicloud/ros-cdk-core.IResolvable | Attribute NetworkRules: The network access rule that is associated with the permission policy. |
attrPermissions | string | @alicloud/ros-cdk-core.IResolvable | Attribute Permissions: A list of operations that can be performed. |
attrPolicyName | string | @alicloud/ros-cdk-core.IResolvable | Attribute PolicyName: The name of the permission policy. |
attrResources | string | @alicloud/ros-cdk-core.IResolvable | Attribute Resources: A list of keys and secrets that are allowed to access. |
props | PolicyProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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.
refRequired
public readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: The policy description.
attrKmsInstanceIdRequired
public readonly attrKmsInstanceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute KmsInstanceId: KMS instance accessed by this policy.
attrNetworkRulesRequired
public readonly attrNetworkRules: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute NetworkRules: The network access rule that is associated with the permission policy.
attrPermissionsRequired
public readonly attrPermissions: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Permissions: A list of operations that can be performed.
attrPolicyNameRequired
public readonly attrPolicyName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute PolicyName: The name of the permission policy.
attrResourcesRequired
public readonly attrResources: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Resources: A list of keys and secrets that are allowed to access.
propsRequired
public readonly props: PolicyProps;
- Type: PolicyProps