Skip to content

KeyConfigurationType

Source code in docs_src/capo_cognito_identity_provider/types/key_configuration_type.py
class KeyConfigurationType(TypedDict, closed=True):
    key_type: NotRequired[
        "capo_cognito_identity_provider.types.encryption_key_type.EncryptionKeyType"
    ]
    """<p>The type of encryption key used for the user pool.</p> <dl> <dt>AWS_OWNED_KEY</dt> <dd> <p>A key owned by Amazon Web Services in Key Management Service.</p> </dd> <dt>CUSTOMER_MANAGED_KEY</dt> <dd> <p>A key managed by the customer in Key Management Service. You must use a multi-region key to enable multi-region replication for a user pool.</p> </dd> </dl>"""
    kms_key_arn: NotRequired[
        "capo_cognito_identity_provider.types.encryption_key_arn_type.EncryptionKeyArnType"
    ]
    """<p>The Amazon Resource Name (ARN) of the KMS key used for encryption. If not specified, Amazon Web Services managed keys are used.</p>"""

key_type instance-attribute

key_type: NotRequired[EncryptionKeyType]

The type of encryption key used for the user pool.

AWS_OWNED_KEY

A key owned by Amazon Web Services in Key Management Service.

CUSTOMER_MANAGED_KEY

A key managed by the customer in Key Management Service. You must use a multi-region key to enable multi-region replication for a user pool.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[EncryptionKeyArnType]

The Amazon Resource Name (ARN) of the KMS key used for encryption. If not specified, Amazon Web Services managed keys are used.