/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include 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 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
* giving permissions, see the Amazon
* SES Developer Guide. When you save your emails to an Amazon S3
* bucket, the maximum email size (including headers) is 30 MB. Emails larger than
* that will bounce. For information about specifying Amazon S3
* actions in receipt rules, see the Amazon
* SES Developer Guide.See Also:
AWS API
* Reference
The ARN of the Amazon SNS topic to notify when the message is saved to the
* Amazon S3 bucket. An example of an Amazon SNS topic ARN is
* arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information
* about Amazon SNS topics, see the Amazon SNS
* Developer Guide.
The ARN of the Amazon SNS topic to notify when the message is saved to the
* Amazon S3 bucket. An example of an Amazon SNS topic ARN is
* arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information
* about Amazon SNS topics, see the Amazon SNS
* Developer Guide.
The ARN of the Amazon SNS topic to notify when the message is saved to the
* Amazon S3 bucket. An example of an Amazon SNS topic ARN is
* arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information
* about Amazon SNS topics, see the Amazon SNS
* Developer Guide.
The ARN of the Amazon SNS topic to notify when the message is saved to the
* Amazon S3 bucket. An example of an Amazon SNS topic ARN is
* arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information
* about Amazon SNS topics, see the Amazon SNS
* Developer Guide.
The ARN of the Amazon SNS topic to notify when the message is saved to the
* Amazon S3 bucket. An example of an Amazon SNS topic ARN is
* arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information
* about Amazon SNS topics, see the Amazon SNS
* Developer Guide.
The ARN of the Amazon SNS topic to notify when the message is saved to the
* Amazon S3 bucket. An example of an Amazon SNS topic ARN is
* arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information
* about Amazon SNS topics, see the Amazon SNS
* Developer Guide.
The ARN of the Amazon SNS topic to notify when the message is saved to the
* Amazon S3 bucket. An example of an Amazon SNS topic ARN is
* arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information
* about Amazon SNS topics, see the Amazon SNS
* Developer Guide.
The ARN of the Amazon SNS topic to notify when the message is saved to the
* Amazon S3 bucket. An example of an Amazon SNS topic ARN is
* arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information
* about Amazon SNS topics, see the Amazon SNS
* Developer Guide.
The name of the Amazon S3 bucket that incoming email will be saved to.
*/ inline const Aws::String& GetBucketName() const{ return m_bucketName; } /** *The name of the Amazon S3 bucket that incoming email will be saved to.
*/ inline bool BucketNameHasBeenSet() const { return m_bucketNameHasBeenSet; } /** *The name of the Amazon S3 bucket that incoming email will be saved to.
*/ inline void SetBucketName(const Aws::String& value) { m_bucketNameHasBeenSet = true; m_bucketName = value; } /** *The name of the Amazon S3 bucket that incoming email will be saved to.
*/ inline void SetBucketName(Aws::String&& value) { m_bucketNameHasBeenSet = true; m_bucketName = std::move(value); } /** *The name of the Amazon S3 bucket that incoming email will be saved to.
*/ inline void SetBucketName(const char* value) { m_bucketNameHasBeenSet = true; m_bucketName.assign(value); } /** *The name of the Amazon S3 bucket that incoming email will be saved to.
*/ inline S3Action& WithBucketName(const Aws::String& value) { SetBucketName(value); return *this;} /** *The name of the Amazon S3 bucket that incoming email will be saved to.
*/ inline S3Action& WithBucketName(Aws::String&& value) { SetBucketName(std::move(value)); return *this;} /** *The name of the Amazon S3 bucket that incoming email will be saved to.
*/ inline S3Action& WithBucketName(const char* value) { SetBucketName(value); return *this;} /** *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.
*/ inline const Aws::String& GetObjectKeyPrefix() const{ return m_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.
*/ inline bool ObjectKeyPrefixHasBeenSet() const { return m_objectKeyPrefixHasBeenSet; } /** *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.
*/ inline void SetObjectKeyPrefix(const Aws::String& value) { m_objectKeyPrefixHasBeenSet = true; m_objectKeyPrefix = value; } /** *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.
*/ inline void SetObjectKeyPrefix(Aws::String&& value) { m_objectKeyPrefixHasBeenSet = true; m_objectKeyPrefix = std::move(value); } /** *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.
*/ inline void SetObjectKeyPrefix(const char* value) { m_objectKeyPrefixHasBeenSet = true; m_objectKeyPrefix.assign(value); } /** *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.
*/ inline S3Action& WithObjectKeyPrefix(const Aws::String& value) { SetObjectKeyPrefix(value); return *this;} /** *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.
*/ inline S3Action& WithObjectKeyPrefix(Aws::String&& value) { SetObjectKeyPrefix(std::move(value)); return *this;} /** *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.
*/ inline S3Action& WithObjectKeyPrefix(const char* value) { SetObjectKeyPrefix(value); return *this;} /** *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 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 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 will 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.
*/ inline const Aws::String& GetKmsKeyArn() const{ return m_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 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 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 will 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.
*/ inline bool KmsKeyArnHasBeenSet() const { return m_kmsKeyArnHasBeenSet; } /** *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 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 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 will 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.
*/ inline void SetKmsKeyArn(const Aws::String& value) { m_kmsKeyArnHasBeenSet = true; m_kmsKeyArn = value; } /** *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 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 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 will 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.
*/ inline void SetKmsKeyArn(Aws::String&& value) { m_kmsKeyArnHasBeenSet = true; m_kmsKeyArn = std::move(value); } /** *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 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 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 will 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.
*/ inline void SetKmsKeyArn(const char* value) { m_kmsKeyArnHasBeenSet = true; m_kmsKeyArn.assign(value); } /** *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 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 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 will 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.
*/ inline S3Action& WithKmsKeyArn(const Aws::String& value) { SetKmsKeyArn(value); return *this;} /** *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 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 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 will 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.
*/ inline S3Action& WithKmsKeyArn(Aws::String&& value) { SetKmsKeyArn(std::move(value)); return *this;} /** *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 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 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 will 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.
*/ inline S3Action& WithKmsKeyArn(const char* value) { SetKmsKeyArn(value); return *this;} private: Aws::String m_topicArn; bool m_topicArnHasBeenSet = false; Aws::String m_bucketName; bool m_bucketNameHasBeenSet = false; Aws::String m_objectKeyPrefix; bool m_objectKeyPrefixHasBeenSet = false; Aws::String m_kmsKeyArn; bool m_kmsKeyArnHasBeenSet = false; }; } // namespace Model } // namespace SES } // namespace Aws