software.amazon.awscdk.services.iam

Class Role.Builder

java.lang.Object

software.amazon.awscdk.services.iam.Role.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Role>

Enclosing class:

Role

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

A fluent builder for Role.

Method Summary

Modifier and Type	Method and Description
Role.Builder	assumedBy(IPrincipal assumedBy) The IAM principal (i.e.
Role	build()
static Role.Builder	create(software.constructs.Construct scope, String id)
Role.Builder	description(String description) A description of the role.
Role.Builder	externalIds(List<String> externalIds) List of IDs that the role assumer needs to provide one of when assuming this role.
Role.Builder	inlinePolicies(Map<String,? extends PolicyDocument> inlinePolicies) A list of named policies to inline into this role.
Role.Builder	managedPolicies(List<? extends IManagedPolicy> managedPolicies) A list of managed policies associated with this role.
Role.Builder	maxSessionDuration(Duration maxSessionDuration) The maximum session duration that you want to set for the specified role.
Role.Builder	path(String path) The path associated with this role.
Role.Builder	permissionsBoundary(IManagedPolicy permissionsBoundary) AWS supports permissions boundaries for IAM entities (users or roles).
Role.Builder	roleName(String roleName) A name for the IAM role.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Role.Builder.

assumedBy

@Stability(value=Stable)
public Role.Builder assumedBy(IPrincipal assumedBy)

The IAM principal (i.e. `new ServicePrincipal('sns.amazonaws.com')`) which can assume this role.

You can later modify the assume role policy document by accessing it via the assumeRolePolicy property.

Parameters:

assumedBy - The IAM principal (i.e. `new ServicePrincipal('sns.amazonaws.com')`) which can assume this role. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public Role.Builder description(String description)

A description of the role.

It can be up to 1000 characters long.

Default: - No description.

Parameters:

description - A description of the role. This parameter is required.

Returns:

this

externalIds

@Stability(value=Stable)
public Role.Builder externalIds(List<String> externalIds)

List of IDs that the role assumer needs to provide one of when assuming this role.

If the configured and provided external IDs do not match, the AssumeRole operation will fail.

Default: No external ID required

Parameters:

externalIds - List of IDs that the role assumer needs to provide one of when assuming this role. This parameter is required.

Returns:

this

inlinePolicies

@Stability(value=Stable)
public Role.Builder inlinePolicies(Map<String,? extends PolicyDocument> inlinePolicies)

A list of named policies to inline into this role.

These policies will be created with the role, whereas those added by addToPolicy are added using a separate CloudFormation resource (allowing a way around circular dependencies that could otherwise be introduced).

Default: - No policy is inlined in the Role resource.

Parameters:

inlinePolicies - A list of named policies to inline into this role. This parameter is required.

Returns:

this

managedPolicies

@Stability(value=Stable)
public Role.Builder managedPolicies(List<? extends IManagedPolicy> managedPolicies)

A list of managed policies associated with this role.

You can add managed policies later using addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName)).

Default: - No managed policies.

Parameters:

managedPolicies - A list of managed policies associated with this role. This parameter is required.

Returns:

this

maxSessionDuration

@Stability(value=Stable)
public Role.Builder maxSessionDuration(Duration maxSessionDuration)

The maximum session duration that you want to set for the specified role.

This setting can have a value from 1 hour (3600sec) to 12 (43200sec) hours.

Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter.

If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL.

Default: Duration.hours(1)

Parameters:

maxSessionDuration - The maximum session duration that you want to set for the specified role. This parameter is required.

Returns:

this

path

@Stability(value=Stable)
public Role.Builder path(String path)

The path associated with this role.

For information about IAM paths, see Friendly Names and Paths in IAM User Guide.

Default: /

Parameters:

path - The path associated with this role. This parameter is required.

Returns:

this

permissionsBoundary

@Stability(value=Stable)
public Role.Builder permissionsBoundary(IManagedPolicy permissionsBoundary)

AWS supports permissions boundaries for IAM entities (users or roles).

A permissions boundary is an advanced feature for using a managed policy to set the maximum permissions that an identity-based policy can grant to an IAM entity. An entity's permissions boundary allows it to perform only the actions that are allowed by both its identity-based policies and its permissions boundaries.

Default: - No permissions boundary.

Parameters:

permissionsBoundary - AWS supports permissions boundaries for IAM entities (users or roles). This parameter is required.

Returns:

this

roleName

@Stability(value=Stable)
public Role.Builder roleName(String roleName)

A name for the IAM role.

For valid values, see the RoleName parameter for the CreateRole action in the IAM API Reference.

IMPORTANT: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the role name.

Parameters:

roleName - A name for the IAM role. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public Role build()

Specified by:

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