Class CreatePolicyStoreRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.verifiedpermissions.model.VerifiedPermissionsRequest
software.amazon.awssdk.services.verifiedpermissions.model.CreatePolicyStoreRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePolicyStoreRequest.Builder,CreatePolicyStoreRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePolicyStoreRequest extends VerifiedPermissionsRequest implements ToCopyableBuilder<CreatePolicyStoreRequest.Builder,CreatePolicyStoreRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

      If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

      Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

      Returns:
      Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

      If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

      Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

    • validationSettings

      public final ValidationSettings validationSettings()

      Specifies the validation setting for this policy store.

      Currently, the only valid and required value is Mode.

      We recommend that you turn on STRICT mode only after you define a schema. If a schema doesn't exist, then STRICT mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the UpdatePolicyStore. Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.

      Returns:
      Specifies the validation setting for this policy store.

      Currently, the only valid and required value is Mode.

      We recommend that you turn on STRICT mode only after you define a schema. If a schema doesn't exist, then STRICT mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the UpdatePolicyStore. Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.

    • description

      public final String description()

      Descriptive text that you can provide to help with identification of the current policy store.

      Returns:
      Descriptive text that you can provide to help with identification of the current policy store.

    • deletionProtection

      public final DeletionProtection deletionProtection()

      Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.

      The default state is DISABLED.

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

      Returns:
      Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.

      The default state is DISABLED.

      See Also:

    • deletionProtectionAsString

      public final String deletionProtectionAsString()

      Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.

      The default state is DISABLED.

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

      Returns:
      Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.

      The default state is DISABLED.

      See Also:

    • 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 Map<String,String> tags()

      The list of key-value pairs to associate with the policy store.

      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:
      The list of key-value pairs to associate with the policy store.

    • toBuilder

      public CreatePolicyStoreRequest.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<CreatePolicyStoreRequest.Builder,CreatePolicyStoreRequest>
      Specified by:
      toBuilder in class VerifiedPermissionsRequest
      Returns:
      a builder for type T

    • builder

      public static CreatePolicyStoreRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreatePolicyStoreRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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