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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
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.
RoleLastUsed	roleLastUsed() Contains information about the last time that an IAM role was used.
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 role.
Role.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

path

public final String path()

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

Returns:

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

roleName

public final String roleName()

The friendly name that identifies the role.

Returns:

The friendly name that identifies the role.

roleId

public final String roleId()

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

Returns:

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

arn

public final 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 final 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 final 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 final String description()

A description of the role that you provide.

Returns:

A description of the role that you provide.

maxSessionDuration

public final Integer maxSessionDuration()

The maximum session duration (in seconds) for the specified role. Anyone who uses the 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 CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

permissionsBoundary

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

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

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

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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

roleLastUsed

public final RoleLastUsed roleLastUsed()

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.

Returns:

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.

toBuilder

public Role.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Role.Builder,Role>

builder

public static Role.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo