software.amazon.awssdk.services.iam.model.AttachedPermissionsBoundary Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of iam Show documentation
The AWS Java SDK for AWS IAM module holds the client classes that are used for communicating with AWS Identity and Access Management Service
There is a newer version: 2.29.15
Show newest version
/*
 * 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.util.Arrays;
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.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * Contains information about an attached permissions boundary.
 * 
 * 
 * An attached permissions boundary is a managed policy that has been attached to a user or role to set the permissions
 * boundary.
 * 
 * 
 * For more information about permissions boundaries, see Permissions boundaries for
 * IAM identities  in the IAM User Guide.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class AttachedPermissionsBoundary implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField PERMISSIONS_BOUNDARY_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("PermissionsBoundaryType").getter(getter(AttachedPermissionsBoundary::permissionsBoundaryTypeAsString))
            .setter(setter(Builder::permissionsBoundaryType))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PermissionsBoundaryType").build())
            .build();

    private static final SdkField PERMISSIONS_BOUNDARY_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("PermissionsBoundaryArn").getter(getter(AttachedPermissionsBoundary::permissionsBoundaryArn))
            .setter(setter(Builder::permissionsBoundaryArn))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PermissionsBoundaryArn").build())
            .build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
            PERMISSIONS_BOUNDARY_TYPE_FIELD, PERMISSIONS_BOUNDARY_ARN_FIELD));

    private static final long serialVersionUID = 1L;

    private final String permissionsBoundaryType;

    private final String permissionsBoundaryArn;

    private AttachedPermissionsBoundary(BuilderImpl builder) {
        this.permissionsBoundaryType = builder.permissionsBoundaryType;
        this.permissionsBoundaryArn = builder.permissionsBoundaryArn;
    }

    /**
     * 
     * The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary
     * for an entity. This data type can only have a value of Policy.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version,
     * {@link #permissionsBoundaryType} will return {@link PermissionsBoundaryAttachmentType#UNKNOWN_TO_SDK_VERSION}.
     * The raw value returned by the service is available from {@link #permissionsBoundaryTypeAsString}.
     * 
     * 
     * @return The permissions boundary usage type that indicates what type of IAM resource is used as the permissions
     *         boundary for an entity. This data type can only have a value of Policy.
     * @see PermissionsBoundaryAttachmentType
     */
    public final PermissionsBoundaryAttachmentType permissionsBoundaryType() {
        return PermissionsBoundaryAttachmentType.fromValue(permissionsBoundaryType);
    }

    /**
     * 
     * The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary
     * for an entity. This data type can only have a value of Policy.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version,
     * {@link #permissionsBoundaryType} will return {@link PermissionsBoundaryAttachmentType#UNKNOWN_TO_SDK_VERSION}.
     * The raw value returned by the service is available from {@link #permissionsBoundaryTypeAsString}.
     * 
     * 
     * @return The permissions boundary usage type that indicates what type of IAM resource is used as the permissions
     *         boundary for an entity. This data type can only have a value of Policy.
     * @see PermissionsBoundaryAttachmentType
     */
    public final String permissionsBoundaryTypeAsString() {
        return permissionsBoundaryType;
    }

    /**
     * 
     * The ARN of the policy used to set the permissions boundary for the user or role.
     * 
     * 
     * @return The ARN of the policy used to set the permissions boundary for the user or role.
     */
    public final String permissionsBoundaryArn() {
        return permissionsBoundaryArn;
    }

    @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(permissionsBoundaryTypeAsString());
        hashCode = 31 * hashCode + Objects.hashCode(permissionsBoundaryArn());
        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 AttachedPermissionsBoundary)) {
            return false;
        }
        AttachedPermissionsBoundary other = (AttachedPermissionsBoundary) obj;
        return Objects.equals(permissionsBoundaryTypeAsString(), other.permissionsBoundaryTypeAsString())
                && Objects.equals(permissionsBoundaryArn(), other.permissionsBoundaryArn());
    }

    /**
     * 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("AttachedPermissionsBoundary").add("PermissionsBoundaryType", permissionsBoundaryTypeAsString())
                .add("PermissionsBoundaryArn", permissionsBoundaryArn()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "PermissionsBoundaryType":
            return Optional.ofNullable(clazz.cast(permissionsBoundaryTypeAsString()));
        case "PermissionsBoundaryArn":
            return Optional.ofNullable(clazz.cast(permissionsBoundaryArn()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((AttachedPermissionsBoundary) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The permissions boundary usage type that indicates what type of IAM resource is used as the permissions
         * boundary for an entity. This data type can only have a value of Policy.
         * 
         * 
         * @param permissionsBoundaryType
         *        The permissions boundary usage type that indicates what type of IAM resource is used as the
         *        permissions boundary for an entity. This data type can only have a value of Policy.
         * @see PermissionsBoundaryAttachmentType
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see PermissionsBoundaryAttachmentType
         */
        Builder permissionsBoundaryType(String permissionsBoundaryType);

        /**
         * 
         * The permissions boundary usage type that indicates what type of IAM resource is used as the permissions
         * boundary for an entity. This data type can only have a value of Policy.
         * 
         * 
         * @param permissionsBoundaryType
         *        The permissions boundary usage type that indicates what type of IAM resource is used as the
         *        permissions boundary for an entity. This data type can only have a value of Policy.
         * @see PermissionsBoundaryAttachmentType
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see PermissionsBoundaryAttachmentType
         */
        Builder permissionsBoundaryType(PermissionsBoundaryAttachmentType permissionsBoundaryType);

        /**
         * 
         * The ARN of the policy used to set the permissions boundary for the user or role.
         * 
         * 
         * @param permissionsBoundaryArn
         *        The ARN of the policy used to set the permissions boundary for the user or role.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder permissionsBoundaryArn(String permissionsBoundaryArn);
    }

    static final class BuilderImpl implements Builder {
        private String permissionsBoundaryType;

        private String permissionsBoundaryArn;

        private BuilderImpl() {
        }

        private BuilderImpl(AttachedPermissionsBoundary model) {
            permissionsBoundaryType(model.permissionsBoundaryType);
            permissionsBoundaryArn(model.permissionsBoundaryArn);
        }

        public final String getPermissionsBoundaryType() {
            return permissionsBoundaryType;
        }

        public final void setPermissionsBoundaryType(String permissionsBoundaryType) {
            this.permissionsBoundaryType = permissionsBoundaryType;
        }

        @Override
        public final Builder permissionsBoundaryType(String permissionsBoundaryType) {
            this.permissionsBoundaryType = permissionsBoundaryType;
            return this;
        }

        @Override
        public final Builder permissionsBoundaryType(PermissionsBoundaryAttachmentType permissionsBoundaryType) {
            this.permissionsBoundaryType(permissionsBoundaryType == null ? null : permissionsBoundaryType.toString());
            return this;
        }

        public final String getPermissionsBoundaryArn() {
            return permissionsBoundaryArn;
        }

        public final void setPermissionsBoundaryArn(String permissionsBoundaryArn) {
            this.permissionsBoundaryArn = permissionsBoundaryArn;
        }

        @Override
        public final Builder permissionsBoundaryArn(String permissionsBoundaryArn) {
            this.permissionsBoundaryArn = permissionsBoundaryArn;
            return this;
        }

        @Override
        public AttachedPermissionsBoundary build() {
            return new AttachedPermissionsBoundary(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}