Skip to content
v2.275.0

S3ActionConfig Struct ​

S3Action configuration.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ses as ses } from 'aws-cdk-lib';
const s3ActionConfig: ses.S3ActionConfig = {
  bucketName: 'bucketName',

  // the properties below are optional
  kmsKeyArn: 'kmsKeyArn',
  objectKeyPrefix: 'objectKeyPrefix',
  topicArn: 'topicArn',
};

Properties ​

bucketNamestringbucket_namestrbucketNameStringBucketNamestringBucketName*stringrequired#
The name of the Amazon S3 bucket that you want to send incoming mail to.
kmsKeyArnoptionalstringkms_key_arnoptionalstrkmsKeyArnoptionalStringKmsKeyArnoptionalstringKmsKeyArnoptional*string#
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket.

Default: Emails are not encrypted.

objectKeyPrefixoptionalstringobject_key_prefixoptionalstrobjectKeyPrefixoptionalStringObjectKeyPrefixoptionalstringObjectKeyPrefixoptional*string#
The key prefix of the Amazon S3 bucket.

Default: No prefix.

topicArnoptionalstringtopic_arnoptionalstrtopicArnoptionalStringTopicArnoptionalstringTopicArnoptional*string#
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket.

Default: No notification is sent to SNS.