See: Description
Interface | Description |
---|---|
AddHeaderActionConfig |
AddHeaderAction configuration.
|
AllowListReceiptFilterProps |
Construction properties for am AllowListReceiptFilter.
|
BounceActionConfig |
BoundAction configuration.
|
CfnConfigurationSet.DeliveryOptionsProperty |
Example:
|
CfnConfigurationSet.ReputationOptionsProperty |
Example:
|
CfnConfigurationSet.SendingOptionsProperty |
Example:
|
CfnConfigurationSet.SuppressionOptionsProperty |
Example:
|
CfnConfigurationSet.TrackingOptionsProperty |
Example:
|
CfnConfigurationSetEventDestination.CloudWatchDestinationProperty |
Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.
|
CfnConfigurationSetEventDestination.DimensionConfigurationProperty |
Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.
|
CfnConfigurationSetEventDestination.EventDestinationProperty |
Contains information about an event destination.
|
CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty |
Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
|
CfnConfigurationSetEventDestination.SnsDestinationProperty |
Example:
|
CfnConfigurationSetEventDestinationProps |
Properties for defining a `CfnConfigurationSetEventDestination`.
|
CfnConfigurationSetProps |
Properties for defining a `CfnConfigurationSet`.
|
CfnContactList.TopicProperty |
An interest group, theme, or label within a list.
|
CfnContactListProps |
Properties for defining a `CfnContactList`.
|
CfnReceiptFilter.FilterProperty |
Specifies an IP address filter.
|
CfnReceiptFilter.IpFilterProperty |
A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
|
CfnReceiptFilterProps |
Properties for defining a `CfnReceiptFilter`.
|
CfnReceiptRule.ActionProperty |
An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own.
|
CfnReceiptRule.AddHeaderActionProperty |
When included in a receipt rule, this action adds a header to the received email.
|
CfnReceiptRule.BounceActionProperty |
When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
CfnReceiptRule.LambdaActionProperty |
When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
CfnReceiptRule.RuleProperty |
Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.
|
CfnReceiptRule.S3ActionProperty |
When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
CfnReceiptRule.SNSActionProperty |
When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
CfnReceiptRule.StopActionProperty |
When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
CfnReceiptRule.WorkmailActionProperty |
When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
CfnReceiptRuleProps |
Properties for defining a `CfnReceiptRule`.
|
CfnReceiptRuleSetProps |
Properties for defining a `CfnReceiptRuleSet`.
|
CfnTemplate.TemplateProperty |
The content of the email, composed of a subject line and either an HTML part or a text-only part.
|
CfnTemplateProps |
Properties for defining a `CfnTemplate`.
|
DropSpamReceiptRuleProps |
Example:
|
IReceiptRule |
A receipt rule.
|
IReceiptRule.Jsii$Default |
Internal default implementation for
IReceiptRule . |
IReceiptRuleAction |
An abstract action for a receipt rule.
|
IReceiptRuleAction.Jsii$Default |
Internal default implementation for
IReceiptRuleAction . |
IReceiptRuleSet |
A receipt rule set.
|
IReceiptRuleSet.Jsii$Default |
Internal default implementation for
IReceiptRuleSet . |
LambdaActionConfig |
LambdaAction configuration.
|
ReceiptFilterProps |
Construction properties for a ReceiptFilter.
|
ReceiptRuleActionConfig |
Properties for a receipt rule action.
|
ReceiptRuleOptions |
Options to add a receipt rule to a receipt rule set.
|
ReceiptRuleProps |
Construction properties for a ReceiptRule.
|
ReceiptRuleSetProps |
Construction properties for a ReceiptRuleSet.
|
S3ActionConfig |
S3Action configuration.
|
SNSActionConfig |
SNSAction configuration.
|
StopActionConfig |
StopAction configuration.
|
WhiteListReceiptFilterProps | Deprecated
use `AllowListReceiptFilterProps`
|
WorkmailActionConfig |
WorkmailAction configuration.
|
Enum | Description |
---|---|
ReceiptFilterPolicy |
The policy for the receipt filter.
|
TlsPolicy |
The type of TLS policy for a receipt rule.
|
---
This module is part of the AWS Cloud Development Kit project.
Create a receipt rule set with rules and actions (actions can be found in the
@aws-cdk/aws-ses-actions
package):
import software.amazon.awscdk.services.s3.*; import software.amazon.awscdk.services.ses.actions.*; Bucket bucket = new Bucket(this, "Bucket"); Topic topic = new Topic(this, "Topic"); ReceiptRuleSet.Builder.create(this, "RuleSet") .rules(List.of(ReceiptRuleOptions.builder() .recipients(List.of("hello@aws.com")) .actions(List.of( AddHeader.Builder.create() .name("X-Special-Header") .value("aws") .build(), S3.Builder.create() .bucket(bucket) .objectKeyPrefix("emails/") .topic(topic) .build())) .build(), ReceiptRuleOptions.builder() .recipients(List.of("aws.com")) .actions(List.of( Sns.Builder.create() .topic(topic) .build())) .build())) .build();
Alternatively, rules can be added to a rule set:
ReceiptRuleSet ruleSet = new ReceiptRuleSet(this, "RuleSet"); ReceiptRule awsRule = ruleSet.addRule("Aws", ReceiptRuleOptions.builder() .recipients(List.of("aws.com")) .build());
And actions to rules:
import software.amazon.awscdk.services.ses.actions.*; ReceiptRule awsRule; Topic topic; awsRule.addAction(Sns.Builder.create() .topic(topic) .build());
When using addRule
, the new rule is added after the last added rule unless after
is specified.
A rule to drop spam can be added by setting dropSpam
to true
:
ReceiptRuleSet.Builder.create(this, "RuleSet") .dropSpam(true) .build();
This will add a rule at the top of the rule set with a Lambda action that stops processing messages that have at least one spam indicator. See Lambda Function Examples.
Create a receipt filter:
ReceiptFilter.Builder.create(this, "Filter") .ip("1.2.3.4/16") .build();
An allow list filter is also available:
AllowListReceiptFilter.Builder.create(this, "AllowList") .ips(List.of("10.0.0.0/16", "1.2.3.4/16")) .build();
This will first create a block all filter and then create allow filters for the listed ip addresses.