AWS Classic v6.2.1, Sep 22 23

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi

pulumi/pulumi-aws

aws.ses.ReceiptRule

Explore with Pulumi AI

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi

pulumi/pulumi-aws

Example Usage

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,
            },
        },
        Enabled = true,
        Recipients = new[]
        {
            "karen@example.com",
        },
        RuleSetName = "default-rule-set",
        S3Actions = new[]
        {
            new Aws.Ses.Inputs.ReceiptRuleS3ActionArgs
            {
                BucketName = "emails",
                Position = 2,
            },
        },
        ScanEnabled = true,
    });

});

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 {
		_, 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),
				},
			},
			Enabled: pulumi.Bool(true),
			Recipients: pulumi.StringArray{
				pulumi.String("karen@example.com"),
			},
			RuleSetName: pulumi.String("default-rule-set"),
			S3Actions: ses.ReceiptRuleS3ActionArray{
				&ses.ReceiptRuleS3ActionArgs{
					BucketName: pulumi.String("emails"),
					Position:   pulumi.Int(2),
				},
			},
			ScanEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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) {
        var store = new ReceiptRule("store", ReceiptRuleArgs.builder()        
            .addHeaderActions(ReceiptRuleAddHeaderActionArgs.builder()
                .headerName("Custom-Header")
                .headerValue("Added by SES")
                .position(1)
                .build())
            .enabled(true)
            .recipients("karen@example.com")
            .ruleSetName("default-rule-set")
            .s3Actions(ReceiptRuleS3ActionArgs.builder()
                .bucketName("emails")
                .position(2)
                .build())
            .scanEnabled(true)
            .build());

    }
}

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=[aws.ses.ReceiptRuleAddHeaderActionArgs(
        header_name="Custom-Header",
        header_value="Added by SES",
        position=1,
    )],
    enabled=True,
    recipients=["karen@example.com"],
    rule_set_name="default-rule-set",
    s3_actions=[aws.ses.ReceiptRuleS3ActionArgs(
        bucket_name="emails",
        position=2,
    )],
    scan_enabled=True)

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,
    }],
    enabled: true,
    recipients: ["karen@example.com"],
    ruleSetName: "default-rule-set",
    s3Actions: [{
        bucketName: "emails",
        position: 2,
    }],
    scanEnabled: true,
});

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
      enabled: true
      recipients:
        - karen@example.com
      ruleSetName: default-rule-set
      s3Actions:
        - bucketName: emails
          position: 2
      scanEnabled: true

Create ReceiptRule Resource

new ReceiptRule(name: string, args: ReceiptRuleArgs, opts?: CustomResourceOptions);

@overload
def ReceiptRule(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                add_header_actions: Optional[Sequence[ReceiptRuleAddHeaderActionArgs]] = None,
                after: 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)
@overload
def ReceiptRule(resource_name: str,
                args: ReceiptRuleArgs,
                opts: Optional[ResourceOptions] = 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.

name string: The unique name of the resource.
args ReceiptRuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ReceiptRuleArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ReceiptRuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ReceiptRuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ReceiptRuleArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ReceiptRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ReceiptRule resource accepts the following input properties:

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

Resource lookup is not supported in YAML

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>: 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 string: The name of the rule
Recipients List<string>: A list of email addresses
RuleSetName 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 string: The name of the rule
Recipients []string: A list of email addresses
RuleSetName 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 String: The name of the rule
recipients List<String>: A list of email addresses
ruleSetName 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 string: The name of the rule
recipients string[]: A list of email addresses
ruleSetName 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 str: The name of the rule
recipients Sequence[str]: A list of email addresses
rule_set_name 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 String: The name of the rule
recipients List<String>: A list of email addresses
ruleSetName 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 string: The name of the header to add
HeaderValue string: The value of the header to add
Position int: The position of the action in the receipt rule

HeaderName string: The name of the header to add
HeaderValue string: The value of the header to add
Position int: The position of the action in the receipt rule

headerName String: The name of the header to add
headerValue String: The value of the header to add
position Integer: The position of the action in the receipt rule

headerName string: The name of the header to add
headerValue string: The value of the header to add
position number: The position of the action in the receipt rule

header_name str: The name of the header to add
header_value str: The value of the header to add
position int: The position of the action in the receipt rule

headerName String: The name of the header to add
headerValue String: The value of the header to add
position Number: The position of the action in the receipt rule

ReceiptRuleBounceAction, ReceiptRuleBounceActionArgs

Message string: The message to send
Position int: The position of the action in the receipt rule
Sender string: The email address of the sender
SmtpReplyCode 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 string: The message to send
Position int: The position of the action in the receipt rule
Sender string: The email address of the sender
SmtpReplyCode 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 String: The message to send
position Integer: The position of the action in the receipt rule
sender String: The email address of the sender
smtpReplyCode 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 string: The message to send
position number: The position of the action in the receipt rule
sender string: The email address of the sender
smtpReplyCode 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 str: The message to send
position int: The position of the action in the receipt rule
sender str: The email address of the sender
smtp_reply_code 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 String: The message to send
position Number: The position of the action in the receipt rule
sender String: The email address of the sender
smtpReplyCode 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 string: The ARN of the Lambda function to invoke
Position 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 string: The ARN of the Lambda function to invoke
Position 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 String: The ARN of the Lambda function to invoke
position 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 string: The ARN of the Lambda function to invoke
position 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 str: The ARN of the Lambda function to invoke
position 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 String: The ARN of the Lambda function to invoke
position 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 string: The name of the S3 bucket
Position int: The position of the action in the receipt rule
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 string: The name of the S3 bucket
Position int: The position of the action in the receipt rule
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 String: The name of the S3 bucket
position Integer: The position of the action in the receipt rule
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 string: The name of the S3 bucket
position number: The position of the action in the receipt rule
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 str: The name of the S3 bucket
position int: The position of the action in the receipt rule
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 String: The name of the S3 bucket
position Number: The position of the action in the receipt rule
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 int: The position of the action in the receipt rule
TopicArn 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 int: The position of the action in the receipt rule
TopicArn 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 Integer: The position of the action in the receipt rule
topicArn 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 number: The position of the action in the receipt rule
topicArn 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 int: The position of the action in the receipt rule
topic_arn 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 Number: The position of the action in the receipt rule
topicArn 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 int: The position of the action in the receipt rule
Scope string: The scope to apply. The only acceptable value is RuleSet.
TopicArn string: The ARN of an SNS topic to notify

Position int: The position of the action in the receipt rule
Scope string: The scope to apply. The only acceptable value is RuleSet.
TopicArn string: The ARN of an SNS topic to notify

position Integer: The position of the action in the receipt rule
scope String: The scope to apply. The only acceptable value is RuleSet.
topicArn String: The ARN of an SNS topic to notify

position number: The position of the action in the receipt rule
scope string: The scope to apply. The only acceptable value is RuleSet.
topicArn string: The ARN of an SNS topic to notify

position int: The position of the action in the receipt rule
scope str: The scope to apply. The only acceptable value is RuleSet.
topic_arn str: The ARN of an SNS topic to notify

position Number: The position of the action in the receipt rule
scope String: The scope to apply. The only acceptable value is RuleSet.
topicArn String: The ARN of an SNS topic to notify

ReceiptRuleWorkmailAction, ReceiptRuleWorkmailActionArgs

OrganizationArn string: The ARN of the WorkMail organization
Position int: The position of the action in the receipt rule
TopicArn string: The ARN of an SNS topic to notify

OrganizationArn string: The ARN of the WorkMail organization
Position int: The position of the action in the receipt rule
TopicArn string: The ARN of an SNS topic to notify

organizationArn String: The ARN of the WorkMail organization
position Integer: The position of the action in the receipt rule
topicArn String: The ARN of an SNS topic to notify

organizationArn string: The ARN of the WorkMail organization
position number: The position of the action in the receipt rule
topicArn string: The ARN of an SNS topic to notify

organization_arn str: The ARN of the WorkMail organization
position int: The position of the action in the receipt rule
topic_arn str: The ARN of an SNS topic to notify

organizationArn String: The ARN of the WorkMail organization
position 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

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi

pulumi/pulumi-aws

aws.ses.ReceiptRule

On this page

On this page

Example Usage

Create ReceiptRule Resource

ReceiptRule Resource Properties

Inputs

Outputs

Look up Existing ReceiptRule Resource

Supporting Types

ReceiptRuleAddHeaderAction, ReceiptRuleAddHeaderActionArgs

ReceiptRuleBounceAction, ReceiptRuleBounceActionArgs

ReceiptRuleLambdaAction, ReceiptRuleLambdaActionArgs

ReceiptRuleS3Action, ReceiptRuleS3ActionArgs

ReceiptRuleSnsAction, ReceiptRuleSnsActionArgs

ReceiptRuleStopAction, ReceiptRuleStopActionArgs

ReceiptRuleWorkmailAction, ReceiptRuleWorkmailActionArgs

Import

Package Details

On this page

On this page