Package software.amazon.awssdk.services.iam.model

Class Policy

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

Contains information about a managed policy.

This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies operations.

For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.

See Also:

  • Method Details

    • policyName

      public final String policyName()

      The friendly name (not ARN) identifying the policy.

      Returns:
      The friendly name (not ARN) identifying the policy.

    • policyId

      public final String policyId()

      The stable and unique string identifying the policy.

      For more information about IDs, see IAM identifiers in the IAM User Guide.

      Returns:
      The stable and unique string identifying the policy.

      For more information about IDs, see IAM identifiers in the IAM User Guide.

    • arn

      public final String arn()
      Returns the value of the Arn property for this object.
      Returns:
      The value of the Arn property for this object.

    • path

      public final String path()

      The path to the policy.

      For more information about paths, see IAM identifiers in the IAM User Guide.

      Returns:
      The path to the policy.

      For more information about paths, see IAM identifiers in the IAM User Guide.

    • defaultVersionId

      public final String defaultVersionId()

      The identifier for the version of the policy that is set as the default version.

      Returns:
      The identifier for the version of the policy that is set as the default version.

    • attachmentCount

      public final Integer attachmentCount()

      The number of entities (users, groups, and roles) that the policy is attached to.

      Returns:
      The number of entities (users, groups, and roles) that the policy is attached to.

    • permissionsBoundaryUsageCount

      public final Integer permissionsBoundaryUsageCount()

      The number of entities (users and roles) for which the policy is used to set the permissions boundary.

      For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

      Returns:
      The number of entities (users and roles) for which the policy is used to set the permissions boundary.

      For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

    • isAttachable

      public final Boolean isAttachable()

      Specifies whether the policy can be attached to an IAM user, group, or role.

      Returns:
      Specifies whether the policy can be attached to an IAM user, group, or role.

    • description

      public final String description()

      A friendly description of the policy.

      This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

      Returns:
      A friendly description of the policy.

      This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

    • createDate

      public final Instant createDate()

      The date and time, in ISO 8601 date-time format, when the policy was created.

      Returns:
      The date and time, in ISO 8601 date-time format, when the policy was created.

    • updateDate

      public final Instant updateDate()

      The date and time, in ISO 8601 date-time format, when the policy was last updated.

      When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

      Returns:
      The date and time, in ISO 8601 date-time format, when the policy was last updated.

      When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

    • hasTags

      public final boolean hasTags()
      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 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.

    • tags

      public final List<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.

      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 hasTags() method.

      Returns:
      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.

    • toBuilder

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

    • builder

      public static Policy.Builder builder()

    • serializableBuilderClass

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