Interface IConfigurationSetProps

Properties for a configuration set.

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IConfigurationSetProps

Syntax (vb)

Public Interface IConfigurationSetProps

Remarks

ExampleMetadata: infused

Examples

new ConfigurationSet(this, "ConfigurationSetWithVdmOptions", new ConfigurationSetProps {
    VdmOptions = new VdmOptions {
        EngagementMetrics = true,
        OptimizedSharedDelivery = true
    }
});

Synopsis

Properties

ConfigurationSetName	A name for the configuration set.
CustomTrackingRedirectDomain	The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
DedicatedIpPool	The dedicated IP pool to associate with the configuration set.
DisableSuppressionList	If true, account-level suppression list is disabled;
MaxDeliveryDuration	The maximum amount of time that Amazon SES API v2 will attempt delivery of email.
ReputationMetrics	Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
SendingEnabled	Whether email sending is enabled.
SuppressionReasons	The reasons for which recipient email addresses should be automatically added to your account's suppression list.
TlsPolicy	Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
VdmOptions	The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

Properties

ConfigurationSetName

A name for the configuration set.

virtual string ConfigurationSetName { get; }

Property Value

System.String

Remarks

Default: - a CloudFormation generated name

CustomTrackingRedirectDomain

The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.

virtual string CustomTrackingRedirectDomain { get; }

Property Value

System.String

Remarks

Default: - use the default awstrack.me domain

DedicatedIpPool

The dedicated IP pool to associate with the configuration set.

virtual IDedicatedIpPool DedicatedIpPool { get; }

Property Value

IDedicatedIpPool

Remarks

Default: - do not use a dedicated IP pool

DisableSuppressionList

If true, account-level suppression list is disabled;

virtual Nullable<bool> DisableSuppressionList { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

email sent with this configuration set will not use any suppression settings at all

Default: false

MaxDeliveryDuration

The maximum amount of time that Amazon SES API v2 will attempt delivery of email.

virtual Duration MaxDeliveryDuration { get; }

Property Value

Duration

Remarks

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

ReputationMetrics

Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

virtual Nullable<bool> ReputationMetrics { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: true

SendingEnabled

Whether email sending is enabled.

virtual Nullable<bool> SendingEnabled { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: true

SuppressionReasons

The reasons for which recipient email addresses should be automatically added to your account's suppression list.

virtual Nullable<SuppressionReasons> SuppressionReasons { get; }

Property Value

System.Nullable<SuppressionReasons>

Remarks

Default: - use account level settings

TlsPolicy

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

virtual Nullable<ConfigurationSetTlsPolicy> TlsPolicy { get; }

Property Value

System.Nullable<ConfigurationSetTlsPolicy>

Remarks

Default: ConfigurationSetTlsPolicy.OPTIONAL

VdmOptions

The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

virtual IVdmOptions VdmOptions { get; }

Property Value

IVdmOptions

Remarks

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.)