Class Policy

The AWS::IAM::Policy resource associates an IAM policy with IAM users, roles, or groups.

Inheritance
System.Object
Construct
Resource
Policy
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.AWS.IAM.dll
Syntax (csharp)
public class Policy : Resource, IPolicy, IResource, IConstruct, IConstruct, IDependable
Syntax (vb)
Public Class Policy
    Inherits Resource
    Implements IPolicy, IResource, IConstruct, IConstruct, IDependable
Remarks

For more information about IAM policies, see Overview of IAM Policies in the IAM User Guide guide.

Stability: Stable

Synopsis

Constructors

Policy(Construct, String, IPolicyProps)
Policy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
Policy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

Document

The policy document.
PolicyName

The name of this policy.

Methods

AddStatements(PolicyStatement[])

Adds a statement to the policy document.
AttachToGroup(IGroup)

Attaches this policy to a group.
AttachToRole(IRole)

Attaches this policy to a role.
AttachToUser(IUser)

Attaches this policy to a user.
FromPolicyName(Construct, String, String)
Prepare()

Perform final modifications before synthesis.
Validate()

Validate the current construct.

Constructors

Policy(Construct, String, IPolicyProps)

public Policy(Construct scope, string id, IPolicyProps props = null)
Parameters
scope Construct
id System.String
props IPolicyProps
Remarks

Stability: Stable

Policy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Policy(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

Policy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Policy(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

Document

The policy document.

public virtual PolicyDocument Document { get; }
Property Value

PolicyDocument

Remarks

Stability: Stable

PolicyName

The name of this policy.

public virtual string PolicyName { get; }
Property Value

System.String

Remarks

Stability: Stable

Attribute: true

Methods

AddStatements(PolicyStatement[])

Adds a statement to the policy document.

public virtual void AddStatements(params PolicyStatement[] statement)
Parameters
statement PolicyStatement[]
Remarks

Stability: Stable

AttachToGroup(IGroup)

Attaches this policy to a group.

public virtual void AttachToGroup(IGroup group)
Parameters
group IGroup
Remarks

Stability: Stable

AttachToRole(IRole)

Attaches this policy to a role.

public virtual void AttachToRole(IRole role)
Parameters
role IRole
Remarks

Stability: Stable

AttachToUser(IUser)

Attaches this policy to a user.

public virtual void AttachToUser(IUser user)
Parameters
user IUser
Remarks

Stability: Stable

FromPolicyName(Construct, String, String)

public static IPolicy FromPolicyName(Construct scope, string id, string policyName)
Parameters
scope Construct
id System.String
policyName System.String
Returns

IPolicy

Remarks

Stability: Stable

Prepare()

Perform final modifications before synthesis.

protected override void Prepare()
Overrides
Remarks

This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.

This is an advanced framework feature. Only use this if you understand the implications.

Stability: Stable

Validate()

Validate the current construct.

protected override string[] Validate()
Returns

System.String[]

Overrides
Remarks

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Stability: Stable

Implements

Constructs.IConstruct