Class CfnCanary.S3EncryptionProperty
A structure that contains the configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3 .
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Synthetics
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3EncryptionProperty : Object, CfnCanary.IS3EncryptionProperty
Syntax (vb)
Public Class S3EncryptionProperty
Inherits Object
Implements CfnCanary.IS3EncryptionProperty
Remarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Synthetics;
var s3EncryptionProperty = new S3EncryptionProperty {
EncryptionMode = "encryptionMode",
KmsKeyArn = "kmsKeyArn"
};
Synopsis
Constructors
S3EncryptionProperty() |
Properties
EncryptionMode | The encryption method to use for artifacts created by this canary. |
KmsKeyArn | The ARN of the customer-managed AWS KMS key to use, if you specify |
Constructors
S3EncryptionProperty()
public S3EncryptionProperty()
Properties
EncryptionMode
The encryption method to use for artifacts created by this canary.
public string EncryptionMode { get; set; }
Property Value
System.String
Remarks
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
The ARN of the customer-managed AWS KMS key to use, if you specify SSE-KMS
for EncryptionMode
.
public string KmsKeyArn { get; set; }
Property Value
System.String