Class ReceiptRule

Provides an SES receipt rule resource

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

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

}

Inheritance

System.Object

Resource

CustomResource

ReceiptRule

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Ses

Assembly: Pulumi.Aws.dll

Syntax

public class ReceiptRule : CustomResource

Constructors

ReceiptRule(String, ReceiptRuleArgs, CustomResourceOptions)

Create a ReceiptRule resource with the given unique name, arguments, and options.

Declaration

public ReceiptRule(string name, ReceiptRuleArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ReceiptRuleArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AddHeaderActions

A list of Add Header Action blocks. Documented below.

Declaration

public Output<ImmutableArray<ReceiptRuleAddHeaderAction>> AddHeaderActions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ReceiptRuleAddHeaderAction>>

After

The name of the rule to place this rule after

Declaration

public Output<string> After { get; }

Property Value

Type	Description
Output<System.String>

BounceActions

A list of Bounce Action blocks. Documented below.

Declaration

public Output<ImmutableArray<ReceiptRuleBounceAction>> BounceActions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ReceiptRuleBounceAction>>

Enabled

If true, the rule will be enabled

Declaration

public Output<bool> Enabled { get; }

Property Value

Type	Description
Output<System.Boolean>

LambdaActions

A list of Lambda Action blocks. Documented below.

Declaration

public Output<ImmutableArray<ReceiptRuleLambdaAction>> LambdaActions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ReceiptRuleLambdaAction>>

Name

The name of the rule

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Recipients

A list of email addresses

Declaration

public Output<ImmutableArray<string>> Recipients { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

RuleSetName

The name of the rule set

Declaration

public Output<string> RuleSetName { get; }

Property Value

Type	Description
Output<System.String>

S3Actions

A list of S3 Action blocks. Documented below.

Declaration

public Output<ImmutableArray<ReceiptRuleS3Action>> S3Actions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ReceiptRuleS3Action>>

ScanEnabled

If true, incoming emails will be scanned for spam and viruses

Declaration

public Output<bool> ScanEnabled { get; }

Property Value

Type	Description
Output<System.Boolean>

SnsActions

A list of SNS Action blocks. Documented below.

Declaration

public Output<ImmutableArray<ReceiptRuleSnsAction>> SnsActions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ReceiptRuleSnsAction>>

StopActions

A list of Stop Action blocks. Documented below.

Declaration

public Output<ImmutableArray<ReceiptRuleStopAction>> StopActions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ReceiptRuleStopAction>>

TlsPolicy

Require or Optional

Declaration

public Output<string> TlsPolicy { get; }

Property Value

Type	Description
Output<System.String>

WorkmailActions

A list of WorkMail Action blocks. Documented below.

Declaration

public Output<ImmutableArray<ReceiptRuleWorkmailAction>> WorkmailActions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ReceiptRuleWorkmailAction>>

Methods

Get(String, Input<String>, ReceiptRuleState, CustomResourceOptions)

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

Declaration

public static ReceiptRule Get(string name, Input<string> id, ReceiptRuleState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ReceiptRuleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ReceiptRule