Interface CfnReceiptRule.IS3ActionProperty
When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
Namespace: Amazon.CDK.AWS.SES
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IS3ActionProperty
Syntax (vb)
Public Interface IS3ActionProperty
Remarks
To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about granting permissions, see the Amazon SES Developer Guide .
When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 40 MB. Emails larger than that bounces.
For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide .
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.SES;
var s3ActionProperty = new S3ActionProperty {
BucketName = "bucketName",
// the properties below are optional
KmsKeyArn = "kmsKeyArn",
ObjectKeyPrefix = "objectKeyPrefix",
TopicArn = "topicArn"
};
Synopsis
Properties
BucketName | The name of the Amazon S3 bucket for incoming email. |
KmsKeyArn | The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. |
ObjectKeyPrefix | The key prefix of the Amazon S3 bucket. |
TopicArn | The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. |
Properties
BucketName
The name of the Amazon S3 bucket for incoming email.
string BucketName { get; }
Property Value
System.String
Remarks
KmsKeyArn
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket.
virtual string KmsKeyArn { get; }
Property Value
System.String
Remarks
You can use the default master key or a custom master key that you created in AWS KMS as follows:
For more information about key policies, see the AWS KMS Developer Guide . If you do not specify a master key, Amazon SES does not encrypt your emails.
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the <a href="https://docs.aws.amazon.com/sdk-for-java/">AWS SDK for Java</a> and <a href="https://docs.aws.amazon.com/sdk-for-ruby/">AWS SDK for Ruby</a> only. For more information about client-side encryption using AWS KMS master keys, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 Developer Guide</a> .
ObjectKeyPrefix
The key prefix of the Amazon S3 bucket.
virtual string ObjectKeyPrefix { get; }
Property Value
System.String
Remarks
The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
TopicArn
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket.
virtual string TopicArn { get; }
Property Value
System.String
Remarks
You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .