Class ConfigurationSet.Builder
java.lang.Object
software.amazon.awscdk.services.ses.ConfigurationSet.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<ConfigurationSet>
- Enclosing class:
ConfigurationSet
@Stability(Stable)
public static final class ConfigurationSet.Builder
extends Object
implements software.amazon.jsii.Builder<ConfigurationSet>
A fluent builder for
ConfigurationSet
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
configurationSetName
(String configurationSetName) A name for the configuration set.static ConfigurationSet.Builder
customTrackingRedirectDomain
(String customTrackingRedirectDomain) The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.dedicatedIpPool
(IDedicatedIpPool dedicatedIpPool) The dedicated IP pool to associate with the configuration set.reputationMetrics
(Boolean reputationMetrics) Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.sendingEnabled
(Boolean sendingEnabled) Whether email sending is enabled.suppressionReasons
(SuppressionReasons suppressionReasons) The reasons for which recipient email addresses should be automatically added to your account's suppression list.tlsPolicy
(ConfigurationSetTlsPolicy tlsPolicy) Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).vdmOptions
(VdmOptions vdmOptions) The Virtual Deliverability Manager (VDM) options that apply to the configuration set.
-
Method Details
-
create
@Stability(Stable) public static ConfigurationSet.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
ConfigurationSet.Builder
.
-
configurationSetName
@Stability(Stable) public ConfigurationSet.Builder configurationSetName(String configurationSetName) A name for the configuration set.Default: - a CloudFormation generated name
- Parameters:
configurationSetName
- A name for the configuration set. This parameter is required.- Returns:
this
-
customTrackingRedirectDomain
@Stability(Stable) public ConfigurationSet.Builder customTrackingRedirectDomain(String customTrackingRedirectDomain) The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.Default: - use the default awstrack.me domain
- Parameters:
customTrackingRedirectDomain
- The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain. This parameter is required.- Returns:
this
-
dedicatedIpPool
@Stability(Stable) public ConfigurationSet.Builder dedicatedIpPool(IDedicatedIpPool dedicatedIpPool) The dedicated IP pool to associate with the configuration set.Default: - do not use a dedicated IP pool
- Parameters:
dedicatedIpPool
- The dedicated IP pool to associate with the configuration set. This parameter is required.- Returns:
this
-
reputationMetrics
Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.Default: true
- Parameters:
reputationMetrics
- Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. This parameter is required.- Returns:
this
-
sendingEnabled
Whether email sending is enabled.Default: true
- Parameters:
sendingEnabled
- Whether email sending is enabled. This parameter is required.- Returns:
this
-
suppressionReasons
@Stability(Stable) public ConfigurationSet.Builder suppressionReasons(SuppressionReasons suppressionReasons) The reasons for which recipient email addresses should be automatically added to your account's suppression list.Default: - use account level settings
- Parameters:
suppressionReasons
- The reasons for which recipient email addresses should be automatically added to your account's suppression list. This parameter is required.- Returns:
this
-
tlsPolicy
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).Default: ConfigurationSetTlsPolicy.OPTIONAL
- Parameters:
tlsPolicy
- Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). This parameter is required.- Returns:
this
-
vdmOptions
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.)
- Parameters:
vdmOptions
- The Virtual Deliverability Manager (VDM) options that apply to the configuration set. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<ConfigurationSet>
- Returns:
- a newly built instance of
ConfigurationSet
.
-