software.amazon.awssdk.services.iam.model

Class UserDetail

java.lang.Object

software.amazon.awssdk.services.iam.model.UserDetail

All Implemented Interfaces:

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

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

Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.

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	UserDetail.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() Returns the value of the Arn property for this object.
List<AttachedPolicy>	attachedManagedPolicies() A list of the managed policies attached to the user.
static UserDetail.Builder	builder()
Instant	createDate() The date and time, in ISO 8601 date-time format, when the user was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<String>	groupList() A list of IAM groups that the user is in.
boolean	hasAttachedManagedPolicies() For responses, this returns true if the service returned a value for the AttachedManagedPolicies property.
boolean	hasGroupList() For responses, this returns true if the service returned a value for the GroupList property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasUserPolicyList() For responses, this returns true if the service returned a value for the UserPolicyList property.
String	path() The path to the user.
AttachedPermissionsBoundary	permissionsBoundary() The ARN of the policy used to set the permissions boundary for the user.
List<SdkField<?>>	sdkFields()
static Class<? extends UserDetail.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of tags that are associated with the user.
UserDetail.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userId() The stable and unique string identifying the user.
String	userName() The friendly name identifying the user.
List<PolicyDetail>	userPolicyList() A list of the inline policies embedded in the user.

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 user. For more information about paths, see IAM identifiers in the IAM User Guide.

Returns:

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

userName

public final String userName()

The friendly name identifying the user.

Returns:

The friendly name identifying the user.

userId

public final String userId()

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

Returns:

The stable and unique string identifying the user. 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 user was created.

Returns:

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

hasUserPolicyList

public final boolean hasUserPolicyList()

For responses, this returns true if the service returned a value for the UserPolicyList 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.

userPolicyList

public final List<PolicyDetail> userPolicyList()

A list of the inline policies embedded in the user.

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 hasUserPolicyList() method.

Returns:

A list of the inline policies embedded in the user.

hasGroupList

public final boolean hasGroupList()

For responses, this returns true if the service returned a value for the GroupList 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.

groupList

public final List<String> groupList()

A list of IAM groups that the user is in.

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 hasGroupList() method.

Returns:

A list of IAM groups that the user is in.

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

attachedManagedPolicies

public final List<AttachedPolicy> attachedManagedPolicies()

A list of the managed policies attached to the user.

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 the managed policies attached to the user.

permissionsBoundary

public final AttachedPermissionsBoundary permissionsBoundary()

The ARN of the policy used to set the permissions boundary for the user.

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

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 associated with the user. 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 associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

toBuilder

public UserDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserDetail.Builder,UserDetail>

builder

public static UserDetail.Builder builder()

serializableBuilderClass

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