Package software.amazon.awssdk.services.iam.model

Class CreateRoleRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.iam.model.CreateRoleRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateRoleRequest.Builder,CreateRoleRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateRoleRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateRoleRequest.Builder,CreateRoleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateRoleRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	assumeRolePolicyDocument()	The trust relationship policy document that grants an entity permission to assume the role.
static CreateRoleRequest.Builder	builder()
String	description()	A customer-provided description of the role.
boolean	equals(Object obj)
int	hashCode()
String	path()	The path to the role.
String	roleName()	The name of the role to create.
static Class<? extends CreateRoleRequest.Builder>	serializableBuilderClass()
CreateRoleRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

path

public 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.

Returns:

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.

roleName

public 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".

Returns:

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".

assumeRolePolicyDocument

public 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 ( ).

Returns:

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 ( ).

description

public String description()

A customer-provided description of the role.

Returns:

A customer-provided description of the role.

toBuilder

public CreateRoleRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRoleRequest.Builder,CreateRoleRequest>

Returns:

a builder for type T

builder

public static CreateRoleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRoleRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object