software.amazon.awssdk.services.iam.model

Class Role

java.lang.Object

software.amazon.awssdk.services.iam.model.Role

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Role.Builder,Role>

@Generated(value="software.amazon.awssdk:codegen")
public final class Role
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Role.Builder,Role>

Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Role.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) specifying the role.
String	assumeRolePolicyDocument() The policy that grants an entity permission to assume the role.
static Role.Builder	builder()
Instant	createDate() The date and time, in ISO 8601 date-time format, when the role was created.
String	description() A description of the role that you provide.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxSessionDuration() The maximum session duration (in seconds) for the specified role.
String	path() The path to the role.
AttachedPermissionsBoundary	permissionsBoundary() The ARN of the policy used to set the permissions boundary for the role.
String	roleId() The stable and unique string identifying the role.
String	roleName() The friendly name that identifies the role.
List<SdkField<?>>	sdkFields()
static Class<? extends Role.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of tags that are attached to the specified role.
Role.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

path

public String path()

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

Returns:

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

roleName

public String roleName()

The friendly name that identifies the role.

Returns:

The friendly name that identifies the role.

roleId

public String roleId()

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

Returns:

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

arn

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

Returns:

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.

createDate

public Instant createDate()

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

Returns:

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

assumeRolePolicyDocument

public String assumeRolePolicyDocument()

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

Returns:

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

description

public String description()

A description of the role that you provide.

Returns:

A description of the role that you provide.

tags

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

maxSessionDuration

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

Returns:

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.

permissionsBoundary

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

Returns:

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.

toBuilder

public Role.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<Role.Builder,Role>

Returns:

a builder for type T

builder

public static Role.Builder builder()

serializableBuilderClass

public static Class<? extends Role.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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.