We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 24, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 24, 2026 by Pulumi
Resource Type definition for AWS::SES::ReceiptRule
Example Usage
Example
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var ruleSetName = config.Require("ruleSetName");
var receiptRuleName1 = config.Require("receiptRuleName1");
var receiptRuleName2 = config.Require("receiptRuleName2");
var tlsPolicy = config.Require("tlsPolicy");
var headerName = config.Require("headerName");
var headerValue = config.Require("headerValue");
var receiptRule1 = new AwsNative.Ses.ReceiptRule("receiptRule1", new()
{
RuleSetName = ruleSetName,
Rule = new AwsNative.Ses.Inputs.ReceiptRuleRuleArgs
{
Name = receiptRuleName1,
Enabled = true,
ScanEnabled = true,
TlsPolicy = tlsPolicy,
Actions = new[]
{
new AwsNative.Ses.Inputs.ReceiptRuleActionArgs
{
AddHeaderAction = new AwsNative.Ses.Inputs.ReceiptRuleAddHeaderActionArgs
{
HeaderName = headerName,
HeaderValue = headerValue,
},
},
},
},
});
var receiptRule2 = new AwsNative.Ses.ReceiptRule("receiptRule2", new()
{
RuleSetName = ruleSetName,
After = receiptRule1.Id,
Rule = new AwsNative.Ses.Inputs.ReceiptRuleRuleArgs
{
Name = receiptRuleName2,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ses"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
ruleSetName := cfg.Require("ruleSetName")
receiptRuleName1 := cfg.Require("receiptRuleName1")
receiptRuleName2 := cfg.Require("receiptRuleName2")
tlsPolicy := cfg.Require("tlsPolicy")
headerName := cfg.Require("headerName")
headerValue := cfg.Require("headerValue")
receiptRule1, err := ses.NewReceiptRule(ctx, "receiptRule1", &ses.ReceiptRuleArgs{
RuleSetName: pulumi.String(ruleSetName),
Rule: &ses.ReceiptRuleRuleArgs{
Name: pulumi.String(receiptRuleName1),
Enabled: pulumi.Bool(true),
ScanEnabled: pulumi.Bool(true),
TlsPolicy: pulumi.String(tlsPolicy),
Actions: ses.ReceiptRuleActionArray{
&ses.ReceiptRuleActionArgs{
AddHeaderAction: &ses.ReceiptRuleAddHeaderActionArgs{
HeaderName: pulumi.String(headerName),
HeaderValue: pulumi.String(headerValue),
},
},
},
},
})
if err != nil {
return err
}
_, err = ses.NewReceiptRule(ctx, "receiptRule2", &ses.ReceiptRuleArgs{
RuleSetName: pulumi.String(ruleSetName),
After: receiptRule1.ID().ToIDOutput().ToStringOutput(),
Rule: &ses.ReceiptRuleRuleArgs{
Name: pulumi.String(receiptRuleName2),
},
})
if err != nil {
return err
}
return nil
})
}
Example coming soon!
Example coming soon!
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";
const config = new pulumi.Config();
const ruleSetName = config.require("ruleSetName");
const receiptRuleName1 = config.require("receiptRuleName1");
const receiptRuleName2 = config.require("receiptRuleName2");
const tlsPolicy = config.require("tlsPolicy");
const headerName = config.require("headerName");
const headerValue = config.require("headerValue");
const receiptRule1 = new aws_native.ses.ReceiptRule("receiptRule1", {
ruleSetName: ruleSetName,
rule: {
name: receiptRuleName1,
enabled: true,
scanEnabled: true,
tlsPolicy: tlsPolicy,
actions: [{
addHeaderAction: {
headerName: headerName,
headerValue: headerValue,
},
}],
},
});
const receiptRule2 = new aws_native.ses.ReceiptRule("receiptRule2", {
ruleSetName: ruleSetName,
after: receiptRule1.id,
rule: {
name: receiptRuleName2,
},
});
import pulumi
import pulumi_aws_native as aws_native
config = pulumi.Config()
rule_set_name = config.require("ruleSetName")
receipt_rule_name1 = config.require("receiptRuleName1")
receipt_rule_name2 = config.require("receiptRuleName2")
tls_policy = config.require("tlsPolicy")
header_name = config.require("headerName")
header_value = config.require("headerValue")
receipt_rule1 = aws_native.ses.ReceiptRule("receiptRule1",
rule_set_name=rule_set_name,
rule={
"name": receipt_rule_name1,
"enabled": True,
"scan_enabled": True,
"tls_policy": tls_policy,
"actions": [{
"add_header_action": {
"header_name": header_name,
"header_value": header_value,
},
}],
})
receipt_rule2 = aws_native.ses.ReceiptRule("receiptRule2",
rule_set_name=rule_set_name,
after=receipt_rule1.id,
rule={
"name": receipt_rule_name2,
})
Example coming soon!
Example
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var ruleSetName = config.Require("ruleSetName");
var receiptRuleName1 = config.Require("receiptRuleName1");
var receiptRuleName2 = config.Require("receiptRuleName2");
var tlsPolicy = config.Require("tlsPolicy");
var headerName = config.Require("headerName");
var headerValue = config.Require("headerValue");
var receiptRule1 = new AwsNative.Ses.ReceiptRule("receiptRule1", new()
{
RuleSetName = ruleSetName,
Rule = new AwsNative.Ses.Inputs.ReceiptRuleRuleArgs
{
Name = receiptRuleName1,
Enabled = true,
ScanEnabled = true,
TlsPolicy = tlsPolicy,
Actions = new[]
{
new AwsNative.Ses.Inputs.ReceiptRuleActionArgs
{
AddHeaderAction = new AwsNative.Ses.Inputs.ReceiptRuleAddHeaderActionArgs
{
HeaderName = headerName,
HeaderValue = headerValue,
},
},
},
},
});
var receiptRule2 = new AwsNative.Ses.ReceiptRule("receiptRule2", new()
{
RuleSetName = ruleSetName,
After = receiptRule1.Id,
Rule = new AwsNative.Ses.Inputs.ReceiptRuleRuleArgs
{
Name = receiptRuleName2,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ses"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
ruleSetName := cfg.Require("ruleSetName")
receiptRuleName1 := cfg.Require("receiptRuleName1")
receiptRuleName2 := cfg.Require("receiptRuleName2")
tlsPolicy := cfg.Require("tlsPolicy")
headerName := cfg.Require("headerName")
headerValue := cfg.Require("headerValue")
receiptRule1, err := ses.NewReceiptRule(ctx, "receiptRule1", &ses.ReceiptRuleArgs{
RuleSetName: pulumi.String(ruleSetName),
Rule: &ses.ReceiptRuleRuleArgs{
Name: pulumi.String(receiptRuleName1),
Enabled: pulumi.Bool(true),
ScanEnabled: pulumi.Bool(true),
TlsPolicy: pulumi.String(tlsPolicy),
Actions: ses.ReceiptRuleActionArray{
&ses.ReceiptRuleActionArgs{
AddHeaderAction: &ses.ReceiptRuleAddHeaderActionArgs{
HeaderName: pulumi.String(headerName),
HeaderValue: pulumi.String(headerValue),
},
},
},
},
})
if err != nil {
return err
}
_, err = ses.NewReceiptRule(ctx, "receiptRule2", &ses.ReceiptRuleArgs{
RuleSetName: pulumi.String(ruleSetName),
After: receiptRule1.ID().ToIDOutput().ToStringOutput(),
Rule: &ses.ReceiptRuleRuleArgs{
Name: pulumi.String(receiptRuleName2),
},
})
if err != nil {
return err
}
return nil
})
}
Example coming soon!
Example coming soon!
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";
const config = new pulumi.Config();
const ruleSetName = config.require("ruleSetName");
const receiptRuleName1 = config.require("receiptRuleName1");
const receiptRuleName2 = config.require("receiptRuleName2");
const tlsPolicy = config.require("tlsPolicy");
const headerName = config.require("headerName");
const headerValue = config.require("headerValue");
const receiptRule1 = new aws_native.ses.ReceiptRule("receiptRule1", {
ruleSetName: ruleSetName,
rule: {
name: receiptRuleName1,
enabled: true,
scanEnabled: true,
tlsPolicy: tlsPolicy,
actions: [{
addHeaderAction: {
headerName: headerName,
headerValue: headerValue,
},
}],
},
});
const receiptRule2 = new aws_native.ses.ReceiptRule("receiptRule2", {
ruleSetName: ruleSetName,
after: receiptRule1.id,
rule: {
name: receiptRuleName2,
},
});
import pulumi
import pulumi_aws_native as aws_native
config = pulumi.Config()
rule_set_name = config.require("ruleSetName")
receipt_rule_name1 = config.require("receiptRuleName1")
receipt_rule_name2 = config.require("receiptRuleName2")
tls_policy = config.require("tlsPolicy")
header_name = config.require("headerName")
header_value = config.require("headerValue")
receipt_rule1 = aws_native.ses.ReceiptRule("receiptRule1",
rule_set_name=rule_set_name,
rule={
"name": receipt_rule_name1,
"enabled": True,
"scan_enabled": True,
"tls_policy": tls_policy,
"actions": [{
"add_header_action": {
"header_name": header_name,
"header_value": header_value,
},
}],
})
receipt_rule2 = aws_native.ses.ReceiptRule("receiptRule2",
rule_set_name=rule_set_name,
after=receipt_rule1.id,
rule={
"name": receipt_rule_name2,
})
Example coming soon!
Create ReceiptRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ReceiptRule(name: string, args: ReceiptRuleArgs, opts?: CustomResourceOptions);@overload
def ReceiptRule(resource_name: str,
args: ReceiptRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ReceiptRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
rule: Optional[ReceiptRuleRuleArgs] = None,
rule_set_name: Optional[str] = None,
after: Optional[str] = None)func NewReceiptRule(ctx *Context, name string, args ReceiptRuleArgs, opts ...ResourceOption) (*ReceiptRule, error)public ReceiptRule(string name, ReceiptRuleArgs args, CustomResourceOptions? opts = null)
public ReceiptRule(String name, ReceiptRuleArgs args)
public ReceiptRule(String name, ReceiptRuleArgs args, CustomResourceOptions options)
type: aws-native:ses:ReceiptRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_ses_receipt_rule" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ReceiptRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ReceiptRuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ReceiptRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ReceiptRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ReceiptRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ReceiptRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ReceiptRule resource accepts the following input properties:
- Rule
Pulumi.
Aws Native. Ses. Inputs. Receipt Rule Rule - A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
- Rule
Set stringName - The name of the rule set where the receipt rule is added.
- After string
- The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
- Rule
Receipt
Rule Rule Args - A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
- Rule
Set stringName - The name of the rule set where the receipt rule is added.
- After string
- The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
- rule object
- A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
- rule_
set_ stringname - The name of the rule set where the receipt rule is added.
- after string
- The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
- rule
Receipt
Rule Rule - A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
- rule
Set StringName - The name of the rule set where the receipt rule is added.
- after String
- The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
- rule
Receipt
Rule Rule - A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
- rule
Set stringName - The name of the rule set where the receipt rule is added.
- after string
- The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
- rule
Receipt
Rule Rule Args - A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
- rule_
set_ strname - The name of the rule set where the receipt rule is added.
- after str
- The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
- rule Property Map
- A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
- rule
Set StringName - The name of the rule set where the receipt rule is added.
- after String
- The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
Outputs
All input properties are implicitly available as output properties. Additionally, the ReceiptRule resource produces the following output properties:
Supporting Types
ReceiptRuleAction, ReceiptRuleActionArgs
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. An instance of this data type can represent only one action.- Add
Header Pulumi.Action Aws Native. Ses. Inputs. Receipt Rule Add Header Action - Adds a header to the received email.
- Bounce
Action Pulumi.Aws Native. Ses. Inputs. Receipt Rule Bounce 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).
- Connect
Action Pulumi.Aws Native. Ses. Inputs. Receipt Rule Connect Action - The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
- Lambda
Action Pulumi.Aws Native. Ses. Inputs. Receipt Rule Lambda Action - Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
- S3Action
Pulumi.
Aws Native. Ses. Inputs. Receipt Rule S3Action - Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
- Sns
Action Pulumi.Aws Native. Ses. Inputs. Receipt Rule Sns Action - Publishes the email content within a notification to Amazon SNS.
- Stop
Action Pulumi.Aws Native. Ses. Inputs. Receipt Rule Stop Action - Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
- Workmail
Action Pulumi.Aws Native. Ses. Inputs. Receipt Rule Workmail Action - Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
- Add
Header ReceiptAction Rule Add Header Action - Adds a header to the received email.
- Bounce
Action ReceiptRule Bounce 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).
- Connect
Action ReceiptRule Connect Action - The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
- Lambda
Action ReceiptRule Lambda Action - Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
- S3Action
Receipt
Rule S3Action - Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
- Sns
Action ReceiptRule Sns Action - Publishes the email content within a notification to Amazon SNS.
- Stop
Action ReceiptRule Stop Action - Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
- Workmail
Action ReceiptRule Workmail Action - Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
- add_
header_ objectaction - Adds a header to the received email.
- bounce_
action object - Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
- connect_
action object - The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
- lambda_
action object - Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
- s3_
action object - Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
- sns_
action object - Publishes the email content within a notification to Amazon SNS.
- stop_
action object - Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
- workmail_
action object - Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
- add
Header ReceiptAction Rule Add Header Action - Adds a header to the received email.
- bounce
Action ReceiptRule Bounce 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).
- connect
Action ReceiptRule Connect Action - The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
- lambda
Action ReceiptRule Lambda Action - Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
- s3Action
Receipt
Rule S3Action - Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
- sns
Action ReceiptRule Sns Action - Publishes the email content within a notification to Amazon SNS.
- stop
Action ReceiptRule Stop Action - Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
- workmail
Action ReceiptRule Workmail Action - Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
- add
Header ReceiptAction Rule Add Header Action - Adds a header to the received email.
- bounce
Action ReceiptRule Bounce 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).
- connect
Action ReceiptRule Connect Action - The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
- lambda
Action ReceiptRule Lambda Action - Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
- s3Action
Receipt
Rule S3Action - Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
- sns
Action ReceiptRule Sns Action - Publishes the email content within a notification to Amazon SNS.
- stop
Action ReceiptRule Stop Action - Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
- workmail
Action ReceiptRule Workmail Action - Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
- add_
header_ Receiptaction Rule Add Header Action - Adds a header to the received email.
- bounce_
action ReceiptRule Bounce 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).
- connect_
action ReceiptRule Connect Action - The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
- lambda_
action ReceiptRule Lambda Action - Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
- s3_
action ReceiptRule S3Action - Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
- sns_
action ReceiptRule Sns Action - Publishes the email content within a notification to Amazon SNS.
- stop_
action ReceiptRule Stop Action - Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
- workmail_
action ReceiptRule Workmail Action - Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
- add
Header Property MapAction - Adds a header to the received email.
- bounce
Action Property Map - Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
- connect
Action Property Map - The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
- lambda
Action Property Map - Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
- s3Action Property Map
- Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
- sns
Action Property Map - Publishes the email content within a notification to Amazon SNS.
- stop
Action Property Map - Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
- workmail
Action Property Map - Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
ReceiptRuleAddHeaderAction, ReceiptRuleAddHeaderActionArgs
When included in a receipt rule, this action adds a header to the received email.- Header
Name string - The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a-z, A-Z, 0-9) characters and dashes.
- Header
Value string - The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\n) or carriage return (\r) characters.
- Header
Name string - The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a-z, A-Z, 0-9) characters and dashes.
- Header
Value string - The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\n) or carriage return (\r) characters.
- header_
name string - The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a-z, A-Z, 0-9) characters and dashes.
- header_
value string - The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\n) or carriage return (\r) characters.
- header
Name String - The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a-z, A-Z, 0-9) characters and dashes.
- header
Value String - The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\n) or carriage return (\r) characters.
- header
Name string - The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a-z, A-Z, 0-9) characters and dashes.
- header
Value string - The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\n) or carriage return (\r) characters.
- header_
name str - The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a-z, A-Z, 0-9) characters and dashes.
- header_
value str - The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\n) or carriage return (\r) characters.
- header
Name String - The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a-z, A-Z, 0-9) characters and dashes.
- header
Value String - The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\n) or carriage return (\r) characters.
ReceiptRuleBounceAction, ReceiptRuleBounceActionArgs
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).- Message string
- Human-readable text to include in the bounce message.
- Sender string
- The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
- Smtp
Reply stringCode - The SMTP reply code, as defined by RFC 5321.
- Status
Code string - The SMTP enhanced status code, as defined by RFC 3463.
- Topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- Message string
- Human-readable text to include in the bounce message.
- Sender string
- The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
- Smtp
Reply stringCode - The SMTP reply code, as defined by RFC 5321.
- Status
Code string - The SMTP enhanced status code, as defined by RFC 3463.
- Topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- message string
- Human-readable text to include in the bounce message.
- sender string
- The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
- smtp_
reply_ stringcode - The SMTP reply code, as defined by RFC 5321.
- status_
code string - The SMTP enhanced status code, as defined by RFC 3463.
- topic_
arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- message String
- Human-readable text to include in the bounce message.
- sender String
- The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
- smtp
Reply StringCode - The SMTP reply code, as defined by RFC 5321.
- status
Code String - The SMTP enhanced status code, as defined by RFC 3463.
- topic
Arn String - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- message string
- Human-readable text to include in the bounce message.
- sender string
- The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
- smtp
Reply stringCode - The SMTP reply code, as defined by RFC 5321.
- status
Code string - The SMTP enhanced status code, as defined by RFC 3463.
- topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- message str
- Human-readable text to include in the bounce message.
- sender str
- The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
- smtp_
reply_ strcode - The SMTP reply code, as defined by RFC 5321.
- status_
code str - The SMTP enhanced status code, as defined by RFC 3463.
- topic_
arn str - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- message String
- Human-readable text to include in the bounce message.
- sender String
- The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
- smtp
Reply StringCode - The SMTP reply code, as defined by RFC 5321.
- status
Code String - The SMTP enhanced status code, as defined by RFC 3463.
- topic
Arn String - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
ReceiptRuleConnectAction, ReceiptRuleConnectActionArgs
When included in a receipt rule, this action parses the received message and starts an email contact in Amazon Connect on your behalf.- Iam
Role stringArn - The Amazon Resource Name (ARN) of the IAM role to be used by Amazon Simple Email Service while starting email contacts to the Amazon Connect instance. This role should have permission to invoke connect:StartEmailContact for the given Amazon Connect instance.
- Instance
Arn string - The Amazon Resource Name (ARN) for the Amazon Connect instance that Amazon SES integrates with for starting email contacts.
- Iam
Role stringArn - The Amazon Resource Name (ARN) of the IAM role to be used by Amazon Simple Email Service while starting email contacts to the Amazon Connect instance. This role should have permission to invoke connect:StartEmailContact for the given Amazon Connect instance.
- Instance
Arn string - The Amazon Resource Name (ARN) for the Amazon Connect instance that Amazon SES integrates with for starting email contacts.
- iam_
role_ stringarn - The Amazon Resource Name (ARN) of the IAM role to be used by Amazon Simple Email Service while starting email contacts to the Amazon Connect instance. This role should have permission to invoke connect:StartEmailContact for the given Amazon Connect instance.
- instance_
arn string - The Amazon Resource Name (ARN) for the Amazon Connect instance that Amazon SES integrates with for starting email contacts.
- iam
Role StringArn - The Amazon Resource Name (ARN) of the IAM role to be used by Amazon Simple Email Service while starting email contacts to the Amazon Connect instance. This role should have permission to invoke connect:StartEmailContact for the given Amazon Connect instance.
- instance
Arn String - The Amazon Resource Name (ARN) for the Amazon Connect instance that Amazon SES integrates with for starting email contacts.
- iam
Role stringArn - The Amazon Resource Name (ARN) of the IAM role to be used by Amazon Simple Email Service while starting email contacts to the Amazon Connect instance. This role should have permission to invoke connect:StartEmailContact for the given Amazon Connect instance.
- instance
Arn string - The Amazon Resource Name (ARN) for the Amazon Connect instance that Amazon SES integrates with for starting email contacts.
- iam_
role_ strarn - The Amazon Resource Name (ARN) of the IAM role to be used by Amazon Simple Email Service while starting email contacts to the Amazon Connect instance. This role should have permission to invoke connect:StartEmailContact for the given Amazon Connect instance.
- instance_
arn str - The Amazon Resource Name (ARN) for the Amazon Connect instance that Amazon SES integrates with for starting email contacts.
- iam
Role StringArn - The Amazon Resource Name (ARN) of the IAM role to be used by Amazon Simple Email Service while starting email contacts to the Amazon Connect instance. This role should have permission to invoke connect:StartEmailContact for the given Amazon Connect instance.
- instance
Arn String - The Amazon Resource Name (ARN) for the Amazon Connect instance that Amazon SES integrates with for starting email contacts.
ReceiptRuleLambdaAction, ReceiptRuleLambdaActionArgs
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).- Function
Arn string - The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.
- Invocation
Type string - The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide. There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
- Topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- Function
Arn string - The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.
- Invocation
Type string - The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide. There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
- Topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- function_
arn string - The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.
- invocation_
type string - The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide. There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
- topic_
arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- function
Arn String - The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.
- invocation
Type String - The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide. There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
- topic
Arn String - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- function
Arn string - The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.
- invocation
Type string - The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide. There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
- topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- function_
arn str - The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.
- invocation_
type str - The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide. There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
- topic_
arn str - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- function
Arn String - The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.
- invocation
Type String - The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide. There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
- topic
Arn String - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
ReceiptRuleRule, ReceiptRuleRuleArgs
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.- Actions
List<Pulumi.
Aws Native. Ses. Inputs. Receipt Rule Action> - 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.
- Enabled bool
- If true, the receipt rule is active. The default value is false.
- Name string
- The name of the receipt rule. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.). Start and end with a letter or number. Contain 64 characters or fewer.
- Recipients List<string>
- The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
- Scan
Enabled bool - If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
- Tls
Policy string - Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
- Actions
[]Receipt
Rule Action - 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.
- Enabled bool
- If true, the receipt rule is active. The default value is false.
- Name string
- The name of the receipt rule. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.). Start and end with a letter or number. Contain 64 characters or fewer.
- Recipients []string
- The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
- Scan
Enabled bool - If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
- Tls
Policy string - Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
- actions list(object)
- 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.
- enabled bool
- If true, the receipt rule is active. The default value is false.
- name string
- The name of the receipt rule. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.). Start and end with a letter or number. Contain 64 characters or fewer.
- recipients list(string)
- The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
- scan_
enabled bool - If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
- tls_
policy string - Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
- actions
List<Receipt
Rule Action> - 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.
- enabled Boolean
- If true, the receipt rule is active. The default value is false.
- name String
- The name of the receipt rule. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.). Start and end with a letter or number. Contain 64 characters or fewer.
- recipients List<String>
- The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
- scan
Enabled Boolean - If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
- tls
Policy String - Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
- actions
Receipt
Rule Action[] - 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.
- enabled boolean
- If true, the receipt rule is active. The default value is false.
- name string
- The name of the receipt rule. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.). Start and end with a letter or number. Contain 64 characters or fewer.
- recipients string[]
- The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
- scan
Enabled boolean - If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
- tls
Policy string - Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
- actions
Sequence[Receipt
Rule Action] - 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.
- enabled bool
- If true, the receipt rule is active. The default value is false.
- name str
- The name of the receipt rule. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.). Start and end with a letter or number. Contain 64 characters or fewer.
- recipients Sequence[str]
- The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
- scan_
enabled bool - If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
- tls_
policy str - Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
- actions List<Property Map>
- 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.
- enabled Boolean
- If true, the receipt rule is active. The default value is false.
- name String
- The name of the receipt rule. The name must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.). Start and end with a letter or number. Contain 64 characters or fewer.
- recipients List<String>
- The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
- scan
Enabled Boolean - If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
- tls
Policy String - Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
ReceiptRuleS3Action, ReceiptRuleS3ActionArgs
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).- Bucket
Name string - The name of the Amazon S3 bucket for incoming email.
- Iam
Role stringArn - The ARN of the IAM role to be used by Amazon SES while writing to the Amazon S3 bucket.
- Kms
Key stringArn - The customer managed key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the AWS managed key or a customer managed key that you created in AWS KMS as follows: To use the AWS managed key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the AWS managed key in the US West (Oregon) Region, the ARN of the AWS managed key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the AWS managed key, you don't need to perform any extra steps to give Amazon SES permission to use the key. To use a customer managed key that you created in AWS KMS, provide the ARN of the customer managed key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide. For more information about key policies, see the AWS KMS Developer Guide. If you do not specify an AWS KMS key, Amazon SES does not encrypt your emails. Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS managed keys, see the Amazon S3 Developer Guide.
- Object
Key stringPrefix - The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
- Topic
Arn string - The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- Bucket
Name string - The name of the Amazon S3 bucket for incoming email.
- Iam
Role stringArn - The ARN of the IAM role to be used by Amazon SES while writing to the Amazon S3 bucket.
- Kms
Key stringArn - The customer managed key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the AWS managed key or a customer managed key that you created in AWS KMS as follows: To use the AWS managed key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the AWS managed key in the US West (Oregon) Region, the ARN of the AWS managed key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the AWS managed key, you don't need to perform any extra steps to give Amazon SES permission to use the key. To use a customer managed key that you created in AWS KMS, provide the ARN of the customer managed key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide. For more information about key policies, see the AWS KMS Developer Guide. If you do not specify an AWS KMS key, Amazon SES does not encrypt your emails. Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS managed keys, see the Amazon S3 Developer Guide.
- Object
Key stringPrefix - The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
- Topic
Arn string - The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- bucket_
name string - The name of the Amazon S3 bucket for incoming email.
- iam_
role_ stringarn - The ARN of the IAM role to be used by Amazon SES while writing to the Amazon S3 bucket.
- kms_
key_ stringarn - The customer managed key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the AWS managed key or a customer managed key that you created in AWS KMS as follows: To use the AWS managed key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the AWS managed key in the US West (Oregon) Region, the ARN of the AWS managed key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the AWS managed key, you don't need to perform any extra steps to give Amazon SES permission to use the key. To use a customer managed key that you created in AWS KMS, provide the ARN of the customer managed key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide. For more information about key policies, see the AWS KMS Developer Guide. If you do not specify an AWS KMS key, Amazon SES does not encrypt your emails. Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS managed keys, see the Amazon S3 Developer Guide.
- object_
key_ stringprefix - The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
- topic_
arn string - The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- bucket
Name String - The name of the Amazon S3 bucket for incoming email.
- iam
Role StringArn - The ARN of the IAM role to be used by Amazon SES while writing to the Amazon S3 bucket.
- kms
Key StringArn - The customer managed key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the AWS managed key or a customer managed key that you created in AWS KMS as follows: To use the AWS managed key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the AWS managed key in the US West (Oregon) Region, the ARN of the AWS managed key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the AWS managed key, you don't need to perform any extra steps to give Amazon SES permission to use the key. To use a customer managed key that you created in AWS KMS, provide the ARN of the customer managed key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide. For more information about key policies, see the AWS KMS Developer Guide. If you do not specify an AWS KMS key, Amazon SES does not encrypt your emails. Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS managed keys, see the Amazon S3 Developer Guide.
- object
Key StringPrefix - The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
- topic
Arn String - The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- bucket
Name string - The name of the Amazon S3 bucket for incoming email.
- iam
Role stringArn - The ARN of the IAM role to be used by Amazon SES while writing to the Amazon S3 bucket.
- kms
Key stringArn - The customer managed key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the AWS managed key or a customer managed key that you created in AWS KMS as follows: To use the AWS managed key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the AWS managed key in the US West (Oregon) Region, the ARN of the AWS managed key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the AWS managed key, you don't need to perform any extra steps to give Amazon SES permission to use the key. To use a customer managed key that you created in AWS KMS, provide the ARN of the customer managed key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide. For more information about key policies, see the AWS KMS Developer Guide. If you do not specify an AWS KMS key, Amazon SES does not encrypt your emails. Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS managed keys, see the Amazon S3 Developer Guide.
- object
Key stringPrefix - The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
- topic
Arn string - The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- bucket_
name str - The name of the Amazon S3 bucket for incoming email.
- iam_
role_ strarn - The ARN of the IAM role to be used by Amazon SES while writing to the Amazon S3 bucket.
- kms_
key_ strarn - The customer managed key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the AWS managed key or a customer managed key that you created in AWS KMS as follows: To use the AWS managed key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the AWS managed key in the US West (Oregon) Region, the ARN of the AWS managed key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the AWS managed key, you don't need to perform any extra steps to give Amazon SES permission to use the key. To use a customer managed key that you created in AWS KMS, provide the ARN of the customer managed key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide. For more information about key policies, see the AWS KMS Developer Guide. If you do not specify an AWS KMS key, Amazon SES does not encrypt your emails. Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS managed keys, see the Amazon S3 Developer Guide.
- object_
key_ strprefix - The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
- topic_
arn str - The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- bucket
Name String - The name of the Amazon S3 bucket for incoming email.
- iam
Role StringArn - The ARN of the IAM role to be used by Amazon SES while writing to the Amazon S3 bucket.
- kms
Key StringArn - The customer managed key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the AWS managed key or a customer managed key that you created in AWS KMS as follows: To use the AWS managed key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the AWS managed key in the US West (Oregon) Region, the ARN of the AWS managed key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the AWS managed key, you don't need to perform any extra steps to give Amazon SES permission to use the key. To use a customer managed key that you created in AWS KMS, provide the ARN of the customer managed key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide. For more information about key policies, see the AWS KMS Developer Guide. If you do not specify an AWS KMS key, Amazon SES does not encrypt your emails. Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS managed keys, see the Amazon S3 Developer Guide.
- object
Key StringPrefix - The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
- topic
Arn String - The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
ReceiptRuleSnsAction, ReceiptRuleSnsActionArgs
The action to publish the email content to an Amazon SNS topic. When executed, this action will send the email as a notification to the specified SNS topic.- Encoding string
- The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8. Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
- Topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
- Encoding string
- The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8. Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
- Topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
- encoding string
- The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8. Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
- topic_
arn string - The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
- encoding String
- The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8. Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
- topic
Arn String - The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
- encoding string
- The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8. Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
- topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
- encoding str
- The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8. Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
- topic_
arn str - The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
- encoding String
- The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8. Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
- topic
Arn String - The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
ReceiptRuleStopAction, ReceiptRuleStopActionArgs
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).ReceiptRuleWorkmailAction, ReceiptRuleWorkmailActionArgs
When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to set this up manually, because Amazon WorkMail adds the rule automatically during its setup procedure.- Organization
Arn string - The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format: arn:aws:workmail:::organization/. You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string of alphanumeric characters.
- Topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- Organization
Arn string - The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format: arn:aws:workmail:::organization/. You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string of alphanumeric characters.
- Topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- organization_
arn string - The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format: arn:aws:workmail:::organization/. You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string of alphanumeric characters.
- topic_
arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- organization
Arn String - The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format: arn:aws:workmail:::organization/. You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string of alphanumeric characters.
- topic
Arn String - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- organization
Arn string - The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format: arn:aws:workmail:::organization/. You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string of alphanumeric characters.
- topic
Arn string - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- organization_
arn str - The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format: arn:aws:workmail:::organization/. You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string of alphanumeric characters.
- topic_
arn str - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
- organization
Arn String - The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format: arn:aws:workmail:::organization/. You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string of alphanumeric characters.
- topic
Arn String - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 24, 2026 by Pulumi