Class PolicyInfo

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

Contains details about a policy evaluated during authorization. Details include the policy type, whether it is inline or managed, a URI that identifies it, and the entities it is attached to.

See Also:

  • Method Details

    • type

      public final PolicyType type()

      The type of policy. Valid values:

      • IDENTITY_BASED_POLICY - An identity-based policy attached to an IAM user, group, or role.

      • PERMISSIONS_BOUNDARY - A permissions boundary for an IAM entity.

      • RESOURCE_BASED_POLICY - A resource-based policy attached to a resource.

      • RESOURCE_CONTROL_POLICY - A resource control policy (RCP) in AWS Organizations.

      • SERVICE_CONTROL_POLICY - A service control policy (SCP) in AWS Organizations.

      • SESSION_POLICY - A session policy passed during role assumption or federation.

      • VPC_ENDPOINT_POLICY - A VPC endpoint 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. Valid values:

      • IDENTITY_BASED_POLICY - An identity-based policy attached to an IAM user, group, or role.

      • PERMISSIONS_BOUNDARY - A permissions boundary for an IAM entity.

      • RESOURCE_BASED_POLICY - A resource-based policy attached to a resource.

      • RESOURCE_CONTROL_POLICY - A resource control policy (RCP) in AWS Organizations.

      • SERVICE_CONTROL_POLICY - A service control policy (SCP) in AWS Organizations.

      • SESSION_POLICY - A session policy passed during role assumption or federation.

      • VPC_ENDPOINT_POLICY - A VPC endpoint policy.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of policy. Valid values:

      • IDENTITY_BASED_POLICY - An identity-based policy attached to an IAM user, group, or role.

      • PERMISSIONS_BOUNDARY - A permissions boundary for an IAM entity.

      • RESOURCE_BASED_POLICY - A resource-based policy attached to a resource.

      • RESOURCE_CONTROL_POLICY - A resource control policy (RCP) in AWS Organizations.

      • SERVICE_CONTROL_POLICY - A service control policy (SCP) in AWS Organizations.

      • SESSION_POLICY - A session policy passed during role assumption or federation.

      • VPC_ENDPOINT_POLICY - A VPC endpoint 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. Valid values:

      • IDENTITY_BASED_POLICY - An identity-based policy attached to an IAM user, group, or role.

      • PERMISSIONS_BOUNDARY - A permissions boundary for an IAM entity.

      • RESOURCE_BASED_POLICY - A resource-based policy attached to a resource.

      • RESOURCE_CONTROL_POLICY - A resource control policy (RCP) in AWS Organizations.

      • SERVICE_CONTROL_POLICY - A service control policy (SCP) in AWS Organizations.

      • SESSION_POLICY - A session policy passed during role assumption or federation.

      • VPC_ENDPOINT_POLICY - A VPC endpoint policy.

      See Also:

    • inline

      public final Boolean inline()

      Specifies whether this is an inline policy (true) or a managed policy (false).

      Returns:
      Specifies whether this is an inline policy (true) or a managed policy (false).

    • uri

      public final String uri()

      A URI that identifies the policy. Use this URI to cross-reference the policy with the matching policies in each evaluation. The value depends on the policy type:

      • For managed policies, this is the policy ARN.

      • For inline policies, which have no ARN, this is an opaque identifier.

      Returns:
      A URI that identifies the policy. Use this URI to cross-reference the policy with the matching policies in each evaluation. The value depends on the policy type:

      • For managed policies, this is the policy ARN.

      • For inline policies, which have no ARN, this is an opaque identifier.

    • hasAttachedTo

      public final boolean hasAttachedTo()
      For responses, this returns true if the service returned a value for the AttachedTo 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.

    • attachedTo

      public final List<AttachedTo> attachedTo()

      The entities that the policy is attached to. For identity, session, and resource-based policies, this is typically a single entity. For organization control policies (SCPs and RCPs), it can be multiple entities at different levels of the organization hierarchy.

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

      Returns:
      The entities that the policy is attached to. For identity, session, and resource-based policies, this is typically a single entity. For organization control policies (SCPs and RCPs), it can be multiple entities at different levels of the organization hierarchy.

    • toBuilder

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

    • builder

      public static PolicyInfo.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.