Class PolicyDefinition

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

A structure that contains the details for a Cedar policy definition. It includes the policy type, a description, and a policy body. This is a top level data type used to create a policy.

This data type is used as a request parameter for the CreatePolicy operation. This structure must always have either an static or a templateLinked element.

See Also:

  • Method Details

    • staticValue

      public final StaticPolicyDefinition staticValue()

      A structure that describes a static policy. An static policy doesn't use a template or allow placeholders for entities.

      Returns:
      A structure that describes a static policy. An static policy doesn't use a template or allow placeholders for entities.

    • templateLinked

      public final TemplateLinkedPolicyDefinition templateLinked()

      A structure that describes a policy that was instantiated from a template. The template can specify placeholders for principal and resource. When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

      Returns:
      A structure that describes a policy that was instantiated from a template. The template can specify placeholders for principal and resource. When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

    • toBuilder

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

    • builder

      public static PolicyDefinition.Builder builder()

    • serializableBuilderClass

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

    • fromStaticValue

      public static PolicyDefinition fromStaticValue(StaticPolicyDefinition staticValue)
      Create an instance of this class with staticValue() initialized to the given value.

      A structure that describes a static policy. An static policy doesn't use a template or allow placeholders for entities.

      Parameters:
      staticValue - A structure that describes a static policy. An static policy doesn't use a template or allow placeholders for entities.

    • fromStaticValue

      public static PolicyDefinition fromStaticValue(Consumer<StaticPolicyDefinition.Builder> staticValue)
      Create an instance of this class with staticValue() initialized to the given value.

      A structure that describes a static policy. An static policy doesn't use a template or allow placeholders for entities.

      Parameters:
      staticValue - A structure that describes a static policy. An static policy doesn't use a template or allow placeholders for entities.

    • fromTemplateLinked

      public static PolicyDefinition fromTemplateLinked(TemplateLinkedPolicyDefinition templateLinked)
      Create an instance of this class with templateLinked() initialized to the given value.

      A structure that describes a policy that was instantiated from a template. The template can specify placeholders for principal and resource. When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

      Parameters:
      templateLinked - A structure that describes a policy that was instantiated from a template. The template can specify placeholders for principal and resource. When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

    • fromTemplateLinked

      public static PolicyDefinition fromTemplateLinked(Consumer<TemplateLinkedPolicyDefinition.Builder> templateLinked)
      Create an instance of this class with templateLinked() initialized to the given value.

      A structure that describes a policy that was instantiated from a template. The template can specify placeholders for principal and resource. When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

      Parameters:
      templateLinked - A structure that describes a policy that was instantiated from a template. The template can specify placeholders for principal and resource. When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

    • type

      public PolicyDefinition.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be PolicyDefinition.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be PolicyDefinition.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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