public static interface CfnReceiptRule.RuleProperty
Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.
For information about setting up receipt rules, see the Amazon SES Developer Guide .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.ses.*; RuleProperty ruleProperty = RuleProperty.builder() .actions(List.of(ActionProperty.builder() .addHeaderAction(AddHeaderActionProperty.builder() .headerName("headerName") .headerValue("headerValue") .build()) .bounceAction(BounceActionProperty.builder() .message("message") .sender("sender") .smtpReplyCode("smtpReplyCode") // the properties below are optional .statusCode("statusCode") .topicArn("topicArn") .build()) .lambdaAction(LambdaActionProperty.builder() .functionArn("functionArn") // the properties below are optional .invocationType("invocationType") .topicArn("topicArn") .build()) .s3Action(S3ActionProperty.builder() .bucketName("bucketName") // the properties below are optional .kmsKeyArn("kmsKeyArn") .objectKeyPrefix("objectKeyPrefix") .topicArn("topicArn") .build()) .snsAction(SNSActionProperty.builder() .encoding("encoding") .topicArn("topicArn") .build()) .stopAction(StopActionProperty.builder() .scope("scope") // the properties below are optional .topicArn("topicArn") .build()) .workmailAction(WorkmailActionProperty.builder() .organizationArn("organizationArn") // the properties below are optional .topicArn("topicArn") .build()) .build())) .enabled(false) .name("name") .recipients(List.of("recipients")) .scanEnabled(false) .tlsPolicy("tlsPolicy") .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnReceiptRule.RuleProperty.Builder
A builder for
CfnReceiptRule.RuleProperty |
static class |
CfnReceiptRule.RuleProperty.Jsii$Proxy
An implementation for
CfnReceiptRule.RuleProperty |
Modifier and Type | Method and Description |
---|---|
static CfnReceiptRule.RuleProperty.Builder |
builder() |
default java.lang.Object |
getActions()
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 java.lang.Object |
getEnabled()
If `true` , the receipt rule is active.
|
default java.lang.String |
getName()
The name of the receipt rule.
|
default java.util.List<java.lang.String> |
getRecipients()
The recipient domains and email addresses that the receipt rule applies to.
|
default java.lang.Object |
getScanEnabled()
If `true` , then messages that this receipt rule applies to are scanned for spam and viruses.
|
default java.lang.String |
getTlsPolicy()
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).
|
default java.lang.Object getActions()
default java.lang.Object getEnabled()
The default value is false
.
default java.lang.String getName()
default java.util.List<java.lang.String> getRecipients()
If this field is not specified, this rule matches all recipients on all verified domains.
default java.lang.Object getScanEnabled()
The default value is false
.
default java.lang.String getTlsPolicy()
If this parameter is set to Require
, Amazon SES bounces emails that are not received over TLS. The default is Optional
.
Valid Values: Require | Optional
static CfnReceiptRule.RuleProperty.Builder builder()