de.sebastianhesse.cdk.ses.email.forwarding

Interface IEmailForwardingRuleProps.Jsii$Default

All Superinterfaces:

IEmailForwardingRuleProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IEmailForwardingRuleProps.Jsii$Proxy

Enclosing interface:

IEmailForwardingRuleProps

@Internal
public static interface IEmailForwardingRuleProps.Jsii$Default
extends IEmailForwardingRuleProps

Internal default implementation for IEmailForwardingRuleProps.

Nested Class Summary

Nested classes/interfaces inherited from interface de.sebastianhesse.cdk.ses.email.forwarding.IEmailForwardingRuleProps

IEmailForwardingRuleProps.Jsii$Default, IEmailForwardingRuleProps.Jsii$Proxy

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.
default String	getDomainName() The domain name of the email addresses, e.g.
default List<IEmailMapping>	getEmailMapping() An email mapping similar to what the NPM library `aws-lambda-ses-forwarder` expects.
default String	getFromPrefix() A prefix that is used as the sender address of the forwarded mail, e.g.
default String	getId() An id for the rule.
default 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
default 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.

Specified by:

getDomainName in interface IEmailForwardingRuleProps

getEmailMapping

@Stability(value=Stable)
 @NotNull
default List<IEmailMapping> getEmailMapping()

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

Specified by:

getEmailMapping in interface IEmailForwardingRuleProps

See Also:

IEmailMapping

getFromPrefix

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

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

Specified by:

getFromPrefix in interface IEmailForwardingRuleProps

getId

@Stability(value=Stable)
 @NotNull
default 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.

Specified by:

getId in interface IEmailForwardingRuleProps

getRuleSet

@Stability(value=Stable)
 @NotNull
default software.amazon.awscdk.services.ses.ReceiptRuleSet getRuleSet()

The rule set this rule belongs to.

Specified by:

getRuleSet in interface IEmailForwardingRuleProps

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.

Specified by:

getBucket in interface IEmailForwardingRuleProps

getBucketPrefix

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

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

Default: inbox/

Specified by:

getBucketPrefix in interface IEmailForwardingRuleProps