Class PolicySummary

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

Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier (ID) of the policy.

      The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

      Returns:
      The unique identifier (ID) of the policy.

      The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the policy.

      For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

      Returns:
      The Amazon Resource Name (ARN) of the policy.

      For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

    • name

      public final String name()

      The friendly name of the policy.

      The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

      Returns:
      The friendly name of the policy.

      The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

    • description

      public final String description()

      The description of the policy.

      Returns:
      The description of the policy.

    • type

      public final PolicyType type()

      The type of policy.

      If the service returns an enum value that is not available in the current SDK version, type will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of policy.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of policy.

      If the service returns an enum value that is not available in the current SDK version, type will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of policy.
      See Also:

    • awsManaged

      public final Boolean awsManaged()

      A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

      Returns:
      A boolean value that indicates whether the specified policy is an Amazon Web Services managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

    • toBuilder

      public PolicySummary.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<PolicySummary.Builder,PolicySummary>
      Returns:
      a builder for type T

    • builder

      public static PolicySummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PolicySummary.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.