interface ReceiptRuleProps

Language	Type name
.NET	Amazon.CDK.AWS.SES.ReceiptRuleProps
Java	software.amazon.awscdk.services.ses.ReceiptRuleProps
Python	aws_cdk.aws_ses.ReceiptRuleProps
TypeScript (source)	@aws-cdk/aws-ses » ReceiptRuleProps

Construction properties for a ReceiptRule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ses from '@aws-cdk/aws-ses';

declare const receiptRule: ses.ReceiptRule;
declare const receiptRuleAction: ses.IReceiptRuleAction;
declare const receiptRuleSet: ses.ReceiptRuleSet;
const receiptRuleProps: ses.ReceiptRuleProps = {
  ruleSet: receiptRuleSet,

  // the properties below are optional
  actions: [receiptRuleAction],
  after: receiptRule,
  enabled: false,
  receiptRuleName: 'receiptRuleName',
  recipients: ['recipients'],
  scanEnabled: false,
  tlsPolicy: ses.TlsPolicy.OPTIONAL,
};

Properties

Name	Type	Description
ruleSet	IReceiptRuleSet	The name of the rule set that the receipt rule will be added to.
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?	IReceiptRule	An existing rule after which the new rule will be placed.
enabled?	boolean	Whether the rule is active.
receiptRuleName?	string	The name for the rule.
recipients?	string[]	The recipient domains and email addresses that the receipt rule applies to.
scanEnabled?	boolean	Whether to scan for spam and viruses.
tlsPolicy?	TlsPolicy	Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

---

ruleSet

Type: IReceiptRuleSet

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

---

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).