software.amazon.awssdk.services.iam.model.InstanceProfile 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.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.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about an instance profile.
*
*
* This data type is used as a response element in the following operations:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class InstanceProfile implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField PATH_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Path")
.getter(getter(InstanceProfile::path)).setter(setter(Builder::path))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Path").build()).build();
private static final SdkField INSTANCE_PROFILE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceProfileName").getter(getter(InstanceProfile::instanceProfileName))
.setter(setter(Builder::instanceProfileName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceProfileName").build())
.build();
private static final SdkField INSTANCE_PROFILE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceProfileId").getter(getter(InstanceProfile::instanceProfileId))
.setter(setter(Builder::instanceProfileId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceProfileId").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(InstanceProfile::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)
.memberName("CreateDate").getter(getter(InstanceProfile::createDate)).setter(setter(Builder::createDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreateDate").build()).build();
private static final SdkField> ROLES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Roles")
.getter(getter(InstanceProfile::roles))
.setter(setter(Builder::roles))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Roles").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Role::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(InstanceProfile::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,
INSTANCE_PROFILE_NAME_FIELD, INSTANCE_PROFILE_ID_FIELD, ARN_FIELD, CREATE_DATE_FIELD, ROLES_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String path;
private final String instanceProfileName;
private final String instanceProfileId;
private final String arn;
private final Instant createDate;
private final List roles;
private final List tags;
private InstanceProfile(BuilderImpl builder) {
this.path = builder.path;
this.instanceProfileName = builder.instanceProfileName;
this.instanceProfileId = builder.instanceProfileId;
this.arn = builder.arn;
this.createDate = builder.createDate;
this.roles = builder.roles;
this.tags = builder.tags;
}
/**
*
* The path to the instance profile. For more information about paths, see IAM identifiers in the IAM
* User Guide.
*
*
* @return The path to the instance profile. For more information about paths, see IAM identifiers in the
* IAM User Guide.
*/
public final String path() {
return path;
}
/**
*
* The name identifying the instance profile.
*
*
* @return The name identifying the instance profile.
*/
public final String instanceProfileName() {
return instanceProfileName;
}
/**
*
* The stable and unique string identifying the instance profile. For more information about IDs, see IAM identifiers in the IAM
* User Guide.
*
*
* @return The stable and unique string identifying the instance profile. For more information about IDs, see IAM identifiers in the
* IAM User Guide.
*/
public final String instanceProfileId() {
return instanceProfileId;
}
/**
*
* The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use
* them in policies, see IAM
* identifiers in the IAM User Guide.
*
*
* @return The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how
* to use them in policies, see IAM identifiers in the
* IAM User Guide.
*/
public final String arn() {
return arn;
}
/**
*
* The date when the instance profile was created.
*
*
* @return The date when the instance profile was created.
*/
public final Instant createDate() {
return createDate;
}
/**
* For responses, this returns true if the service returned a value for the Roles 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 hasRoles() {
return roles != null && !(roles instanceof SdkAutoConstructList);
}
/**
*
* The role associated with the instance profile.
*
*
* 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 #hasRoles} method.
*
*
* @return The role associated with the instance profile.
*/
public final List roles() {
return roles;
}
/**
* 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 are attached to the instance profile. 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 {@link #hasTags} method.
*
*
* @return A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*/
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 + Objects.hashCode(path());
hashCode = 31 * hashCode + Objects.hashCode(instanceProfileName());
hashCode = 31 * hashCode + Objects.hashCode(instanceProfileId());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(createDate());
hashCode = 31 * hashCode + Objects.hashCode(hasRoles() ? roles() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof InstanceProfile)) {
return false;
}
InstanceProfile other = (InstanceProfile) obj;
return Objects.equals(path(), other.path()) && Objects.equals(instanceProfileName(), other.instanceProfileName())
&& Objects.equals(instanceProfileId(), other.instanceProfileId()) && Objects.equals(arn(), other.arn())
&& Objects.equals(createDate(), other.createDate()) && hasRoles() == other.hasRoles()
&& Objects.equals(roles(), other.roles()) && 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("InstanceProfile").add("Path", path()).add("InstanceProfileName", instanceProfileName())
.add("InstanceProfileId", instanceProfileId()).add("Arn", arn()).add("CreateDate", createDate())
.add("Roles", hasRoles() ? roles() : null).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 "InstanceProfileName":
return Optional.ofNullable(clazz.cast(instanceProfileName()));
case "InstanceProfileId":
return Optional.ofNullable(clazz.cast(instanceProfileId()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "CreateDate":
return Optional.ofNullable(clazz.cast(createDate()));
case "Roles":
return Optional.ofNullable(clazz.cast(roles()));
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((InstanceProfile) 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 instance profile. For more information about paths, see IAM identifiers in the
* IAM User Guide.
*
*
* @param path
* The path to the instance profile. For more information about paths, see IAM identifiers in
* the IAM User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder path(String path);
/**
*
* The name identifying the instance profile.
*
*
* @param instanceProfileName
* The name identifying the instance profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceProfileName(String instanceProfileName);
/**
*
* The stable and unique string identifying the instance profile. For more information about IDs, see IAM identifiers in the
* IAM User Guide.
*
*
* @param instanceProfileId
* The stable and unique string identifying the instance profile. For more information about IDs, see IAM identifiers in
* the IAM User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceProfileId(String instanceProfileId);
/**
*
* The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to
* use them in policies, see IAM identifiers in the
* IAM User Guide.
*
*
* @param arn
* The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and
* how to use them in policies, see IAM identifiers in
* the IAM User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The date when the instance profile was created.
*
*
* @param createDate
* The date when the instance profile was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createDate(Instant createDate);
/**
*
* The role associated with the instance profile.
*
*
* @param roles
* The role associated with the instance profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roles(Collection roles);
/**
*
* The role associated with the instance profile.
*
*
* @param roles
* The role associated with the instance profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder roles(Role... roles);
/**
*
* The role associated with the instance profile.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iam.model.Role.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.iam.model.Role#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.iam.model.Role.Builder#build()}
* is called immediately and its result is passed to {@link #roles(List)}.
*
* @param roles
* a consumer that will call methods on {@link software.amazon.awssdk.services.iam.model.Role.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #roles(java.util.Collection)
*/
Builder roles(Consumer... roles);
/**
*
* A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
*
* @param tags
* A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources 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 attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
*
* @param tags
* A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources 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 attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
* 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);
}
static final class BuilderImpl implements Builder {
private String path;
private String instanceProfileName;
private String instanceProfileId;
private String arn;
private Instant createDate;
private List roles = DefaultSdkAutoConstructList.getInstance();
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(InstanceProfile model) {
path(model.path);
instanceProfileName(model.instanceProfileName);
instanceProfileId(model.instanceProfileId);
arn(model.arn);
createDate(model.createDate);
roles(model.roles);
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 getInstanceProfileName() {
return instanceProfileName;
}
public final void setInstanceProfileName(String instanceProfileName) {
this.instanceProfileName = instanceProfileName;
}
@Override
public final Builder instanceProfileName(String instanceProfileName) {
this.instanceProfileName = instanceProfileName;
return this;
}
public final String getInstanceProfileId() {
return instanceProfileId;
}
public final void setInstanceProfileId(String instanceProfileId) {
this.instanceProfileId = instanceProfileId;
}
@Override
public final Builder instanceProfileId(String instanceProfileId) {
this.instanceProfileId = instanceProfileId;
return this;
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final Instant getCreateDate() {
return createDate;
}
public final void setCreateDate(Instant createDate) {
this.createDate = createDate;
}
@Override
public final Builder createDate(Instant createDate) {
this.createDate = createDate;
return this;
}
public final List getRoles() {
List result = _roleListTypeCopier.copyToBuilder(this.roles);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setRoles(Collection roles) {
this.roles = _roleListTypeCopier.copyFromBuilder(roles);
}
@Override
public final Builder roles(Collection roles) {
this.roles = _roleListTypeCopier.copy(roles);
return this;
}
@Override
@SafeVarargs
public final Builder roles(Role... roles) {
roles(Arrays.asList(roles));
return this;
}
@Override
@SafeVarargs
public final Builder roles(Consumer... roles) {
roles(Stream.of(roles).map(c -> Role.builder().applyMutation(c).build()).collect(Collectors.toList()));
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 InstanceProfile build() {
return new InstanceProfile(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}