Package software.amazon.awscdk.services.pinpointemail

Interface CfnConfigurationSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfigurationSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:43.250Z")
@Stability(Stable)
public interface CfnConfigurationSetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConfigurationSet.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpointemail.*;
 CfnConfigurationSetProps cfnConfigurationSetProps = CfnConfigurationSetProps.builder()
         .name("name")
         // the properties below are optional
         .deliveryOptions(DeliveryOptionsProperty.builder()
                 .sendingPoolName("sendingPoolName")
                 .build())
         .reputationOptions(ReputationOptionsProperty.builder()
                 .reputationMetricsEnabled(false)
                 .build())
         .sendingOptions(SendingOptionsProperty.builder()
                 .sendingEnabled(false)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trackingOptions(TrackingOptionsProperty.builder()
                 .customRedirectDomain("customRedirectDomain")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnConfigurationSetProps.Builder	builder()
default Object	getDeliveryOptions()	An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
String	getName()	The name of the configuration set.
default Object	getReputationOptions()	An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
default Object	getSendingOptions()	An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
default List<CfnTag>	getTags()	An object that defines the tags (keys and values) that you want to associate with the configuration set.
default Object	getTrackingOptions()	An object that defines the open and click tracking options for emails that you send using the configuration set.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the configuration set.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-name

getDeliveryOptions

@Stability(Stable)
@Nullable
default Object getDeliveryOptions()

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

Returns union: either IResolvable or CfnConfigurationSet.DeliveryOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-deliveryoptions

getReputationOptions

@Stability(Stable)
@Nullable
default Object getReputationOptions()

An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.

Returns union: either IResolvable or CfnConfigurationSet.ReputationOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-reputationoptions

getSendingOptions

@Stability(Stable)
@Nullable
default Object getSendingOptions()

An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

Returns union: either IResolvable or CfnConfigurationSet.SendingOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-sendingoptions

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An object that defines the tags (keys and values) that you want to associate with the configuration set.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-tags

getTrackingOptions

@Stability(Stable)
@Nullable
default Object getTrackingOptions()

An object that defines the open and click tracking options for emails that you send using the configuration set.

Returns union: either IResolvable or CfnConfigurationSet.TrackingOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-configurationset.html#cfn-pinpointemail-configurationset-trackingoptions

builder

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

Returns:

a CfnConfigurationSetProps.Builder of CfnConfigurationSetProps