software.amazon.awssdk.services.iam.model.User Maven / Gradle / Ivy
Show all versions of iam Show documentation
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.iam.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about an IAM user entity.
*
*
* This data type is used as a response element in the following operations:
*
*
* -
*
* CreateUser
*
*
* -
*
* GetUser
*
*
* -
*
* ListUsers
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class User implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField PATH_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(User::path)).setter(setter(Builder::path))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Path").build()).build();
private static final SdkField USER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(User::userName)).setter(setter(Builder::userName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserName").build()).build();
private static final SdkField USER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(User::userId)).setter(setter(Builder::userId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserId").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).getter(getter(User::arn))
.setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField CREATE_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.getter(getter(User::createDate)).setter(setter(Builder::createDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreateDate").build()).build();
private static final SdkField PASSWORD_LAST_USED_FIELD = SdkField. builder(MarshallingType.INSTANT)
.getter(getter(User::passwordLastUsed)).setter(setter(Builder::passwordLastUsed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PasswordLastUsed").build()).build();
private static final SdkField PERMISSIONS_BOUNDARY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).getter(getter(User::permissionsBoundary))
.setter(setter(Builder::permissionsBoundary)).constructor(AttachedPermissionsBoundary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PermissionsBoundary").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(User::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PATH_FIELD, USER_NAME_FIELD,
USER_ID_FIELD, ARN_FIELD, CREATE_DATE_FIELD, PASSWORD_LAST_USED_FIELD, PERMISSIONS_BOUNDARY_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String path;
private final String userName;
private final String userId;
private final String arn;
private final Instant createDate;
private final Instant passwordLastUsed;
private final AttachedPermissionsBoundary permissionsBoundary;
private final List tags;
private User(BuilderImpl builder) {
this.path = builder.path;
this.userName = builder.userName;
this.userId = builder.userId;
this.arn = builder.arn;
this.createDate = builder.createDate;
this.passwordLastUsed = builder.passwordLastUsed;
this.permissionsBoundary = builder.permissionsBoundary;
this.tags = builder.tags;
}
/**
*
* The path to the user. For more information about paths, see IAM Identifiers in the Using
* IAM guide.
*
*
* @return The path to the user. For more information about paths, see IAM Identifiers in the
* Using IAM guide.
*/
public String path() {
return path;
}
/**
*
* The friendly name identifying the user.
*
*
* @return The friendly name identifying the user.
*/
public String userName() {
return userName;
}
/**
*
* The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using
* IAM guide.
*
*
* @return The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the
* Using IAM guide.
*/
public String userId() {
return userId;
}
/**
*
* The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in
* policies, see IAM
* Identifiers in the Using IAM guide.
*
*
* @return The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use
* ARNs in policies, see IAM Identifiers in the
* Using IAM guide.
*/
public String arn() {
return arn;
}
/**
*
* The date and time, in ISO 8601 date-time format, when the user was
* created.
*
*
* @return The date and time, in ISO 8601 date-time format, when the
* user was created.
*/
public Instant createDate() {
return createDate;
}
/**
*
* The date and time, in ISO 8601 date-time format, when the user's
* password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last
* sign-in time, see the Credential Reports topic in
* the Using IAM guide. If a password is used more than once in a five-minute span, only the first use is
* returned in this field. If the field is null (no value), then it indicates that they never signed in with a
* password. This can be because:
*
*
* -
*
* The user never had a password.
*
*
* -
*
* A password exists but has not been used since IAM started tracking this information on October 20, 2014.
*
*
*
*
* A null valuedoes not mean that the user never had a password. Also, if the user does not currently have a
* password, but had one in the past, then this field contains the date and time the most recent password was used.
*
*
* This value is returned only in the GetUser and ListUsers operations.
*
*
* @return The date and time, in ISO 8601 date-time format, when the
* user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a
* user's last sign-in time, see the Credential Reports
* topic in the Using IAM guide. If a password is used more than once in a five-minute span, only the
* first use is returned in this field. If the field is null (no value), then it indicates that they never
* signed in with a password. This can be because:
*
* -
*
* The user never had a password.
*
*
* -
*
* A password exists but has not been used since IAM started tracking this information on October 20, 2014.
*
*
*
*
* A null valuedoes not mean that the user never had a password. Also, if the user does not currently
* have a password, but had one in the past, then this field contains the date and time the most recent
* password was used.
*
*
* This value is returned only in the GetUser and ListUsers operations.
*/
public Instant passwordLastUsed() {
return passwordLastUsed;
}
/**
*
* 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.
*
*
* @return 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.
*/
public AttachedPermissionsBoundary permissionsBoundary() {
return permissionsBoundary;
}
/**
*
* A list of tags that are associated with the specified user. 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.
*
*
* @return A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the
* IAM User Guide.
*/
public List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(path());
hashCode = 31 * hashCode + Objects.hashCode(userName());
hashCode = 31 * hashCode + Objects.hashCode(userId());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(createDate());
hashCode = 31 * hashCode + Objects.hashCode(passwordLastUsed());
hashCode = 31 * hashCode + Objects.hashCode(permissionsBoundary());
hashCode = 31 * hashCode + Objects.hashCode(tags());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof User)) {
return false;
}
User other = (User) obj;
return Objects.equals(path(), other.path()) && Objects.equals(userName(), other.userName())
&& Objects.equals(userId(), other.userId()) && Objects.equals(arn(), other.arn())
&& Objects.equals(createDate(), other.createDate())
&& Objects.equals(passwordLastUsed(), other.passwordLastUsed())
&& Objects.equals(permissionsBoundary(), other.permissionsBoundary()) && Objects.equals(tags(), other.tags());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("User").add("Path", path()).add("UserName", userName()).add("UserId", userId()).add("Arn", arn())
.add("CreateDate", createDate()).add("PasswordLastUsed", passwordLastUsed())
.add("PermissionsBoundary", permissionsBoundary()).add("Tags", tags()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Path":
return Optional.ofNullable(clazz.cast(path()));
case "UserName":
return Optional.ofNullable(clazz.cast(userName()));
case "UserId":
return Optional.ofNullable(clazz.cast(userId()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "CreateDate":
return Optional.ofNullable(clazz.cast(createDate()));
case "PasswordLastUsed":
return Optional.ofNullable(clazz.cast(passwordLastUsed()));
case "PermissionsBoundary":
return Optional.ofNullable(clazz.cast(permissionsBoundary()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((User) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The path to the user. For more information about paths, see IAM Identifiers in the
* Using IAM guide.
*
*
* @param path
* The path to the user. For more information about paths, see IAM Identifiers in
* the Using IAM guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder path(String path);
/**
*
* The friendly name identifying the user.
*
*
* @param userName
* The friendly name identifying the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userName(String userName);
/**
*
* The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the
* Using IAM guide.
*
*
* @param userId
* The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in
* the Using IAM guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userId(String userId);
/**
*
* The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs
* in policies, see IAM
* Identifiers in the Using IAM guide.
*
*
* @param arn
* The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to
* use ARNs in policies, see IAM Identifiers in
* the Using IAM guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The date and time, in ISO 8601 date-time format, when the user
* was created.
*
*
* @param createDate
* The date and time, in ISO 8601 date-time format, when the
* user was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createDate(Instant createDate);
/**
*
* The date and time, in ISO 8601 date-time format, when the user's
* password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last
* sign-in time, see the Credential Reports topic
* in the Using IAM guide. If a password is used more than once in a five-minute span, only the first use
* is returned in this field. If the field is null (no value), then it indicates that they never signed in with
* a password. This can be because:
*
*
* -
*
* The user never had a password.
*
*
* -
*
* A password exists but has not been used since IAM started tracking this information on October 20, 2014.
*
*
*
*
* A null valuedoes not mean that the user never had a password. Also, if the user does not currently
* have a password, but had one in the past, then this field contains the date and time the most recent password
* was used.
*
*
* This value is returned only in the GetUser and ListUsers operations.
*
*
* @param passwordLastUsed
* The date and time, in ISO 8601 date-time format, when the
* user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a
* user's last sign-in time, see the Credential Reports
* topic in the Using IAM guide. If a password is used more than once in a five-minute span, only
* the first use is returned in this field. If the field is null (no value), then it indicates that they
* never signed in with a password. This can be because:
*
* -
*
* The user never had a password.
*
*
* -
*
* A password exists but has not been used since IAM started tracking this information on October 20,
* 2014.
*
*
*
*
* A null valuedoes not mean that the user never had a password. Also, if the user does not
* currently have a password, but had one in the past, then this field contains the date and time the
* most recent password was used.
*
*
* This value is returned only in the GetUser and ListUsers operations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder passwordLastUsed(Instant passwordLastUsed);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder permissionsBoundary(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.
*
* This is a convenience that creates an instance of the {@link AttachedPermissionsBoundary.Builder} avoiding
* the need to create one manually via {@link AttachedPermissionsBoundary#builder()}.
*
* When the {@link Consumer} completes, {@link AttachedPermissionsBoundary.Builder#build()} is called
* immediately and its result is passed to {@link #permissionsBoundary(AttachedPermissionsBoundary)}.
*
* @param permissionsBoundary
* a consumer that will call methods on {@link AttachedPermissionsBoundary.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #permissionsBoundary(AttachedPermissionsBoundary)
*/
default Builder permissionsBoundary(Consumer permissionsBoundary) {
return permissionsBoundary(AttachedPermissionsBoundary.builder().applyMutation(permissionsBoundary).build());
}
/**
*
* A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM
* User Guide.
*
*
* @param tags
* A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the
* IAM User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM
* User Guide.
*
*
* @param tags
* A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the
* IAM User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM
* User Guide.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
}
static final class BuilderImpl implements Builder {
private String path;
private String userName;
private String userId;
private String arn;
private Instant createDate;
private Instant passwordLastUsed;
private AttachedPermissionsBoundary permissionsBoundary;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(User model) {
path(model.path);
userName(model.userName);
userId(model.userId);
arn(model.arn);
createDate(model.createDate);
passwordLastUsed(model.passwordLastUsed);
permissionsBoundary(model.permissionsBoundary);
tags(model.tags);
}
public final String getPath() {
return path;
}
@Override
public final Builder path(String path) {
this.path = path;
return this;
}
public final void setPath(String path) {
this.path = path;
}
public final String getUserName() {
return userName;
}
@Override
public final Builder userName(String userName) {
this.userName = userName;
return this;
}
public final void setUserName(String userName) {
this.userName = userName;
}
public final String getUserId() {
return userId;
}
@Override
public final Builder userId(String userId) {
this.userId = userId;
return this;
}
public final void setUserId(String userId) {
this.userId = userId;
}
public final String getArn() {
return arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final void setArn(String arn) {
this.arn = arn;
}
public final Instant getCreateDate() {
return createDate;
}
@Override
public final Builder createDate(Instant createDate) {
this.createDate = createDate;
return this;
}
public final void setCreateDate(Instant createDate) {
this.createDate = createDate;
}
public final Instant getPasswordLastUsed() {
return passwordLastUsed;
}
@Override
public final Builder passwordLastUsed(Instant passwordLastUsed) {
this.passwordLastUsed = passwordLastUsed;
return this;
}
public final void setPasswordLastUsed(Instant passwordLastUsed) {
this.passwordLastUsed = passwordLastUsed;
}
public final AttachedPermissionsBoundary.Builder getPermissionsBoundary() {
return permissionsBoundary != null ? permissionsBoundary.toBuilder() : null;
}
@Override
public final Builder permissionsBoundary(AttachedPermissionsBoundary permissionsBoundary) {
this.permissionsBoundary = permissionsBoundary;
return this;
}
public final void setPermissionsBoundary(AttachedPermissionsBoundary.BuilderImpl permissionsBoundary) {
this.permissionsBoundary = permissionsBoundary != null ? permissionsBoundary.build() : null;
}
public final Collection getTags() {
return tags != null ? tags.stream().map(Tag::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder tags(Collection tags) {
this.tags = _tagListTypeCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setTags(Collection tags) {
this.tags = _tagListTypeCopier.copyFromBuilder(tags);
}
@Override
public User build() {
return new User(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}