Package de.sebastianhesse.cdk.ses.email.forwarding

Interface EmailForwardingRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EmailForwardingRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.59.0 (build eb02c92)",
           date="2022-06-01T13:32:59.405Z")
@Stability(Stable)
public interface EmailForwardingRuleProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EmailForwardingRuleProps.Builder	builder()
default software.amazon.awscdk.services.s3.Bucket	getBucket()	A bucket to store the email files to.
default String	getBucketPrefix()	A prefix for the email files that are saved to the bucket.
String	getDomainName()	The domain name of the email addresses, e.g.
List<EmailMapping>	getEmailMapping()	An email mapping similar to what the NPM library `aws-lambda-ses-forwarder` expects.
default Boolean	getEnableLambdaLogging()	Enable log messages in Lambda function which forwards emails.
String	getFromPrefix()	A prefix that is used as the sender address of the forwarded mail, e.g.
String	getId()	An id for the rule.
software.amazon.awscdk.services.ses.IReceiptRuleSet	getRuleSet()	The rule set this rule belongs to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The domain name of the email addresses, e.g. 'example.org'. It is used to connect the `fromPrefix` and `receivePrefix` properties with a proper domain.

getEmailMapping

@Stability(Stable)
@NotNull
List<EmailMapping> getEmailMapping()

An email mapping similar to what the NPM library `aws-lambda-ses-forwarder` expects.

See Also:

EmailMapping

getFromPrefix

@Stability(Stable)
@NotNull
String getFromPrefix()

A prefix that is used as the sender address of the forwarded mail, e.g. `noreply`.

getId

@Stability(Stable)
@NotNull
String getId()

An id for the rule.

This will mainly be used to provide a name to the underlying rule but may also be used as a prefix for other resources.

getRuleSet

@Stability(Stable)
@NotNull
software.amazon.awscdk.services.ses.IReceiptRuleSet getRuleSet()

The rule set this rule belongs to.

getBucket

@Stability(Stable)
@Nullable
default software.amazon.awscdk.services.s3.Bucket getBucket()

A bucket to store the email files to.

If no bucket is provided, a new one will be created using a managed KMS key to encrypt the bucket.

Default: A new bucket will be created.

getBucketPrefix

@Stability(Stable)
@Nullable
default String getBucketPrefix()

A prefix for the email files that are saved to the bucket.

Default: inbox/

getEnableLambdaLogging

@Stability(Stable)
@Nullable
default Boolean getEnableLambdaLogging()

Enable log messages in Lambda function which forwards emails.

Default: true

builder

@Stability(Stable)
static EmailForwardingRuleProps.Builder builder()

Returns:

a EmailForwardingRuleProps.Builder of EmailForwardingRuleProps