Receipt Rule Args
data class ReceiptRuleArgs(val addHeaderActions: Output<List<ReceiptRuleAddHeaderActionArgs>>? = null, val after: Output<String>? = null, val bounceActions: Output<List<ReceiptRuleBounceActionArgs>>? = null, val enabled: Output<Boolean>? = null, val lambdaActions: Output<List<ReceiptRuleLambdaActionArgs>>? = null, val name: Output<String>? = null, val recipients: Output<List<String>>? = null, val ruleSetName: Output<String>? = null, val s3Actions: Output<List<ReceiptRuleS3ActionArgs>>? = null, val scanEnabled: Output<Boolean>? = null, val snsActions: Output<List<ReceiptRuleSnsActionArgs>>? = null, val stopActions: Output<List<ReceiptRuleStopActionArgs>>? = null, val tlsPolicy: Output<String>? = null, val workmailActions: Output<List<ReceiptRuleWorkmailActionArgs>>? = null) : ConvertibleToJava<ReceiptRuleArgs>
Provides an SES receipt rule resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
// Add a header to the email and store it in S3
const store = new aws.ses.ReceiptRule("store", {
name: "store",
ruleSetName: "default-rule-set",
recipients: ["karen@example.com"],
enabled: true,
scanEnabled: true,
addHeaderActions: [{
headerName: "Custom-Header",
headerValue: "Added by SES",
position: 1,
}],
s3Actions: [{
bucketName: "emails",
position: 2,
}],
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
# Add a header to the email and store it in S3
store = aws.ses.ReceiptRule("store",
name="store",
rule_set_name="default-rule-set",
recipients=["karen@example.com"],
enabled=True,
scan_enabled=True,
add_header_actions=[{
"header_name": "Custom-Header",
"header_value": "Added by SES",
"position": 1,
}],
s3_actions=[{
"bucket_name": "emails",
"position": 2,
}])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
// Add a header to the email and store it in S3
var store = new Aws.Ses.ReceiptRule("store", new()
{
Name = "store",
RuleSetName = "default-rule-set",
Recipients = new[]
{
"karen@example.com",
},
Enabled = true,
ScanEnabled = true,
AddHeaderActions = new[]
{
new Aws.Ses.Inputs.ReceiptRuleAddHeaderActionArgs
{
HeaderName = "Custom-Header",
HeaderValue = "Added by SES",
Position = 1,
},
},
S3Actions = new[]
{
new Aws.Ses.Inputs.ReceiptRuleS3ActionArgs
{
BucketName = "emails",
Position = 2,
},
},
});
});
Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ses"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Add a header to the email and store it in S3
_, err := ses.NewReceiptRule(ctx, "store", &ses.ReceiptRuleArgs{
Name: pulumi.String("store"),
RuleSetName: pulumi.String("default-rule-set"),
Recipients: pulumi.StringArray{
pulumi.String("karen@example.com"),
},
Enabled: pulumi.Bool(true),
ScanEnabled: pulumi.Bool(true),
AddHeaderActions: ses.ReceiptRuleAddHeaderActionArray{
&ses.ReceiptRuleAddHeaderActionArgs{
HeaderName: pulumi.String("Custom-Header"),
HeaderValue: pulumi.String("Added by SES"),
Position: pulumi.Int(1),
},
},
S3Actions: ses.ReceiptRuleS3ActionArray{
&ses.ReceiptRuleS3ActionArgs{
BucketName: pulumi.String("emails"),
Position: pulumi.Int(2),
},
},
})
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ses.ReceiptRule;
import com.pulumi.aws.ses.ReceiptRuleArgs;
import com.pulumi.aws.ses.inputs.ReceiptRuleAddHeaderActionArgs;
import com.pulumi.aws.ses.inputs.ReceiptRuleS3ActionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Add a header to the email and store it in S3
var store = new ReceiptRule("store", ReceiptRuleArgs.builder()
.name("store")
.ruleSetName("default-rule-set")
.recipients("karen@example.com")
.enabled(true)
.scanEnabled(true)
.addHeaderActions(ReceiptRuleAddHeaderActionArgs.builder()
.headerName("Custom-Header")
.headerValue("Added by SES")
.position(1)
.build())
.s3Actions(ReceiptRuleS3ActionArgs.builder()
.bucketName("emails")
.position(2)
.build())
.build());
}
}
Content copied to clipboard
resources:
# Add a header to the email and store it in S3
store:
type: aws:ses:ReceiptRule
properties:
name: store
ruleSetName: default-rule-set
recipients:
- karen@example.com
enabled: true
scanEnabled: true
addHeaderActions:
- headerName: Custom-Header
headerValue: Added by SES
position: 1
s3Actions:
- bucketName: emails
position: 2
Content copied to clipboard
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
Content copied to clipboard
Constructors
Link copied to clipboard
constructor(addHeaderActions: Output<List<ReceiptRuleAddHeaderActionArgs>>? = null, after: Output<String>? = null, bounceActions: Output<List<ReceiptRuleBounceActionArgs>>? = null, enabled: Output<Boolean>? = null, lambdaActions: Output<List<ReceiptRuleLambdaActionArgs>>? = null, name: Output<String>? = null, recipients: Output<List<String>>? = null, ruleSetName: Output<String>? = null, s3Actions: Output<List<ReceiptRuleS3ActionArgs>>? = null, scanEnabled: Output<Boolean>? = null, snsActions: Output<List<ReceiptRuleSnsActionArgs>>? = null, stopActions: Output<List<ReceiptRuleStopActionArgs>>? = null, tlsPolicy: Output<String>? = null, workmailActions: Output<List<ReceiptRuleWorkmailActionArgs>>? = null)
Properties
Link copied to clipboard
A list of Add Header Action blocks. Documented below.
Link copied to clipboard
A list of Bounce Action blocks. Documented below.
Link copied to clipboard
A list of Lambda Action blocks. Documented below.
Link copied to clipboard
A list of email addresses
Link copied to clipboard
The name of the rule set
Link copied to clipboard
A list of S3 Action blocks. Documented below.
Link copied to clipboard
If true, incoming emails will be scanned for spam and viruses
Link copied to clipboard
A list of SNS Action blocks. Documented below.
Link copied to clipboard
A list of Stop Action blocks. Documented below.
Link copied to clipboard
A list of WorkMail Action blocks. Documented below.