Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. ses
  6. ReceiptRule
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.ses.ReceiptRule

aws logo aws logo
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
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", {
    addHeaderActions: [{
        headerName: "Custom-Header",
        headerValue: "Added by SES",
        position: 1,
    }],
    s3Actions: [{
        bucketName: "emails",
        position: 2,
    }],
    name: "store",
    ruleSetName: "default-rule-set",
    recipients: ["karen@example.com"],
    enabled: true,
    scanEnabled: true,
});

    import pulumi
import pulumi_aws as aws

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

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			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),
				},
			},
			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),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        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,
            },
        },
        Name = "store",
        RuleSetName = "default-rule-set",
        Recipients = new[]
        {
            "karen@example.com",
        },
        Enabled = true,
        ScanEnabled = true,
    });

});

    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.ArrayList;
import java.util.Arrays;
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()
            .addHeaderActions(ReceiptRuleAddHeaderActionArgs.builder()
                .headerName("Custom-Header")
                .headerValue("Added by SES")
                .position(1)
                .build())
            .s3Actions(ReceiptRuleS3ActionArgs.builder()
                .bucketName("emails")
                .position(2)
                .build())
            .name("store")
            .ruleSetName("default-rule-set")
            .recipients("karen@example.com")
            .enabled(true)
            .scanEnabled(true)
            .build());

    }
}

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

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

# Add a header to the email and store it in S3
resource "aws_ses_receiptrule" "store" {
  add_header_actions {
    header_name  = "Custom-Header"
    header_value = "Added by SES"
    position     = 1
  }
  s3_actions {
    bucket_name = "emails"
    position    = 2
  }
  name          = "store"
  rule_set_name = "default-rule-set"
  recipients    = ["karen@example.com"]
  enabled       = true
  scan_enabled  = true
}

    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,
                after: Optional[str] = None,
                enabled: Optional[bool] = None,
                lambda_actions: Optional[Sequence[ReceiptRuleLambdaActionArgs]] = None,
                name: Optional[str] = None,
                add_header_actions: Optional[Sequence[ReceiptRuleAddHeaderActionArgs]] = None,
                region: Optional[str] = None,
                bounce_actions: Optional[Sequence[ReceiptRuleBounceActionArgs]] = 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.


    resource "aws_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.

    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",
    },
    After = "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,
        },
    },
    Region = "string",
    BounceActions = new[]
    {
        new Aws.Ses.Inputs.ReceiptRuleBounceActionArgs
        {
            Message = "string",
            Position = 0,
            Sender = "string",
            SmtpReplyCode = "string",
            StatusCode = "string",
            TopicArn = "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",
        },
    },
});

    example, err := ses.NewReceiptRule(ctx, "receiptRuleResource", &ses.ReceiptRuleArgs{
	RuleSetName: pulumi.String("string"),
	Recipients: pulumi.StringArray{
		pulumi.String("string"),
	},
	After:   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),
		},
	},
	Region: 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"),
		},
	},
	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"),
		},
	},
})

    resource "aws_ses_receipt_rule" "receiptRuleResource" {
  lifecycle {
    create_before_destroy = true
  }
  rule_set_name = "string"
  recipients    = ["string"]
  after         = "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
  }
  region = "string"
  bounce_actions {
    message         = "string"
    position        = 0
    sender          = "string"
    smtp_reply_code = "string"
    status_code     = "string"
    topic_arn       = "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"
  }
}

    var receiptRuleResource = new ReceiptRule("receiptRuleResource", ReceiptRuleArgs.builder()
    .ruleSetName("string")
    .recipients("string")
    .after("string")
    .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())
    .region("string")
    .bounceActions(ReceiptRuleBounceActionArgs.builder()
        .message("string")
        .position(0)
        .sender("string")
        .smtpReplyCode("string")
        .statusCode("string")
        .topicArn("string")
        .build())
    .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());

    receipt_rule_resource = aws.ses.ReceiptRule("receiptRuleResource",
    rule_set_name="string",
    recipients=["string"],
    after="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,
    }],
    region="string",
    bounce_actions=[{
        "message": "string",
        "position": 0,
        "sender": "string",
        "smtp_reply_code": "string",
        "status_code": "string",
        "topic_arn": "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",
    }])

    const receiptRuleResource = new aws.ses.ReceiptRule("receiptRuleResource", {
    ruleSetName: "string",
    recipients: ["string"],
    after: "string",
    enabled: false,
    lambdaActions: [{
        functionArn: "string",
        position: 0,
        invocationType: "string",
        topicArn: "string",
    }],
    name: "string",
    addHeaderActions: [{
        headerName: "string",
        headerValue: "string",
        position: 0,
    }],
    region: "string",
    bounceActions: [{
        message: "string",
        position: 0,
        sender: "string",
        smtpReplyCode: "string",
        statusCode: "string",
        topicArn: "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",
    }],
});

    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
    region: 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

    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 string

    Name of the rule set.

    The following arguments are optional:

    AddHeaderActions List<ReceiptRuleAddHeaderAction>
    Configuration block for adding a header to received emails. Detailed below.
    After string
    Name of the rule to place this rule after.
    BounceActions List<ReceiptRuleBounceAction>
    Configuration block for rejecting received emails. Detailed below.
    Enabled bool
    If true, the rule will be enabled.
    LambdaActions List<ReceiptRuleLambdaAction>
    Configuration block for calling an AWS Lambda function. Detailed below.
    Name string
    Name of the rule.
    Recipients List<string>
    List of email addresses.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    S3Actions List<ReceiptRuleS3Action>
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    ScanEnabled bool
    If true, incoming emails will be scanned for spam and viruses.
    SnsActions List<ReceiptRuleSnsAction>
    Configuration block for publishing to an SNS topic. Detailed below.
    StopActions List<ReceiptRuleStopAction>
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    TlsPolicy string
    Require or Optional.
    WorkmailActions List<ReceiptRuleWorkmailAction>
    Configuration block for calling Amazon WorkMail. Detailed below.
    RuleSetName string

    Name of the rule set.

    The following arguments are optional:

    AddHeaderActions []ReceiptRuleAddHeaderActionArgs
    Configuration block for adding a header to received emails. Detailed below.
    After string
    Name of the rule to place this rule after.
    BounceActions []ReceiptRuleBounceActionArgs
    Configuration block for rejecting received emails. Detailed below.
    Enabled bool
    If true, the rule will be enabled.
    LambdaActions []ReceiptRuleLambdaActionArgs
    Configuration block for calling an AWS Lambda function. Detailed below.
    Name string
    Name of the rule.
    Recipients []string
    List of email addresses.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    S3Actions []ReceiptRuleS3ActionArgs
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    ScanEnabled bool
    If true, incoming emails will be scanned for spam and viruses.
    SnsActions []ReceiptRuleSnsActionArgs
    Configuration block for publishing to an SNS topic. Detailed below.
    StopActions []ReceiptRuleStopActionArgs
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    TlsPolicy string
    Require or Optional.
    WorkmailActions []ReceiptRuleWorkmailActionArgs
    Configuration block for calling Amazon WorkMail. Detailed below.
    rule_set_name string

    Name of the rule set.

    The following arguments are optional:

    add_header_actions list(object)
    Configuration block for adding a header to received emails. Detailed below.
    after string
    Name of the rule to place this rule after.
    bounce_actions list(object)
    Configuration block for rejecting received emails. Detailed below.
    enabled bool
    If true, the rule will be enabled.
    lambda_actions list(object)
    Configuration block for calling an AWS Lambda function. Detailed below.
    name string
    Name of the rule.
    recipients list(string)
    List of email addresses.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    s3_actions list(object)
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    scan_enabled bool
    If true, incoming emails will be scanned for spam and viruses.
    sns_actions list(object)
    Configuration block for publishing to an SNS topic. Detailed below.
    stop_actions list(object)
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    tls_policy string
    Require or Optional.
    workmail_actions list(object)
    Configuration block for calling Amazon WorkMail. Detailed below.
    ruleSetName String

    Name of the rule set.

    The following arguments are optional:

    addHeaderActions List<ReceiptRuleAddHeaderAction>
    Configuration block for adding a header to received emails. Detailed below.
    after String
    Name of the rule to place this rule after.
    bounceActions List<ReceiptRuleBounceAction>
    Configuration block for rejecting received emails. Detailed below.
    enabled Boolean
    If true, the rule will be enabled.
    lambdaActions List<ReceiptRuleLambdaAction>
    Configuration block for calling an AWS Lambda function. Detailed below.
    name String
    Name of the rule.
    recipients List<String>
    List of email addresses.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    s3Actions List<ReceiptRuleS3Action>
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    scanEnabled Boolean
    If true, incoming emails will be scanned for spam and viruses.
    snsActions List<ReceiptRuleSnsAction>
    Configuration block for publishing to an SNS topic. Detailed below.
    stopActions List<ReceiptRuleStopAction>
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    tlsPolicy String
    Require or Optional.
    workmailActions List<ReceiptRuleWorkmailAction>
    Configuration block for calling Amazon WorkMail. Detailed below.
    ruleSetName string

    Name of the rule set.

    The following arguments are optional:

    addHeaderActions ReceiptRuleAddHeaderAction[]
    Configuration block for adding a header to received emails. Detailed below.
    after string
    Name of the rule to place this rule after.
    bounceActions ReceiptRuleBounceAction[]
    Configuration block for rejecting received emails. Detailed below.
    enabled boolean
    If true, the rule will be enabled.
    lambdaActions ReceiptRuleLambdaAction[]
    Configuration block for calling an AWS Lambda function. Detailed below.
    name string
    Name of the rule.
    recipients string[]
    List of email addresses.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    s3Actions ReceiptRuleS3Action[]
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    scanEnabled boolean
    If true, incoming emails will be scanned for spam and viruses.
    snsActions ReceiptRuleSnsAction[]
    Configuration block for publishing to an SNS topic. Detailed below.
    stopActions ReceiptRuleStopAction[]
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    tlsPolicy string
    Require or Optional.
    workmailActions ReceiptRuleWorkmailAction[]
    Configuration block for calling Amazon WorkMail. Detailed below.
    rule_set_name str

    Name of the rule set.

    The following arguments are optional:

    add_header_actions Sequence[ReceiptRuleAddHeaderActionArgs]
    Configuration block for adding a header to received emails. Detailed below.
    after str
    Name of the rule to place this rule after.
    bounce_actions Sequence[ReceiptRuleBounceActionArgs]
    Configuration block for rejecting received emails. Detailed below.
    enabled bool
    If true, the rule will be enabled.
    lambda_actions Sequence[ReceiptRuleLambdaActionArgs]
    Configuration block for calling an AWS Lambda function. Detailed below.
    name str
    Name of the rule.
    recipients Sequence[str]
    List of email addresses.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    s3_actions Sequence[ReceiptRuleS3ActionArgs]
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    scan_enabled bool
    If true, incoming emails will be scanned for spam and viruses.
    sns_actions Sequence[ReceiptRuleSnsActionArgs]
    Configuration block for publishing to an SNS topic. Detailed below.
    stop_actions Sequence[ReceiptRuleStopActionArgs]
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    tls_policy str
    Require or Optional.
    workmail_actions Sequence[ReceiptRuleWorkmailActionArgs]
    Configuration block for calling Amazon WorkMail. Detailed below.
    ruleSetName String

    Name of the rule set.

    The following arguments are optional:

    addHeaderActions List<Property Map>
    Configuration block for adding a header to received emails. Detailed below.
    after String
    Name of the rule to place this rule after.
    bounceActions List<Property Map>
    Configuration block for rejecting received emails. Detailed below.
    enabled Boolean
    If true, the rule will be enabled.
    lambdaActions List<Property Map>
    Configuration block for calling an AWS Lambda function. Detailed below.
    name String
    Name of the rule.
    recipients List<String>
    List of email addresses.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    s3Actions List<Property Map>
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    scanEnabled Boolean
    If true, incoming emails will be scanned for spam and viruses.
    snsActions List<Property Map>
    Configuration block for publishing to an SNS topic. Detailed below.
    stopActions List<Property Map>
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    tlsPolicy String
    Require or Optional.
    workmailActions List<Property Map>
    Configuration block for calling Amazon WorkMail. Detailed below.

    Outputs

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

    Arn string
    SES receipt rule ARN.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    SES receipt rule ARN.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn string
    SES receipt rule ARN.
    id string
    The provider-assigned unique ID for this managed resource.
    arn String
    SES receipt rule ARN.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    SES receipt rule ARN.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    SES receipt rule ARN.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    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,
        region: Optional[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}
    import {
  to = aws_ses_receipt_rule.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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>
    Configuration block for adding a header to received emails. Detailed below.
    After string
    Name of the rule to place this rule after.
    Arn string
    SES receipt rule ARN.
    BounceActions List<ReceiptRuleBounceAction>
    Configuration block for rejecting received emails. Detailed below.
    Enabled bool
    If true, the rule will be enabled.
    LambdaActions List<ReceiptRuleLambdaAction>
    Configuration block for calling an AWS Lambda function. Detailed below.
    Name string
    Name of the rule.
    Recipients List<string>
    List of email addresses.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RuleSetName string

    Name of the rule set.

    The following arguments are optional:

    S3Actions List<ReceiptRuleS3Action>
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    ScanEnabled bool
    If true, incoming emails will be scanned for spam and viruses.
    SnsActions List<ReceiptRuleSnsAction>
    Configuration block for publishing to an SNS topic. Detailed below.
    StopActions List<ReceiptRuleStopAction>
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    TlsPolicy string
    Require or Optional.
    WorkmailActions List<ReceiptRuleWorkmailAction>
    Configuration block for calling Amazon WorkMail. Detailed below.
    AddHeaderActions []ReceiptRuleAddHeaderActionArgs
    Configuration block for adding a header to received emails. Detailed below.
    After string
    Name of the rule to place this rule after.
    Arn string
    SES receipt rule ARN.
    BounceActions []ReceiptRuleBounceActionArgs
    Configuration block for rejecting received emails. Detailed below.
    Enabled bool
    If true, the rule will be enabled.
    LambdaActions []ReceiptRuleLambdaActionArgs
    Configuration block for calling an AWS Lambda function. Detailed below.
    Name string
    Name of the rule.
    Recipients []string
    List of email addresses.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    RuleSetName string

    Name of the rule set.

    The following arguments are optional:

    S3Actions []ReceiptRuleS3ActionArgs
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    ScanEnabled bool
    If true, incoming emails will be scanned for spam and viruses.
    SnsActions []ReceiptRuleSnsActionArgs
    Configuration block for publishing to an SNS topic. Detailed below.
    StopActions []ReceiptRuleStopActionArgs
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    TlsPolicy string
    Require or Optional.
    WorkmailActions []ReceiptRuleWorkmailActionArgs
    Configuration block for calling Amazon WorkMail. Detailed below.
    add_header_actions list(object)
    Configuration block for adding a header to received emails. Detailed below.
    after string
    Name of the rule to place this rule after.
    arn string
    SES receipt rule ARN.
    bounce_actions list(object)
    Configuration block for rejecting received emails. Detailed below.
    enabled bool
    If true, the rule will be enabled.
    lambda_actions list(object)
    Configuration block for calling an AWS Lambda function. Detailed below.
    name string
    Name of the rule.
    recipients list(string)
    List of email addresses.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    rule_set_name string

    Name of the rule set.

    The following arguments are optional:

    s3_actions list(object)
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    scan_enabled bool
    If true, incoming emails will be scanned for spam and viruses.
    sns_actions list(object)
    Configuration block for publishing to an SNS topic. Detailed below.
    stop_actions list(object)
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    tls_policy string
    Require or Optional.
    workmail_actions list(object)
    Configuration block for calling Amazon WorkMail. Detailed below.
    addHeaderActions List<ReceiptRuleAddHeaderAction>
    Configuration block for adding a header to received emails. Detailed below.
    after String
    Name of the rule to place this rule after.
    arn String
    SES receipt rule ARN.
    bounceActions List<ReceiptRuleBounceAction>
    Configuration block for rejecting received emails. Detailed below.
    enabled Boolean
    If true, the rule will be enabled.
    lambdaActions List<ReceiptRuleLambdaAction>
    Configuration block for calling an AWS Lambda function. Detailed below.
    name String
    Name of the rule.
    recipients List<String>
    List of email addresses.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    ruleSetName String

    Name of the rule set.

    The following arguments are optional:

    s3Actions List<ReceiptRuleS3Action>
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    scanEnabled Boolean
    If true, incoming emails will be scanned for spam and viruses.
    snsActions List<ReceiptRuleSnsAction>
    Configuration block for publishing to an SNS topic. Detailed below.
    stopActions List<ReceiptRuleStopAction>
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    tlsPolicy String
    Require or Optional.
    workmailActions List<ReceiptRuleWorkmailAction>
    Configuration block for calling Amazon WorkMail. Detailed below.
    addHeaderActions ReceiptRuleAddHeaderAction[]
    Configuration block for adding a header to received emails. Detailed below.
    after string
    Name of the rule to place this rule after.
    arn string
    SES receipt rule ARN.
    bounceActions ReceiptRuleBounceAction[]
    Configuration block for rejecting received emails. Detailed below.
    enabled boolean
    If true, the rule will be enabled.
    lambdaActions ReceiptRuleLambdaAction[]
    Configuration block for calling an AWS Lambda function. Detailed below.
    name string
    Name of the rule.
    recipients string[]
    List of email addresses.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    ruleSetName string

    Name of the rule set.

    The following arguments are optional:

    s3Actions ReceiptRuleS3Action[]
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    scanEnabled boolean
    If true, incoming emails will be scanned for spam and viruses.
    snsActions ReceiptRuleSnsAction[]
    Configuration block for publishing to an SNS topic. Detailed below.
    stopActions ReceiptRuleStopAction[]
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    tlsPolicy string
    Require or Optional.
    workmailActions ReceiptRuleWorkmailAction[]
    Configuration block for calling Amazon WorkMail. Detailed below.
    add_header_actions Sequence[ReceiptRuleAddHeaderActionArgs]
    Configuration block for adding a header to received emails. Detailed below.
    after str
    Name of the rule to place this rule after.
    arn str
    SES receipt rule ARN.
    bounce_actions Sequence[ReceiptRuleBounceActionArgs]
    Configuration block for rejecting received emails. Detailed below.
    enabled bool
    If true, the rule will be enabled.
    lambda_actions Sequence[ReceiptRuleLambdaActionArgs]
    Configuration block for calling an AWS Lambda function. Detailed below.
    name str
    Name of the rule.
    recipients Sequence[str]
    List of email addresses.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    rule_set_name str

    Name of the rule set.

    The following arguments are optional:

    s3_actions Sequence[ReceiptRuleS3ActionArgs]
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    scan_enabled bool
    If true, incoming emails will be scanned for spam and viruses.
    sns_actions Sequence[ReceiptRuleSnsActionArgs]
    Configuration block for publishing to an SNS topic. Detailed below.
    stop_actions Sequence[ReceiptRuleStopActionArgs]
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    tls_policy str
    Require or Optional.
    workmail_actions Sequence[ReceiptRuleWorkmailActionArgs]
    Configuration block for calling Amazon WorkMail. Detailed below.
    addHeaderActions List<Property Map>
    Configuration block for adding a header to received emails. Detailed below.
    after String
    Name of the rule to place this rule after.
    arn String
    SES receipt rule ARN.
    bounceActions List<Property Map>
    Configuration block for rejecting received emails. Detailed below.
    enabled Boolean
    If true, the rule will be enabled.
    lambdaActions List<Property Map>
    Configuration block for calling an AWS Lambda function. Detailed below.
    name String
    Name of the rule.
    recipients List<String>
    List of email addresses.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    ruleSetName String

    Name of the rule set.

    The following arguments are optional:

    s3Actions List<Property Map>
    Configuration block for storing received emails in an S3 bucket. Detailed below.
    scanEnabled Boolean
    If true, incoming emails will be scanned for spam and viruses.
    snsActions List<Property Map>
    Configuration block for publishing to an SNS topic. Detailed below.
    stopActions List<Property Map>
    Configuration block for terminating the evaluation of the receipt rule set. Detailed below.
    tlsPolicy String
    Require or Optional.
    workmailActions List<Property Map>
    Configuration block for calling Amazon WorkMail. Detailed below.

    Supporting Types

    ReceiptRuleAddHeaderAction, ReceiptRuleAddHeaderActionArgs

    HeaderName string
    Name of the header to add.
    HeaderValue string
    Value of the header to add.
    Position int
    Position of the action in the receipt rule.
    HeaderName string
    Name of the header to add.
    HeaderValue string
    Value of the header to add.
    Position int
    Position of the action in the receipt rule.
    header_name string
    Name of the header to add.
    header_value string
    Value of the header to add.
    position number
    Position of the action in the receipt rule.
    headerName String
    Name of the header to add.
    headerValue String
    Value of the header to add.
    position Integer
    Position of the action in the receipt rule.
    headerName string
    Name of the header to add.
    headerValue string
    Value of the header to add.
    position number
    Position of the action in the receipt rule.
    header_name str
    Name of the header to add.
    header_value str
    Value of the header to add.
    position int
    Position of the action in the receipt rule.
    headerName String
    Name of the header to add.
    headerValue String
    Value of the header to add.
    position Number
    Position of the action in the receipt rule.

    ReceiptRuleBounceAction, ReceiptRuleBounceActionArgs

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

    ReceiptRuleLambdaAction, ReceiptRuleLambdaActionArgs

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

    ReceiptRuleS3Action, ReceiptRuleS3ActionArgs

    BucketName string
    Name of the S3 bucket.
    Position int
    Position of the action in the receipt rule.
    IamRoleArn string
    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
    ARN of the KMS key.
    ObjectKeyPrefix string
    Key prefix of the S3 bucket.
    TopicArn string
    ARN of an SNS topic to notify.
    BucketName string
    Name of the S3 bucket.
    Position int
    Position of the action in the receipt rule.
    IamRoleArn string
    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
    ARN of the KMS key.
    ObjectKeyPrefix string
    Key prefix of the S3 bucket.
    TopicArn string
    ARN of an SNS topic to notify.
    bucket_name string
    Name of the S3 bucket.
    position number
    Position of the action in the receipt rule.
    iam_role_arn string
    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 string
    ARN of the KMS key.
    object_key_prefix string
    Key prefix of the S3 bucket.
    topic_arn string
    ARN of an SNS topic to notify.
    bucketName String
    Name of the S3 bucket.
    position Integer
    Position of the action in the receipt rule.
    iamRoleArn String
    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
    ARN of the KMS key.
    objectKeyPrefix String
    Key prefix of the S3 bucket.
    topicArn String
    ARN of an SNS topic to notify.
    bucketName string
    Name of the S3 bucket.
    position number
    Position of the action in the receipt rule.
    iamRoleArn string
    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
    ARN of the KMS key.
    objectKeyPrefix string
    Key prefix of the S3 bucket.
    topicArn string
    ARN of an SNS topic to notify.
    bucket_name str
    Name of the S3 bucket.
    position int
    Position of the action in the receipt rule.
    iam_role_arn str
    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
    ARN of the KMS key.
    object_key_prefix str
    Key prefix of the S3 bucket.
    topic_arn str
    ARN of an SNS topic to notify.
    bucketName String
    Name of the S3 bucket.
    position Number
    Position of the action in the receipt rule.
    iamRoleArn String
    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
    ARN of the KMS key.
    objectKeyPrefix String
    Key prefix of the S3 bucket.
    topicArn String
    ARN of an SNS topic to notify.

    ReceiptRuleSnsAction, ReceiptRuleSnsActionArgs

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

    ReceiptRuleStopAction, ReceiptRuleStopActionArgs

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

    ReceiptRuleWorkmailAction, ReceiptRuleWorkmailActionArgs

    OrganizationArn string
    ARN of the WorkMail organization.
    Position int
    Position of the action in the receipt rule.
    TopicArn string
    ARN of an SNS topic to notify.
    OrganizationArn string
    ARN of the WorkMail organization.
    Position int
    Position of the action in the receipt rule.
    TopicArn string
    ARN of an SNS topic to notify.
    organization_arn string
    ARN of the WorkMail organization.
    position number
    Position of the action in the receipt rule.
    topic_arn string
    ARN of an SNS topic to notify.
    organizationArn String
    ARN of the WorkMail organization.
    position Integer
    Position of the action in the receipt rule.
    topicArn String
    ARN of an SNS topic to notify.
    organizationArn string
    ARN of the WorkMail organization.
    position number
    Position of the action in the receipt rule.
    topicArn string
    ARN of an SNS topic to notify.
    organization_arn str
    ARN of the WorkMail organization.
    position int
    Position of the action in the receipt rule.
    topic_arn str
    ARN of an SNS topic to notify.
    organizationArn String
    ARN of the WorkMail organization.
    position Number
    Position of the action in the receipt rule.
    topicArn String
    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

    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 logo aws logo
    Viewing docs for AWS v7.46.0
    published on Thursday, Sep 10, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial