@pulumi/aws/ses/configurationSet.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Provides an SES configuration set resource.
 *
 * ## Example Usage
 *
 * ### Basic Example
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const test = new aws.ses.ConfigurationSet("test", {name: "some-configuration-set-test"});
 * ```
 *
 * ### Require TLS Connections
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const test = new aws.ses.ConfigurationSet("test", {
 *     name: "some-configuration-set-test",
 *     deliveryOptions: {
 *         tlsPolicy: "Require",
 *     },
 * });
 * ```
 *
 * ### Tracking Options
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const test = new aws.ses.ConfigurationSet("test", {
 *     name: "some-configuration-set-test",
 *     trackingOptions: {
 *         customRedirectDomain: "sub.example.com",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * Using `pulumi import`, import SES Configuration Sets using their `name`. For example:
 *
 * ```sh
 * $ pulumi import aws:ses/configurationSet:ConfigurationSet test some-configuration-set-test
 * ```
 */
export declare class ConfigurationSet extends pulumi.CustomResource {
    /**
     * Get an existing ConfigurationSet resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigurationSetState, opts?: pulumi.CustomResourceOptions): ConfigurationSet;
    /**
     * Returns true if the given object is an instance of ConfigurationSet.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is ConfigurationSet;
    /**
     * SES configuration set ARN.
     */
    readonly arn: pulumi.Output<string>;
    /**
     * Whether messages that use the configuration set are required to use TLS. See below.
     */
    readonly deliveryOptions: pulumi.Output<outputs.ses.ConfigurationSetDeliveryOptions | undefined>;
    /**
     * Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.
     */
    readonly lastFreshStart: pulumi.Output<string>;
    /**
     * Name of the configuration set.
     *
     * The following arguments are optional:
     */
    readonly name: pulumi.Output<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    readonly region: pulumi.Output<string>;
    /**
     * 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`.
     */
    readonly reputationMetricsEnabled: pulumi.Output<boolean | undefined>;
    /**
     * Whether email sending is enabled or disabled for the configuration set. The default value is `true`.
     */
    readonly sendingEnabled: pulumi.Output<boolean | undefined>;
    /**
     * Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. **NOTE:** This functionality is best effort.
     */
    readonly trackingOptions: pulumi.Output<outputs.ses.ConfigurationSetTrackingOptions | undefined>;
    /**
     * Create a ConfigurationSet resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args?: ConfigurationSetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ConfigurationSet resources.
 */
export interface ConfigurationSetState {
    /**
     * SES configuration set ARN.
     */
    arn?: pulumi.Input<string>;
    /**
     * Whether messages that use the configuration set are required to use TLS. See below.
     */
    deliveryOptions?: pulumi.Input<inputs.ses.ConfigurationSetDeliveryOptions>;
    /**
     * Date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.
     */
    lastFreshStart?: pulumi.Input<string>;
    /**
     * Name of the configuration set.
     *
     * The following arguments are optional:
     */
    name?: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * 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`.
     */
    reputationMetricsEnabled?: pulumi.Input<boolean>;
    /**
     * Whether email sending is enabled or disabled for the configuration set. The default value is `true`.
     */
    sendingEnabled?: pulumi.Input<boolean>;
    /**
     * Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. **NOTE:** This functionality is best effort.
     */
    trackingOptions?: pulumi.Input<inputs.ses.ConfigurationSetTrackingOptions>;
}
/**
 * The set of arguments for constructing a ConfigurationSet resource.
 */
export interface ConfigurationSetArgs {
    /**
     * Whether messages that use the configuration set are required to use TLS. See below.
     */
    deliveryOptions?: pulumi.Input<inputs.ses.ConfigurationSetDeliveryOptions>;
    /**
     * Name of the configuration set.
     *
     * The following arguments are optional:
     */
    name?: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * 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`.
     */
    reputationMetricsEnabled?: pulumi.Input<boolean>;
    /**
     * Whether email sending is enabled or disabled for the configuration set. The default value is `true`.
     */
    sendingEnabled?: pulumi.Input<boolean>;
    /**
     * Domain that is used to redirect email recipients to an Amazon SES-operated domain. See below. **NOTE:** This functionality is best effort.
     */
    trackingOptions?: pulumi.Input<inputs.ses.ConfigurationSetTrackingOptions>;
}