software.amazon.awscdk.services.ses

Class ReceiptRuleSet

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ses.ReceiptRuleSet

All Implemented Interfaces:

IResource, IReceiptRuleSet, 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.220Z")
 @Stability(value=Stable)
public class ReceiptRuleSet
extends Resource
implements IReceiptRuleSet

A new receipt rule set.

Example:

 ReceiptRuleSet ruleSet = new ReceiptRuleSet(this, "RuleSet");
 ReceiptRule awsRule = ruleSet.addRule("Aws", ReceiptRuleOptions.builder()
         .recipients(List.of("aws.com"))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReceiptRuleSet.Builder A fluent builder for ReceiptRuleSet.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ses.IReceiptRuleSet

IReceiptRuleSet.Jsii$Default, IReceiptRuleSet.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	ReceiptRuleSet(software.constructs.Construct scope, String id)
	ReceiptRuleSet(software.constructs.Construct scope, String id, ReceiptRuleSetProps props)
protected	ReceiptRuleSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ReceiptRuleSet(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected void	addDropSpamRule() Adds a drop spam rule.
ReceiptRule	addRule(String id) Adds a new receipt rule in this rule set.
ReceiptRule	addRule(String id, ReceiptRuleOptions options) Adds a new receipt rule in this rule set.
static IReceiptRuleSet	fromReceiptRuleSetName(software.constructs.Construct scope, String id, String receiptRuleSetName) Import an exported receipt rule set.
String	getReceiptRuleSetName() The receipt rule set name.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ReceiptRuleSet

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

ReceiptRuleSet

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

ReceiptRuleSet

@Stability(value=Stable)
public ReceiptRuleSet(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @Nullable
                                               ReceiptRuleSetProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

ReceiptRuleSet

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromReceiptRuleSetName

@Stability(value=Stable)
 @NotNull
public static IReceiptRuleSet fromReceiptRuleSetName(@NotNull
                                                                                        software.constructs.Construct scope,
                                                                                        @NotNull
                                                                                        String id,
                                                                                        @NotNull
                                                                                        String receiptRuleSetName)

Import an exported receipt rule set.

Parameters:

scope - This parameter is required.

id - This parameter is required.

receiptRuleSetName - This parameter is required.

addDropSpamRule

@Stability(value=Stable)
protected void addDropSpamRule()

Adds a drop spam rule.

addRule

@Stability(value=Stable)
 @NotNull
public ReceiptRule addRule(@NotNull
                                                              String id,
                                                              @Nullable
                                                              ReceiptRuleOptions options)

Adds a new receipt rule in this rule set.

The new rule is added after the last added rule unless after is specified.

Specified by:

addRule in interface IReceiptRuleSet

Parameters:

id - This parameter is required.

options -

addRule

@Stability(value=Stable)
 @NotNull
public ReceiptRule addRule(@NotNull
                                                              String id)

Adds a new receipt rule in this rule set.

The new rule is added after the last added rule unless after is specified.

Specified by:

addRule in interface IReceiptRuleSet

Parameters:

id - This parameter is required.

getReceiptRuleSetName

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

The receipt rule set name.

Specified by:

getReceiptRuleSetName in interface IReceiptRuleSet