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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreatePolicyStoreRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreatePolicyStoreRequest.Builderbuilder()StringclientToken()Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request.DeletionProtectiondeletionProtection()Specifies whether the policy store can be deleted.StringdeletionProtectionAsString()Specifies whether the policy store can be deleted.Stringdescription()Descriptive text that you can provide to help with identification of the current policy store.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreatePolicyStoreRequest.Builder>serializableBuilderClass()Map<String,String>tags()The list of key-value pairs to associate with the policy store.CreatePolicyStoreRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.ValidationSettingsvalidationSettings()Specifies the validation setting for this policy store.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
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 anConflictExceptionerror.Verified Permissions recognizes a
ClientTokenfor eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value ofClientToken.- 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 anConflictExceptionerror.Verified Permissions recognizes a
ClientTokenfor eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value ofClientToken.
-
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
STRICTmode only after you define a schema. If a schema doesn't exist, thenSTRICTmode 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
STRICTmode only after you define a schema. If a schema doesn't exist, thenSTRICTmode 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,
deletionProtectionwill returnDeletionProtection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeletionProtectionAsString().- 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:
DeletionProtection
-
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,
deletionProtectionwill returnDeletionProtection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeletionProtectionAsString().- 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:
DeletionProtection
-
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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreatePolicyStoreRequest.Builder,CreatePolicyStoreRequest>- Specified by:
toBuilderin classVerifiedPermissionsRequest
-
builder
public static CreatePolicyStoreRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreatePolicyStoreRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-