software.amazon.awscdk.services.ses.actions

Interface S3Props

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

S3Props.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.225Z")
 @Stability(value=Stable)
public interface S3Props
extends software.amazon.jsii.JsiiSerializable

Construction properties for a S3 action.

Example:

 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.services.ses.actions.*;
 Bucket bucket = new Bucket(this, "Bucket");
 Topic topic = new Topic(this, "Topic");
 ReceiptRuleSet.Builder.create(this, "RuleSet")
         .rules(List.of(ReceiptRuleOptions.builder()
                 .recipients(List.of("hello@aws.com"))
                 .actions(List.of(
                     AddHeader.Builder.create()
                             .name("X-Special-Header")
                             .value("aws")
                             .build(),
                     S3.Builder.create()
                             .bucket(bucket)
                             .objectKeyPrefix("emails/")
                             .topic(topic)
                             .build()))
                 .build(), ReceiptRuleOptions.builder()
                 .recipients(List.of("aws.com"))
                 .actions(List.of(
                     Sns.Builder.create()
                             .topic(topic)
                             .build()))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	S3Props.Builder A builder for S3Props
static class	S3Props.Jsii$Proxy An implementation for S3Props

Method Summary

Modifier and Type	Method and Description
static S3Props.Builder	builder()
IBucket	getBucket() The S3 bucket that incoming email will be saved to.
default IKey	getKmsKey() The master key that SES should use to encrypt your emails before saving them to the S3 bucket.
default String	getObjectKeyPrefix() The key prefix of the S3 bucket.
default ITopic	getTopic() The SNS topic to notify when the S3 action is taken.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBucket

@Stability(value=Stable)
 @NotNull
IBucket getBucket()

The S3 bucket that incoming email will be saved to.

getKmsKey

@Stability(value=Stable)
 @Nullable
default IKey getKmsKey()

The master key that SES should use to encrypt your emails before saving them to the S3 bucket.

Default: no encryption

getObjectKeyPrefix

@Stability(value=Stable)
 @Nullable
default String getObjectKeyPrefix()

The key prefix of the S3 bucket.

Default: no prefix

getTopic

@Stability(value=Stable)
 @Nullable
default ITopic getTopic()

The SNS topic to notify when the S3 action is taken.

Default: no notification

builder

@Stability(value=Stable)
static S3Props.Builder builder()

Returns:

a S3Props.Builder of S3Props