@Generated(value="software.amazon.awssdk:codegen") public final class CreateRoleRequest extends IamRequest implements ToCopyableBuilder<CreateRoleRequest.Builder,CreateRoleRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateRoleRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
assumeRolePolicyDocument()
The trust relationship policy document that grants an entity permission to assume the role.
|
static CreateRoleRequest.Builder |
builder() |
String |
description()
A description of the role.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
maxSessionDuration()
The maximum session duration (in seconds) that you want to set for the specified role.
|
String |
path()
The path to the role.
|
String |
permissionsBoundary()
The ARN of the policy that is used to set the permissions boundary for the role.
|
String |
roleName()
The name of the role to create.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateRoleRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
A list of tags that you want to attach to the newly created role.
|
CreateRoleRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
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 parameter 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. In addition, it can contain any ASCII character from the ! (!) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter 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. In addition, it can contain any ASCII character from the ! (!) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.
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".
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".
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 the following:
Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
The special characters tab ( ), line feed ( ), and carriage return ( )
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
The special characters tab ( ), line feed ( ), and carriage return ( )
public String description()
A description of the role.
public List<Tag> tags()
A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created.
public Integer maxSessionDuration()
The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 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. For more information, see Using
IAM Roles in the IAM User Guide.
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. For more
information, see Using IAM
Roles in the IAM User Guide.
public String permissionsBoundary()
The ARN of the policy that is used to set the permissions boundary for the role.
public CreateRoleRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateRoleRequest.Builder,CreateRoleRequest>
toBuilder
in class IamRequest
public static CreateRoleRequest.Builder builder()
public static Class<? extends CreateRoleRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.