Skip to content

PolicyAttachment

This class encapsulates and extends the ROS resource type ALIYUN::ResourceManager::PolicyAttachment, which is used to attach a policy to an object.

After you attach a policy to an object, the object has the permissions to manage the resources in the current resource group or within the current Alibaba Cloud account.

Initializers

import { PolicyAttachment } from '@alicloud/ros-cdk-resourcemanager'
new PolicyAttachment(scope: Construct, id: string, props: PolicyAttachmentProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props PolicyAttachmentProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

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

idRequired

  • Type: string

propsRequired


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.

sessionRequired

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

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

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

addCount

public addCount(count: number | IResolvable): void

countRequired

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

addDependency

public addDependency(resource: Resource): void

resourceRequired

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

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

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

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct

import { PolicyAttachment } from '@alicloud/ros-cdk-resourcemanager'
PolicyAttachment.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • 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.
attrAttachDate string | @alicloud/ros-cdk-core.IResolvable Attribute AttachDate: Authorization time.
attrDescription string | @alicloud/ros-cdk-core.IResolvable Attribute Description: Policy description.
attrPolicyName string | @alicloud/ros-cdk-core.IResolvable Attribute PolicyName: The name of the policy.
attrPolicyType string | @alicloud/ros-cdk-core.IResolvable Attribute PolicyType: The type of the policy.
attrPrincipalName string | @alicloud/ros-cdk-core.IResolvable Attribute PrincipalName: The name of the object to which you want to attach the policy.
attrPrincipalType string | @alicloud/ros-cdk-core.IResolvable Attribute PrincipalType: The type of the object to which you want to attach the policy.
attrResourceGroupId string | @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group or the ID of the Alibaba Cloud account to which the resource group belongs.
props PolicyAttachmentProps 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

attrAttachDateRequired

public readonly attrAttachDate: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AttachDate: Authorization time.


attrDescriptionRequired

public readonly attrDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Description: Policy description.


attrPolicyNameRequired

public readonly attrPolicyName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PolicyName: The name of the policy.


attrPolicyTypeRequired

public readonly attrPolicyType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PolicyType: The type of the policy.


attrPrincipalNameRequired

public readonly attrPrincipalName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PrincipalName: The name of the object to which you want to attach the policy.


attrPrincipalTypeRequired

public readonly attrPrincipalType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PrincipalType: The type of the object to which you want to attach the policy.

Valid values: IMSUser: RAM user, IMSGroup: RAM user group, ServiceRole: RAM role


attrResourceGroupIdRequired

public readonly attrResourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group or the ID of the Alibaba Cloud account to which the resource group belongs.


propsRequired

public readonly props: PolicyAttachmentProps;