de.sebastianhesse.cdk.ses.email.forwarding

Interface IEmailForwardingRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IEmailForwardingRuleProps.Jsii$Default

All Known Implementing Classes:

IEmailForwardingRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.21.0 (build 4262b22)",
           date="2021-02-28T10:11:05.678Z")
 @Stability(value=Stable)
public interface IEmailForwardingRuleProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IEmailForwardingRuleProps.Jsii$Default Internal default implementation for IEmailForwardingRuleProps.
static class	IEmailForwardingRuleProps.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
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<IEmailMapping>	getEmailMapping() An email mapping similar to what the NPM library `aws-lambda-ses-forwarder` expects.
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.ReceiptRuleSet	getRuleSet() The rule set this rule belongs to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDomainName

@Stability(value=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(value=Stable)
 @NotNull
List<IEmailMapping> getEmailMapping()

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

See Also:

IEmailMapping

getFromPrefix

@Stability(value=Stable)
 @NotNull
String getFromPrefix()

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

getId

@Stability(value=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(value=Stable)
 @NotNull
software.amazon.awscdk.services.ses.ReceiptRuleSet getRuleSet()

The rule set this rule belongs to.

getBucket

@Stability(value=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(value=Stable)
 @Nullable
default String getBucketPrefix()

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

Default: inbox/