Class Role
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) specifying the role.final String
The policy that grants an entity permission to assume the role.static Role.Builder
builder()
final Instant
The date and time, in ISO 8601 date-time format, when the role was created.final String
A description of the role that you provide.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Integer
The maximum session duration (in seconds) for the specified role.final String
path()
The path to the role.The ARN of the policy used to set the permissions boundary for the role.final String
roleId()
The stable and unique string identifying the role.final RoleLastUsed
Contains information about the last time that an IAM role was used.final String
roleName()
The friendly name that identifies the role.static Class
<? extends Role.Builder> tags()
A list of tags that are attached to the role.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The friendly name that identifies the role.
- Returns:
- The friendly name that identifies the role.
-
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
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
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
The policy that grants an entity permission to assume the role.
- Returns:
- The policy that grants an entity permission to assume the role.
-
description
A description of the role that you provide.
- Returns:
- A description of the role that you provide.
-
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 orduration-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 orduration-seconds
CLI parameter.
-
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 theisEmpty()
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
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
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
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 interfaceToCopyableBuilder<Role.Builder,
Role> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-