public class S3Action extends Object implements Serializable, Cloneable
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.
For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.
Constructor and Description |
---|
S3Action() |
Modifier and Type | Method and Description |
---|---|
S3Action |
clone() |
boolean |
equals(Object obj) |
String |
getBucketName()
The name of the Amazon S3 bucket to which to save the received email.
|
String |
getKmsKeyArn()
The customer master key that Amazon SES should use to encrypt your emails
before saving them to the Amazon S3 bucket.
|
String |
getObjectKeyPrefix()
The key prefix of the Amazon S3 bucket.
|
String |
getTopicArn()
The ARN of the Amazon SNS topic to notify when the message is saved to
the Amazon S3 bucket.
|
int |
hashCode() |
void |
setBucketName(String bucketName)
The name of the Amazon S3 bucket to which to save the received email.
|
void |
setKmsKeyArn(String kmsKeyArn)
The customer master key that Amazon SES should use to encrypt your emails
before saving them to the Amazon S3 bucket.
|
void |
setObjectKeyPrefix(String objectKeyPrefix)
The key prefix of the Amazon S3 bucket.
|
void |
setTopicArn(String topicArn)
The ARN of the Amazon SNS topic to notify when the message is saved to
the Amazon S3 bucket.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
S3Action |
withBucketName(String bucketName)
The name of the Amazon S3 bucket to which to save the received email.
|
S3Action |
withKmsKeyArn(String kmsKeyArn)
The customer master key that Amazon SES should use to encrypt your emails
before saving them to the Amazon S3 bucket.
|
S3Action |
withObjectKeyPrefix(String objectKeyPrefix)
The key prefix of the Amazon S3 bucket.
|
S3Action |
withTopicArn(String topicArn)
The ARN of the Amazon SNS topic to notify when the message is saved to
the Amazon S3 bucket.
|
public void setTopicArn(String topicArn)
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.
topicArn
- 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.public String getTopicArn()
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.
arn:aws:sns:us-west-2:123456789012:MyTopic
.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.public S3Action withTopicArn(String topicArn)
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.
topicArn
- 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.public void setBucketName(String bucketName)
The name of the Amazon S3 bucket to which to save the received email.
bucketName
- The name of the Amazon S3 bucket to which to save the received
email.public String getBucketName()
The name of the Amazon S3 bucket to which to save the received email.
public S3Action withBucketName(String bucketName)
The name of the Amazon S3 bucket to which to save the received email.
bucketName
- The name of the Amazon S3 bucket to which to save the received
email.public void setObjectKeyPrefix(String 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.
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.public String getObjectKeyPrefix()
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.
public S3Action withObjectKeyPrefix(String 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.
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.public void setKmsKeyArn(String 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:
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.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.
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:
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.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.
public String getKmsKeyArn()
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:
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.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.
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.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.
public S3Action withKmsKeyArn(String 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:
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.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.
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:
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.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.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2016. All rights reserved.