aws-cdk-lib.aws_ses.IReceiptRuleSet

interface IReceiptRuleSet

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

Implemented by ReceiptRuleSet

Obtainable from ReceiptRuleSet.fromReceiptRuleSetName()

A receipt rule set.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
receiptRuleSetNamestringThe receipt rule set name.
stackStackThe stack in which this resource is defined.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node

Type: Node

The tree node.


receiptRuleSetName

Type: string

The receipt rule set name.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
addRule(id, options?)Adds a new receipt rule in this rule set.
applyRemovalPolicy(policy)Apply the given removal policy to this resource.

addRule(id, options?)

public addRule(id: string, options?: ReceiptRuleOptions): ReceiptRule

Parameters

  • id string
  • options ReceiptRuleOptions

Returns

  • ReceiptRule

Adds a new receipt rule in this rule set.

The new rule is added after the last added rule unless after is specified.


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