class ReceiptRuleSet (construct)

Language	Type name
.NET	Amazon.CDK.AWS.SES.ReceiptRuleSet
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsses#ReceiptRuleSet
Java	software.amazon.awscdk.services.ses.ReceiptRuleSet
Python	aws_cdk.aws_ses.ReceiptRuleSet
TypeScript (source)	aws-cdk-lib » aws_ses » ReceiptRuleSet

Implements IConstruct, IDependable, IResource, IReceiptRuleSet

A new receipt rule set.

Example

const ruleSet = new ses.ReceiptRuleSet(this, 'RuleSet');

const awsRule = ruleSet.addRule('Aws', {
  recipients: ['aws.com'],
});

Initializer

new ReceiptRuleSet(scope: Construct, id: string, props?: ReceiptRuleSetProps)

Parameters

• scope Construct
• id string
• props ReceiptRuleSetProps

Construct Props

Name	Type	Description
dropSpam?	boolean	Whether to add a first rule to stop processing messages that have at least one spam indicator.
receiptRuleSetName?	string	The name for the receipt rule set.
rules?	ReceiptRuleOptions[]	The list of rules to add to this rule set.

---

dropSpam?

Type: boolean (optional, default: false)

Whether to add a first rule to stop processing messages that have at least one spam indicator.

---

receiptRuleSetName?

Type: string (optional, default: A CloudFormation generated name.)

The name for the receipt rule set.

---

rules?

Type: ReceiptRuleOptions[] (optional, default: No rules are added to the rule set.)

The list of rules to add to this rule set.

Rules are added in the same order as they appear in the list.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
receiptRuleSetName	string	The receipt rule set name.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

receiptRuleSetName

Type: string

The receipt rule set name.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addRule(id, options?)	Adds a new receipt rule in this rule set.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
protected addDropSpamRule()	Adds a drop spam rule.
static fromReceiptRuleSetName(scope, id, receiptRuleSetName)	Import an exported receipt rule set.

---

addRule(id, options?)

public addRule(id: string, options?: ReceiptRuleOptions): ReceiptRule

Parameters

• id string
• options ReceiptRuleOptions

Returns

• ReceiptRule

Adds a new receipt rule in this rule set.

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

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected addDropSpamRule()

protected addDropSpamRule(): void

Adds a drop spam rule.

---

static fromReceiptRuleSetName(scope, id, receiptRuleSetName)

public static fromReceiptRuleSetName(scope: Construct, id: string, receiptRuleSetName: string): IReceiptRuleSet

Parameters

• scope Construct
• id string
• receiptRuleSetName string

Returns

• IReceiptRuleSet

Import an exported receipt rule set.