Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sesv2
  5. ConfigurationSet
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.sesv2.ConfigurationSet

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    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", {
    configurationSetName: "example",
    deliveryOptions: {
        tlsPolicy: "REQUIRE",
    },
    reputationOptions: {
        reputationMetricsEnabled: false,
    },
    sendingOptions: {
        sendingEnabled: true,
    },
    suppressionOptions: {
        suppressedReasons: [
            "BOUNCE",
            "COMPLAINT",
        ],
    },
    trackingOptions: {
        customRedirectDomain: "example.com",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.sesv2.ConfigurationSet("example",
    configuration_set_name="example",
    delivery_options={
        "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",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			ConfigurationSetName: pulumi.String("example"),
			DeliveryOptions: &sesv2.ConfigurationSetDeliveryOptionsArgs{
				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"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        ConfigurationSetName = "example",
        DeliveryOptions = new Aws.SesV2.Inputs.ConfigurationSetDeliveryOptionsArgs
        {
            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",
        },
    });

});

    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.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 example = new ConfigurationSet("example", ConfigurationSetArgs.builder()
            .configurationSetName("example")
            .deliveryOptions(ConfigurationSetDeliveryOptionsArgs.builder()
                .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")
                .build())
            .build());

    }
}

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

    Create ConfigurationSet Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ConfigurationSet(name: string, args: ConfigurationSetArgs, opts?: CustomResourceOptions);
    @overload
def ConfigurationSet(resource_name: str,
                     args: ConfigurationSetArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def ConfigurationSet(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     configuration_set_name: Optional[str] = None,
                     delivery_options: Optional[ConfigurationSetDeliveryOptionsArgs] = None,
                     reputation_options: Optional[ConfigurationSetReputationOptionsArgs] = None,
                     sending_options: Optional[ConfigurationSetSendingOptionsArgs] = None,
                     suppression_options: Optional[ConfigurationSetSuppressionOptionsArgs] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     tracking_options: Optional[ConfigurationSetTrackingOptionsArgs] = None,
                     vdm_options: Optional[ConfigurationSetVdmOptionsArgs] = None)
    func NewConfigurationSet(ctx *Context, name string, args ConfigurationSetArgs, opts ...ResourceOption) (*ConfigurationSet, error)
    public ConfigurationSet(string name, ConfigurationSetArgs args, CustomResourceOptions? opts = null)
    public ConfigurationSet(String name, ConfigurationSetArgs args)
public ConfigurationSet(String name, ConfigurationSetArgs args, CustomResourceOptions options)

    type: aws:sesv2:ConfigurationSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ConfigurationSetArgs
    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 ConfigurationSetArgs
    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 ConfigurationSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigurationSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigurationSetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsConfigurationSetResource = new Aws.SesV2.ConfigurationSet("awsConfigurationSetResource", new()
{
    ConfigurationSetName = "string",
    DeliveryOptions = new Aws.SesV2.Inputs.ConfigurationSetDeliveryOptionsArgs
    {
        SendingPoolName = "string",
        TlsPolicy = "string",
    },
    ReputationOptions = new Aws.SesV2.Inputs.ConfigurationSetReputationOptionsArgs
    {
        LastFreshStart = "string",
        ReputationMetricsEnabled = false,
    },
    SendingOptions = new Aws.SesV2.Inputs.ConfigurationSetSendingOptionsArgs
    {
        SendingEnabled = false,
    },
    SuppressionOptions = new Aws.SesV2.Inputs.ConfigurationSetSuppressionOptionsArgs
    {
        SuppressedReasons = new[]
        {
            "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    TrackingOptions = new Aws.SesV2.Inputs.ConfigurationSetTrackingOptionsArgs
    {
        CustomRedirectDomain = "string",
    },
    VdmOptions = new Aws.SesV2.Inputs.ConfigurationSetVdmOptionsArgs
    {
        DashboardOptions = new Aws.SesV2.Inputs.ConfigurationSetVdmOptionsDashboardOptionsArgs
        {
            EngagementMetrics = "string",
        },
        GuardianOptions = new Aws.SesV2.Inputs.ConfigurationSetVdmOptionsGuardianOptionsArgs
        {
            OptimizedSharedDelivery = "string",
        },
    },
});

    example, err := sesv2.NewConfigurationSet(ctx, "awsConfigurationSetResource", &sesv2.ConfigurationSetArgs{
	ConfigurationSetName: pulumi.String("string"),
	DeliveryOptions: &sesv2.ConfigurationSetDeliveryOptionsArgs{
		SendingPoolName: pulumi.String("string"),
		TlsPolicy:       pulumi.String("string"),
	},
	ReputationOptions: &sesv2.ConfigurationSetReputationOptionsArgs{
		LastFreshStart:           pulumi.String("string"),
		ReputationMetricsEnabled: pulumi.Bool(false),
	},
	SendingOptions: &sesv2.ConfigurationSetSendingOptionsArgs{
		SendingEnabled: pulumi.Bool(false),
	},
	SuppressionOptions: &sesv2.ConfigurationSetSuppressionOptionsArgs{
		SuppressedReasons: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TrackingOptions: &sesv2.ConfigurationSetTrackingOptionsArgs{
		CustomRedirectDomain: pulumi.String("string"),
	},
	VdmOptions: &sesv2.ConfigurationSetVdmOptionsArgs{
		DashboardOptions: &sesv2.ConfigurationSetVdmOptionsDashboardOptionsArgs{
			EngagementMetrics: pulumi.String("string"),
		},
		GuardianOptions: &sesv2.ConfigurationSetVdmOptionsGuardianOptionsArgs{
			OptimizedSharedDelivery: pulumi.String("string"),
		},
	},
})

    var awsConfigurationSetResource = new ConfigurationSet("awsConfigurationSetResource", ConfigurationSetArgs.builder()
    .configurationSetName("string")
    .deliveryOptions(ConfigurationSetDeliveryOptionsArgs.builder()
        .sendingPoolName("string")
        .tlsPolicy("string")
        .build())
    .reputationOptions(ConfigurationSetReputationOptionsArgs.builder()
        .lastFreshStart("string")
        .reputationMetricsEnabled(false)
        .build())
    .sendingOptions(ConfigurationSetSendingOptionsArgs.builder()
        .sendingEnabled(false)
        .build())
    .suppressionOptions(ConfigurationSetSuppressionOptionsArgs.builder()
        .suppressedReasons("string")
        .build())
    .tags(Map.of("string", "string"))
    .trackingOptions(ConfigurationSetTrackingOptionsArgs.builder()
        .customRedirectDomain("string")
        .build())
    .vdmOptions(ConfigurationSetVdmOptionsArgs.builder()
        .dashboardOptions(ConfigurationSetVdmOptionsDashboardOptionsArgs.builder()
            .engagementMetrics("string")
            .build())
        .guardianOptions(ConfigurationSetVdmOptionsGuardianOptionsArgs.builder()
            .optimizedSharedDelivery("string")
            .build())
        .build())
    .build());

    aws_configuration_set_resource = aws.sesv2.ConfigurationSet("awsConfigurationSetResource",
    configuration_set_name="string",
    delivery_options={
        "sendingPoolName": "string",
        "tlsPolicy": "string",
    },
    reputation_options={
        "lastFreshStart": "string",
        "reputationMetricsEnabled": False,
    },
    sending_options={
        "sendingEnabled": False,
    },
    suppression_options={
        "suppressedReasons": ["string"],
    },
    tags={
        "string": "string",
    },
    tracking_options={
        "customRedirectDomain": "string",
    },
    vdm_options={
        "dashboardOptions": {
            "engagementMetrics": "string",
        },
        "guardianOptions": {
            "optimizedSharedDelivery": "string",
        },
    })

    const awsConfigurationSetResource = new aws.sesv2.ConfigurationSet("awsConfigurationSetResource", {
    configurationSetName: "string",
    deliveryOptions: {
        sendingPoolName: "string",
        tlsPolicy: "string",
    },
    reputationOptions: {
        lastFreshStart: "string",
        reputationMetricsEnabled: false,
    },
    sendingOptions: {
        sendingEnabled: false,
    },
    suppressionOptions: {
        suppressedReasons: ["string"],
    },
    tags: {
        string: "string",
    },
    trackingOptions: {
        customRedirectDomain: "string",
    },
    vdmOptions: {
        dashboardOptions: {
            engagementMetrics: "string",
        },
        guardianOptions: {
            optimizedSharedDelivery: "string",
        },
    },
});

    type: aws:sesv2:ConfigurationSet
properties:
    configurationSetName: string
    deliveryOptions:
        sendingPoolName: string
        tlsPolicy: string
    reputationOptions:
        lastFreshStart: string
        reputationMetricsEnabled: false
    sendingOptions:
        sendingEnabled: false
    suppressionOptions:
        suppressedReasons:
            - string
    tags:
        string: string
    trackingOptions:
        customRedirectDomain: string
    vdmOptions:
        dashboardOptions:
            engagementMetrics: string
        guardianOptions:
            optimizedSharedDelivery: string

    ConfigurationSet 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 ConfigurationSet resource accepts the following input properties:

    ConfigurationSetName string
    The name of the configuration set.
    DeliveryOptions ConfigurationSetDeliveryOptions
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    ReputationOptions ConfigurationSetReputationOptions
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    SendingOptions ConfigurationSetSendingOptions
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    SuppressionOptions ConfigurationSetSuppressionOptions
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    Tags Dictionary<string, string>
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TrackingOptions ConfigurationSetTrackingOptions
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    VdmOptions ConfigurationSetVdmOptions
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.
    ConfigurationSetName string
    The name of the configuration set.
    DeliveryOptions ConfigurationSetDeliveryOptionsArgs
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    ReputationOptions ConfigurationSetReputationOptionsArgs
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    SendingOptions ConfigurationSetSendingOptionsArgs
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    SuppressionOptions ConfigurationSetSuppressionOptionsArgs
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    Tags map[string]string
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TrackingOptions ConfigurationSetTrackingOptionsArgs
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    VdmOptions ConfigurationSetVdmOptionsArgs
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.
    configurationSetName String
    The name of the configuration set.
    deliveryOptions ConfigurationSetDeliveryOptions
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    reputationOptions ConfigurationSetReputationOptions
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    sendingOptions ConfigurationSetSendingOptions
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    suppressionOptions ConfigurationSetSuppressionOptions
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    tags Map<String,String>
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    trackingOptions ConfigurationSetTrackingOptions
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    vdmOptions ConfigurationSetVdmOptions
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.
    configurationSetName string
    The name of the configuration set.
    deliveryOptions ConfigurationSetDeliveryOptions
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    reputationOptions ConfigurationSetReputationOptions
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    sendingOptions ConfigurationSetSendingOptions
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    suppressionOptions ConfigurationSetSuppressionOptions
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    tags {[key: string]: string}
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    trackingOptions ConfigurationSetTrackingOptions
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    vdmOptions ConfigurationSetVdmOptions
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.
    configuration_set_name str
    The name of the configuration set.
    delivery_options ConfigurationSetDeliveryOptionsArgs
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    reputation_options ConfigurationSetReputationOptionsArgs
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    sending_options ConfigurationSetSendingOptionsArgs
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    suppression_options ConfigurationSetSuppressionOptionsArgs
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    tags Mapping[str, str]
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tracking_options ConfigurationSetTrackingOptionsArgs
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    vdm_options ConfigurationSetVdmOptionsArgs
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.
    configurationSetName String
    The name of the configuration set.
    deliveryOptions Property Map
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    reputationOptions Property Map
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    sendingOptions Property Map
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    suppressionOptions Property Map
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    tags Map<String>
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    trackingOptions Property Map
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    vdmOptions Property Map
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConfigurationSet resource produces the following output properties:

    Arn string
    ARN of the Configuration Set.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Configuration Set.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    ARN of the Configuration Set.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    ARN of the Configuration Set.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    ARN of the Configuration Set.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    ARN of the Configuration Set.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing ConfigurationSet Resource

    Get an existing ConfigurationSet 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?: ConfigurationSetState, opts?: CustomResourceOptions): ConfigurationSet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        configuration_set_name: Optional[str] = None,
        delivery_options: Optional[ConfigurationSetDeliveryOptionsArgs] = None,
        reputation_options: Optional[ConfigurationSetReputationOptionsArgs] = None,
        sending_options: Optional[ConfigurationSetSendingOptionsArgs] = None,
        suppression_options: Optional[ConfigurationSetSuppressionOptionsArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        tracking_options: Optional[ConfigurationSetTrackingOptionsArgs] = None,
        vdm_options: Optional[ConfigurationSetVdmOptionsArgs] = None) -> ConfigurationSet
    func GetConfigurationSet(ctx *Context, name string, id IDInput, state *ConfigurationSetState, opts ...ResourceOption) (*ConfigurationSet, error)
    public static ConfigurationSet Get(string name, Input<string> id, ConfigurationSetState? state, CustomResourceOptions? opts = null)
    public static ConfigurationSet get(String name, Output<String> id, ConfigurationSetState 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:
    Arn string
    ARN of the Configuration Set.
    ConfigurationSetName string
    The name of the configuration set.
    DeliveryOptions ConfigurationSetDeliveryOptions
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    ReputationOptions ConfigurationSetReputationOptions
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    SendingOptions ConfigurationSetSendingOptions
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    SuppressionOptions ConfigurationSetSuppressionOptions
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    Tags Dictionary<string, string>
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    TrackingOptions ConfigurationSetTrackingOptions
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    VdmOptions ConfigurationSetVdmOptions
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.
    Arn string
    ARN of the Configuration Set.
    ConfigurationSetName string
    The name of the configuration set.
    DeliveryOptions ConfigurationSetDeliveryOptionsArgs
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    ReputationOptions ConfigurationSetReputationOptionsArgs
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    SendingOptions ConfigurationSetSendingOptionsArgs
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    SuppressionOptions ConfigurationSetSuppressionOptionsArgs
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    Tags map[string]string
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    TrackingOptions ConfigurationSetTrackingOptionsArgs
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    VdmOptions ConfigurationSetVdmOptionsArgs
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.
    arn String
    ARN of the Configuration Set.
    configurationSetName String
    The name of the configuration set.
    deliveryOptions ConfigurationSetDeliveryOptions
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    reputationOptions ConfigurationSetReputationOptions
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    sendingOptions ConfigurationSetSendingOptions
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    suppressionOptions ConfigurationSetSuppressionOptions
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    tags Map<String,String>
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    trackingOptions ConfigurationSetTrackingOptions
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    vdmOptions ConfigurationSetVdmOptions
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.
    arn string
    ARN of the Configuration Set.
    configurationSetName string
    The name of the configuration set.
    deliveryOptions ConfigurationSetDeliveryOptions
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    reputationOptions ConfigurationSetReputationOptions
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    sendingOptions ConfigurationSetSendingOptions
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    suppressionOptions ConfigurationSetSuppressionOptions
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    tags {[key: string]: string}
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    trackingOptions ConfigurationSetTrackingOptions
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    vdmOptions ConfigurationSetVdmOptions
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.
    arn str
    ARN of the Configuration Set.
    configuration_set_name str
    The name of the configuration set.
    delivery_options ConfigurationSetDeliveryOptionsArgs
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    reputation_options ConfigurationSetReputationOptionsArgs
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    sending_options ConfigurationSetSendingOptionsArgs
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    suppression_options ConfigurationSetSuppressionOptionsArgs
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    tags Mapping[str, str]
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    tracking_options ConfigurationSetTrackingOptionsArgs
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    vdm_options ConfigurationSetVdmOptionsArgs
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.
    arn String
    ARN of the Configuration Set.
    configurationSetName String
    The name of the configuration set.
    deliveryOptions Property Map
    An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See delivery_options Block for details.
    reputationOptions Property Map
    An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See reputation_options Block for details.
    sendingOptions Property Map
    An object that defines whether or not Amazon SES can send email that you send using the configuration set. See sending_options Block for details.
    suppressionOptions Property Map
    An object that contains information about the suppression list preferences for your account. See suppression_options Block for details.
    tags Map<String>
    A map of tags to assign to the service. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    trackingOptions Property Map
    An object that defines the open and click tracking options for emails that you send using the configuration set. See tracking_options Block for details.
    vdmOptions Property Map
    An object that defines the VDM settings that apply to emails that you send using the configuration set. See vdm_options Block for details.

    Supporting Types

    ConfigurationSetDeliveryOptions, ConfigurationSetDeliveryOptionsArgs

    SendingPoolName string
    The name of the dedicated IP pool to associate with the configuration set.
    TlsPolicy string
    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). Valid values: REQUIRE, OPTIONAL.
    SendingPoolName string
    The name of the dedicated IP pool to associate with the configuration set.
    TlsPolicy string
    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). Valid values: REQUIRE, OPTIONAL.
    sendingPoolName String
    The name of the dedicated IP pool to associate with the configuration set.
    tlsPolicy String
    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). Valid values: REQUIRE, OPTIONAL.
    sendingPoolName string
    The name of the dedicated IP pool to associate with the configuration set.
    tlsPolicy string
    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). Valid values: REQUIRE, OPTIONAL.
    sending_pool_name str
    The name of the dedicated IP pool to associate with the configuration set.
    tls_policy str
    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). Valid values: REQUIRE, OPTIONAL.
    sendingPoolName String
    The name of the dedicated IP pool to associate with the configuration set.
    tlsPolicy String
    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). Valid values: REQUIRE, OPTIONAL.

    ConfigurationSetReputationOptions, ConfigurationSetReputationOptionsArgs

    LastFreshStart string
    The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
    ReputationMetricsEnabled bool
    If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
    LastFreshStart string
    The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
    ReputationMetricsEnabled bool
    If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
    lastFreshStart String
    The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
    reputationMetricsEnabled Boolean
    If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
    lastFreshStart string
    The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
    reputationMetricsEnabled boolean
    If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
    last_fresh_start str
    The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
    reputation_metrics_enabled bool
    If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
    lastFreshStart String
    The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
    reputationMetricsEnabled Boolean
    If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

    ConfigurationSetSendingOptions, ConfigurationSetSendingOptionsArgs

    SendingEnabled bool
    If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
    SendingEnabled bool
    If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
    sendingEnabled Boolean
    If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
    sendingEnabled boolean
    If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
    sending_enabled bool
    If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
    sendingEnabled Boolean
    If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

    ConfigurationSetSuppressionOptions, ConfigurationSetSuppressionOptionsArgs

    SuppressedReasons List<string>
    A list that contains the reasons that email addresses are automatically added to the suppression list for your account. Valid values: BOUNCE, COMPLAINT.
    SuppressedReasons []string
    A list that contains the reasons that email addresses are automatically added to the suppression list for your account. Valid values: BOUNCE, COMPLAINT.
    suppressedReasons List<String>
    A list that contains the reasons that email addresses are automatically added to the suppression list for your account. Valid values: BOUNCE, COMPLAINT.
    suppressedReasons string[]
    A list that contains the reasons that email addresses are automatically added to the suppression list for your account. Valid values: BOUNCE, COMPLAINT.
    suppressed_reasons Sequence[str]
    A list that contains the reasons that email addresses are automatically added to the suppression list for your account. Valid values: BOUNCE, COMPLAINT.
    suppressedReasons List<String>
    A list that contains the reasons that email addresses are automatically added to the suppression list for your account. Valid values: BOUNCE, COMPLAINT.

    ConfigurationSetTrackingOptions, ConfigurationSetTrackingOptionsArgs

    CustomRedirectDomain string
    The domain to use for tracking open and click events.
    CustomRedirectDomain string
    The domain to use for tracking open and click events.
    customRedirectDomain String
    The domain to use for tracking open and click events.
    customRedirectDomain string
    The domain to use for tracking open and click events.
    custom_redirect_domain str
    The domain to use for tracking open and click events.
    customRedirectDomain String
    The domain to use for tracking open and click events.

    ConfigurationSetVdmOptions, ConfigurationSetVdmOptionsArgs

    DashboardOptions ConfigurationSetVdmOptionsDashboardOptions
    Specifies additional settings for your VDM configuration as applicable to the Dashboard. See dashboard_options Block for details.
    GuardianOptions ConfigurationSetVdmOptionsGuardianOptions
    Specifies additional settings for your VDM configuration as applicable to the Guardian. See guardian_options Block for details.
    DashboardOptions ConfigurationSetVdmOptionsDashboardOptions
    Specifies additional settings for your VDM configuration as applicable to the Dashboard. See dashboard_options Block for details.
    GuardianOptions ConfigurationSetVdmOptionsGuardianOptions
    Specifies additional settings for your VDM configuration as applicable to the Guardian. See guardian_options Block for details.
    dashboardOptions ConfigurationSetVdmOptionsDashboardOptions
    Specifies additional settings for your VDM configuration as applicable to the Dashboard. See dashboard_options Block for details.
    guardianOptions ConfigurationSetVdmOptionsGuardianOptions
    Specifies additional settings for your VDM configuration as applicable to the Guardian. See guardian_options Block for details.
    dashboardOptions ConfigurationSetVdmOptionsDashboardOptions
    Specifies additional settings for your VDM configuration as applicable to the Dashboard. See dashboard_options Block for details.
    guardianOptions ConfigurationSetVdmOptionsGuardianOptions
    Specifies additional settings for your VDM configuration as applicable to the Guardian. See guardian_options Block for details.
    dashboard_options ConfigurationSetVdmOptionsDashboardOptions
    Specifies additional settings for your VDM configuration as applicable to the Dashboard. See dashboard_options Block for details.
    guardian_options ConfigurationSetVdmOptionsGuardianOptions
    Specifies additional settings for your VDM configuration as applicable to the Guardian. See guardian_options Block for details.
    dashboardOptions Property Map
    Specifies additional settings for your VDM configuration as applicable to the Dashboard. See dashboard_options Block for details.
    guardianOptions Property Map
    Specifies additional settings for your VDM configuration as applicable to the Guardian. See guardian_options Block for details.

    ConfigurationSetVdmOptionsDashboardOptions, ConfigurationSetVdmOptionsDashboardOptionsArgs

    EngagementMetrics string
    Specifies the status of your VDM engagement metrics collection. Valid values: ENABLED, DISABLED.
    EngagementMetrics string
    Specifies the status of your VDM engagement metrics collection. Valid values: ENABLED, DISABLED.
    engagementMetrics String
    Specifies the status of your VDM engagement metrics collection. Valid values: ENABLED, DISABLED.
    engagementMetrics string
    Specifies the status of your VDM engagement metrics collection. Valid values: ENABLED, DISABLED.
    engagement_metrics str
    Specifies the status of your VDM engagement metrics collection. Valid values: ENABLED, DISABLED.
    engagementMetrics String
    Specifies the status of your VDM engagement metrics collection. Valid values: ENABLED, DISABLED.

    ConfigurationSetVdmOptionsGuardianOptions, ConfigurationSetVdmOptionsGuardianOptionsArgs

    OptimizedSharedDelivery string
    Specifies the status of your VDM optimized shared delivery. Valid values: ENABLED, DISABLED.
    OptimizedSharedDelivery string
    Specifies the status of your VDM optimized shared delivery. Valid values: ENABLED, DISABLED.
    optimizedSharedDelivery String
    Specifies the status of your VDM optimized shared delivery. Valid values: ENABLED, DISABLED.
    optimizedSharedDelivery string
    Specifies the status of your VDM optimized shared delivery. Valid values: ENABLED, DISABLED.
    optimized_shared_delivery str
    Specifies the status of your VDM optimized shared delivery. Valid values: ENABLED, DISABLED.
    optimizedSharedDelivery String
    Specifies the status of your VDM optimized shared delivery. Valid values: ENABLED, DISABLED.

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws