S3ActionConfig

class aws_cdk.aws_ses.S3ActionConfig(*, bucket_name, kms_key_arn=None, object_key_prefix=None, topic_arn=None)

Bases: object

S3Action configuration.

Parameters:

  • bucket_name (str) – The name of the Amazon S3 bucket that you want to send incoming mail to.

  • kms_key_arn (Optional[str]) – 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.

  • object_key_prefix (Optional[str]) – The key prefix of the Amazon S3 bucket. Default: - No prefix.

  • topic_arn (Optional[str]) – 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.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ses as ses

s3_action_config = ses.S3ActionConfig(
    bucket_name="bucketName",

    # the properties below are optional
    kms_key_arn="kmsKeyArn",
    object_key_prefix="objectKeyPrefix",
    topic_arn="topicArn"
)

Attributes

bucket_name

The name of the Amazon S3 bucket that you want to send incoming mail to.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-bucketname

kms_key_arn

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-kmskeyarn

object_key_prefix

The key prefix of the Amazon S3 bucket.

Default:

  • No prefix.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-objectkeyprefix

topic_arn

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-s3action.html#cfn-ses-receiptrule-s3action-topicarn