Class PermissionsBoundary

java.lang.Object
software.amazon.awssdk.services.ssoadmin.model.PermissionsBoundary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PermissionsBoundary.Builder,PermissionsBoundary>
@Generated("software.amazon.awssdk:codegen") public final class PermissionsBoundary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PermissionsBoundary.Builder,PermissionsBoundary>

Specifies the configuration of the Amazon Web Services managed or customer managed policy that you want to set as a permissions boundary. Specify either CustomerManagedPolicyReference to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an Amazon Web Services managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide.

Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide.

See Also:

  • Method Details

    • customerManagedPolicyReference

      public final CustomerManagedPolicyReference customerManagedPolicyReference()

      Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

      Returns:
      Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

    • managedPolicyArn

      public final String managedPolicyArn()

      The Amazon Web Services managed policy ARN that you want to attach to a permission set as a permissions boundary.

      Returns:
      The Amazon Web Services managed policy ARN that you want to attach to a permission set as a permissions boundary.

    • toBuilder

      public PermissionsBoundary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PermissionsBoundary.Builder,PermissionsBoundary>
      Returns:
      a builder for type T

    • builder

      public static PermissionsBoundary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PermissionsBoundary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.