interface S3EncryptionProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Synthetics.CfnCanary.S3EncryptionProperty |
 Java | software.amazon.awscdk.services.synthetics.CfnCanary.S3EncryptionProperty |
 Python | aws_cdk.aws_synthetics.CfnCanary.S3EncryptionProperty |
 TypeScript | @aws-cdk/aws-synthetics » CfnCanary » S3EncryptionProperty |
A structure that contains the configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3 .
Artifact encryption functionality is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3 or later. For more information, see Encrypting canary artifacts .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as synthetics from '@aws-cdk/aws-synthetics';
const s3EncryptionProperty: synthetics.CfnCanary.S3EncryptionProperty = {
encryptionMode: 'encryptionMode',
kmsKeyArn: 'kmsKeyArn',
};
Properties
| Name | Type | Description |
|---|---|---|
| encryption | string | The encryption method to use for artifacts created by this canary. |
| kms | string | The ARN of the customer-managed AWS KMS key to use, if you specify SSE-KMS for EncryptionMode. |
encryptionMode?
Type:
string
(optional)
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 AWS KMS key.
If you omit this parameter, an AWS -managed AWS KMS key is used.
kmsKeyArn?
Type:
string
(optional)
The ARN of the customer-managed AWS KMS key to use, if you specify SSE-KMS for EncryptionMode.