Class: Aws::SES::Types::S3Action

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ses/types.rb

Overview

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).

To enable Amazon SES to write emails to your Amazon S3 bucket, use an Amazon Web Services 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].

<note markdown=“1”> When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 40 MB. Emails larger than that bounces.

</note>

For information about specifying Amazon S3 actions in receipt rules, see the [Amazon SES Developer Guide].

[1]: docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html [2]: docs.aws.amazon.com/ses/latest/dg/receiving-email-action-s3.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_name ⇒ String

The name of the Amazon S3 bucket for incoming email.

Returns:

  • (String) 


3598
3599
3600
3601
3602
3603
3604
3605
3606
 
# File 'lib/aws-sdk-ses/types.rb', line 3598

class S3Action < Struct.new(
  :topic_arn,
  :bucket_name,
  :object_key_prefix,
  :kms_key_arn,
  :iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arn ⇒ String

The ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket, optionally encrypting your mail via the provided customer managed key, and publishing to the Amazon SNS topic. This role should have access to the following APIs:

  • ‘s3:PutObject`, `kms:Encrypt` and `kms:GenerateDataKey` for the given Amazon S3 bucket.

  • ‘kms:GenerateDataKey` for the given Amazon Web Services KMS customer managed key.

  • ‘sns:Publish` for the given Amazon SNS topic.

<note markdown=“1”> If an IAM role ARN is provided, the role (and only the role) is used to access all the given resources (Amazon S3 bucket, Amazon Web Services KMS customer managed key and Amazon SNS topic). Therefore, setting up individual resource access permissions is not required.

</note>

Returns:

  • (String) 


3598
3599
3600
3601
3602
3603
3604
3605
3606
 
# File 'lib/aws-sdk-ses/types.rb', line 3598

class S3Action < Struct.new(
  :topic_arn,
  :bucket_name,
  :object_key_prefix,
  :kms_key_arn,
  :iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

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

  • To use the default managed key, provide an ARN in the form of ‘arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses`. For example, if your Amazon Web Services account ID is 123456789012 and you want to use the default managed 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 managed key, you don’t need to perform any extra steps to give Amazon SES permission to use the key.

  • To use a custom managed key that you created in Amazon Web Services KMS, provide the ARN of the managed 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 [Amazon Web Services KMS Developer Guide]. If you do not specify a managed 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 Amazon Web Services KMS keys for decryption. This encryption client is currently available with the [Amazon Web Services SDK for Java] and [Amazon Web Services SDK for Ruby] only. For more information about client-side encryption using Amazon Web Services KMS managed keys, see the [Amazon S3 Developer Guide].

[1]: docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html [2]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html [3]: aws.amazon.com/sdk-for-java/ [4]: aws.amazon.com/sdk-for-ruby/ [5]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html

Returns:

  • (String) 


3598
3599
3600
3601
3602
3603
3604
3605
3606
 
# File 'lib/aws-sdk-ses/types.rb', line 3598

class S3Action < Struct.new(
  :topic_arn,
  :bucket_name,
  :object_key_prefix,
  :kms_key_arn,
  :iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#object_key_prefix ⇒ String

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:

  • (String) 


3598
3599
3600
3601
3602
3603
3604
3605
3606
 
# File 'lib/aws-sdk-ses/types.rb', line 3598

class S3Action < Struct.new(
  :topic_arn,
  :bucket_name,
  :object_key_prefix,
  :kms_key_arn,
  :iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#topic_arn ⇒ String

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].

[1]: docs.aws.amazon.com/sns/latest/api/API_ListTopics.html [2]: docs.aws.amazon.com/sns/latest/dg/CreateTopic.html

Returns:

  • (String) 


3598
3599
3600
3601
3602
3603
3604
3605
3606
 
# File 'lib/aws-sdk-ses/types.rb', line 3598

class S3Action < Struct.new(
  :topic_arn,
  :bucket_name,
  :object_key_prefix,
  :kms_key_arn,
  :iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end