software.amazon.awssdk.services.ses.model.S3Action Maven / Gradle / Ivy
Show all versions of ses Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.ses.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* 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.
*
*
*
* When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 40 MB. Emails larger
* than that bounces.
*
*
*
* For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class S3Action implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField TOPIC_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TopicArn").getter(getter(S3Action::topicArn)).setter(setter(Builder::topicArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TopicArn").build()).build();
private static final SdkField BUCKET_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("BucketName").getter(getter(S3Action::bucketName)).setter(setter(Builder::bucketName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BucketName").build()).build();
private static final SdkField OBJECT_KEY_PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ObjectKeyPrefix").getter(getter(S3Action::objectKeyPrefix)).setter(setter(Builder::objectKeyPrefix))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ObjectKeyPrefix").build()).build();
private static final SdkField KMS_KEY_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KmsKeyArn").getter(getter(S3Action::kmsKeyArn)).setter(setter(Builder::kmsKeyArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KmsKeyArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TOPIC_ARN_FIELD,
BUCKET_NAME_FIELD, OBJECT_KEY_PREFIX_FIELD, KMS_KEY_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final String topicArn;
private final String bucketName;
private final String objectKeyPrefix;
private final String kmsKeyArn;
private S3Action(BuilderImpl builder) {
this.topicArn = builder.topicArn;
this.bucketName = builder.bucketName;
this.objectKeyPrefix = builder.objectKeyPrefix;
this.kmsKeyArn = builder.kmsKeyArn;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String topicArn() {
return topicArn;
}
/**
*
* The name of the Amazon S3 bucket for incoming email.
*
*
* @return The name of the Amazon S3 bucket for incoming email.
*/
public final String bucketName() {
return bucketName;
}
/**
*
* 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.
*
*
* @return 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 final String objectKeyPrefix() {
return objectKeyPrefix;
}
/**
*
* 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 Amazon Web Services 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 Amazon Web
* Services 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 Amazon Web Services 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 Amazon Web Services 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 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 master keys, see the Amazon S3 Developer
* Guide.
*
*
*
* @return 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 Amazon
* Web Services 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 Amazon Web
* Services 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 Amazon Web Services 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 Amazon Web Services 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 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 master keys, see the Amazon S3 Developer
* Guide.
*
*/
public final String kmsKeyArn() {
return kmsKeyArn;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(topicArn());
hashCode = 31 * hashCode + Objects.hashCode(bucketName());
hashCode = 31 * hashCode + Objects.hashCode(objectKeyPrefix());
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyArn());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof S3Action)) {
return false;
}
S3Action other = (S3Action) obj;
return Objects.equals(topicArn(), other.topicArn()) && Objects.equals(bucketName(), other.bucketName())
&& Objects.equals(objectKeyPrefix(), other.objectKeyPrefix()) && Objects.equals(kmsKeyArn(), other.kmsKeyArn());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("S3Action").add("TopicArn", topicArn()).add("BucketName", bucketName())
.add("ObjectKeyPrefix", objectKeyPrefix()).add("KmsKeyArn", kmsKeyArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TopicArn":
return Optional.ofNullable(clazz.cast(topicArn()));
case "BucketName":
return Optional.ofNullable(clazz.cast(bucketName()));
case "ObjectKeyPrefix":
return Optional.ofNullable(clazz.cast(objectKeyPrefix()));
case "KmsKeyArn":
return Optional.ofNullable(clazz.cast(kmsKeyArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((S3Action) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder topicArn(String topicArn);
/**
*
* The name of the Amazon S3 bucket for incoming email.
*
*
* @param bucketName
* The name of the Amazon S3 bucket for incoming email.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bucketName(String bucketName);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder objectKeyPrefix(String objectKeyPrefix);
/**
*
* 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 Amazon Web Services 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 Amazon Web
* Services 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 Amazon Web Services 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 Amazon Web Services 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 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 master keys, see the Amazon S3 Developer
* Guide.
*
*
*
* @param 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 Amazon
* Web Services 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 Amazon
* Web Services 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 Amazon Web Services 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 Amazon Web Services 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 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
* master keys, see the Amazon S3
* Developer Guide.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKeyArn(String kmsKeyArn);
}
static final class BuilderImpl implements Builder {
private String topicArn;
private String bucketName;
private String objectKeyPrefix;
private String kmsKeyArn;
private BuilderImpl() {
}
private BuilderImpl(S3Action model) {
topicArn(model.topicArn);
bucketName(model.bucketName);
objectKeyPrefix(model.objectKeyPrefix);
kmsKeyArn(model.kmsKeyArn);
}
public final String getTopicArn() {
return topicArn;
}
public final void setTopicArn(String topicArn) {
this.topicArn = topicArn;
}
@Override
public final Builder topicArn(String topicArn) {
this.topicArn = topicArn;
return this;
}
public final String getBucketName() {
return bucketName;
}
public final void setBucketName(String bucketName) {
this.bucketName = bucketName;
}
@Override
public final Builder bucketName(String bucketName) {
this.bucketName = bucketName;
return this;
}
public final String getObjectKeyPrefix() {
return objectKeyPrefix;
}
public final void setObjectKeyPrefix(String objectKeyPrefix) {
this.objectKeyPrefix = objectKeyPrefix;
}
@Override
public final Builder objectKeyPrefix(String objectKeyPrefix) {
this.objectKeyPrefix = objectKeyPrefix;
return this;
}
public final String getKmsKeyArn() {
return kmsKeyArn;
}
public final void setKmsKeyArn(String kmsKeyArn) {
this.kmsKeyArn = kmsKeyArn;
}
@Override
public final Builder kmsKeyArn(String kmsKeyArn) {
this.kmsKeyArn = kmsKeyArn;
return this;
}
@Override
public S3Action build() {
return new S3Action(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}