software.amazon.awscdk.services.ses

Class CfnReceiptRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ses.CfnReceiptRule

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.188Z")
 @Stability(value=Stable)
public class CfnReceiptRule
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SES::ReceiptRule`.

Specifies a receipt rule.

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.*;
 CfnReceiptRule cfnReceiptRule = CfnReceiptRule.Builder.create(this, "MyCfnReceiptRule")
         .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	Class and Description
static interface	CfnReceiptRule.ActionProperty An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own.
static interface	CfnReceiptRule.AddHeaderActionProperty When included in a receipt rule, this action adds a header to the received email.
static interface	CfnReceiptRule.BounceActionProperty When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
static class	CfnReceiptRule.Builder A fluent builder for CfnReceiptRule.
static interface	CfnReceiptRule.LambdaActionProperty When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
static interface	CfnReceiptRule.RuleProperty Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.
static interface	CfnReceiptRule.S3ActionProperty When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
static interface	CfnReceiptRule.SNSActionProperty When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS).
static interface	CfnReceiptRule.StopActionProperty When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
static interface	CfnReceiptRule.WorkmailActionProperty When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnReceiptRule(software.constructs.Construct scope, String id, CfnReceiptRuleProps props) Create a new `AWS::SES::ReceiptRule`.
protected	CfnReceiptRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnReceiptRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAfter() The name of an existing rule after which the new rule is placed.
protected Map<String,Object>	getCfnProperties()
Object	getRule() A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
String	getRuleSetName() The name of the rule set where the receipt rule is added.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAfter(String value) The name of an existing rule after which the new rule is placed.
void	setRule(CfnReceiptRule.RuleProperty value) A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
void	setRule(IResolvable value) A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
void	setRuleSetName(String value) The name of the rule set where the receipt rule is added.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnReceiptRule

protected CfnReceiptRule(software.amazon.jsii.JsiiObjectRef objRef)

CfnReceiptRule

protected CfnReceiptRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnReceiptRule

@Stability(value=Stable)
public CfnReceiptRule(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnReceiptRuleProps props)

Create a new `AWS::SES::ReceiptRule`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getRule

@Stability(value=Stable)
 @NotNull
public Object getRule()

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

setRule

@Stability(value=Stable)
public void setRule(@NotNull
                                             CfnReceiptRule.RuleProperty value)

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

setRule

@Stability(value=Stable)
public void setRule(@NotNull
                                             IResolvable value)

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

getRuleSetName

@Stability(value=Stable)
 @NotNull
public String getRuleSetName()

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

setRuleSetName

@Stability(value=Stable)
public void setRuleSetName(@NotNull
                                                    String value)

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

getAfter

@Stability(value=Stable)
 @Nullable
public 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.

setAfter

@Stability(value=Stable)
public void setAfter(@Nullable
                                              String value)

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.