software.amazon.awscdk.services.ses

Class ReceiptRule.Builder

java.lang.Object

software.amazon.awscdk.services.ses.ReceiptRule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ReceiptRule>

Enclosing class:

ReceiptRule

@Stability(value=Experimental)
public static final class ReceiptRule.Builder
extends Object
implements software.amazon.jsii.Builder<ReceiptRule>

(experimental) A fluent builder for ReceiptRule.

Method Summary

Modifier and Type	Method and Description
ReceiptRule.Builder	actions(List<? extends IReceiptRuleAction> actions) (experimental) An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
ReceiptRule.Builder	after(IReceiptRule after) (experimental) An existing rule after which the new rule will be placed.
ReceiptRule	build()
static ReceiptRule.Builder	create(software.constructs.Construct scope, String id)
ReceiptRule.Builder	enabled(Boolean enabled) (experimental) Whether the rule is active.
ReceiptRule.Builder	receiptRuleName(String receiptRuleName) (experimental) The name for the rule.
ReceiptRule.Builder	recipients(List<String> recipients) (experimental) The recipient domains and email addresses that the receipt rule applies to.
ReceiptRule.Builder	ruleSet(IReceiptRuleSet ruleSet) (experimental) The name of the rule set that the receipt rule will be added to.
ReceiptRule.Builder	scanEnabled(Boolean scanEnabled) (experimental) Whether to scan for spam and viruses.
ReceiptRule.Builder	tlsPolicy(TlsPolicy tlsPolicy) (experimental) Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static ReceiptRule.Builder create(software.constructs.Construct scope,
                                                                        String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ReceiptRule.Builder.

actions

@Stability(value=Experimental)
public ReceiptRule.Builder actions(List<? extends IReceiptRuleAction> actions)

(experimental) An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

Default: - No actions.

Parameters:

actions - An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule. This parameter is required.

Returns:

this

after

@Stability(value=Experimental)
public ReceiptRule.Builder after(IReceiptRule after)

(experimental) An existing rule after which the new rule will be placed.

Default: - The new rule is inserted at the beginning of the rule list.

Parameters:

after - An existing rule after which the new rule will be placed. This parameter is required.

Returns:

this

enabled

@Stability(value=Experimental)
public ReceiptRule.Builder enabled(Boolean enabled)

(experimental) Whether the rule is active.

Default: true

Parameters:

enabled - Whether the rule is active. This parameter is required.

Returns:

this

receiptRuleName

@Stability(value=Experimental)
public ReceiptRule.Builder receiptRuleName(String receiptRuleName)

(experimental) The name for the rule.

Default: - A CloudFormation generated name.

Parameters:

receiptRuleName - The name for the rule. This parameter is required.

Returns:

this

recipients

@Stability(value=Experimental)
public ReceiptRule.Builder recipients(List<String> recipients)

(experimental) The recipient domains and email addresses that the receipt rule applies to.

Default: - Match all recipients under all verified domains.

Parameters:

recipients - The recipient domains and email addresses that the receipt rule applies to. This parameter is required.

Returns:

this

scanEnabled

@Stability(value=Experimental)
public ReceiptRule.Builder scanEnabled(Boolean scanEnabled)

(experimental) Whether to scan for spam and viruses.

Default: false

Parameters:

scanEnabled - Whether to scan for spam and viruses. This parameter is required.

Returns:

this

tlsPolicy

@Stability(value=Experimental)
public ReceiptRule.Builder tlsPolicy(TlsPolicy tlsPolicy)

(experimental) Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

Default: - Optional which will not check for TLS.

Parameters:

tlsPolicy - Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). This parameter is required.

Returns:

this

ruleSet

@Stability(value=Experimental)
public ReceiptRule.Builder ruleSet(IReceiptRuleSet ruleSet)

(experimental) The name of the rule set that the receipt rule will be added to.

Parameters:

ruleSet - The name of the rule set that the receipt rule will be added to. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public ReceiptRule build()

Specified by:

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