Package software.amazon.awscdk.services.ses

Class ReceiptRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ses.ReceiptRule

All Implemented Interfaces:

IResource, IReceiptRule, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:24.986Z")
@Stability(Stable)
public class ReceiptRule
extends Resource
implements IReceiptRule

A new receipt rule.

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	Description
static final class	ReceiptRule.Builder	A fluent builder for ReceiptRule.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IReceiptRule.Jsii$Default, IReceiptRule.Jsii$Proxy

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

IResource.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addAction(IReceiptRuleAction action)	Adds an action to this receipt rule.
static IReceiptRule	fromReceiptRuleName(software.constructs.Construct scope, String id, String receiptRuleName)
String	getReceiptRuleName()	The name of the receipt rule.

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ReceiptRule

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

ReceiptRule

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

ReceiptRule

@Stability(Stable)
public ReceiptRule(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ReceiptRuleProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromReceiptRuleName

@Stability(Stable)
@NotNull
public static IReceiptRule fromReceiptRuleName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String receiptRuleName)

Parameters:

scope - This parameter is required.

id - This parameter is required.

receiptRuleName - This parameter is required.

addAction

@Stability(Stable)
public void addAction(@NotNull
 IReceiptRuleAction action)

Adds an action to this receipt rule.

Parameters:

action - This parameter is required.

getReceiptRuleName

@Stability(Stable)
@NotNull
public String getReceiptRuleName()

The name of the receipt rule.

Specified by:

getReceiptRuleName in interface IReceiptRule