Package software.amazon.awscdk.services.ses

Interface ConfigurationSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ConfigurationSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.057Z")
@Stability(Stable)
public interface ConfigurationSetProps
extends software.amazon.jsii.JsiiSerializable

Properties for a configuration set.

Example:

 IDedicatedIpPool myPool;
 ConfigurationSet.Builder.create(this, "ConfigurationSet")
         .customTrackingRedirectDomain("track.cdk.dev")
         .suppressionReasons(SuppressionReasons.COMPLAINTS_ONLY)
         .tlsPolicy(ConfigurationSetTlsPolicy.REQUIRE)
         .dedicatedIpPool(myPool)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ConfigurationSetProps.Builder	A builder for ConfigurationSetProps
static final class	ConfigurationSetProps.Jsii$Proxy	An implementation for ConfigurationSetProps

Method Summary

Modifier and Type	Method	Description
static ConfigurationSetProps.Builder	builder()
default String	getConfigurationSetName()	A name for the configuration set.
default String	getCustomTrackingRedirectDomain()	The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
default IDedicatedIpPool	getDedicatedIpPool()	The dedicated IP pool to associate with the configuration set.
default Boolean	getReputationMetrics()	Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
default Boolean	getSendingEnabled()	Whether email sending is enabled.
default SuppressionReasons	getSuppressionReasons()	The reasons for which recipient email addresses should be automatically added to your account's suppression list.
default ConfigurationSetTlsPolicy	getTlsPolicy()	Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigurationSetName

@Stability(Stable)
@Nullable
default String getConfigurationSetName()

A name for the configuration set.

Default: - a CloudFormation generated name

getCustomTrackingRedirectDomain

@Stability(Stable)
@Nullable
default String getCustomTrackingRedirectDomain()

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

Default: - use the default awstrack.me domain

getDedicatedIpPool

@Stability(Stable)
@Nullable
default IDedicatedIpPool getDedicatedIpPool()

The dedicated IP pool to associate with the configuration set.

Default: - do not use a dedicated IP pool

getReputationMetrics

@Stability(Stable)
@Nullable
default Boolean getReputationMetrics()

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

Default: false

getSendingEnabled

@Stability(Stable)
@Nullable
default Boolean getSendingEnabled()

Whether email sending is enabled.

Default: true

getSuppressionReasons

@Stability(Stable)
@Nullable
default SuppressionReasons getSuppressionReasons()

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

Default: - use account level settings

getTlsPolicy

@Stability(Stable)
@Nullable
default ConfigurationSetTlsPolicy getTlsPolicy()

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

Default: ConfigurationSetTlsPolicy.OPTIONAL

builder

@Stability(Stable)
static ConfigurationSetProps.Builder builder()

Returns:

a ConfigurationSetProps.Builder of ConfigurationSetProps