github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/ses/receiptRule.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package ses

import (
	"context"
	"reflect"

	"errors"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Provides an SES receipt rule resource
//
// ## Example Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// 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
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ## Import
//
// Using `pulumi import`, import SES receipt rules using the ruleset name and rule name separated by `:`. For example:
//
// ```sh
// $ pulumi import aws:ses/receiptRule:ReceiptRule my_rule my_rule_set:my_rule
// ```
type ReceiptRule struct {
	pulumi.CustomResourceState

	// A list of Add Header Action blocks. Documented below.
	AddHeaderActions ReceiptRuleAddHeaderActionArrayOutput `pulumi:"addHeaderActions"`
	// The name of the rule to place this rule after
	After pulumi.StringPtrOutput `pulumi:"after"`
	// The SES receipt rule ARN.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// A list of Bounce Action blocks. Documented below.
	BounceActions ReceiptRuleBounceActionArrayOutput `pulumi:"bounceActions"`
	// If true, the rule will be enabled
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
	// A list of Lambda Action blocks. Documented below.
	LambdaActions ReceiptRuleLambdaActionArrayOutput `pulumi:"lambdaActions"`
	// The name of the rule
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of email addresses
	Recipients pulumi.StringArrayOutput `pulumi:"recipients"`
	// The name of the rule set
	RuleSetName pulumi.StringOutput `pulumi:"ruleSetName"`
	// A list of S3 Action blocks. Documented below.
	S3Actions ReceiptRuleS3ActionArrayOutput `pulumi:"s3Actions"`
	// If true, incoming emails will be scanned for spam and viruses
	ScanEnabled pulumi.BoolPtrOutput `pulumi:"scanEnabled"`
	// A list of SNS Action blocks. Documented below.
	SnsActions ReceiptRuleSnsActionArrayOutput `pulumi:"snsActions"`
	// A list of Stop Action blocks. Documented below.
	StopActions ReceiptRuleStopActionArrayOutput `pulumi:"stopActions"`
	// `Require` or `Optional`
	TlsPolicy pulumi.StringOutput `pulumi:"tlsPolicy"`
	// A list of WorkMail Action blocks. Documented below.
	WorkmailActions ReceiptRuleWorkmailActionArrayOutput `pulumi:"workmailActions"`
}

// NewReceiptRule registers a new resource with the given unique name, arguments, and options.
func NewReceiptRule(ctx *pulumi.Context,
	name string, args *ReceiptRuleArgs, opts ...pulumi.ResourceOption) (*ReceiptRule, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.RuleSetName == nil {
		return nil, errors.New("invalid value for required argument 'RuleSetName'")
	}
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource ReceiptRule
	err := ctx.RegisterResource("aws:ses/receiptRule:ReceiptRule", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetReceiptRule gets an existing ReceiptRule resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetReceiptRule(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ReceiptRuleState, opts ...pulumi.ResourceOption) (*ReceiptRule, error) {
	var resource ReceiptRule
	err := ctx.ReadResource("aws:ses/receiptRule:ReceiptRule", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering ReceiptRule resources.
type receiptRuleState struct {
	// A list of Add Header Action blocks. Documented below.
	AddHeaderActions []ReceiptRuleAddHeaderAction `pulumi:"addHeaderActions"`
	// The name of the rule to place this rule after
	After *string `pulumi:"after"`
	// The SES receipt rule ARN.
	Arn *string `pulumi:"arn"`
	// A list of Bounce Action blocks. Documented below.
	BounceActions []ReceiptRuleBounceAction `pulumi:"bounceActions"`
	// If true, the rule will be enabled
	Enabled *bool `pulumi:"enabled"`
	// A list of Lambda Action blocks. Documented below.
	LambdaActions []ReceiptRuleLambdaAction `pulumi:"lambdaActions"`
	// The name of the rule
	Name *string `pulumi:"name"`
	// A list of email addresses
	Recipients []string `pulumi:"recipients"`
	// The name of the rule set
	RuleSetName *string `pulumi:"ruleSetName"`
	// A list of S3 Action blocks. Documented below.
	S3Actions []ReceiptRuleS3Action `pulumi:"s3Actions"`
	// If true, incoming emails will be scanned for spam and viruses
	ScanEnabled *bool `pulumi:"scanEnabled"`
	// A list of SNS Action blocks. Documented below.
	SnsActions []ReceiptRuleSnsAction `pulumi:"snsActions"`
	// A list of Stop Action blocks. Documented below.
	StopActions []ReceiptRuleStopAction `pulumi:"stopActions"`
	// `Require` or `Optional`
	TlsPolicy *string `pulumi:"tlsPolicy"`
	// A list of WorkMail Action blocks. Documented below.
	WorkmailActions []ReceiptRuleWorkmailAction `pulumi:"workmailActions"`
}

type ReceiptRuleState struct {
	// A list of Add Header Action blocks. Documented below.
	AddHeaderActions ReceiptRuleAddHeaderActionArrayInput
	// The name of the rule to place this rule after
	After pulumi.StringPtrInput
	// The SES receipt rule ARN.
	Arn pulumi.StringPtrInput
	// A list of Bounce Action blocks. Documented below.
	BounceActions ReceiptRuleBounceActionArrayInput
	// If true, the rule will be enabled
	Enabled pulumi.BoolPtrInput
	// A list of Lambda Action blocks. Documented below.
	LambdaActions ReceiptRuleLambdaActionArrayInput
	// The name of the rule
	Name pulumi.StringPtrInput
	// A list of email addresses
	Recipients pulumi.StringArrayInput
	// The name of the rule set
	RuleSetName pulumi.StringPtrInput
	// A list of S3 Action blocks. Documented below.
	S3Actions ReceiptRuleS3ActionArrayInput
	// If true, incoming emails will be scanned for spam and viruses
	ScanEnabled pulumi.BoolPtrInput
	// A list of SNS Action blocks. Documented below.
	SnsActions ReceiptRuleSnsActionArrayInput
	// A list of Stop Action blocks. Documented below.
	StopActions ReceiptRuleStopActionArrayInput
	// `Require` or `Optional`
	TlsPolicy pulumi.StringPtrInput
	// A list of WorkMail Action blocks. Documented below.
	WorkmailActions ReceiptRuleWorkmailActionArrayInput
}

func (ReceiptRuleState) ElementType() reflect.Type {
	return reflect.TypeOf((*receiptRuleState)(nil)).Elem()
}

type receiptRuleArgs struct {
	// A list of Add Header Action blocks. Documented below.
	AddHeaderActions []ReceiptRuleAddHeaderAction `pulumi:"addHeaderActions"`
	// The name of the rule to place this rule after
	After *string `pulumi:"after"`
	// A list of Bounce Action blocks. Documented below.
	BounceActions []ReceiptRuleBounceAction `pulumi:"bounceActions"`
	// If true, the rule will be enabled
	Enabled *bool `pulumi:"enabled"`
	// A list of Lambda Action blocks. Documented below.
	LambdaActions []ReceiptRuleLambdaAction `pulumi:"lambdaActions"`
	// The name of the rule
	Name *string `pulumi:"name"`
	// A list of email addresses
	Recipients []string `pulumi:"recipients"`
	// The name of the rule set
	RuleSetName string `pulumi:"ruleSetName"`
	// A list of S3 Action blocks. Documented below.
	S3Actions []ReceiptRuleS3Action `pulumi:"s3Actions"`
	// If true, incoming emails will be scanned for spam and viruses
	ScanEnabled *bool `pulumi:"scanEnabled"`
	// A list of SNS Action blocks. Documented below.
	SnsActions []ReceiptRuleSnsAction `pulumi:"snsActions"`
	// A list of Stop Action blocks. Documented below.
	StopActions []ReceiptRuleStopAction `pulumi:"stopActions"`
	// `Require` or `Optional`
	TlsPolicy *string `pulumi:"tlsPolicy"`
	// A list of WorkMail Action blocks. Documented below.
	WorkmailActions []ReceiptRuleWorkmailAction `pulumi:"workmailActions"`
}

// The set of arguments for constructing a ReceiptRule resource.
type ReceiptRuleArgs struct {
	// A list of Add Header Action blocks. Documented below.
	AddHeaderActions ReceiptRuleAddHeaderActionArrayInput
	// The name of the rule to place this rule after
	After pulumi.StringPtrInput
	// A list of Bounce Action blocks. Documented below.
	BounceActions ReceiptRuleBounceActionArrayInput
	// If true, the rule will be enabled
	Enabled pulumi.BoolPtrInput
	// A list of Lambda Action blocks. Documented below.
	LambdaActions ReceiptRuleLambdaActionArrayInput
	// The name of the rule
	Name pulumi.StringPtrInput
	// A list of email addresses
	Recipients pulumi.StringArrayInput
	// The name of the rule set
	RuleSetName pulumi.StringInput
	// A list of S3 Action blocks. Documented below.
	S3Actions ReceiptRuleS3ActionArrayInput
	// If true, incoming emails will be scanned for spam and viruses
	ScanEnabled pulumi.BoolPtrInput
	// A list of SNS Action blocks. Documented below.
	SnsActions ReceiptRuleSnsActionArrayInput
	// A list of Stop Action blocks. Documented below.
	StopActions ReceiptRuleStopActionArrayInput
	// `Require` or `Optional`
	TlsPolicy pulumi.StringPtrInput
	// A list of WorkMail Action blocks. Documented below.
	WorkmailActions ReceiptRuleWorkmailActionArrayInput
}

func (ReceiptRuleArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*receiptRuleArgs)(nil)).Elem()
}

type ReceiptRuleInput interface {
	pulumi.Input

	ToReceiptRuleOutput() ReceiptRuleOutput
	ToReceiptRuleOutputWithContext(ctx context.Context) ReceiptRuleOutput
}

func (*ReceiptRule) ElementType() reflect.Type {
	return reflect.TypeOf((**ReceiptRule)(nil)).Elem()
}

func (i *ReceiptRule) ToReceiptRuleOutput() ReceiptRuleOutput {
	return i.ToReceiptRuleOutputWithContext(context.Background())
}

func (i *ReceiptRule) ToReceiptRuleOutputWithContext(ctx context.Context) ReceiptRuleOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ReceiptRuleOutput)
}

// ReceiptRuleArrayInput is an input type that accepts ReceiptRuleArray and ReceiptRuleArrayOutput values.
// You can construct a concrete instance of `ReceiptRuleArrayInput` via:
//
//	ReceiptRuleArray{ ReceiptRuleArgs{...} }
type ReceiptRuleArrayInput interface {
	pulumi.Input

	ToReceiptRuleArrayOutput() ReceiptRuleArrayOutput
	ToReceiptRuleArrayOutputWithContext(context.Context) ReceiptRuleArrayOutput
}

type ReceiptRuleArray []ReceiptRuleInput

func (ReceiptRuleArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*ReceiptRule)(nil)).Elem()
}

func (i ReceiptRuleArray) ToReceiptRuleArrayOutput() ReceiptRuleArrayOutput {
	return i.ToReceiptRuleArrayOutputWithContext(context.Background())
}

func (i ReceiptRuleArray) ToReceiptRuleArrayOutputWithContext(ctx context.Context) ReceiptRuleArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ReceiptRuleArrayOutput)
}

// ReceiptRuleMapInput is an input type that accepts ReceiptRuleMap and ReceiptRuleMapOutput values.
// You can construct a concrete instance of `ReceiptRuleMapInput` via:
//
//	ReceiptRuleMap{ "key": ReceiptRuleArgs{...} }
type ReceiptRuleMapInput interface {
	pulumi.Input

	ToReceiptRuleMapOutput() ReceiptRuleMapOutput
	ToReceiptRuleMapOutputWithContext(context.Context) ReceiptRuleMapOutput
}

type ReceiptRuleMap map[string]ReceiptRuleInput

func (ReceiptRuleMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*ReceiptRule)(nil)).Elem()
}

func (i ReceiptRuleMap) ToReceiptRuleMapOutput() ReceiptRuleMapOutput {
	return i.ToReceiptRuleMapOutputWithContext(context.Background())
}

func (i ReceiptRuleMap) ToReceiptRuleMapOutputWithContext(ctx context.Context) ReceiptRuleMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(ReceiptRuleMapOutput)
}

type ReceiptRuleOutput struct{ *pulumi.OutputState }

func (ReceiptRuleOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**ReceiptRule)(nil)).Elem()
}

func (o ReceiptRuleOutput) ToReceiptRuleOutput() ReceiptRuleOutput {
	return o
}

func (o ReceiptRuleOutput) ToReceiptRuleOutputWithContext(ctx context.Context) ReceiptRuleOutput {
	return o
}

// A list of Add Header Action blocks. Documented below.
func (o ReceiptRuleOutput) AddHeaderActions() ReceiptRuleAddHeaderActionArrayOutput {
	return o.ApplyT(func(v *ReceiptRule) ReceiptRuleAddHeaderActionArrayOutput { return v.AddHeaderActions }).(ReceiptRuleAddHeaderActionArrayOutput)
}

// The name of the rule to place this rule after
func (o ReceiptRuleOutput) After() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *ReceiptRule) pulumi.StringPtrOutput { return v.After }).(pulumi.StringPtrOutput)
}

// The SES receipt rule ARN.
func (o ReceiptRuleOutput) Arn() pulumi.StringOutput {
	return o.ApplyT(func(v *ReceiptRule) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput)
}

// A list of Bounce Action blocks. Documented below.
func (o ReceiptRuleOutput) BounceActions() ReceiptRuleBounceActionArrayOutput {
	return o.ApplyT(func(v *ReceiptRule) ReceiptRuleBounceActionArrayOutput { return v.BounceActions }).(ReceiptRuleBounceActionArrayOutput)
}

// If true, the rule will be enabled
func (o ReceiptRuleOutput) Enabled() pulumi.BoolPtrOutput {
	return o.ApplyT(func(v *ReceiptRule) pulumi.BoolPtrOutput { return v.Enabled }).(pulumi.BoolPtrOutput)
}

// A list of Lambda Action blocks. Documented below.
func (o ReceiptRuleOutput) LambdaActions() ReceiptRuleLambdaActionArrayOutput {
	return o.ApplyT(func(v *ReceiptRule) ReceiptRuleLambdaActionArrayOutput { return v.LambdaActions }).(ReceiptRuleLambdaActionArrayOutput)
}

// The name of the rule
func (o ReceiptRuleOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v *ReceiptRule) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}

// A list of email addresses
func (o ReceiptRuleOutput) Recipients() pulumi.StringArrayOutput {
	return o.ApplyT(func(v *ReceiptRule) pulumi.StringArrayOutput { return v.Recipients }).(pulumi.StringArrayOutput)
}

// The name of the rule set
func (o ReceiptRuleOutput) RuleSetName() pulumi.StringOutput {
	return o.ApplyT(func(v *ReceiptRule) pulumi.StringOutput { return v.RuleSetName }).(pulumi.StringOutput)
}

// A list of S3 Action blocks. Documented below.
func (o ReceiptRuleOutput) S3Actions() ReceiptRuleS3ActionArrayOutput {
	return o.ApplyT(func(v *ReceiptRule) ReceiptRuleS3ActionArrayOutput { return v.S3Actions }).(ReceiptRuleS3ActionArrayOutput)
}

// If true, incoming emails will be scanned for spam and viruses
func (o ReceiptRuleOutput) ScanEnabled() pulumi.BoolPtrOutput {
	return o.ApplyT(func(v *ReceiptRule) pulumi.BoolPtrOutput { return v.ScanEnabled }).(pulumi.BoolPtrOutput)
}

// A list of SNS Action blocks. Documented below.
func (o ReceiptRuleOutput) SnsActions() ReceiptRuleSnsActionArrayOutput {
	return o.ApplyT(func(v *ReceiptRule) ReceiptRuleSnsActionArrayOutput { return v.SnsActions }).(ReceiptRuleSnsActionArrayOutput)
}

// A list of Stop Action blocks. Documented below.
func (o ReceiptRuleOutput) StopActions() ReceiptRuleStopActionArrayOutput {
	return o.ApplyT(func(v *ReceiptRule) ReceiptRuleStopActionArrayOutput { return v.StopActions }).(ReceiptRuleStopActionArrayOutput)
}

// `Require` or `Optional`
func (o ReceiptRuleOutput) TlsPolicy() pulumi.StringOutput {
	return o.ApplyT(func(v *ReceiptRule) pulumi.StringOutput { return v.TlsPolicy }).(pulumi.StringOutput)
}

// A list of WorkMail Action blocks. Documented below.
func (o ReceiptRuleOutput) WorkmailActions() ReceiptRuleWorkmailActionArrayOutput {
	return o.ApplyT(func(v *ReceiptRule) ReceiptRuleWorkmailActionArrayOutput { return v.WorkmailActions }).(ReceiptRuleWorkmailActionArrayOutput)
}

type ReceiptRuleArrayOutput struct{ *pulumi.OutputState }

func (ReceiptRuleArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*ReceiptRule)(nil)).Elem()
}

func (o ReceiptRuleArrayOutput) ToReceiptRuleArrayOutput() ReceiptRuleArrayOutput {
	return o
}

func (o ReceiptRuleArrayOutput) ToReceiptRuleArrayOutputWithContext(ctx context.Context) ReceiptRuleArrayOutput {
	return o
}

func (o ReceiptRuleArrayOutput) Index(i pulumi.IntInput) ReceiptRuleOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *ReceiptRule {
		return vs[0].([]*ReceiptRule)[vs[1].(int)]
	}).(ReceiptRuleOutput)
}

type ReceiptRuleMapOutput struct{ *pulumi.OutputState }

func (ReceiptRuleMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*ReceiptRule)(nil)).Elem()
}

func (o ReceiptRuleMapOutput) ToReceiptRuleMapOutput() ReceiptRuleMapOutput {
	return o
}

func (o ReceiptRuleMapOutput) ToReceiptRuleMapOutputWithContext(ctx context.Context) ReceiptRuleMapOutput {
	return o
}

func (o ReceiptRuleMapOutput) MapIndex(k pulumi.StringInput) ReceiptRuleOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *ReceiptRule {
		return vs[0].(map[string]*ReceiptRule)[vs[1].(string)]
	}).(ReceiptRuleOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*ReceiptRuleInput)(nil)).Elem(), &ReceiptRule{})
	pulumi.RegisterInputType(reflect.TypeOf((*ReceiptRuleArrayInput)(nil)).Elem(), ReceiptRuleArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*ReceiptRuleMapInput)(nil)).Elem(), ReceiptRuleMap{})
	pulumi.RegisterOutputType(ReceiptRuleOutput{})
	pulumi.RegisterOutputType(ReceiptRuleArrayOutput{})
	pulumi.RegisterOutputType(ReceiptRuleMapOutput{})
}