software.amazon.awscdk.services.ses

Class CfnReceiptRule.S3ActionProperty.Builder

java.lang.Object

software.amazon.awscdk.services.ses.CfnReceiptRule.S3ActionProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnReceiptRule.S3ActionProperty>

Enclosing interface:

CfnReceiptRule.S3ActionProperty

@Stability(value=Stable)
public static final class CfnReceiptRule.S3ActionProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnReceiptRule.S3ActionProperty>

A builder for CfnReceiptRule.S3ActionProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnReceiptRule.S3ActionProperty.Builder	bucketName(String bucketName) Sets the value of CfnReceiptRule.S3ActionProperty.getBucketName()
CfnReceiptRule.S3ActionProperty	build() Builds the configured instance.
CfnReceiptRule.S3ActionProperty.Builder	kmsKeyArn(String kmsKeyArn) Sets the value of CfnReceiptRule.S3ActionProperty.getKmsKeyArn()
CfnReceiptRule.S3ActionProperty.Builder	objectKeyPrefix(String objectKeyPrefix) Sets the value of CfnReceiptRule.S3ActionProperty.getObjectKeyPrefix()
CfnReceiptRule.S3ActionProperty.Builder	topicArn(String topicArn) Sets the value of CfnReceiptRule.S3ActionProperty.getTopicArn()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

bucketName

@Stability(value=Stable)
public CfnReceiptRule.S3ActionProperty.Builder bucketName(String bucketName)

Sets the value of CfnReceiptRule.S3ActionProperty.getBucketName()

Parameters:

bucketName - The name of the Amazon S3 bucket for incoming email. This parameter is required.

Returns:

this

kmsKeyArn

@Stability(value=Stable)
public CfnReceiptRule.S3ActionProperty.Builder kmsKeyArn(String kmsKeyArn)

Sets the value of CfnReceiptRule.S3ActionProperty.getKmsKeyArn()

Parameters:

kmsKeyArn - The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key that you created in AWS KMS as follows:

• To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses . For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) Region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses . If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.
• To use a custom master key that you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide .

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 AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide .

Returns:

this

objectKeyPrefix

@Stability(value=Stable)
public CfnReceiptRule.S3ActionProperty.Builder objectKeyPrefix(String objectKeyPrefix)

Sets the value of CfnReceiptRule.S3ActionProperty.getObjectKeyPrefix()

Parameters:

objectKeyPrefix - The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.

Returns:

this

topicArn

@Stability(value=Stable)
public CfnReceiptRule.S3ActionProperty.Builder topicArn(String topicArn)

Sets the value of CfnReceiptRule.S3ActionProperty.getTopicArn()

Parameters:

topicArn - The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. 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 .

Returns:

this

build

@Stability(value=Stable)
public CfnReceiptRule.S3ActionProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnReceiptRule.S3ActionProperty>

Returns:

a new instance of CfnReceiptRule.S3ActionProperty

Throws:

NullPointerException - if any required attribute was not provided