software.amazon.awssdk.services.verifiedpermissions.model

Class ValidationSettings

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.ValidationSettings

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class ValidationSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ValidationSettings.Builder,ValidationSettings>

A structure that contains Cedar policy validation settings for the policy store. The validation mode determines which validation failures that Cedar considers serious enough to block acceptance of a new or edited static policy or policy template.

This data type is used as a request parameter in the CreatePolicyStore and UpdatePolicyStore operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ValidationSettings.Builder

Method Summary

Modifier and Type	Method and Description
static ValidationSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ValidationMode	mode() The validation mode currently configured for this policy store.
String	modeAsString() The validation mode currently configured for this policy store.
List<SdkField<?>>	sdkFields()
static Class<? extends ValidationSettings.Builder>	serializableBuilderClass()
ValidationSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

mode

public final ValidationMode mode()

The validation mode currently configured for this policy store. The valid values are:

• OFF – Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.

• STRICT – Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.

If Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against.

To submit a static policy or policy template without a schema, you must turn off validation.

If the service returns an enum value that is not available in the current SDK version, mode will return ValidationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

The validation mode currently configured for this policy store. The valid values are:

• OFF – Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.

• STRICT – Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.

If Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against.

To submit a static policy or policy template without a schema, you must turn off validation.

See Also:

ValidationMode

modeAsString

public final String modeAsString()

The validation mode currently configured for this policy store. The valid values are:

• OFF – Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.

• STRICT – Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.

If Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against.

To submit a static policy or policy template without a schema, you must turn off validation.

If the service returns an enum value that is not available in the current SDK version, mode will return ValidationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

The validation mode currently configured for this policy store. The valid values are:

• OFF – Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.

• STRICT – Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.

If Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against.

To submit a static policy or policy template without a schema, you must turn off validation.

See Also:

ValidationMode

toBuilder

public ValidationSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ValidationSettings.Builder,ValidationSettings>

builder

public static ValidationSettings.Builder builder()

serializableBuilderClass

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo