software.amazon.awssdk.services.iam.model

Interface Role.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Role.Builder,Role>, SdkBuilder<Role.Builder,Role>, SdkPojo

Enclosing class:

Role

public static interface Role.Builder
extends SdkPojo, CopyableBuilder<Role.Builder,Role>

Method Summary

Modifier and Type	Method and Description
Role.Builder	arn(String arn) The Amazon Resource Name (ARN) specifying the role.
Role.Builder	assumeRolePolicyDocument(String assumeRolePolicyDocument) The policy that grants an entity permission to assume the role.
Role.Builder	createDate(Instant createDate) The date and time, in ISO 8601 date-time format, when the role was created.
Role.Builder	description(String description) A description of the role that you provide.
Role.Builder	maxSessionDuration(Integer maxSessionDuration) The maximum session duration (in seconds) for the specified role.
Role.Builder	path(String path) The path to the role.
Role.Builder	permissionsBoundary(AttachedPermissionsBoundary permissionsBoundary) The ARN of the policy used to set the permissions boundary for the role.
default Role.Builder	permissionsBoundary(Consumer<AttachedPermissionsBoundary.Builder> permissionsBoundary) The ARN of the policy used to set the permissions boundary for the role.
Role.Builder	roleId(String roleId) The stable and unique string identifying the role.
Role.Builder	roleName(String roleName) The friendly name that identifies the role.
Role.Builder	tags(Collection<Tag> tags) A list of tags that are attached to the specified role.
Role.Builder	tags(Consumer<Tag.Builder>... tags) A list of tags that are attached to the specified role.
Role.Builder	tags(Tag... tags) A list of tags that are attached to the specified role.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

path

Role.Builder path(String path)

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

Parameters:

path - The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleName

Role.Builder roleName(String roleName)

The friendly name that identifies the role.

Parameters:

roleName - The friendly name that identifies the role.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleId

Role.Builder roleId(String roleId)

The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.

Parameters:

roleId - The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

arn

Role.Builder arn(String arn)

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide guide.

Parameters:

arn - The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

createDate

Role.Builder createDate(Instant createDate)

The date and time, in ISO 8601 date-time format, when the role was created.

Parameters:

createDate - The date and time, in ISO 8601 date-time format, when the role was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

assumeRolePolicyDocument

Role.Builder assumeRolePolicyDocument(String assumeRolePolicyDocument)

The policy that grants an entity permission to assume the role.

Parameters:

assumeRolePolicyDocument - The policy that grants an entity permission to assume the role.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

Role.Builder description(String description)

A description of the role that you provide.

Parameters:

description - A description of the role that you provide.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Role.Builder tags(Collection<Tag> tags)

A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Parameters:

tags - A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Role.Builder tags(Tag... tags)

A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Parameters:

tags - A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Role.Builder tags(Consumer<Tag.Builder>... tags)

A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

maxSessionDuration

Role.Builder maxSessionDuration(Integer maxSessionDuration)

The maximum session duration (in seconds) for the specified role. Anyone who uses the AWS CLI or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

Parameters:

maxSessionDuration - The maximum session duration (in seconds) for the specified role. Anyone who uses the AWS CLI or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

permissionsBoundary

Role.Builder permissionsBoundary(AttachedPermissionsBoundary permissionsBoundary)

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Parameters:

permissionsBoundary - The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

permissionsBoundary

default Role.Builder permissionsBoundary(Consumer<AttachedPermissionsBoundary.Builder> permissionsBoundary)

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

This is a convenience that creates an instance of the AttachedPermissionsBoundary.Builder avoiding the need to create one manually via AttachedPermissionsBoundary.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to permissionsBoundary(AttachedPermissionsBoundary).

Parameters:

permissionsBoundary - a consumer that will call methods on AttachedPermissionsBoundary.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

permissionsBoundary(AttachedPermissionsBoundary)