software.amazon.awssdk.services.iam.model

Interface CreateRoleRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<CreateRoleRequest.Builder,CreateRoleRequest>, IamRequest.Builder, SdkBuilder<CreateRoleRequest.Builder,CreateRoleRequest>, SdkRequest.Builder

Enclosing class:

CreateRoleRequest

public static interface CreateRoleRequest.Builder
extends IamRequest.Builder, CopyableBuilder<CreateRoleRequest.Builder,CreateRoleRequest>

Method Summary

Modifier and Type	Method and Description
CreateRoleRequest.Builder	assumeRolePolicyDocument(String assumeRolePolicyDocument) The trust relationship policy document that grants an entity permission to assume the role.
CreateRoleRequest.Builder	description(String description) A customer-provided description of the role.
CreateRoleRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateRoleRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateRoleRequest.Builder	path(String path) The path to the role.
CreateRoleRequest.Builder	roleName(String roleName) The name of the role to create.

Methods inherited from interface software.amazon.awssdk.services.iam.model.IamRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

CreateRoleRequest.Builder path(String path)

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

This parameter is optional. If it is not included, it defaults to a slash (/).

This paramater allows (per 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, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Parameters:

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

This parameter is optional. If it is not included, it defaults to a slash (/).

This paramater allows (per 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, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Returns:

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

roleName

CreateRoleRequest.Builder roleName(String roleName)

The name of the role to create.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Role names are not distinguished by case. For example, you cannot create roles named both "PRODROLE" and "prodrole".

Parameters:

roleName - The name of the role to create.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Role names are not distinguished by case. For example, you cannot create roles named both "PRODROLE" and "prodrole".

Returns:

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

assumeRolePolicyDocument

CreateRoleRequest.Builder assumeRolePolicyDocument(String assumeRolePolicyDocument)

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

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Parameters:

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

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Returns:

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

description

CreateRoleRequest.Builder description(String description)

A customer-provided description of the role.

Parameters:

description - A customer-provided description of the role.

Returns:

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

overrideConfiguration

CreateRoleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateRoleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.