software.amazon.awscdk.services.ses

Interface CfnReceiptRuleProps

All Known Implementing Classes:

CfnReceiptRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:55.085Z")
public interface CfnReceiptRuleProps

Properties for defining a `CfnReceiptRule`.

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.*;
 CfnReceiptRuleProps cfnReceiptRuleProps = CfnReceiptRuleProps.builder()
         .rule(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())
         .ruleSetName("ruleSetName")
         // the properties below are optional
         .after("after")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnReceiptRuleProps.Builder A builder for CfnReceiptRuleProps
static class	CfnReceiptRuleProps.Jsii$Proxy An implementation for CfnReceiptRuleProps

Method Summary

Modifier and Type	Method and Description
static CfnReceiptRuleProps.Builder	builder()
default java.lang.String	getAfter() The name of an existing rule after which the new rule is placed.
java.lang.Object	getRule() A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
java.lang.String	getRuleSetName() The name of the rule set where the receipt rule is added.

Method Detail

getRule

java.lang.Object getRule()

A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

getRuleSetName

java.lang.String getRuleSetName()

The name of the rule set where the receipt rule is added.

getAfter

default java.lang.String getAfter()

The name of an existing rule after which the new rule is placed.

If this parameter is null, the new rule is inserted at the beginning of the rule list.

builder

static CfnReceiptRuleProps.Builder builder()

Returns:

a CfnReceiptRuleProps.Builder of CfnReceiptRuleProps