ReceiptRule L2 construct

A new receipt rule.

CloudFormation: AWS::SES::ReceiptRule
L1 type: CfnReceiptRule
Source: aws-ses/lib/receipt-rule.ts
Type last changed: v2.268.0 · 2 Sep 2026

Example

const ruleSet = new ses.ReceiptRuleSet(this, 'RuleSet');

const awsRule = ruleSet.addRule('Aws', {
  recipients: ['aws.com'],
});

python

rule_set = ses.ReceiptRuleSet(self, "RuleSet")

aws_rule = rule_set.add_rule("Aws",
    recipients=["aws.com"]
)

java

ReceiptRuleSet ruleSet = new ReceiptRuleSet(this, "RuleSet");

ReceiptRule awsRule = ruleSet.addRule("Aws", ReceiptRuleOptions.builder()
        .recipients(List.of("aws.com"))
        .build());

csharp

// Install: dotnet add package Amazon.CDK.Lib
var ruleSet = new ReceiptRuleSet(this, "RuleSet");

var awsRule = ruleSet.AddRule("Aws", new ReceiptRuleOptions {
    Recipients = new [] { "aws.com" }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
ruleSet := ses.NewReceiptRuleSet(this, jsii.String("RuleSet"))

awsRule := ruleSet.addRule(jsii.String("Aws"), &ReceiptRuleOptions{
	Recipients: []*string{
		jsii.String("aws.com"),
	},
})

Initializer

new ReceiptRule(scope: Construct, id: string, props: ReceiptRuleProps)

python

ReceiptRule(scope: Construct, id: str, props: ReceiptRuleProps)

java

new ReceiptRule(Construct scope, String id, ReceiptRuleProps props)

csharp

new ReceiptRule(Construct scope, string id, ReceiptRuleProps props)

NewReceiptRule(Scope Construct, Id *string, Props ReceiptRuleProps)

Construct Props

actionsIReceiptRuleAction[]actionstyping.List[IReceiptRuleAction]actionsList<IReceiptRuleAction>ActionsIReceiptRuleAction[]Actions*[]IReceiptRuleAction= 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.

afterIReceiptRuleRefafterIReceiptRuleRefafterIReceiptRuleRefAfterIReceiptRuleRefAfterIReceiptRuleRef= The new rule is inserted at the …#

An existing rule after which the new rule will be placed.

default

Default: The new rule is inserted at the beginning of the rule list.

enabledbooleanenabledboolenabledBooleanEnabledboolEnabled*bool= true#

Whether the rule is active.

receiptRuleNamestringreceipt_rule_namestrreceiptRuleNameStringReceiptRuleNamestringReceiptRuleName*string= A CloudFormation generated name.#

The name for the rule.

recipientsstring[]recipientstyping.List[str]recipientsList<String>Recipientsstring[]Recipients*[]*string= Match all recipients under all v…#

The recipient domains and email addresses that the receipt rule applies to.

default

Default: Match all recipients under all verified domains.

ruleSetIReceiptRuleSetRefrule_setIReceiptRuleSetRefruleSetIReceiptRuleSetRefRuleSetIReceiptRuleSetRefRuleSetIReceiptRuleSetRefrequired#

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

scanEnabledbooleanscan_enabledboolscanEnabledBooleanScanEnabledboolScanEnabled*bool= false#

Whether to scan for spam and viruses.

tlsPolicyTlsPolicytls_policyTlsPolicytlsPolicyTlsPolicyTlsPolicyTlsPolicyTlsPolicyTlsPolicy= Optional which will not check fo…#

Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

default

Default: Optional which will not check for TLS.

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

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.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

receiptRuleNamestringreceipt_rule_namestrreceiptRuleNameStringReceiptRuleNamestringReceiptRuleName*stringrequired#

The name of the receipt rule.

receiptRuleRefReceiptRuleReferencereceipt_rule_refReceiptRuleReferencereceiptRuleRefReceiptRuleReferenceReceiptRuleRefReceiptRuleReferenceReceiptRuleRefReceiptRuleReferencerequired#

A reference to a ReceiptRule resource.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

Methods

addAction(action: IReceiptRuleAction): voiddef add_action(self, action: IReceiptRuleAction) -> Nonepublic void addAction(IReceiptRuleAction action)public void AddAction(IReceiptRuleAction action)func AddAction(Action IReceiptRuleAction)#

Adds an action to this receipt rule.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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

fromReceiptRuleAttributes(scope: Construct, id: string, attrs: ReceiptRuleAttributes): IReceiptRule@staticmethod def from_receipt_rule_attributes(scope: Construct, id: str, attrs: ReceiptRuleAttributes) -> IReceiptRulepublic static IReceiptRule fromReceiptRuleAttributes(Construct scope, String id, ReceiptRuleAttributes attrs)public static IReceiptRule FromReceiptRuleAttributes(Construct scope, string id, ReceiptRuleAttributes attrs)func FromReceiptRuleAttributes(Scope Construct, Id *string, Attrs ReceiptRuleAttributes) IReceiptRulestatic#

Import an existing receipt rule from its attributes.

fromReceiptRuleName(scope: Construct, id: string, receiptRuleName: string): IReceiptRule@staticmethod def from_receipt_rule_name(scope: Construct, id: str, receipt_rule_name: str) -> IReceiptRulepublic static IReceiptRule fromReceiptRuleName(Construct scope, String id, String receiptRuleName)public static IReceiptRule FromReceiptRuleName(Construct scope, string id, string receiptRuleName)func FromReceiptRuleName(Scope Construct, Id *string, ReceiptRuleName *string) IReceiptRulestatic#

Import an existing receipt rule by its name.

A name alone does not identify the rule set the rule belongs to, so ruleSetName is not available on the returned reference. Use fromReceiptRuleAttributes() if you need it.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

ReceiptRule L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

ReceiptRule L2 construct

Example

Initializer

Construct Props

Properties

Methods