software.amazon.awssdk.services.iam.model.Role 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 IAM role. This structure is returned as a response element in several API operations
* that interact with roles.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Role implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField PATH_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Path")
.getter(getter(Role::path)).setter(setter(Builder::path))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Path").build()).build();
private static final SdkField ROLE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RoleName").getter(getter(Role::roleName)).setter(setter(Builder::roleName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RoleName").build()).build();
private static final SdkField ROLE_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("RoleId")
.getter(getter(Role::roleId)).setter(setter(Builder::roleId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RoleId").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(Role::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(Role::createDate)).setter(setter(Builder::createDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreateDate").build()).build();
private static final SdkField ASSUME_ROLE_POLICY_DOCUMENT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AssumeRolePolicyDocument").getter(getter(Role::assumeRolePolicyDocument))
.setter(setter(Builder::assumeRolePolicyDocument))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AssumeRolePolicyDocument").build())
.build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(Role::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField MAX_SESSION_DURATION_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxSessionDuration").getter(getter(Role::maxSessionDuration))
.setter(setter(Builder::maxSessionDuration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxSessionDuration").build())
.build();
private static final SdkField PERMISSIONS_BOUNDARY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("PermissionsBoundary")
.getter(getter(Role::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)
.memberName("Tags")
.getter(getter(Role::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 SdkField ROLE_LAST_USED_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("RoleLastUsed").getter(getter(Role::roleLastUsed)).setter(setter(Builder::roleLastUsed))
.constructor(RoleLastUsed::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RoleLastUsed").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PATH_FIELD, ROLE_NAME_FIELD,
ROLE_ID_FIELD, ARN_FIELD, CREATE_DATE_FIELD, ASSUME_ROLE_POLICY_DOCUMENT_FIELD, DESCRIPTION_FIELD,
MAX_SESSION_DURATION_FIELD, PERMISSIONS_BOUNDARY_FIELD, TAGS_FIELD, ROLE_LAST_USED_FIELD));
private static final long serialVersionUID = 1L;
private final String path;
private final String roleName;
private final String roleId;
private final String arn;
private final Instant createDate;
private final String assumeRolePolicyDocument;
private final String description;
private final Integer maxSessionDuration;
private final AttachedPermissionsBoundary permissionsBoundary;
private final List tags;
private final RoleLastUsed roleLastUsed;
private Role(BuilderImpl builder) {
this.path = builder.path;
this.roleName = builder.roleName;
this.roleId = builder.roleId;
this.arn = builder.arn;
this.createDate = builder.createDate;
this.assumeRolePolicyDocument = builder.assumeRolePolicyDocument;
this.description = builder.description;
this.maxSessionDuration = builder.maxSessionDuration;
this.permissionsBoundary = builder.permissionsBoundary;
this.tags = builder.tags;
this.roleLastUsed = builder.roleLastUsed;
}
/**
*
* The path to the role. For more information about paths, see IAM identifiers in the IAM
* User Guide.
*
*
* @return The path to the role. For more information about paths, see IAM identifiers in the
* IAM User Guide.
*/
public final String path() {
return path;
}
/**
*
* The friendly name that identifies the role.
*
*
* @return The friendly name that identifies the role.
*/
public final String roleName() {
return roleName;
}
/**
*
* The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM
* User Guide.
*
*
* @return The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the
* IAM User Guide.
*/
public final String roleId() {
return roleId;
}
/**
*
* The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in
* policies, see IAM
* identifiers in the IAM User Guide guide.
*
*
* @return The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them
* in policies, see IAM
* identifiers in the IAM User Guide guide.
*/
public final String arn() {
return arn;
}
/**
*
* The date and time, in ISO 8601 date-time format, when the role was
* created.
*
*
* @return The date and time, in ISO 8601 date-time format, when the
* role was created.
*/
public final Instant createDate() {
return createDate;
}
/**
*
* The policy that grants an entity permission to assume the role.
*
*
* @return The policy that grants an entity permission to assume the role.
*/
public final String assumeRolePolicyDocument() {
return assumeRolePolicyDocument;
}
/**
*
* A description of the role that you provide.
*
*
* @return A description of the role that you provide.
*/
public final String description() {
return description;
}
/**
*
* The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the
* role can specify the duration using the optional DurationSeconds
API parameter or
* duration-seconds
CLI parameter.
*
*
* @return The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to
* assume the role can specify the duration using the optional DurationSeconds
API parameter or
* duration-seconds
CLI parameter.
*/
public final Integer maxSessionDuration() {
return maxSessionDuration;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final AttachedPermissionsBoundary 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 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 {@link #hasTags} method.
*
*
* @return A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*/
public final List tags() {
return tags;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final RoleLastUsed roleLastUsed() {
return roleLastUsed;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(path());
hashCode = 31 * hashCode + Objects.hashCode(roleName());
hashCode = 31 * hashCode + Objects.hashCode(roleId());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(createDate());
hashCode = 31 * hashCode + Objects.hashCode(assumeRolePolicyDocument());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(maxSessionDuration());
hashCode = 31 * hashCode + Objects.hashCode(permissionsBoundary());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(roleLastUsed());
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 Role)) {
return false;
}
Role other = (Role) obj;
return Objects.equals(path(), other.path()) && Objects.equals(roleName(), other.roleName())
&& Objects.equals(roleId(), other.roleId()) && Objects.equals(arn(), other.arn())
&& Objects.equals(createDate(), other.createDate())
&& Objects.equals(assumeRolePolicyDocument(), other.assumeRolePolicyDocument())
&& Objects.equals(description(), other.description())
&& Objects.equals(maxSessionDuration(), other.maxSessionDuration())
&& Objects.equals(permissionsBoundary(), other.permissionsBoundary()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(roleLastUsed(), other.roleLastUsed());
}
/**
* 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("Role").add("Path", path()).add("RoleName", roleName()).add("RoleId", roleId()).add("Arn", arn())
.add("CreateDate", createDate()).add("AssumeRolePolicyDocument", assumeRolePolicyDocument())
.add("Description", description()).add("MaxSessionDuration", maxSessionDuration())
.add("PermissionsBoundary", permissionsBoundary()).add("Tags", hasTags() ? tags() : null)
.add("RoleLastUsed", roleLastUsed()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Path":
return Optional.ofNullable(clazz.cast(path()));
case "RoleName":
return Optional.ofNullable(clazz.cast(roleName()));
case "RoleId":
return Optional.ofNullable(clazz.cast(roleId()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "CreateDate":
return Optional.ofNullable(clazz.cast(createDate()));
case "AssumeRolePolicyDocument":
return Optional.ofNullable(clazz.cast(assumeRolePolicyDocument()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "MaxSessionDuration":
return Optional.ofNullable(clazz.cast(maxSessionDuration()));
case "PermissionsBoundary":
return Optional.ofNullable(clazz.cast(permissionsBoundary()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "RoleLastUsed":
return Optional.ofNullable(clazz.cast(roleLastUsed()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function