aws-cdk-lib/aws-ses/lib/configuration-set.d.ts

Version 2 of the AWS Cloud Development Kit library

import { Construct } from 'constructs';
import { ConfigurationSetEventDestination, ConfigurationSetEventDestinationOptions } from './configuration-set-event-destination';
import { IDedicatedIpPool } from './dedicated-ip-pool';
import { Duration, IResource, Resource } from '../../core';
/**
 * A configuration set
 */
export interface IConfigurationSet extends IResource {
    /**
     * The name of the configuration set
     *
     * @attribute
     */
    readonly configurationSetName: string;
}
/**
 * Properties for a configuration set
 */
export interface ConfigurationSetProps {
    /**
     * A name for the configuration set
     *
     * @default - a CloudFormation generated name
     */
    readonly configurationSetName?: string;
    /**
     * The dedicated IP pool to associate with the configuration set
     *
     * @default - do not use a dedicated IP pool
     */
    readonly dedicatedIpPool?: IDedicatedIpPool;
    /**
     * Specifies whether messages that use the configuration set are required to
     * use Transport Layer Security (TLS)
     *
     * @default ConfigurationSetTlsPolicy.OPTIONAL
     */
    readonly tlsPolicy?: ConfigurationSetTlsPolicy;
    /**
     * Whether to publish reputation metrics for the configuration set, such as
     * bounce and complaint rates, to Amazon CloudWatch
     *
     * @default true
     */
    readonly reputationMetrics?: boolean;
    /**
     * Whether email sending is enabled
     *
     * @default true
     */
    readonly sendingEnabled?: boolean;
    /**
     * The reasons for which recipient email addresses should be automatically added
     * to your account's suppression list
     *
     * @default - use account level settings
     */
    readonly suppressionReasons?: SuppressionReasons;
    /**
     * If true, account-level suppression list is disabled; email sent with this configuration set
     * will not use any suppression settings at all
     *
     * @default false
     */
    readonly disableSuppressionList?: boolean;
    /**
     * The custom subdomain that is used to redirect email recipients to the
     * Amazon SES event tracking domain
     *
     * @default - use the default awstrack.me domain
     */
    readonly customTrackingRedirectDomain?: string;
    /**
     * The https policy to use for tracking open and click events.
     *
     * @default - HttpsPolicy.OPTIONAL if customTrackingRedirectDomain is set, otherwise undefined
     */
    readonly customTrackingHttpsPolicy?: HttpsPolicy;
    /**
     * The Virtual Deliverability Manager (VDM) options that apply to the configuration set
     *
     * @default - VDM options not configured at the configuration set level. In this case, use account level settings. (To set the account level settings using CDK, use the `VdmAttributes` Construct.)
     */
    readonly vdmOptions?: VdmOptions;
    /**
     * The maximum amount of time that Amazon SES API v2 will attempt delivery of email.
     *
     * This value must be greater than or equal to 5 minutes and less than or equal to 14 hours.
     *
     * @default undefined - SES defaults to 14 hours
     */
    readonly maxDeliveryDuration?: Duration;
}
/**
 * Properties for the Virtual Deliverability Manager (VDM) options that apply to the configuration set
 */
export interface VdmOptions {
    /**
     * If true, engagement metrics are enabled for the configuration set
     *
     * @default - Engagement metrics not configured at the configuration set level. In this case, use account level settings.
     */
    readonly engagementMetrics?: boolean;
    /**
     * If true, optimized shared delivery is enabled for the configuration set
     *
     * @default - Optimized shared delivery not configured at the configuration set level. In this case, use account level settings.
     */
    readonly optimizedSharedDelivery?: boolean;
}
/**
 * TLS policy for a configuration set
 */
export declare enum ConfigurationSetTlsPolicy {
    /**
     * Messages are only delivered if a TLS connection can be established
     */
    REQUIRE = "REQUIRE",
    /**
     * Messages can be delivered in plain text if a TLS connection can't be established
     */
    OPTIONAL = "OPTIONAL"
}
/**
 * HTTPS policy option for the protocol of the open and click tracking links for your custom redirect domain.
 */
export declare enum HttpsPolicy {
    /**
     * Open and Click tracking links will both be wrapped using HTTPS.
     */
    REQUIRE = "REQUIRE",
    /**
     * Open tracking links will be wrapped using HTTPS.
     * Click tracking links will be wrapped using the original protocol of the link.
     */
    REQUIRE_OPEN_ONLY = "REQUIRE_OPEN_ONLY",
    /**
     * Open tracking links will be wrapped using HTTP.
     * Click tracking links will be wrapped using the original protocol of the link.
     */
    OPTIONAL = "OPTIONAL"
}
/**
 * Reasons for which recipient email addresses should be automatically added
 * to your account's suppression list
 */
export declare enum SuppressionReasons {
    /**
     * Bounces and complaints
     */
    BOUNCES_AND_COMPLAINTS = "BOUNCES_AND_COMPLAINTS",
    /**
     * Bounces only
     */
    BOUNCES_ONLY = "BOUNCES_ONLY",
    /**
     * Complaints only
     */
    COMPLAINTS_ONLY = "COMPLAINTS_ONLY"
}
/**
 * A configuration set
 */
export declare class ConfigurationSet extends Resource implements IConfigurationSet {
    /**
     * Uniquely identifies this class.
     */
    static readonly PROPERTY_INJECTION_ID: string;
    /**
     * Use an existing configuration set
     */
    static fromConfigurationSetName(scope: Construct, id: string, configurationSetName: string): IConfigurationSet;
    readonly configurationSetName: string;
    constructor(scope: Construct, id: string, props?: ConfigurationSetProps);
    /**
     * Adds an event destination to this configuration set
     */
    addEventDestination(id: string, options: ConfigurationSetEventDestinationOptions): ConfigurationSetEventDestination;
}