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(Stable)
public static final class ReceiptRule.Builder
extends Object
implements software.amazon.jsii.Builder<ReceiptRule>
A fluent builder for
ReceiptRule
.-
Method Summary
Modifier and TypeMethodDescriptionactions
(List<? extends IReceiptRuleAction> 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.after
(IReceiptRule after) An existing rule after which the new rule will be placed.build()
static ReceiptRule.Builder
Whether the rule is active.receiptRuleName
(String receiptRuleName) The name for the rule.recipients
(List<String> recipients) The recipient domains and email addresses that the receipt rule applies to.ruleSet
(IReceiptRuleSet ruleSet) The name of the rule set that the receipt rule will be added to.scanEnabled
(Boolean scanEnabled) Whether to scan for spam and viruses.Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).
-
Method Details
-
create
@Stability(Stable) 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
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
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
Whether the rule is active.Default: true
- Parameters:
enabled
- Whether the rule is active. This parameter is required.- Returns:
this
-
receiptRuleName
The name for the rule.Default: - A CloudFormation generated name.
- Parameters:
receiptRuleName
- The name for the rule. This parameter is required.- Returns:
this
-
recipients
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
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
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
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
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<ReceiptRule>
- Returns:
- a newly built instance of
ReceiptRule
.
-