Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ses
  5. ReceiptRule
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.ses.ReceiptRule

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

Provides an SES receipt rule resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

// Add a header to the email and store it in S3
const store = new aws.ses.ReceiptRule("store", {
    name: "store",
    ruleSetName: "default-rule-set",
    recipients: ["karen@example.com"],
    enabled: true,
    scanEnabled: true,
    addHeaderActions: [{
        headerName: "Custom-Header",
        headerValue: "Added by SES",
        position: 1,
    }],
    s3Actions: [{
        bucketName: "emails",
        position: 2,
    }],
});
Copy
import pulumi
import pulumi_aws as aws

# Add a header to the email and store it in S3
store = aws.ses.ReceiptRule("store",
    name="store",
    rule_set_name="default-rule-set",
    recipients=["karen@example.com"],
    enabled=True,
    scan_enabled=True,
    add_header_actions=[{
        "header_name": "Custom-Header",
        "header_value": "Added by SES",
        "position": 1,
    }],
    s3_actions=[{
        "bucket_name": "emails",
        "position": 2,
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ses"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Add a header to the email and store it in S3
		_, err := ses.NewReceiptRule(ctx, "store", &ses.ReceiptRuleArgs{
			Name:        pulumi.String("store"),
			RuleSetName: pulumi.String("default-rule-set"),
			Recipients: pulumi.StringArray{
				pulumi.String("karen@example.com"),
			},
			Enabled:     pulumi.Bool(true),
			ScanEnabled: pulumi.Bool(true),
			AddHeaderActions: ses.ReceiptRuleAddHeaderActionArray{
				&ses.ReceiptRuleAddHeaderActionArgs{
					HeaderName:  pulumi.String("Custom-Header"),
					HeaderValue: pulumi.String("Added by SES"),
					Position:    pulumi.Int(1),
				},
			},
			S3Actions: ses.ReceiptRuleS3ActionArray{
				&ses.ReceiptRuleS3ActionArgs{
					BucketName: pulumi.String("emails"),
					Position:   pulumi.Int(2),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    // Add a header to the email and store it in S3
    var store = new Aws.Ses.ReceiptRule("store", new()
    {
        Name = "store",
        RuleSetName = "default-rule-set",
        Recipients = new[]
        {
            "karen@example.com",
        },
        Enabled = true,
        ScanEnabled = true,
        AddHeaderActions = new[]
        {
            new Aws.Ses.Inputs.ReceiptRuleAddHeaderActionArgs
            {
                HeaderName = "Custom-Header",
                HeaderValue = "Added by SES",
                Position = 1,
            },
        },
        S3Actions = new[]
        {
            new Aws.Ses.Inputs.ReceiptRuleS3ActionArgs
            {
                BucketName = "emails",
                Position = 2,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ses.ReceiptRule;
import com.pulumi.aws.ses.ReceiptRuleArgs;
import com.pulumi.aws.ses.inputs.ReceiptRuleAddHeaderActionArgs;
import com.pulumi.aws.ses.inputs.ReceiptRuleS3ActionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Add a header to the email and store it in S3
        var store = new ReceiptRule("store", ReceiptRuleArgs.builder()
            .name("store")
            .ruleSetName("default-rule-set")
            .recipients("karen@example.com")
            .enabled(true)
            .scanEnabled(true)
            .addHeaderActions(ReceiptRuleAddHeaderActionArgs.builder()
                .headerName("Custom-Header")
                .headerValue("Added by SES")
                .position(1)
                .build())
            .s3Actions(ReceiptRuleS3ActionArgs.builder()
                .bucketName("emails")
                .position(2)
                .build())
            .build());

    }
}
Copy
resources:
  # Add a header to the email and store it in S3
  store:
    type: aws:ses:ReceiptRule
    properties:
      name: store
      ruleSetName: default-rule-set
      recipients:
        - karen@example.com
      enabled: true
      scanEnabled: true
      addHeaderActions:
        - headerName: Custom-Header
          headerValue: Added by SES
          position: 1
      s3Actions:
        - bucketName: emails
          position: 2
Copy

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_set_name: Optional[str] = None,
                recipients: Optional[Sequence[str]] = None,
                bounce_actions: Optional[Sequence[ReceiptRuleBounceActionArgs]] = None,
                enabled: Optional[bool] = None,
                lambda_actions: Optional[Sequence[ReceiptRuleLambdaActionArgs]] = None,
                name: Optional[str] = None,
                add_header_actions: Optional[Sequence[ReceiptRuleAddHeaderActionArgs]] = None,
                after: Optional[str] = None,
                s3_actions: Optional[Sequence[ReceiptRuleS3ActionArgs]] = None,
                scan_enabled: Optional[bool] = None,
                sns_actions: Optional[Sequence[ReceiptRuleSnsActionArgs]] = None,
                stop_actions: Optional[Sequence[ReceiptRuleStopActionArgs]] = None,
                tls_policy: Optional[str] = None,
                workmail_actions: Optional[Sequence[ReceiptRuleWorkmailActionArgs]] = 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:ses:ReceiptRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ReceiptRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ReceiptRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ReceiptRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ReceiptRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var receiptRuleResource = new Aws.Ses.ReceiptRule("receiptRuleResource", new()
{
    RuleSetName = "string",
    Recipients = new[]
    {
        "string",
    },
    BounceActions = new[]
    {
        new Aws.Ses.Inputs.ReceiptRuleBounceActionArgs
        {
            Message = "string",
            Position = 0,
            Sender = "string",
            SmtpReplyCode = "string",
            StatusCode = "string",
            TopicArn = "string",
        },
    },
    Enabled = false,
    LambdaActions = new[]
    {
        new Aws.Ses.Inputs.ReceiptRuleLambdaActionArgs
        {
            FunctionArn = "string",
            Position = 0,
            InvocationType = "string",
            TopicArn = "string",
        },
    },
    Name = "string",
    AddHeaderActions = new[]
    {
        new Aws.Ses.Inputs.ReceiptRuleAddHeaderActionArgs
        {
            HeaderName = "string",
            HeaderValue = "string",
            Position = 0,
        },
    },
    After = "string",
    S3Actions = new[]
    {
        new Aws.Ses.Inputs.ReceiptRuleS3ActionArgs
        {
            BucketName = "string",
            Position = 0,
            IamRoleArn = "string",
            KmsKeyArn = "string",
            ObjectKeyPrefix = "string",
            TopicArn = "string",
        },
    },
    ScanEnabled = false,
    SnsActions = new[]
    {
        new Aws.Ses.Inputs.ReceiptRuleSnsActionArgs
        {
            Position = 0,
            TopicArn = "string",
            Encoding = "string",
        },
    },
    StopActions = new[]
    {
        new Aws.Ses.Inputs.ReceiptRuleStopActionArgs
        {
            Position = 0,
            Scope = "string",
            TopicArn = "string",
        },
    },
    TlsPolicy = "string",
    WorkmailActions = new[]
    {
        new Aws.Ses.Inputs.ReceiptRuleWorkmailActionArgs
        {
            OrganizationArn = "string",
            Position = 0,
            TopicArn = "string",
        },
    },
});
Copy
example, err := ses.NewReceiptRule(ctx, "receiptRuleResource", &ses.ReceiptRuleArgs{
	RuleSetName: pulumi.String("string"),
	Recipients: pulumi.StringArray{
		pulumi.String("string"),
	},
	BounceActions: ses.ReceiptRuleBounceActionArray{
		&ses.ReceiptRuleBounceActionArgs{
			Message:       pulumi.String("string"),
			Position:      pulumi.Int(0),
			Sender:        pulumi.String("string"),
			SmtpReplyCode: pulumi.String("string"),
			StatusCode:    pulumi.String("string"),
			TopicArn:      pulumi.String("string"),
		},
	},
	Enabled: pulumi.Bool(false),
	LambdaActions: ses.ReceiptRuleLambdaActionArray{
		&ses.ReceiptRuleLambdaActionArgs{
			FunctionArn:    pulumi.String("string"),
			Position:       pulumi.Int(0),
			InvocationType: pulumi.String("string"),
			TopicArn:       pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	AddHeaderActions: ses.ReceiptRuleAddHeaderActionArray{
		&ses.ReceiptRuleAddHeaderActionArgs{
			HeaderName:  pulumi.String("string"),
			HeaderValue: pulumi.String("string"),
			Position:    pulumi.Int(0),
		},
	},
	After: pulumi.String("string"),
	S3Actions: ses.ReceiptRuleS3ActionArray{
		&ses.ReceiptRuleS3ActionArgs{
			BucketName:      pulumi.String("string"),
			Position:        pulumi.Int(0),
			IamRoleArn:      pulumi.String("string"),
			KmsKeyArn:       pulumi.String("string"),
			ObjectKeyPrefix: pulumi.String("string"),
			TopicArn:        pulumi.String("string"),
		},
	},
	ScanEnabled: pulumi.Bool(false),
	SnsActions: ses.ReceiptRuleSnsActionArray{
		&ses.ReceiptRuleSnsActionArgs{
			Position: pulumi.Int(0),
			TopicArn: pulumi.String("string"),
			Encoding: pulumi.String("string"),
		},
	},
	StopActions: ses.ReceiptRuleStopActionArray{
		&ses.ReceiptRuleStopActionArgs{
			Position: pulumi.Int(0),
			Scope:    pulumi.String("string"),
			TopicArn: pulumi.String("string"),
		},
	},
	TlsPolicy: pulumi.String("string"),
	WorkmailActions: ses.ReceiptRuleWorkmailActionArray{
		&ses.ReceiptRuleWorkmailActionArgs{
			OrganizationArn: pulumi.String("string"),
			Position:        pulumi.Int(0),
			TopicArn:        pulumi.String("string"),
		},
	},
})
Copy
var receiptRuleResource = new ReceiptRule("receiptRuleResource", ReceiptRuleArgs.builder()
    .ruleSetName("string")
    .recipients("string")
    .bounceActions(ReceiptRuleBounceActionArgs.builder()
        .message("string")
        .position(0)
        .sender("string")
        .smtpReplyCode("string")
        .statusCode("string")
        .topicArn("string")
        .build())
    .enabled(false)
    .lambdaActions(ReceiptRuleLambdaActionArgs.builder()
        .functionArn("string")
        .position(0)
        .invocationType("string")
        .topicArn("string")
        .build())
    .name("string")
    .addHeaderActions(ReceiptRuleAddHeaderActionArgs.builder()
        .headerName("string")
        .headerValue("string")
        .position(0)
        .build())
    .after("string")
    .s3Actions(ReceiptRuleS3ActionArgs.builder()
        .bucketName("string")
        .position(0)
        .iamRoleArn("string")
        .kmsKeyArn("string")
        .objectKeyPrefix("string")
        .topicArn("string")
        .build())
    .scanEnabled(false)
    .snsActions(ReceiptRuleSnsActionArgs.builder()
        .position(0)
        .topicArn("string")
        .encoding("string")
        .build())
    .stopActions(ReceiptRuleStopActionArgs.builder()
        .position(0)
        .scope("string")
        .topicArn("string")
        .build())
    .tlsPolicy("string")
    .workmailActions(ReceiptRuleWorkmailActionArgs.builder()
        .organizationArn("string")
        .position(0)
        .topicArn("string")
        .build())
    .build());
Copy
receipt_rule_resource = aws.ses.ReceiptRule("receiptRuleResource",
    rule_set_name="string",
    recipients=["string"],
    bounce_actions=[{
        "message": "string",
        "position": 0,
        "sender": "string",
        "smtp_reply_code": "string",
        "status_code": "string",
        "topic_arn": "string",
    }],
    enabled=False,
    lambda_actions=[{
        "function_arn": "string",
        "position": 0,
        "invocation_type": "string",
        "topic_arn": "string",
    }],
    name="string",
    add_header_actions=[{
        "header_name": "string",
        "header_value": "string",
        "position": 0,
    }],
    after="string",
    s3_actions=[{
        "bucket_name": "string",
        "position": 0,
        "iam_role_arn": "string",
        "kms_key_arn": "string",
        "object_key_prefix": "string",
        "topic_arn": "string",
    }],
    scan_enabled=False,
    sns_actions=[{
        "position": 0,
        "topic_arn": "string",
        "encoding": "string",
    }],
    stop_actions=[{
        "position": 0,
        "scope": "string",
        "topic_arn": "string",
    }],
    tls_policy="string",
    workmail_actions=[{
        "organization_arn": "string",
        "position": 0,
        "topic_arn": "string",
    }])
Copy
const receiptRuleResource = new aws.ses.ReceiptRule("receiptRuleResource", {
    ruleSetName: "string",
    recipients: ["string"],
    bounceActions: [{
        message: "string",
        position: 0,
        sender: "string",
        smtpReplyCode: "string",
        statusCode: "string",
        topicArn: "string",
    }],
    enabled: false,
    lambdaActions: [{
        functionArn: "string",
        position: 0,
        invocationType: "string",
        topicArn: "string",
    }],
    name: "string",
    addHeaderActions: [{
        headerName: "string",
        headerValue: "string",
        position: 0,
    }],
    after: "string",
    s3Actions: [{
        bucketName: "string",
        position: 0,
        iamRoleArn: "string",
        kmsKeyArn: "string",
        objectKeyPrefix: "string",
        topicArn: "string",
    }],
    scanEnabled: false,
    snsActions: [{
        position: 0,
        topicArn: "string",
        encoding: "string",
    }],
    stopActions: [{
        position: 0,
        scope: "string",
        topicArn: "string",
    }],
    tlsPolicy: "string",
    workmailActions: [{
        organizationArn: "string",
        position: 0,
        topicArn: "string",
    }],
});
Copy
type: aws:ses:ReceiptRule
properties:
    addHeaderActions:
        - headerName: string
          headerValue: string
          position: 0
    after: string
    bounceActions:
        - message: string
          position: 0
          sender: string
          smtpReplyCode: string
          statusCode: string
          topicArn: string
    enabled: false
    lambdaActions:
        - functionArn: string
          invocationType: string
          position: 0
          topicArn: string
    name: string
    recipients:
        - string
    ruleSetName: string
    s3Actions:
        - bucketName: string
          iamRoleArn: string
          kmsKeyArn: string
          objectKeyPrefix: string
          position: 0
          topicArn: string
    scanEnabled: false
    snsActions:
        - encoding: string
          position: 0
          topicArn: string
    stopActions:
        - position: 0
          scope: string
          topicArn: string
    tlsPolicy: string
    workmailActions:
        - organizationArn: string
          position: 0
          topicArn: string
Copy

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:

RuleSetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the rule set
AddHeaderActions List<ReceiptRuleAddHeaderAction>
A list of Add Header Action blocks. Documented below.
After string
The name of the rule to place this rule after
BounceActions List<ReceiptRuleBounceAction>
A list of Bounce Action blocks. Documented below.
Enabled bool
If true, the rule will be enabled
LambdaActions List<ReceiptRuleLambdaAction>
A list of Lambda Action blocks. Documented below.
Name Changes to this property will trigger replacement. string
The name of the rule
Recipients List<string>
A list of email addresses
S3Actions List<ReceiptRuleS3Action>
A list of S3 Action blocks. Documented below.
ScanEnabled bool
If true, incoming emails will be scanned for spam and viruses
SnsActions List<ReceiptRuleSnsAction>
A list of SNS Action blocks. Documented below.
StopActions List<ReceiptRuleStopAction>
A list of Stop Action blocks. Documented below.
TlsPolicy string
Require or Optional
WorkmailActions List<ReceiptRuleWorkmailAction>
A list of WorkMail Action blocks. Documented below.
RuleSetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the rule set
AddHeaderActions []ReceiptRuleAddHeaderActionArgs
A list of Add Header Action blocks. Documented below.
After string
The name of the rule to place this rule after
BounceActions []ReceiptRuleBounceActionArgs
A list of Bounce Action blocks. Documented below.
Enabled bool
If true, the rule will be enabled
LambdaActions []ReceiptRuleLambdaActionArgs
A list of Lambda Action blocks. Documented below.
Name Changes to this property will trigger replacement. string
The name of the rule
Recipients []string
A list of email addresses
S3Actions []ReceiptRuleS3ActionArgs
A list of S3 Action blocks. Documented below.
ScanEnabled bool
If true, incoming emails will be scanned for spam and viruses
SnsActions []ReceiptRuleSnsActionArgs
A list of SNS Action blocks. Documented below.
StopActions []ReceiptRuleStopActionArgs
A list of Stop Action blocks. Documented below.
TlsPolicy string
Require or Optional
WorkmailActions []ReceiptRuleWorkmailActionArgs
A list of WorkMail Action blocks. Documented below.
ruleSetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the rule set
addHeaderActions List<ReceiptRuleAddHeaderAction>
A list of Add Header Action blocks. Documented below.
after String
The name of the rule to place this rule after
bounceActions List<ReceiptRuleBounceAction>
A list of Bounce Action blocks. Documented below.
enabled Boolean
If true, the rule will be enabled
lambdaActions List<ReceiptRuleLambdaAction>
A list of Lambda Action blocks. Documented below.
name Changes to this property will trigger replacement. String
The name of the rule
recipients List<String>
A list of email addresses
s3Actions List<ReceiptRuleS3Action>
A list of S3 Action blocks. Documented below.
scanEnabled Boolean
If true, incoming emails will be scanned for spam and viruses
snsActions List<ReceiptRuleSnsAction>
A list of SNS Action blocks. Documented below.
stopActions List<ReceiptRuleStopAction>
A list of Stop Action blocks. Documented below.
tlsPolicy String
Require or Optional
workmailActions List<ReceiptRuleWorkmailAction>
A list of WorkMail Action blocks. Documented below.
ruleSetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the rule set
addHeaderActions ReceiptRuleAddHeaderAction[]
A list of Add Header Action blocks. Documented below.
after string
The name of the rule to place this rule after
bounceActions ReceiptRuleBounceAction[]
A list of Bounce Action blocks. Documented below.
enabled boolean
If true, the rule will be enabled
lambdaActions ReceiptRuleLambdaAction[]
A list of Lambda Action blocks. Documented below.
name Changes to this property will trigger replacement. string
The name of the rule
recipients string[]
A list of email addresses
s3Actions ReceiptRuleS3Action[]
A list of S3 Action blocks. Documented below.
scanEnabled boolean
If true, incoming emails will be scanned for spam and viruses
snsActions ReceiptRuleSnsAction[]
A list of SNS Action blocks. Documented below.
stopActions ReceiptRuleStopAction[]
A list of Stop Action blocks. Documented below.
tlsPolicy string
Require or Optional
workmailActions ReceiptRuleWorkmailAction[]
A list of WorkMail Action blocks. Documented below.
rule_set_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the rule set
add_header_actions Sequence[ReceiptRuleAddHeaderActionArgs]
A list of Add Header Action blocks. Documented below.
after str
The name of the rule to place this rule after
bounce_actions Sequence[ReceiptRuleBounceActionArgs]
A list of Bounce Action blocks. Documented below.
enabled bool
If true, the rule will be enabled
lambda_actions Sequence[ReceiptRuleLambdaActionArgs]
A list of Lambda Action blocks. Documented below.
name Changes to this property will trigger replacement. str
The name of the rule
recipients Sequence[str]
A list of email addresses
s3_actions Sequence[ReceiptRuleS3ActionArgs]
A list of S3 Action blocks. Documented below.
scan_enabled bool
If true, incoming emails will be scanned for spam and viruses
sns_actions Sequence[ReceiptRuleSnsActionArgs]
A list of SNS Action blocks. Documented below.
stop_actions Sequence[ReceiptRuleStopActionArgs]
A list of Stop Action blocks. Documented below.
tls_policy str
Require or Optional
workmail_actions Sequence[ReceiptRuleWorkmailActionArgs]
A list of WorkMail Action blocks. Documented below.
ruleSetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the rule set
addHeaderActions List<Property Map>
A list of Add Header Action blocks. Documented below.
after String
The name of the rule to place this rule after
bounceActions List<Property Map>
A list of Bounce Action blocks. Documented below.
enabled Boolean
If true, the rule will be enabled
lambdaActions List<Property Map>
A list of Lambda Action blocks. Documented below.
name Changes to this property will trigger replacement. String
The name of the rule
recipients List<String>
A list of email addresses
s3Actions List<Property Map>
A list of S3 Action blocks. Documented below.
scanEnabled Boolean
If true, incoming emails will be scanned for spam and viruses
snsActions List<Property Map>
A list of SNS Action blocks. Documented below.
stopActions List<Property Map>
A list of Stop Action blocks. Documented below.
tlsPolicy String
Require or Optional
workmailActions List<Property Map>
A list of WorkMail Action blocks. Documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the ReceiptRule resource produces the following output properties:

Arn string
The SES receipt rule ARN.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
The SES receipt rule ARN.
Id string
The provider-assigned unique ID for this managed resource.
arn String
The SES receipt rule ARN.
id String
The provider-assigned unique ID for this managed resource.
arn string
The SES receipt rule ARN.
id string
The provider-assigned unique ID for this managed resource.
arn str
The SES receipt rule ARN.
id str
The provider-assigned unique ID for this managed resource.
arn String
The SES receipt rule ARN.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ReceiptRule Resource

Get an existing ReceiptRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ReceiptRuleState, opts?: CustomResourceOptions): ReceiptRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        add_header_actions: Optional[Sequence[ReceiptRuleAddHeaderActionArgs]] = None,
        after: Optional[str] = None,
        arn: Optional[str] = None,
        bounce_actions: Optional[Sequence[ReceiptRuleBounceActionArgs]] = None,
        enabled: Optional[bool] = None,
        lambda_actions: Optional[Sequence[ReceiptRuleLambdaActionArgs]] = None,
        name: Optional[str] = None,
        recipients: Optional[Sequence[str]] = None,
        rule_set_name: Optional[str] = None,
        s3_actions: Optional[Sequence[ReceiptRuleS3ActionArgs]] = None,
        scan_enabled: Optional[bool] = None,
        sns_actions: Optional[Sequence[ReceiptRuleSnsActionArgs]] = None,
        stop_actions: Optional[Sequence[ReceiptRuleStopActionArgs]] = None,
        tls_policy: Optional[str] = None,
        workmail_actions: Optional[Sequence[ReceiptRuleWorkmailActionArgs]] = None) -> ReceiptRule
func GetReceiptRule(ctx *Context, name string, id IDInput, state *ReceiptRuleState, opts ...ResourceOption) (*ReceiptRule, error)
public static ReceiptRule Get(string name, Input<string> id, ReceiptRuleState? state, CustomResourceOptions? opts = null)
public static ReceiptRule get(String name, Output<String> id, ReceiptRuleState state, CustomResourceOptions options)
resources:  _:    type: aws:ses:ReceiptRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AddHeaderActions List<ReceiptRuleAddHeaderAction>
A list of Add Header Action blocks. Documented below.
After string
The name of the rule to place this rule after
Arn string
The SES receipt rule ARN.
BounceActions List<ReceiptRuleBounceAction>
A list of Bounce Action blocks. Documented below.
Enabled bool
If true, the rule will be enabled
LambdaActions List<ReceiptRuleLambdaAction>
A list of Lambda Action blocks. Documented below.
Name Changes to this property will trigger replacement. string
The name of the rule
Recipients List<string>
A list of email addresses
RuleSetName Changes to this property will trigger replacement. string
The name of the rule set
S3Actions List<ReceiptRuleS3Action>
A list of S3 Action blocks. Documented below.
ScanEnabled bool
If true, incoming emails will be scanned for spam and viruses
SnsActions List<ReceiptRuleSnsAction>
A list of SNS Action blocks. Documented below.
StopActions List<ReceiptRuleStopAction>
A list of Stop Action blocks. Documented below.
TlsPolicy string
Require or Optional
WorkmailActions List<ReceiptRuleWorkmailAction>
A list of WorkMail Action blocks. Documented below.
AddHeaderActions []ReceiptRuleAddHeaderActionArgs
A list of Add Header Action blocks. Documented below.
After string
The name of the rule to place this rule after
Arn string
The SES receipt rule ARN.
BounceActions []ReceiptRuleBounceActionArgs
A list of Bounce Action blocks. Documented below.
Enabled bool
If true, the rule will be enabled
LambdaActions []ReceiptRuleLambdaActionArgs
A list of Lambda Action blocks. Documented below.
Name Changes to this property will trigger replacement. string
The name of the rule
Recipients []string
A list of email addresses
RuleSetName Changes to this property will trigger replacement. string
The name of the rule set
S3Actions []ReceiptRuleS3ActionArgs
A list of S3 Action blocks. Documented below.
ScanEnabled bool
If true, incoming emails will be scanned for spam and viruses
SnsActions []ReceiptRuleSnsActionArgs
A list of SNS Action blocks. Documented below.
StopActions []ReceiptRuleStopActionArgs
A list of Stop Action blocks. Documented below.
TlsPolicy string
Require or Optional
WorkmailActions []ReceiptRuleWorkmailActionArgs
A list of WorkMail Action blocks. Documented below.
addHeaderActions List<ReceiptRuleAddHeaderAction>
A list of Add Header Action blocks. Documented below.
after String
The name of the rule to place this rule after
arn String
The SES receipt rule ARN.
bounceActions List<ReceiptRuleBounceAction>
A list of Bounce Action blocks. Documented below.
enabled Boolean
If true, the rule will be enabled
lambdaActions List<ReceiptRuleLambdaAction>
A list of Lambda Action blocks. Documented below.
name Changes to this property will trigger replacement. String
The name of the rule
recipients List<String>
A list of email addresses
ruleSetName Changes to this property will trigger replacement. String
The name of the rule set
s3Actions List<ReceiptRuleS3Action>
A list of S3 Action blocks. Documented below.
scanEnabled Boolean
If true, incoming emails will be scanned for spam and viruses
snsActions List<ReceiptRuleSnsAction>
A list of SNS Action blocks. Documented below.
stopActions List<ReceiptRuleStopAction>
A list of Stop Action blocks. Documented below.
tlsPolicy String
Require or Optional
workmailActions List<ReceiptRuleWorkmailAction>
A list of WorkMail Action blocks. Documented below.
addHeaderActions ReceiptRuleAddHeaderAction[]
A list of Add Header Action blocks. Documented below.
after string
The name of the rule to place this rule after
arn string
The SES receipt rule ARN.
bounceActions ReceiptRuleBounceAction[]
A list of Bounce Action blocks. Documented below.
enabled boolean
If true, the rule will be enabled
lambdaActions ReceiptRuleLambdaAction[]
A list of Lambda Action blocks. Documented below.
name Changes to this property will trigger replacement. string
The name of the rule
recipients string[]
A list of email addresses
ruleSetName Changes to this property will trigger replacement. string
The name of the rule set
s3Actions ReceiptRuleS3Action[]
A list of S3 Action blocks. Documented below.
scanEnabled boolean
If true, incoming emails will be scanned for spam and viruses
snsActions ReceiptRuleSnsAction[]
A list of SNS Action blocks. Documented below.
stopActions ReceiptRuleStopAction[]
A list of Stop Action blocks. Documented below.
tlsPolicy string
Require or Optional
workmailActions ReceiptRuleWorkmailAction[]
A list of WorkMail Action blocks. Documented below.
add_header_actions Sequence[ReceiptRuleAddHeaderActionArgs]
A list of Add Header Action blocks. Documented below.
after str
The name of the rule to place this rule after
arn str
The SES receipt rule ARN.
bounce_actions Sequence[ReceiptRuleBounceActionArgs]
A list of Bounce Action blocks. Documented below.
enabled bool
If true, the rule will be enabled
lambda_actions Sequence[ReceiptRuleLambdaActionArgs]
A list of Lambda Action blocks. Documented below.
name Changes to this property will trigger replacement. str
The name of the rule
recipients Sequence[str]
A list of email addresses
rule_set_name Changes to this property will trigger replacement. str
The name of the rule set
s3_actions Sequence[ReceiptRuleS3ActionArgs]
A list of S3 Action blocks. Documented below.
scan_enabled bool
If true, incoming emails will be scanned for spam and viruses
sns_actions Sequence[ReceiptRuleSnsActionArgs]
A list of SNS Action blocks. Documented below.
stop_actions Sequence[ReceiptRuleStopActionArgs]
A list of Stop Action blocks. Documented below.
tls_policy str
Require or Optional
workmail_actions Sequence[ReceiptRuleWorkmailActionArgs]
A list of WorkMail Action blocks. Documented below.
addHeaderActions List<Property Map>
A list of Add Header Action blocks. Documented below.
after String
The name of the rule to place this rule after
arn String
The SES receipt rule ARN.
bounceActions List<Property Map>
A list of Bounce Action blocks. Documented below.
enabled Boolean
If true, the rule will be enabled
lambdaActions List<Property Map>
A list of Lambda Action blocks. Documented below.
name Changes to this property will trigger replacement. String
The name of the rule
recipients List<String>
A list of email addresses
ruleSetName Changes to this property will trigger replacement. String
The name of the rule set
s3Actions List<Property Map>
A list of S3 Action blocks. Documented below.
scanEnabled Boolean
If true, incoming emails will be scanned for spam and viruses
snsActions List<Property Map>
A list of SNS Action blocks. Documented below.
stopActions List<Property Map>
A list of Stop Action blocks. Documented below.
tlsPolicy String
Require or Optional
workmailActions List<Property Map>
A list of WorkMail Action blocks. Documented below.

Supporting Types

ReceiptRuleAddHeaderAction
, ReceiptRuleAddHeaderActionArgs

HeaderName This property is required. string
The name of the header to add
HeaderValue This property is required. string
The value of the header to add
Position This property is required. int
The position of the action in the receipt rule
HeaderName This property is required. string
The name of the header to add
HeaderValue This property is required. string
The value of the header to add
Position This property is required. int
The position of the action in the receipt rule
headerName This property is required. String
The name of the header to add
headerValue This property is required. String
The value of the header to add
position This property is required. Integer
The position of the action in the receipt rule
headerName This property is required. string
The name of the header to add
headerValue This property is required. string
The value of the header to add
position This property is required. number
The position of the action in the receipt rule
header_name This property is required. str
The name of the header to add
header_value This property is required. str
The value of the header to add
position This property is required. int
The position of the action in the receipt rule
headerName This property is required. String
The name of the header to add
headerValue This property is required. String
The value of the header to add
position This property is required. Number
The position of the action in the receipt rule

ReceiptRuleBounceAction
, ReceiptRuleBounceActionArgs

Message This property is required. string
The message to send
Position This property is required. int
The position of the action in the receipt rule
Sender This property is required. string
The email address of the sender
SmtpReplyCode This property is required. string
The RFC 5321 SMTP reply code
StatusCode string
The RFC 3463 SMTP enhanced status code
TopicArn string
The ARN of an SNS topic to notify
Message This property is required. string
The message to send
Position This property is required. int
The position of the action in the receipt rule
Sender This property is required. string
The email address of the sender
SmtpReplyCode This property is required. string
The RFC 5321 SMTP reply code
StatusCode string
The RFC 3463 SMTP enhanced status code
TopicArn string
The ARN of an SNS topic to notify
message This property is required. String
The message to send
position This property is required. Integer
The position of the action in the receipt rule
sender This property is required. String
The email address of the sender
smtpReplyCode This property is required. String
The RFC 5321 SMTP reply code
statusCode String
The RFC 3463 SMTP enhanced status code
topicArn String
The ARN of an SNS topic to notify
message This property is required. string
The message to send
position This property is required. number
The position of the action in the receipt rule
sender This property is required. string
The email address of the sender
smtpReplyCode This property is required. string
The RFC 5321 SMTP reply code
statusCode string
The RFC 3463 SMTP enhanced status code
topicArn string
The ARN of an SNS topic to notify
message This property is required. str
The message to send
position This property is required. int
The position of the action in the receipt rule
sender This property is required. str
The email address of the sender
smtp_reply_code This property is required. str
The RFC 5321 SMTP reply code
status_code str
The RFC 3463 SMTP enhanced status code
topic_arn str
The ARN of an SNS topic to notify
message This property is required. String
The message to send
position This property is required. Number
The position of the action in the receipt rule
sender This property is required. String
The email address of the sender
smtpReplyCode This property is required. String
The RFC 5321 SMTP reply code
statusCode String
The RFC 3463 SMTP enhanced status code
topicArn String
The ARN of an SNS topic to notify

ReceiptRuleLambdaAction
, ReceiptRuleLambdaActionArgs

FunctionArn This property is required. string
The ARN of the Lambda function to invoke
Position This property is required. int
The position of the action in the receipt rule
InvocationType string
Event or RequestResponse
TopicArn string
The ARN of an SNS topic to notify
FunctionArn This property is required. string
The ARN of the Lambda function to invoke
Position This property is required. int
The position of the action in the receipt rule
InvocationType string
Event or RequestResponse
TopicArn string
The ARN of an SNS topic to notify
functionArn This property is required. String
The ARN of the Lambda function to invoke
position This property is required. Integer
The position of the action in the receipt rule
invocationType String
Event or RequestResponse
topicArn String
The ARN of an SNS topic to notify
functionArn This property is required. string
The ARN of the Lambda function to invoke
position This property is required. number
The position of the action in the receipt rule
invocationType string
Event or RequestResponse
topicArn string
The ARN of an SNS topic to notify
function_arn This property is required. str
The ARN of the Lambda function to invoke
position This property is required. int
The position of the action in the receipt rule
invocation_type str
Event or RequestResponse
topic_arn str
The ARN of an SNS topic to notify
functionArn This property is required. String
The ARN of the Lambda function to invoke
position This property is required. Number
The position of the action in the receipt rule
invocationType String
Event or RequestResponse
topicArn String
The ARN of an SNS topic to notify

ReceiptRuleS3Action
, ReceiptRuleS3ActionArgs

BucketName This property is required. string
The name of the S3 bucket
Position This property is required. int
The position of the action in the receipt rule
IamRoleArn string
The ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket, optionally encrypting your mail via the provided customer managed key, and publishing to the Amazon SNS topic
KmsKeyArn string
The ARN of the KMS key
ObjectKeyPrefix string
The key prefix of the S3 bucket
TopicArn string
The ARN of an SNS topic to notify
BucketName This property is required. string
The name of the S3 bucket
Position This property is required. int
The position of the action in the receipt rule
IamRoleArn string
The ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket, optionally encrypting your mail via the provided customer managed key, and publishing to the Amazon SNS topic
KmsKeyArn string
The ARN of the KMS key
ObjectKeyPrefix string
The key prefix of the S3 bucket
TopicArn string
The ARN of an SNS topic to notify
bucketName This property is required. String
The name of the S3 bucket
position This property is required. Integer
The position of the action in the receipt rule
iamRoleArn String
The ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket, optionally encrypting your mail via the provided customer managed key, and publishing to the Amazon SNS topic
kmsKeyArn String
The ARN of the KMS key
objectKeyPrefix String
The key prefix of the S3 bucket
topicArn String
The ARN of an SNS topic to notify
bucketName This property is required. string
The name of the S3 bucket
position This property is required. number
The position of the action in the receipt rule
iamRoleArn string
The ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket, optionally encrypting your mail via the provided customer managed key, and publishing to the Amazon SNS topic
kmsKeyArn string
The ARN of the KMS key
objectKeyPrefix string
The key prefix of the S3 bucket
topicArn string
The ARN of an SNS topic to notify
bucket_name This property is required. str
The name of the S3 bucket
position This property is required. int
The position of the action in the receipt rule
iam_role_arn str
The ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket, optionally encrypting your mail via the provided customer managed key, and publishing to the Amazon SNS topic
kms_key_arn str
The ARN of the KMS key
object_key_prefix str
The key prefix of the S3 bucket
topic_arn str
The ARN of an SNS topic to notify
bucketName This property is required. String
The name of the S3 bucket
position This property is required. Number
The position of the action in the receipt rule
iamRoleArn String
The ARN of the IAM role to be used by Amazon Simple Email Service while writing to the Amazon S3 bucket, optionally encrypting your mail via the provided customer managed key, and publishing to the Amazon SNS topic
kmsKeyArn String
The ARN of the KMS key
objectKeyPrefix String
The key prefix of the S3 bucket
topicArn String
The ARN of an SNS topic to notify

ReceiptRuleSnsAction
, ReceiptRuleSnsActionArgs

Position This property is required. int
The position of the action in the receipt rule
TopicArn This property is required. string
The ARN of an SNS topic to notify
Encoding string
The encoding to use for the email within the Amazon SNS notification. Default value is UTF-8.
Position This property is required. int
The position of the action in the receipt rule
TopicArn This property is required. string
The ARN of an SNS topic to notify
Encoding string
The encoding to use for the email within the Amazon SNS notification. Default value is UTF-8.
position This property is required. Integer
The position of the action in the receipt rule
topicArn This property is required. String
The ARN of an SNS topic to notify
encoding String
The encoding to use for the email within the Amazon SNS notification. Default value is UTF-8.
position This property is required. number
The position of the action in the receipt rule
topicArn This property is required. string
The ARN of an SNS topic to notify
encoding string
The encoding to use for the email within the Amazon SNS notification. Default value is UTF-8.
position This property is required. int
The position of the action in the receipt rule
topic_arn This property is required. str
The ARN of an SNS topic to notify
encoding str
The encoding to use for the email within the Amazon SNS notification. Default value is UTF-8.
position This property is required. Number
The position of the action in the receipt rule
topicArn This property is required. String
The ARN of an SNS topic to notify
encoding String
The encoding to use for the email within the Amazon SNS notification. Default value is UTF-8.

ReceiptRuleStopAction
, ReceiptRuleStopActionArgs

Position This property is required. int
The position of the action in the receipt rule
Scope This property is required. string
The scope to apply. The only acceptable value is RuleSet.
TopicArn string
The ARN of an SNS topic to notify
Position This property is required. int
The position of the action in the receipt rule
Scope This property is required. string
The scope to apply. The only acceptable value is RuleSet.
TopicArn string
The ARN of an SNS topic to notify
position This property is required. Integer
The position of the action in the receipt rule
scope This property is required. String
The scope to apply. The only acceptable value is RuleSet.
topicArn String
The ARN of an SNS topic to notify
position This property is required. number
The position of the action in the receipt rule
scope This property is required. string
The scope to apply. The only acceptable value is RuleSet.
topicArn string
The ARN of an SNS topic to notify
position This property is required. int
The position of the action in the receipt rule
scope This property is required. str
The scope to apply. The only acceptable value is RuleSet.
topic_arn str
The ARN of an SNS topic to notify
position This property is required. Number
The position of the action in the receipt rule
scope This property is required. String
The scope to apply. The only acceptable value is RuleSet.
topicArn String
The ARN of an SNS topic to notify

ReceiptRuleWorkmailAction
, ReceiptRuleWorkmailActionArgs

OrganizationArn This property is required. string
The ARN of the WorkMail organization
Position This property is required. int
The position of the action in the receipt rule
TopicArn string
The ARN of an SNS topic to notify
OrganizationArn This property is required. string
The ARN of the WorkMail organization
Position This property is required. int
The position of the action in the receipt rule
TopicArn string
The ARN of an SNS topic to notify
organizationArn This property is required. String
The ARN of the WorkMail organization
position This property is required. Integer
The position of the action in the receipt rule
topicArn String
The ARN of an SNS topic to notify
organizationArn This property is required. string
The ARN of the WorkMail organization
position This property is required. number
The position of the action in the receipt rule
topicArn string
The ARN of an SNS topic to notify
organization_arn This property is required. str
The ARN of the WorkMail organization
position This property is required. int
The position of the action in the receipt rule
topic_arn str
The ARN of an SNS topic to notify
organizationArn This property is required. String
The ARN of the WorkMail organization
position This property is required. Number
The position of the action in the receipt rule
topicArn String
The ARN of an SNS topic to notify

Import

Using pulumi import, import SES receipt rules using the ruleset name and rule name separated by :. For example:

$ pulumi import aws:ses/receiptRule:ReceiptRule my_rule my_rule_set:my_rule
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws