software.amazon.awssdk.services.iam.model.CreateUserRequest Maven / Gradle / Ivy
Show all versions of iam Show documentation
/*
* Copyright 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.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.awscore.AwsRequestOverrideConfiguration;
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.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateUserRequest extends IamRequest implements
ToCopyableBuilder {
private static final SdkField PATH_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Path")
.getter(getter(CreateUserRequest::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)
.memberName("UserName").getter(getter(CreateUserRequest::userName)).setter(setter(Builder::userName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserName").build()).build();
private static final SdkField PERMISSIONS_BOUNDARY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PermissionsBoundary").getter(getter(CreateUserRequest::permissionsBoundary))
.setter(setter(Builder::permissionsBoundary))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PermissionsBoundary").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateUserRequest::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,
PERMISSIONS_BOUNDARY_FIELD, TAGS_FIELD));
private final String path;
private final String userName;
private final String permissionsBoundary;
private final List tags;
private CreateUserRequest(BuilderImpl builder) {
super(builder);
this.path = builder.path;
this.userName = builder.userName;
this.permissionsBoundary = builder.permissionsBoundary;
this.tags = builder.tags;
}
/**
*
* The path for the user name. For more information about paths, see IAM identifiers in the IAM
* User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
* slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL
* character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
*
*
* @return The path for the user name. For more information about paths, see IAM identifiers in the
* IAM User Guide.
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
*
* This parameter allows (through its regex pattern) a string
* of characters consisting of either a forward slash (/) by itself or a string that must begin and end with
* forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through
* the DEL character (\u007F), including most punctuation characters, digits, and upper and
* lowercased letters.
*/
public final String path() {
return path;
}
/**
*
* The name of the user to create.
*
*
* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case.
* For example, you cannot create resources named both "MyResource" and "myresource".
*
*
* @return The name of the user to create.
*
* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by
* case. For example, you cannot create resources named both "MyResource" and "myresource".
*/
public final String userName() {
return userName;
}
/**
*
* The ARN of the managed policy that is used to set the permissions boundary for the user.
*
*
* A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an
* entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a
* resource-based policy can grant to an entity. To learn more, see Permissions boundaries
* for IAM entities in the IAM User Guide.
*
*
* For more information about policy types, see Policy types
* in the IAM User Guide.
*
*
* @return The ARN of the managed policy that is used to set the permissions boundary for the user.
*
* A permissions boundary policy defines the maximum permissions that identity-based policies can grant to
* an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions
* that a resource-based policy can grant to an entity. To learn more, see Permissions
* boundaries for IAM entities in the IAM User Guide.
*
*
* For more information about policy types, see Policy
* types in the IAM User Guide.
*/
public final String permissionsBoundary() {
return permissionsBoundary;
}
/**
* 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 {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value.
* For more information about tagging, see Tagging IAM resources in the IAM User
* Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request
* fails and the resource is not created.
*
*
*
* 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 {@link #hasTags} method.
*
*
* @return A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated
* value. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
*/
public final 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 final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(path());
hashCode = 31 * hashCode + Objects.hashCode(userName());
hashCode = 31 * hashCode + Objects.hashCode(permissionsBoundary());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateUserRequest)) {
return false;
}
CreateUserRequest other = (CreateUserRequest) obj;
return Objects.equals(path(), other.path()) && Objects.equals(userName(), other.userName())
&& Objects.equals(permissionsBoundary(), other.permissionsBoundary()) && hasTags() == other.hasTags()
&& 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 final String toString() {
return ToString.builder("CreateUserRequest").add("Path", path()).add("UserName", userName())
.add("PermissionsBoundary", permissionsBoundary()).add("Tags", hasTags() ? tags() : null).build();
}
public final 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 "PermissionsBoundary":
return Optional.ofNullable(clazz.cast(permissionsBoundary()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateUserRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The path for the user name. For more information about paths, see IAM identifiers in the
* IAM User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of either a forward slash (/) by itself or a string that must begin and end with
* forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the
* DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased
* letters.
*
*
* @param path
* The path for the user name. For more information about paths, see IAM identifiers in
* the IAM User Guide.
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
*
* This parameter allows (through its regex pattern) a
* string of characters consisting of either a forward slash (/) by itself or a string that must begin
* and end with forward slashes. In addition, it can contain any ASCII character from the ! (
* \u0021) through the DEL character (\u007F), including most punctuation
* characters, digits, and upper and lowercased letters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder path(String path);
/**
*
* The name of the user to create.
*
*
* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by
* case. For example, you cannot create resources named both "MyResource" and "myresource".
*
*
* @param userName
* The name of the user to create.
*
* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished
* by case. For example, you cannot create resources named both "MyResource" and "myresource".
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userName(String userName);
/**
*
* The ARN of the managed policy that is used to set the permissions boundary for the user.
*
*
* A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an
* entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a
* resource-based policy can grant to an entity. To learn more, see Permissions
* boundaries for IAM entities in the IAM User Guide.
*
*
* For more information about policy types, see Policy types
* in the IAM User Guide.
*
*
* @param permissionsBoundary
* The ARN of the managed policy that is used to set the permissions boundary for the user.
*
* A permissions boundary policy defines the maximum permissions that identity-based policies can grant
* to an entity, but does not grant permissions. Permissions boundaries do not define the maximum
* permissions that a resource-based policy can grant to an entity. To learn more, see Permissions
* boundaries for IAM entities in the IAM User Guide.
*
*
* For more information about policy types, see Policy types in the IAM User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder permissionsBoundary(String permissionsBoundary);
/**
*
* A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated
* value. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
*
*
* @param tags
* A list of tags that you want to attach to the new user. Each tag consists of a key name and an
* associated value. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated
* value. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
*
*
* @param tags
* A list of tags that you want to attach to the new user. Each tag consists of a key name and an
* associated value. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated
* value. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iam.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.iam.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.iam.model.Tag.Builder#build()} is
* called immediately and its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link software.amazon.awssdk.services.iam.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IamRequest.BuilderImpl implements Builder {
private String path;
private String userName;
private String permissionsBoundary;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateUserRequest model) {
super(model);
path(model.path);
userName(model.userName);
permissionsBoundary(model.permissionsBoundary);
tags(model.tags);
}
public final String getPath() {
return path;
}
public final void setPath(String path) {
this.path = path;
}
@Override
public final Builder path(String path) {
this.path = path;
return this;
}
public final String getUserName() {
return userName;
}
public final void setUserName(String userName) {
this.userName = userName;
}
@Override
public final Builder userName(String userName) {
this.userName = userName;
return this;
}
public final String getPermissionsBoundary() {
return permissionsBoundary;
}
public final void setPermissionsBoundary(String permissionsBoundary) {
this.permissionsBoundary = permissionsBoundary;
}
@Override
public final Builder permissionsBoundary(String permissionsBoundary) {
this.permissionsBoundary = permissionsBoundary;
return this;
}
public final List getTags() {
List result = _tagListTypeCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = _tagListTypeCopier.copyFromBuilder(tags);
}
@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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateUserRequest build() {
return new CreateUserRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}