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

Class EmailForwardingRule.Builder

java.lang.Object

de.sebastianhesse.cdk.ses.email.forwarding.EmailForwardingRule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EmailForwardingRule>

Enclosing class:

EmailForwardingRule

@Stability(Stable)
public static final class EmailForwardingRule.Builder
extends Object
implements software.amazon.jsii.Builder<EmailForwardingRule>

A fluent builder for EmailForwardingRule.

Method Summary

Modifier and Type	Method	Description
EmailForwardingRule.Builder	bucket(software.amazon.awscdk.services.s3.Bucket bucket)	A bucket to store the email files to.
EmailForwardingRule.Builder	bucketPrefix(String bucketPrefix)	A prefix for the email files that are saved to the bucket.
EmailForwardingRule	build()
static EmailForwardingRule.Builder	create(software.constructs.Construct parent, String name)
EmailForwardingRule.Builder	domainName(String domainName)	The domain name of the email addresses, e.g.
EmailForwardingRule.Builder	emailMapping(List<? extends EmailMapping> emailMapping)	An email mapping similar to what the NPM library `aws-lambda-ses-forwarder` expects.
EmailForwardingRule.Builder	enableLambdaLogging(Boolean enableLambdaLogging)	Enable log messages in Lambda function which forwards emails.
EmailForwardingRule.Builder	fromPrefix(String fromPrefix)	A prefix that is used as the sender address of the forwarded mail, e.g.
EmailForwardingRule.Builder	id(String id)	An id for the rule.
EmailForwardingRule.Builder	ruleSet(software.amazon.awscdk.services.ses.IReceiptRuleSet ruleSet)	The rule set this rule belongs to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(Stable)
public static EmailForwardingRule.Builder create(software.constructs.Construct parent,
                                                 String name)

Parameters:

parent - This parameter is required.

name - This parameter is required.

Returns:

a new instance of EmailForwardingRule.Builder.

domainName

@Stability(Stable)
public EmailForwardingRule.Builder domainName(String domainName)

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.

Parameters:

domainName - 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. This parameter is required.

Returns:

this

emailMapping

@Stability(Stable)
public EmailForwardingRule.Builder emailMapping(List<? extends EmailMapping> emailMapping)

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

Parameters:

emailMapping - An email mapping similar to what the NPM library `aws-lambda-ses-forwarder` expects. This parameter is required.

Returns:

this

See Also:

EmailMapping

fromPrefix

@Stability(Stable)
public EmailForwardingRule.Builder fromPrefix(String fromPrefix)

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

Parameters:

fromPrefix - A prefix that is used as the sender address of the forwarded mail, e.g. `noreply`. This parameter is required.

Returns:

this

id

@Stability(Stable)
public EmailForwardingRule.Builder id(String id)

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.

Parameters:

id - An id for the rule. This parameter is required.

Returns:

this

ruleSet

@Stability(Stable)
public EmailForwardingRule.Builder ruleSet(software.amazon.awscdk.services.ses.IReceiptRuleSet ruleSet)

The rule set this rule belongs to.

Parameters:

ruleSet - The rule set this rule belongs to. This parameter is required.

Returns:

this

bucket

@Stability(Stable)
public EmailForwardingRule.Builder bucket(software.amazon.awscdk.services.s3.Bucket bucket)

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.

Parameters:

bucket - A bucket to store the email files to. This parameter is required.

Returns:

this

bucketPrefix

@Stability(Stable)
public EmailForwardingRule.Builder bucketPrefix(String bucketPrefix)

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

Default: inbox/

Parameters:

bucketPrefix - A prefix for the email files that are saved to the bucket. This parameter is required.

Returns:

this

enableLambdaLogging

@Stability(Stable)
public EmailForwardingRule.Builder enableLambdaLogging(Boolean enableLambdaLogging)

Enable log messages in Lambda function which forwards emails.

Default: true

Parameters:

enableLambdaLogging - Enable log messages in Lambda function which forwards emails. This parameter is required.

Returns:

this

build

@Stability(Stable)
public EmailForwardingRule build()

Specified by:

build in interface software.amazon.jsii.Builder<EmailForwardingRule>