software.amazon.awscdk.services.iam

Interface PolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:31.424Z")
 @Stability(value=Experimental)
public interface PolicyProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for defining an IAM inline policy document.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PolicyProps.Builder A builder for PolicyProps
static class	PolicyProps.Jsii$Proxy An implementation for PolicyProps

Method Summary

Modifier and Type	Method and Description
static PolicyProps.Builder	builder()
default PolicyDocument	getDocument() (experimental) Initial PolicyDocument to use for this Policy.
default Boolean	getForce() (experimental) Force creation of an `AWS::IAM::Policy`.
default List<IGroup>	getGroups() (experimental) Groups to attach this policy to.
default String	getPolicyName() (experimental) The name of the policy.
default List<IRole>	getRoles() (experimental) Roles to attach this policy to.
default List<PolicyStatement>	getStatements() (experimental) Initial set of permissions to add to this policy document.
default List<IUser>	getUsers() (experimental) Users to attach this policy to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDocument

@Stability(value=Experimental)
 @Nullable
default PolicyDocument getDocument()

(experimental) Initial PolicyDocument to use for this Policy.

If omited, any PolicyStatement provided in the statements property will be applied against the empty default PolicyDocument.

Default: - An empty policy.

getForce

@Stability(value=Experimental)
 @Nullable
default Boolean getForce()

(experimental) Force creation of an `AWS::IAM::Policy`.

Unless set to true, this Policy construct will not materialize to an AWS::IAM::Policy CloudFormation resource in case it would have no effect (for example, if it remains unattached to an IAM identity or if it has no statements). This is generally desired behavior, since it prevents creating invalid--and hence undeployable--CloudFormation templates.

In cases where you know the policy must be created and it is actually an error if no statements have been added to it, you can set this to true.

Default: false

getGroups

@Stability(value=Experimental)
 @Nullable
default List<IGroup> getGroups()

(experimental) Groups to attach this policy to.

You can also use attachToGroup(group) to attach this policy to a group.

Default: - No groups.

getPolicyName

@Stability(value=Experimental)
 @Nullable
default String getPolicyName()

(experimental) The name of the policy.

If you specify multiple policies for an entity, specify unique names. For example, if you specify a list of policies for an IAM role, each policy must have a unique name.

Default: - Uses the logical ID of the policy resource, which is ensured to be unique within the stack.

getRoles

@Stability(value=Experimental)
 @Nullable
default List<IRole> getRoles()

(experimental) Roles to attach this policy to.

You can also use attachToRole(role) to attach this policy to a role.

Default: - No roles.

getStatements

@Stability(value=Experimental)
 @Nullable
default List<PolicyStatement> getStatements()

(experimental) Initial set of permissions to add to this policy document.

You can also use addStatements(...statement) to add permissions later.

Default: - No statements.

getUsers

@Stability(value=Experimental)
 @Nullable
default List<IUser> getUsers()

(experimental) Users to attach this policy to.

You can also use attachToUser(user) to attach this policy to a user.

Default: - No users.

builder

@Stability(value=Experimental)
static PolicyProps.Builder builder()

Returns:

a PolicyProps.Builder of PolicyProps