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

Class EmailForwardingRuleSet.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<EmailForwardingRuleSet>

Enclosing class:

EmailForwardingRuleSet

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

A fluent builder for EmailForwardingRuleSet.

Method Summary

Modifier and Type	Method	Description
EmailForwardingRuleSet	build()
static EmailForwardingRuleSet.Builder	create(software.constructs.Construct parent, String name)
EmailForwardingRuleSet.Builder	emailForwardingProps(List<? extends EmailForwardingProps> emailForwardingProps)	A list of mapping options to define how emails should be forwarded.
EmailForwardingRuleSet.Builder	enableRuleSet(Boolean enableRuleSet)	Optional: whether to enable the rule set or not.
EmailForwardingRuleSet.Builder	ruleSet(software.amazon.awscdk.services.ses.IReceiptRuleSet ruleSet)	Optional: an existing SES receipt rule set.
EmailForwardingRuleSet.Builder	ruleSetName(String ruleSetName)	Optional: provide a name for the receipt rule set that this construct creates if you don't provide one.

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 EmailForwardingRuleSet.Builder create(software.constructs.Construct parent,
                                                    String name)

Parameters:

parent - This parameter is required.

name - This parameter is required.

Returns:

a new instance of EmailForwardingRuleSet.Builder.

emailForwardingProps

@Stability(Stable)
public EmailForwardingRuleSet.Builder emailForwardingProps(List<? extends EmailForwardingProps> emailForwardingProps)

A list of mapping options to define how emails should be forwarded.

Parameters:

emailForwardingProps - A list of mapping options to define how emails should be forwarded. This parameter is required.

Returns:

this

enableRuleSet

@Stability(Stable)
public EmailForwardingRuleSet.Builder enableRuleSet(Boolean enableRuleSet)

Optional: whether to enable the rule set or not.

Default: true

Parameters:

enableRuleSet - Optional: whether to enable the rule set or not. This parameter is required.

Returns:

this

ruleSet

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

Optional: an existing SES receipt rule set.

If none is provided, a new one will be created using the name provided with ruleSetName or a default one.

Parameters:

ruleSet - Optional: an existing SES receipt rule set. This parameter is required.

Returns:

this

ruleSetName

@Stability(Stable)
public EmailForwardingRuleSet.Builder ruleSetName(String ruleSetName)

Optional: provide a name for the receipt rule set that this construct creates if you don't provide one.

Default: custom-rule-set

Parameters:

ruleSetName - Optional: provide a name for the receipt rule set that this construct creates if you don't provide one. This parameter is required.

Returns:

this

build

@Stability(Stable)
public EmailForwardingRuleSet build()

Specified by:

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