Skip to content
v2.274.0

S3ActionProperty Struct ​

Writes the MIME content of the email to an S3 bucket.

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 s3ActionProperty: ses.CfnMailManagerRuleSet.S3ActionProperty = {
  roleArn: 'roleArn',
  s3Bucket: 's3Bucket',

  // the properties below are optional
  actionFailurePolicy: 'actionFailurePolicy',
  s3Prefix: 's3Prefix',
  s3SseKmsKeyId: 's3SseKmsKeyId',
};

Properties ​

actionFailurePolicyoptionalstringaction_failure_policyoptionalstractionFailurePolicyoptionalStringActionFailurePolicyoptionalstringActionFailurePolicyoptional*string#
A policy that states what to do in the case of failure.

The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#
The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3.

This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.

s3Bucketstrings3_bucketstrs3BucketStringS3BucketstringS3Bucket*stringrequired#
The bucket name of the S3 bucket to write to.
s3Prefixoptionalstrings3_prefixoptionalstrs3PrefixoptionalStringS3PrefixoptionalstringS3Prefixoptional*string#
The S3 prefix to use for the write to the s3 bucket.
s3SseKmsKeyIdoptionalstrings3_sse_kms_key_idoptionalstrs3SseKmsKeyIdoptionalStringS3SseKmsKeyIdoptionalstringS3SseKmsKeyIdoptional*string#
The KMS Key ID to use to encrypt the message in S3.