Class RoleDetail
- java.lang.Object
-
- software.amazon.awssdk.services.iam.model.RoleDetail
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RoleDetail.Builder,RoleDetail>
@Generated("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 Description static interface
RoleDetail.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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()
For responses, this returns true if the service returned a value for the AttachedManagedPolicies property.int
hashCode()
boolean
hasInstanceProfileList()
For responses, this returns true if the service returned a value for the InstanceProfileList property.boolean
hasRolePolicyList()
For responses, this returns true if the service returned a value for the RolePolicyList property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.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.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends RoleDetail.Builder>
serializableBuilderClass()
List<Tag>
tags()
A list of tags that are attached to the 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 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()
Returns the value of the Arn property for this object.- Returns:
- The value of the Arn property for this object.
-
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 trust policy that grants permission to assume the role.
- Returns:
- The trust policy that grants permission to assume the role.
-
hasInstanceProfileList
public final boolean hasInstanceProfileList()
For responses, this returns true if the service returned a value for the InstanceProfileList 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.
-
instanceProfileList
public final 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.
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
hasInstanceProfileList()
method.- Returns:
- A list of instance profiles that contain this role.
-
hasRolePolicyList
public final boolean hasRolePolicyList()
For responses, this returns true if the service returned a value for the RolePolicyList 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.
-
rolePolicyList
public final 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.
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
hasRolePolicyList()
method.- Returns:
- A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.
-
hasAttachedManagedPolicies
public final boolean hasAttachedManagedPolicies()
For responses, this returns true if the service returned a value for the AttachedManagedPolicies 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.
-
attachedManagedPolicies
public final 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.
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
hasAttachedManagedPolicies()
method.- Returns:
- A list of managed policies attached to the role. These policies are the role's access (permissions) policies.
-
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 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
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 RoleDetail.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<RoleDetail.Builder,RoleDetail>
-
builder
public static RoleDetail.Builder builder()
-
serializableBuilderClass
public static Class<? extends RoleDetail.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-