ConfigurationSet class

Resource for managing an AWS SESv2 (Simple Email V2) Configuration Set.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.sesv2.ConfigurationSet("example", {
    deliveryOptions: {
        maxDeliverySeconds: 300,
        tlsPolicy: "REQUIRE",
    },
    reputationOptions: {
        reputationMetricsEnabled: false,
    },
    sendingOptions: {
        sendingEnabled: true,
    },
    suppressionOptions: {
        suppressedReasons: [
            "BOUNCE",
            "COMPLAINT",
        ],
    },
    trackingOptions: {
        customRedirectDomain: "example.com",
        httpsPolicy: "REQUIRE",
    },
    configurationSetName: "example",
});
import pulumi
import pulumi_aws as aws

example = aws.sesv2.ConfigurationSet("example",
    delivery_options={
        "max_delivery_seconds": 300,
        "tls_policy": "REQUIRE",
    },
    reputation_options={
        "reputation_metrics_enabled": False,
    },
    sending_options={
        "sending_enabled": True,
    },
    suppression_options={
        "suppressed_reasons": [
            "BOUNCE",
            "COMPLAINT",
        ],
    },
    tracking_options={
        "custom_redirect_domain": "example.com",
        "https_policy": "REQUIRE",
    },
    configuration_set_name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.SesV2.ConfigurationSet("example", new()
    {
        DeliveryOptions = new Aws.SesV2.Inputs.ConfigurationSetDeliveryOptionsArgs
        {
            MaxDeliverySeconds = 300,
            TlsPolicy = "REQUIRE",
        },
        ReputationOptions = new Aws.SesV2.Inputs.ConfigurationSetReputationOptionsArgs
        {
            ReputationMetricsEnabled = false,
        },
        SendingOptions = new Aws.SesV2.Inputs.ConfigurationSetSendingOptionsArgs
        {
            SendingEnabled = true,
        },
        SuppressionOptions = new Aws.SesV2.Inputs.ConfigurationSetSuppressionOptionsArgs
        {
            SuppressedReasons = new[]
            {
                "BOUNCE",
                "COMPLAINT",
            },
        },
        TrackingOptions = new Aws.SesV2.Inputs.ConfigurationSetTrackingOptionsArgs
        {
            CustomRedirectDomain = "example.com",
            HttpsPolicy = "REQUIRE",
        },
        ConfigurationSetName = "example",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sesv2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sesv2.NewConfigurationSet(ctx, "example", &sesv2.ConfigurationSetArgs{
			DeliveryOptions: &sesv2.ConfigurationSetDeliveryOptionsArgs{
				MaxDeliverySeconds: pulumi.Int(300),
				TlsPolicy:          pulumi.String("REQUIRE"),
			},
			ReputationOptions: &sesv2.ConfigurationSetReputationOptionsArgs{
				ReputationMetricsEnabled: pulumi.Bool(false),
			},
			SendingOptions: &sesv2.ConfigurationSetSendingOptionsArgs{
				SendingEnabled: pulumi.Bool(true),
			},
			SuppressionOptions: &sesv2.ConfigurationSetSuppressionOptionsArgs{
				SuppressedReasons: pulumi.StringArray{
					pulumi.String("BOUNCE"),
					pulumi.String("COMPLAINT"),
				},
			},
			TrackingOptions: &sesv2.ConfigurationSetTrackingOptionsArgs{
				CustomRedirectDomain: pulumi.String("example.com"),
				HttpsPolicy:          pulumi.String("REQUIRE"),
			},
			ConfigurationSetName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sesv2_configurationset" "example" {
  delivery_options = {
    max_delivery_seconds = 300
    tls_policy           = "REQUIRE"
  }
  reputation_options = {
    reputation_metrics_enabled = false
  }
  sending_options = {
    sending_enabled = true
  }
  suppression_options = {
    suppressed_reasons = ["BOUNCE", "COMPLAINT"]
  }
  tracking_options = {
    custom_redirect_domain = "example.com"
    https_policy           = "REQUIRE"
  }
  configuration_set_name = "example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sesv2.ConfigurationSet;
import com.pulumi.aws.sesv2.ConfigurationSetArgs;
import com.pulumi.aws.sesv2.inputs.ConfigurationSetDeliveryOptionsArgs;
import com.pulumi.aws.sesv2.inputs.ConfigurationSetReputationOptionsArgs;
import com.pulumi.aws.sesv2.inputs.ConfigurationSetSendingOptionsArgs;
import com.pulumi.aws.sesv2.inputs.ConfigurationSetSuppressionOptionsArgs;
import com.pulumi.aws.sesv2.inputs.ConfigurationSetTrackingOptionsArgs;
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) {
        var example = new ConfigurationSet("example", ConfigurationSetArgs.builder()
            .deliveryOptions(ConfigurationSetDeliveryOptionsArgs.builder()
                .maxDeliverySeconds(300)
                .tlsPolicy("REQUIRE")
                .build())
            .reputationOptions(ConfigurationSetReputationOptionsArgs.builder()
                .reputationMetricsEnabled(false)
                .build())
            .sendingOptions(ConfigurationSetSendingOptionsArgs.builder()
                .sendingEnabled(true)
                .build())
            .suppressionOptions(ConfigurationSetSuppressionOptionsArgs.builder()
                .suppressedReasons(
                    "BOUNCE",
                    "COMPLAINT")
                .build())
            .trackingOptions(ConfigurationSetTrackingOptionsArgs.builder()
                .customRedirectDomain("example.com")
                .httpsPolicy("REQUIRE")
                .build())
            .configurationSetName("example")
            .build());

    }
}
resources:
  example:
    type: aws:sesv2:ConfigurationSet
    properties:
      deliveryOptions:
        maxDeliverySeconds: 300
        tlsPolicy: REQUIRE
      reputationOptions:
        reputationMetricsEnabled: false
      sendingOptions:
        sendingEnabled: true
      suppressionOptions:
        suppressedReasons:
          - BOUNCE
          - COMPLAINT
      trackingOptions:
        customRedirectDomain: example.com
        httpsPolicy: REQUIRE
      configurationSetName: example

Import

Using pulumi import, import SESv2 (Simple Email V2) Configuration Set using the configurationSetName. For example:

$ pulumi import aws:sesv2/configurationSet:ConfigurationSet example example

Constructors

ConfigurationSet(String name, {ConfigurationSetArgs? args, CustomResourceOptions? options})
Creates a new ConfigurationSet. name The Pulumi resource name. args Arguments used to configure this ConfigurationSet. The set of arguments for ConfigurationSet. options Resource options controlling this resource's behavior.
ConfigurationSet.reference(String urn)
Creates a typed reference to an existing ConfigurationSet resource.

Properties

arn ↔ Output<String>
ARN of the Configuration Set.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
configurationSetName ↔ Output<String>
Name of the configuration set.
latefinal
deliveryOptions ↔ Output<ConfigurationSetDeliveryOptions?>
Object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See deliveryOptions Block for details.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
reputationOptions ↔ Output<ConfigurationSetReputationOptions>
Object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputationOptions Block for details.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sendingOptions ↔ Output<ConfigurationSetSendingOptions>
Object that defines whether or not Amazon SES can send email that you send using the configuration set. See sendingOptions Block for details.
latefinal
suppressionOptions ↔ Output<ConfigurationSetSuppressionOptions?>
Object that contains information about the suppression list preferences for your account. See suppressionOptions Block for details.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the service. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
trackingOptions ↔ Output<ConfigurationSetTrackingOptions?>
Object that defines the open and click tracking options for emails that you send using the configuration set. See trackingOptions Block for details.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vdmOptions ↔ Output<ConfigurationSetVdmOptions?>
Object that defines the VDM settings that apply to emails that you send using the configuration set. See vdmOptions Block for details.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ConfigurationSetState? state, CustomResourceOptions? options}) → ConfigurationSet
Gets an existing ConfigurationSet resource's state with the given name and id.