class DropSpamReceiptRule (construct)

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

Implements IConstruct, IDependable

A rule added at the top of the rule set to drop spam/virus.

Example

// 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 dropSpamReceiptRule = new ses.DropSpamReceiptRule(this, 'MyDropSpamReceiptRule', {
  ruleSet: receiptRuleSetRef,

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

Initializer

new DropSpamReceiptRule(scope: Construct, id: string, props: DropSpamReceiptRuleProps)

Parameters

scope Construct
id string
props DropSpamReceiptRuleProps

Construct Props

Name	Type	Description
ruleSet	`IReceiptRuleSetRef`	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?	`IReceiptRuleRef`	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: IReceiptRuleSetRef

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: IReceiptRuleRef (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).

Properties

Name	Type	Description
node	`Node`	The tree node.
rule	`ReceiptRule`
static PROPERTY_INJECTION_ID	`string`	Uniquely identifies this class.

node

Type: Node

The tree node.

rule

Type: ReceiptRule

static PROPERTY_INJECTION_ID

Type: string

Uniquely identifies this class.

Methods

Name	Description
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

with(...mixins)

public with(...mixins: IMixin[]): IConstruct