Skip to content

S3EncryptionConfig

Source code in docs_src/capo_synthetics/types/s3_encryption_config.py
class S3EncryptionConfig(TypedDict, closed=True):
    encryption_mode: NotRequired["capo_synthetics.types.encryption_mode.EncryptionMode"]
    """<p> The encryption method to use for artifacts created by this canary. Specify <code>SSE_S3</code> to use server-side encryption (SSE) with an Amazon S3-managed key. Specify <code>SSE-KMS</code> to use server-side encryption with a customer-managed KMS key.</p> <p>If you omit this parameter, an Amazon Web Services-managed KMS key is used. </p>"""
    kms_key_arn: NotRequired["capo_synthetics.types.kms_key_arn.KmsKeyArn"]
    """<p>The ARN of the customer-managed KMS key to use, if you specify <code>SSE-KMS</code> for <code>EncryptionMode</code> </p>"""

encryption_mode instance-attribute

encryption_mode: NotRequired[EncryptionMode]

The encryption method to use for artifacts created by this canary. Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed KMS key.

If you omit this parameter, an Amazon Web Services-managed KMS key is used.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KmsKeyArn]

The ARN of the customer-managed KMS key to use, if you specify SSE-KMS for EncryptionMode