Class PolicyStatement
Represents a statement in an IAM policy document.
Inheritance
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.AWS.IAM.dll
Syntax (csharp)
public class PolicyStatement : DeputyBaseSyntax (vb)
Public Class PolicyStatement
Inherits DeputyBaseRemarks
stability: Stable
Synopsis
Constructors
| PolicyStatement(IPolicyStatementProps) | |
| PolicyStatement(ByRefValue) | |
| PolicyStatement(DeputyBase.DeputyProps) |
Properties
| Effect | |
| HasPrincipal | Indicates if this permission has a "Principal" section. |
| HasResource | Indicates if this permission as at least one resource associated with it. |
| Sid | Statement ID for this statement. |
Methods
| AddAccountCondition(String) | Add a condition that limits to a given account. |
| AddAccountRootPrincipal() | |
| AddActions(String[]) | |
| AddAllResources() | Adds a |
| AddAnyPrincipal() | |
| AddArnPrincipal(String) | |
| AddAwsAccountPrincipal(String) | |
| AddCanonicalUserPrincipal(String) | |
| AddCondition(String, Object) | Add a condition to the Policy. |
| AddConditions(IDictionary<String, Object>) | Add multiple conditions to the Policy. |
| AddFederatedPrincipal(Object, IDictionary<String, Object>) | |
| AddNotActions(String[]) | |
| AddNotPrincipals(IPrincipal[]) | |
| AddNotResources(String[]) | |
| AddPrincipals(IPrincipal[]) | |
| AddResources(String[]) | |
| AddServicePrincipal(String, IServicePrincipalOpts) | Adds a service principal to this policy statement. |
| ToJSON() | JSON-ify the statement. |
| ToStatementJson() | |
| ToString() |
Constructors
PolicyStatement(IPolicyStatementProps)
public PolicyStatement(IPolicyStatementProps props = null)Parameters
- props IPolicyStatementProps
Remarks
stability: Stable
PolicyStatement(ByRefValue)
protected PolicyStatement(ByRefValue reference)Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
PolicyStatement(DeputyBase.DeputyProps)
protected PolicyStatement(DeputyBase.DeputyProps props)Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
Properties
Effect
HasPrincipal
Indicates if this permission has a "Principal" section.
public virtual bool HasPrincipal { get; }Property Value
System.Boolean
Remarks
stability: Stable
HasResource
Indicates if this permission as at least one resource associated with it.
public virtual bool HasResource { get; }Property Value
System.Boolean
Remarks
stability: Stable
Sid
Statement ID for this statement.
public virtual string Sid { get; set; }Property Value
System.String
Remarks
stability: Stable
Methods
AddAccountCondition(String)
Add a condition that limits to a given account.
public virtual void AddAccountCondition(string accountId)Parameters
- accountId System.String
Remarks
stability: Stable
AddAccountRootPrincipal()
public virtual void AddAccountRootPrincipal()Remarks
stability: Stable
AddActions(String[])
public virtual void AddActions(params string[] actions)Parameters
- actions System.String[]
Remarks
stability: Stable
AddAllResources()
Adds a "*" resource to this statement.
public virtual void AddAllResources()Remarks
stability: Stable
AddAnyPrincipal()
public virtual void AddAnyPrincipal()Remarks
stability: Stable
AddArnPrincipal(String)
public virtual void AddArnPrincipal(string arn)Parameters
- arn System.String
Remarks
stability: Stable
AddAwsAccountPrincipal(String)
public virtual void AddAwsAccountPrincipal(string accountId)Parameters
- accountId System.String
Remarks
stability: Stable
AddCanonicalUserPrincipal(String)
public virtual void AddCanonicalUserPrincipal(string canonicalUserId)Parameters
- canonicalUserId System.String
Remarks
stability: Stable
AddCondition(String, Object)
Add a condition to the Policy.
public virtual void AddCondition(string key, object value)Parameters
- key System.String
- value System.Object
Remarks
stability: Stable
AddConditions(IDictionary<String, Object>)
Add multiple conditions to the Policy.
public virtual void AddConditions(IDictionary<string, object> conditions)Parameters
- conditions System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
stability: Stable
AddFederatedPrincipal(Object, IDictionary<String, Object>)
public virtual void AddFederatedPrincipal(object federated, IDictionary<string, object> conditions)Parameters
- federated System.Object
- conditions System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
stability: Stable
AddNotActions(String[])
public virtual void AddNotActions(params string[] notActions)Parameters
- notActions System.String[]
Remarks
stability: Stable
AddNotPrincipals(IPrincipal[])
public virtual void AddNotPrincipals(params IPrincipal[] notPrincipals)Parameters
- notPrincipals IPrincipal[]
Remarks
stability: Stable
AddNotResources(String[])
public virtual void AddNotResources(params string[] arns)Parameters
- arns System.String[]
Remarks
stability: Stable
AddPrincipals(IPrincipal[])
public virtual void AddPrincipals(params IPrincipal[] principals)Parameters
- principals IPrincipal[]
Remarks
stability: Stable
AddResources(String[])
public virtual void AddResources(params string[] arns)Parameters
- arns System.String[]
Remarks
stability: Stable
AddServicePrincipal(String, IServicePrincipalOpts)
Adds a service principal to this policy statement.
public virtual void AddServicePrincipal(string service, IServicePrincipalOpts opts = null)Parameters
- service System.String
the service name for which a service principal is requested (e.g:
s3.amazonaws.com).- opts IServicePrincipalOpts
options for adding the service principal (such as specifying a principal in a different region).
Remarks
stability: Stable
ToJSON()
JSON-ify the statement.
public virtual object ToJSON()Returns
System.Object
Remarks
Used when JSON.stringify() is called stability: Stable
ToStatementJson()
public virtual object ToStatementJson()Returns
System.Object
Remarks
stability: Stable
ToString()
public override string ToString()Returns
System.String
Remarks
stability: Stable