software.amazon.awscdk.services.iam

Class ManagedPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.iam.ManagedPolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ManagedPolicy>

Enclosing class:

ManagedPolicy

@Stability(value=Experimental)
public static final class ManagedPolicy.Builder
extends Object
implements software.amazon.jsii.Builder<ManagedPolicy>

(experimental) A fluent builder for ManagedPolicy.

Method Summary

Modifier and Type	Method and Description
ManagedPolicy	build()
static ManagedPolicy.Builder	create(software.constructs.Construct scope, String id)
ManagedPolicy.Builder	description(String description) (experimental) A description of the managed policy.
ManagedPolicy.Builder	document(PolicyDocument document) (experimental) Initial PolicyDocument to use for this ManagedPolicy.
ManagedPolicy.Builder	groups(List<? extends IGroup> groups) (experimental) Groups to attach this policy to.
ManagedPolicy.Builder	managedPolicyName(String managedPolicyName) (experimental) The name of the managed policy.
ManagedPolicy.Builder	path(String path) (experimental) The path for the policy.
ManagedPolicy.Builder	roles(List<? extends IRole> roles) (experimental) Roles to attach this policy to.
ManagedPolicy.Builder	statements(List<? extends PolicyStatement> statements) (experimental) Initial set of permissions to add to this policy document.
ManagedPolicy.Builder	users(List<? extends IUser> users) (experimental) Users to attach this policy to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static ManagedPolicy.Builder create(software.constructs.Construct scope,
                                                                          String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ManagedPolicy.Builder.

description

@Stability(value=Experimental)
public ManagedPolicy.Builder description(String description)

(experimental) A description of the managed policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." The policy description is immutable. After a value is assigned, it cannot be changed.

Default: - empty

Parameters:

description - A description of the managed policy. This parameter is required.

Returns:

this

document

@Stability(value=Experimental)
public ManagedPolicy.Builder document(PolicyDocument document)

(experimental) Initial PolicyDocument to use for this ManagedPolicy.

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

Default: - An empty policy.

Parameters:

document - Initial PolicyDocument to use for this ManagedPolicy. This parameter is required.

Returns:

this

groups

@Stability(value=Experimental)
public ManagedPolicy.Builder groups(List<? extends IGroup> groups)

(experimental) Groups to attach this policy to.

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

Default: - No groups.

Parameters:

groups - Groups to attach this policy to. This parameter is required.

Returns:

this

managedPolicyName

@Stability(value=Experimental)
public ManagedPolicy.Builder managedPolicyName(String managedPolicyName)

(experimental) The name of the managed 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: - A name is automatically generated.

Parameters:

managedPolicyName - The name of the managed policy. This parameter is required.

Returns:

this

path

@Stability(value=Experimental)
public ManagedPolicy.Builder path(String path)

(experimental) The path for the policy.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

For more information about paths, see IAM Identifiers in the IAM User Guide.

Default: - "/"

Parameters:

path - The path for the policy. This parameter is required.

Returns:

this

roles

@Stability(value=Experimental)
public ManagedPolicy.Builder roles(List<? extends IRole> roles)

(experimental) Roles to attach this policy to.

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

Default: - No roles.

Parameters:

roles - Roles to attach this policy to. This parameter is required.

Returns:

this

statements

@Stability(value=Experimental)
public ManagedPolicy.Builder statements(List<? extends PolicyStatement> statements)

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

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

Default: - No statements.

Parameters:

statements - Initial set of permissions to add to this policy document. This parameter is required.

Returns:

this

users

@Stability(value=Experimental)
public ManagedPolicy.Builder users(List<? extends IUser> users)

(experimental) Users to attach this policy to.

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

Default: - No users.

Parameters:

users - Users to attach this policy to. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public ManagedPolicy build()

Specified by:

build in interface software.amazon.jsii.Builder<ManagedPolicy>