Package software.amazon.awscdk.services.synthetics

Interface CfnCanary.S3EncryptionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCanary.S3EncryptionProperty.Jsii$Proxy

Enclosing class:

CfnCanary

@Stability(Stable)
public static interface CfnCanary.S3EncryptionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.synthetics.*;
 S3EncryptionProperty s3EncryptionProperty = S3EncryptionProperty.builder()
         .encryptionMode("encryptionMode")
         .kmsKeyArn("kmsKeyArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCanary.S3EncryptionProperty.Builder	A builder for CfnCanary.S3EncryptionProperty
static final class	CfnCanary.S3EncryptionProperty.Jsii$Proxy	An implementation for CfnCanary.S3EncryptionProperty

Method Summary

Modifier and Type	Method	Description
static CfnCanary.S3EncryptionProperty.Builder	builder()
default String	getEncryptionMode()	The encryption method to use for artifacts created by this canary.
default String	getKmsKeyArn()	The ARN of the customer-managed AWS KMS key to use, if you specify SSE-KMS for EncryptionMode.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEncryptionMode

@Stability(Stable)
@Nullable
default String getEncryptionMode()

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.

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

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

builder

@Stability(Stable)
static CfnCanary.S3EncryptionProperty.Builder builder()

Returns:

a CfnCanary.S3EncryptionProperty.Builder of CfnCanary.S3EncryptionProperty