class ReceiptFilter (construct)

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

Implements IConstruct, IDependable, IResource, IEnvironmentAware

A receipt filter.

When instantiated without props, it creates a block all receipt filter.

Example

new ses.ReceiptFilter(this, 'Filter', {
  ip: '1.2.3.4/16', // Will be blocked
});

Initializer

new ReceiptFilter(scope: Construct, id: string, props?: ReceiptFilterProps)

Parameters

• scope Construct
• id string
• props ReceiptFilterProps

Construct Props

Name	Type	Description
ip?	string	The ip address or range to filter.
policy?	ReceiptFilterPolicy	The policy for the filter.
receiptFilterName?	string	The name for the receipt filter.

---

ip?

Type: string (optional, default: 0.0.0.0/0)

The ip address or range to filter.

---

policy?

Type: ReceiptFilterPolicy (optional, default: Block)

The policy for the filter.

---

receiptFilterName?

Type: string (optional, default: a CloudFormation generated name)

The name for the receipt filter.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

static PROPERTY_INJECTION_ID

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.