software.amazon.awssdk.services.verifiedpermissions.model

Class PolicyDefinition

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.PolicyDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PolicyDefinition.Builder,PolicyDefinition>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PolicyDefinition.Builder
static class	PolicyDefinition.Type

Method Summary

Modifier and Type	Method and Description
static PolicyDefinition.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static PolicyDefinition	fromStaticValue(Consumer<StaticPolicyDefinition.Builder> staticValue) Create an instance of this class with staticValue() initialized to the given value.
static PolicyDefinition	fromStaticValue(StaticPolicyDefinition staticValue) Create an instance of this class with staticValue() initialized to the given value.
static PolicyDefinition	fromTemplateLinked(Consumer<TemplateLinkedPolicyDefinition.Builder> templateLinked) Create an instance of this class with templateLinked() initialized to the given value.
static PolicyDefinition	fromTemplateLinked(TemplateLinkedPolicyDefinition templateLinked) Create an instance of this class with templateLinked() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PolicyDefinition.Builder>	serializableBuilderClass()
StaticPolicyDefinition	staticValue() A structure that describes a static policy.
TemplateLinkedPolicyDefinition	templateLinked() A structure that describes a policy that was instantiated from a template.
PolicyDefinition.Builder	toBuilder()
String	toString() Returns a string representation of this object.
PolicyDefinition.Type	type() Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<PolicyDefinition.Builder,PolicyDefinition>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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