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

Class EmailForwardingRuleProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<EmailForwardingRuleProps>

Enclosing interface:

EmailForwardingRuleProps

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

A builder for EmailForwardingRuleProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EmailForwardingRuleProps.Builder	bucket(software.amazon.awscdk.services.s3.Bucket bucket)	Sets the value of EmailForwardingRuleProps.getBucket()
EmailForwardingRuleProps.Builder	bucketPrefix(String bucketPrefix)	Sets the value of EmailForwardingRuleProps.getBucketPrefix()
EmailForwardingRuleProps	build()	Builds the configured instance.
EmailForwardingRuleProps.Builder	domainName(String domainName)	Sets the value of EmailForwardingRuleProps.getDomainName()
EmailForwardingRuleProps.Builder	emailMapping(List<? extends EmailMapping> emailMapping)	Sets the value of EmailForwardingRuleProps.getEmailMapping()
EmailForwardingRuleProps.Builder	enableLambdaLogging(Boolean enableLambdaLogging)	Sets the value of EmailForwardingRuleProps.getEnableLambdaLogging()
EmailForwardingRuleProps.Builder	fromPrefix(String fromPrefix)	Sets the value of EmailForwardingRuleProps.getFromPrefix()
EmailForwardingRuleProps.Builder	id(String id)	Sets the value of EmailForwardingRuleProps.getId()
EmailForwardingRuleProps.Builder	ruleSet(software.amazon.awscdk.services.ses.IReceiptRuleSet ruleSet)	Sets the value of EmailForwardingRuleProps.getRuleSet()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

domainName

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

Sets the value of EmailForwardingRuleProps.getDomainName()

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 EmailForwardingRuleProps.Builder emailMapping(List<? extends EmailMapping> emailMapping)

Sets the value of EmailForwardingRuleProps.getEmailMapping()

Parameters:

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

Returns:

this

fromPrefix

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

Sets the value of EmailForwardingRuleProps.getFromPrefix()

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 EmailForwardingRuleProps.Builder id(String id)

Sets the value of EmailForwardingRuleProps.getId()

Parameters:

id - An id for the rule. This parameter is required. This will mainly be used to provide a name to the underlying rule but may also be used as a prefix for other resources.

Returns:

this

ruleSet

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

Sets the value of EmailForwardingRuleProps.getRuleSet()

Parameters:

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

Returns:

this

bucket

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

Sets the value of EmailForwardingRuleProps.getBucket()

Parameters:

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.

Returns:

this

bucketPrefix

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

Sets the value of EmailForwardingRuleProps.getBucketPrefix()

Parameters:

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

Returns:

this

enableLambdaLogging

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

Sets the value of EmailForwardingRuleProps.getEnableLambdaLogging()

Parameters:

enableLambdaLogging - Enable log messages in Lambda function which forwards emails.

Returns:

this

build

@Stability(Stable)
public EmailForwardingRuleProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EmailForwardingRuleProps

Throws:

NullPointerException - if any required attribute was not provided