Class Policy

    • Method Detail

      • 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.

      • 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.
      • 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
      • 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)