aws-cdk-lib.aws_ses.ReceiptRuleOptions

interface ReceiptRuleOptions

LanguageType name
.NETAmazon.CDK.AWS.SES.ReceiptRuleOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsses#ReceiptRuleOptions
Javasoftware.amazon.awscdk.services.ses.ReceiptRuleOptions
Pythonaws_cdk.aws_ses.ReceiptRuleOptions
TypeScript (source)aws-cdk-lib » aws_ses » ReceiptRuleOptions

Options to add a receipt rule to a receipt rule set.

Example

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

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

Properties

NameTypeDescription
actions?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.
after?IReceiptRuleAn existing rule after which the new rule will be placed.
enabled?booleanWhether the rule is active.
receiptRuleName?stringThe name for the rule.
recipients?string[]The recipient domains and email addresses that the receipt rule applies to.
scanEnabled?booleanWhether to scan for spam and viruses.
tlsPolicy?TlsPolicyWhether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

actions?

Type: IReceiptRuleAction[] (optional, default: No actions.)

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.


after?

Type: IReceiptRule (optional, default: The new rule is inserted at the beginning of the rule list.)

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


enabled?

Type: boolean (optional, default: true)

Whether the rule is active.


receiptRuleName?

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

The name for the rule.


recipients?

Type: string[] (optional, default: Match all recipients under all verified domains.)

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


scanEnabled?

Type: boolean (optional, default: false)

Whether to scan for spam and viruses.


tlsPolicy?

Type: TlsPolicy (optional, default: Optional which will not check for TLS.)

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