AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

ReceiptRule

A new receipt rule.

Import

import { ReceiptRule } from 'aws-cdk-lib/aws-ses';

Or use the module namespace:

import * as ses from 'aws-cdk-lib/aws-ses';
// ses.ReceiptRule

Properties

Configuration passed to the constructor as ReceiptRuleProps.

ruleSetRequired
IReceiptRuleSetRef

The name of the rule set that the receipt rule will be added to.

7 properties inherited from ReceiptRuleOptions
actionsOptionalinherited from ReceiptRuleOptions
IReceiptRuleAction[]

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

Default: - No actions.

afterOptionalinherited from ReceiptRuleOptions
IReceiptRuleRef

An existing rule after which the new rule will be placed.

Default: - The new rule is inserted at the beginning of the rule list.

enabledOptionalinherited from ReceiptRuleOptions
boolean

Whether the rule is active.

Default: true

receiptRuleNameOptionalinherited from ReceiptRuleOptions
string

The name for the rule.

Default: - A CloudFormation generated name.

recipientsOptionalinherited from ReceiptRuleOptions
string[]

The recipient domains and email addresses that the receipt rule applies to.

Default: - Match all recipients under all verified domains.

scanEnabledOptionalinherited from ReceiptRuleOptions
boolean

Whether to scan for spam and viruses.

Default: false

tlsPolicyOptionalinherited from ReceiptRuleOptions
TlsPolicy

Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

Default: - Optional which will not check for TLS.

Get the Amazon SES Cheat Sheet

Everything you need to know about Amazon SES on one page. HD quality, print-friendly.

Download Free Infographic