ReceiptRuleProps Struct
Construction properties for a ReceiptRule.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ses as ses } from 'aws-cdk-lib';
import { aws_ses as interfaces_ses } from 'aws-cdk-lib/interfaces';
declare const receiptRuleAction: ses.IReceiptRuleAction;
declare const receiptRuleRef: interfaces_ses.IReceiptRuleRef;
declare const receiptRuleSetRef: interfaces_ses.IReceiptRuleSetRef;
const receiptRuleProps: ses.ReceiptRuleProps = {
ruleSet: receiptRuleSetRef,
// the properties below are optional
actions: [receiptRuleAction],
after: receiptRuleRef,
enabled: false,
receiptRuleName: 'receiptRuleName',
recipients: ['recipients'],
scanEnabled: false,
tlsPolicy: ses.TlsPolicy.OPTIONAL,
};
Properties
actionsoptionalIReceiptRuleAction[]actionsoptionaltyping.List[IReceiptRuleAction]actionsoptionalList<IReceiptRuleAction>ActionsoptionalIReceiptRuleAction[]Actionsoptional*[]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.
afteroptionalIReceiptRuleRefafteroptionalIReceiptRuleRefafteroptionalIReceiptRuleRefAfteroptionalIReceiptRuleRefAfteroptionalIReceiptRuleRef#An existing rule after which the new rule will be placed.
Default: The new rule is inserted at the beginning of the rule list.
enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*bool= true#Whether the rule is active.
receiptRuleNameoptionalstringreceipt_rule_nameoptionalstrreceiptRuleNameoptionalStringReceiptRuleNameoptionalstringReceiptRuleNameoptional*string#The name for the rule.
Default: A CloudFormation generated name.
recipientsoptionalstring[]recipientsoptionaltyping.List[str]recipientsoptionalList<String>Recipientsoptionalstring[]Recipientsoptional*[]*string#The recipient domains and email addresses that the receipt rule applies to.
Default: Match all recipients under all verified domains.
ruleSetIReceiptRuleSetRefrule_setIReceiptRuleSetRefruleSetIReceiptRuleSetRefRuleSetIReceiptRuleSetRefRuleSetIReceiptRuleSetRefrequired#The name of the rule set that the receipt rule will be added to.
scanEnabledoptionalbooleanscan_enabledoptionalboolscanEnabledoptionalBooleanScanEnabledoptionalboolScanEnabledoptional*bool= false#Whether to scan for spam and viruses.
tlsPolicyoptionalTlsPolicytls_policyoptionalTlsPolicytlsPolicyoptionalTlsPolicyTlsPolicyoptionalTlsPolicyTlsPolicyoptionalTlsPolicy#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.