software.amazon.awssdk.services.iam.model

Class RoleDetail

java.lang.Object

software.amazon.awssdk.services.iam.model.RoleDetail

All Implemented Interfaces:

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

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

Contains information about an IAM role, including all of the role's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RoleDetail.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() Returns the value of the Arn property for this object.
String	assumeRolePolicyDocument() The trust policy that grants permission to assume the role.
List<AttachedPolicy>	attachedManagedPolicies() A list of managed policies attached to the role.
static RoleDetail.Builder	builder()
Instant	createDate() The date and time, in ISO 8601 date-time format, when the role was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttachedManagedPolicies() Returns true if the AttachedManagedPolicies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasInstanceProfileList() Returns true if the InstanceProfileList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasRolePolicyList() Returns true if the RolePolicyList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<InstanceProfile>	instanceProfileList() A list of instance profiles that contain this 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<PolicyDetail>	rolePolicyList() A list of inline policies embedded in the role.
List<SdkField<?>>	sdkFields()
static Class<? extends RoleDetail.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of tags that are attached to the specified role.
RoleDetail.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 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 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 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 String arn()

Returns the value of the Arn property for this object.

Returns:

The value of the Arn property for this object.

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 trust policy that grants permission to assume the role.

Returns:

The trust policy that grants permission to assume the role.

hasInstanceProfileList

public boolean hasInstanceProfileList()

Returns true if the InstanceProfileList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

instanceProfileList

public List<InstanceProfile> instanceProfileList()

A list of instance profiles that contain this role.

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

You can use hasInstanceProfileList() to see if a value was sent in this field.

Returns:

A list of instance profiles that contain this role.

hasRolePolicyList

public boolean hasRolePolicyList()

Returns true if the RolePolicyList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

rolePolicyList

public List<PolicyDetail> rolePolicyList()

A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.

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

You can use hasRolePolicyList() to see if a value was sent in this field.

Returns:

A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.

hasAttachedManagedPolicies

public boolean hasAttachedManagedPolicies()

Returns true if the AttachedManagedPolicies property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

attachedManagedPolicies

public List<AttachedPolicy> attachedManagedPolicies()

A list of managed policies attached to the role. These policies are the role's access (permissions) policies.

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

You can use hasAttachedManagedPolicies() to see if a value was sent in this field.

Returns:

A list of managed policies attached to the role. These policies are the role's access (permissions) policies.

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.

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasTags() to see if a value was sent in this field.

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.

roleLastUsed

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

Specified by:

toBuilder in interface ToCopyableBuilder<RoleDetail.Builder,RoleDetail>

builder

public static RoleDetail.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo