Skip to content

CreatePolicyStoreInput

Source code in docs_src/capo_verifiedpermissions/types/create_policy_store_input.py
class CreatePolicyStoreInput(TypedDict, closed=True):
    client_token: NotRequired[
        "capo_verifiedpermissions.types.idempotency_token.IdempotencyToken"
    ]
    """<p>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 <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value.</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>ConflictException</code> error.</p> <p>Verified Permissions recognizes a <code>ClientToken</code> for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of <code>ClientToken</code>.</p>"""
    validation_settings: (
        "capo_verifiedpermissions.types.validation_settings.ValidationSettings"
    )
    """<p>Specifies the validation setting for this policy store.</p> <p>Currently, the only valid and required value is <code>Mode</code>.</p> <important> <p>We recommend that you turn on <code>STRICT</code> mode only after you define a schema. If a schema doesn't exist, then <code>STRICT</code> mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore">UpdatePolicyStore</a>. Then, when you have a schema defined, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore">UpdatePolicyStore</a> again to turn validation back on.</p> </important>"""
    description: NotRequired[
        "capo_verifiedpermissions.types.policy_store_description.PolicyStoreDescription"
    ]
    """<p>Descriptive text that you can provide to help with identification of the current policy store.</p>"""
    deletion_protection: NotRequired[
        "capo_verifiedpermissions.types.deletion_protection.DeletionProtection"
    ]
    """<p>Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.</p> <p>The default state is <code>DISABLED</code>.</p>"""
    encryption_settings: NotRequired[
        "capo_verifiedpermissions.types.encryption_settings.EncryptionSettings"
    ]
    """<p>Specifies the encryption settings used to encrypt the policy store and their child resources. Allows for the ability to use a customer owned KMS key for encryption of data.</p> <p>This is an optional field to be used when providing a customer-managed KMS key for encryption.</p>"""
    tags: NotRequired["capo_verifiedpermissions.types.tag_map.TagMap"]
    """<p>The list of key-value pairs to associate with the policy store.</p>"""

client_token instance-attribute

client_token: NotRequired[IdempotencyToken]

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.

deletion_protection instance-attribute

deletion_protection: NotRequired[DeletionProtection]

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

The default state is DISABLED.

description instance-attribute

description: NotRequired[PolicyStoreDescription]

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

encryption_settings instance-attribute

encryption_settings: NotRequired[EncryptionSettings]

Specifies the encryption settings used to encrypt the policy store and their child resources. Allows for the ability to use a customer owned KMS key for encryption of data.

This is an optional field to be used when providing a customer-managed KMS key for encryption.

tags instance-attribute

tags: NotRequired[TagMap]

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

validation_settings instance-attribute

validation_settings: 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.