AWS Classic

v5.16.0 published on Saturday, Sep 24, 2022 by Pulumi

ConfigurationSet

Provides an SES configuration set resource.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Ses.ConfigurationSet("test");

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ses"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ses.NewConfigurationSet(ctx, "test", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ses.ConfigurationSet;
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 test = new ConfigurationSet("test");

    }
}

import pulumi
import pulumi_aws as aws

test = aws.ses.ConfigurationSet("test")

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

const test = new aws.ses.ConfigurationSet("test", {});

resources:
  test:
    type: aws:ses:ConfigurationSet

Require TLS Connections

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Ses.ConfigurationSet("test", new()
    {
        DeliveryOptions = new Aws.Ses.Inputs.ConfigurationSetDeliveryOptionsArgs
        {
            TlsPolicy = "Require",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ses"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ses.NewConfigurationSet(ctx, "test", &ses.ConfigurationSetArgs{
			DeliveryOptions: &ses.ConfigurationSetDeliveryOptionsArgs{
				TlsPolicy: pulumi.String("Require"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ses.ConfigurationSet;
import com.pulumi.aws.ses.ConfigurationSetArgs;
import com.pulumi.aws.ses.inputs.ConfigurationSetDeliveryOptionsArgs;
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 test = new ConfigurationSet("test", ConfigurationSetArgs.builder()        
            .deliveryOptions(ConfigurationSetDeliveryOptionsArgs.builder()
                .tlsPolicy("Require")
                .build())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

test = aws.ses.ConfigurationSet("test", delivery_options=aws.ses.ConfigurationSetDeliveryOptionsArgs(
    tls_policy="Require",
))

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

const test = new aws.ses.ConfigurationSet("test", {
    deliveryOptions: {
        tlsPolicy: "Require",
    },
});

resources:
  test:
    type: aws:ses:ConfigurationSet
    properties:
      deliveryOptions:
        tlsPolicy: Require

Create a ConfigurationSet Resource

new ConfigurationSet(name: string, args?: ConfigurationSetArgs, opts?: CustomResourceOptions);

@overload
def ConfigurationSet(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     delivery_options: Optional[ConfigurationSetDeliveryOptionsArgs] = None,
                     name: Optional[str] = None,
                     reputation_metrics_enabled: Optional[bool] = None,
                     sending_enabled: Optional[bool] = None,
                     tracking_options: Optional[ConfigurationSetTrackingOptionsArgs] = None)
@overload
def ConfigurationSet(resource_name: str,
                     args: Optional[ConfigurationSetArgs] = None,
                     opts: Optional[ResourceOptions] = None)

func NewConfigurationSet(ctx *Context, name string, args *ConfigurationSetArgs, opts ...ResourceOption) (*ConfigurationSet, error)

public ConfigurationSet(string name, ConfigurationSetArgs? args = null, CustomResourceOptions? opts = null)

public ConfigurationSet(String name, ConfigurationSetArgs args)
public ConfigurationSet(String name, ConfigurationSetArgs args, CustomResourceOptions options)

type: aws:ses:ConfigurationSet
properties: # The arguments to resource properties.
options: # 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.

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.

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:

DeliveryOptions Pulumi.Aws.Ses.Inputs.ConfigurationSetDeliveryOptionsArgs: Whether messages that use the configuration set are required to use TLS. See below.
Name string: Name of the configuration set.
ReputationMetricsEnabled bool: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
SendingEnabled bool: Whether email sending is enabled or disabled for the configuration set. The default value is true.
TrackingOptions Pulumi.Aws.Ses.Inputs.ConfigurationSetTrackingOptionsArgs: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

DeliveryOptions ConfigurationSetDeliveryOptionsArgs: Whether messages that use the configuration set are required to use TLS. See below.
Name string: Name of the configuration set.
ReputationMetricsEnabled bool: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
SendingEnabled bool: Whether email sending is enabled or disabled for the configuration set. The default value is true.
TrackingOptions ConfigurationSetTrackingOptionsArgs: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

deliveryOptions ConfigurationSetDeliveryOptionsArgs: Whether messages that use the configuration set are required to use TLS. See below.
name String: Name of the configuration set.
reputationMetricsEnabled Boolean: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
sendingEnabled Boolean: Whether email sending is enabled or disabled for the configuration set. The default value is true.
trackingOptions ConfigurationSetTrackingOptionsArgs: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

deliveryOptions ConfigurationSetDeliveryOptionsArgs: Whether messages that use the configuration set are required to use TLS. See below.
name string: Name of the configuration set.
reputationMetricsEnabled boolean: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
sendingEnabled boolean: Whether email sending is enabled or disabled for the configuration set. The default value is true.
trackingOptions ConfigurationSetTrackingOptionsArgs: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

delivery_options ConfigurationSetDeliveryOptionsArgs: Whether messages that use the configuration set are required to use TLS. See below.
name str: Name of the configuration set.
reputation_metrics_enabled bool: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
sending_enabled bool: Whether email sending is enabled or disabled for the configuration set. The default value is true.
tracking_options ConfigurationSetTrackingOptionsArgs: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

deliveryOptions Property Map: Whether messages that use the configuration set are required to use TLS. See below.
name String: Name of the configuration set.
reputationMetricsEnabled Boolean: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
sendingEnabled Boolean: Whether email sending is enabled or disabled for the configuration set. The default value is true.
trackingOptions Property Map: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

Outputs

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

Arn string: SES configuration set ARN.
Id string: The provider-assigned unique ID for this managed resource.
LastFreshStart string: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.

Arn string: SES configuration set ARN.
Id string: The provider-assigned unique ID for this managed resource.
LastFreshStart string: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.

arn String: SES configuration set ARN.
id String: The provider-assigned unique ID for this managed resource.
lastFreshStart String: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.

arn string: SES configuration set ARN.
id string: The provider-assigned unique ID for this managed resource.
lastFreshStart string: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.

arn str: SES configuration set ARN.
id str: The provider-assigned unique ID for this managed resource.
last_fresh_start str: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.

arn String: SES configuration set ARN.
id String: The provider-assigned unique ID for this managed resource.
lastFreshStart String: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.

Look up an 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,
        delivery_options: Optional[ConfigurationSetDeliveryOptionsArgs] = None,
        last_fresh_start: Optional[str] = None,
        name: Optional[str] = None,
        reputation_metrics_enabled: Optional[bool] = None,
        sending_enabled: Optional[bool] = None,
        tracking_options: Optional[ConfigurationSetTrackingOptionsArgs] = 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: SES configuration set ARN.
DeliveryOptions Pulumi.Aws.Ses.Inputs.ConfigurationSetDeliveryOptionsArgs: Whether messages that use the configuration set are required to use TLS. See below.
LastFreshStart string: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.
Name string: Name of the configuration set.
ReputationMetricsEnabled bool: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
SendingEnabled bool: Whether email sending is enabled or disabled for the configuration set. The default value is true.
TrackingOptions Pulumi.Aws.Ses.Inputs.ConfigurationSetTrackingOptionsArgs: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

Arn string: SES configuration set ARN.
DeliveryOptions ConfigurationSetDeliveryOptionsArgs: Whether messages that use the configuration set are required to use TLS. See below.
LastFreshStart string: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.
Name string: Name of the configuration set.
ReputationMetricsEnabled bool: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
SendingEnabled bool: Whether email sending is enabled or disabled for the configuration set. The default value is true.
TrackingOptions ConfigurationSetTrackingOptionsArgs: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

arn String: SES configuration set ARN.
deliveryOptions ConfigurationSetDeliveryOptionsArgs: Whether messages that use the configuration set are required to use TLS. See below.
lastFreshStart String: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.
name String: Name of the configuration set.
reputationMetricsEnabled Boolean: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
sendingEnabled Boolean: Whether email sending is enabled or disabled for the configuration set. The default value is true.
trackingOptions ConfigurationSetTrackingOptionsArgs: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

arn string: SES configuration set ARN.
deliveryOptions ConfigurationSetDeliveryOptionsArgs: Whether messages that use the configuration set are required to use TLS. See below.
lastFreshStart string: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.
name string: Name of the configuration set.
reputationMetricsEnabled boolean: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
sendingEnabled boolean: Whether email sending is enabled or disabled for the configuration set. The default value is true.
trackingOptions ConfigurationSetTrackingOptionsArgs: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

arn str: SES configuration set ARN.
delivery_options ConfigurationSetDeliveryOptionsArgs: Whether messages that use the configuration set are required to use TLS. See below.
last_fresh_start str: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.
name str: Name of the configuration set.
reputation_metrics_enabled bool: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
sending_enabled bool: Whether email sending is enabled or disabled for the configuration set. The default value is true.
tracking_options ConfigurationSetTrackingOptionsArgs: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

arn String: SES configuration set ARN.
deliveryOptions Property Map: Whether messages that use the configuration set are required to use TLS. See below.
lastFreshStart String: Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.
name String: Name of the configuration set.
reputationMetricsEnabled Boolean: Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is false.
sendingEnabled Boolean: Whether email sending is enabled or disabled for the configuration set. The default value is true.
trackingOptions Property Map: Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. NOTE: This functionality is best effort.

Supporting Types

ConfigurationSetDeliveryOptions

TlsPolicy string: Whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established. Valid values: Require or Optional. Defaults to Optional.

TlsPolicy string: Whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established. Valid values: Require or Optional. Defaults to Optional.

tlsPolicy String: Whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established. Valid values: Require or Optional. Defaults to Optional.

tlsPolicy string: Whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established. Valid values: Require or Optional. Defaults to Optional.

tls_policy str: Whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established. Valid values: Require or Optional. Defaults to Optional.

tlsPolicy String: Whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established. Valid values: Require or Optional. Defaults to Optional.

ConfigurationSetTrackingOptions

CustomRedirectDomain string: Custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

CustomRedirectDomain string: Custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

customRedirectDomain String: Custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

customRedirectDomain string: Custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

custom_redirect_domain str: Custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

customRedirectDomain String: Custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

Import

SES Configuration Sets can be imported using their name, e.g.,

 $ pulumi import aws:ses/configurationSet:ConfigurationSet test some-configuration-set-test

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.