software.amazon.awscdk.services.pinpointemail

Class CfnConfigurationSet

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pinpointemail.CfnConfigurationSet

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.251Z")
 @Stability(value=Stable)
public class CfnConfigurationSet
extends CfnResource
implements IInspectable

A CloudFormation `AWS::PinpointEmail::ConfigurationSet`.

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

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.*;
 CfnConfigurationSet cfnConfigurationSet = CfnConfigurationSet.Builder.create(this, "MyCfnConfigurationSet")
         .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(TagsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trackingOptions(TrackingOptionsProperty.builder()
                 .customRedirectDomain("customRedirectDomain")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnConfigurationSet.Builder A fluent builder for CfnConfigurationSet.
static interface	CfnConfigurationSet.DeliveryOptionsProperty Used to associate a configuration set with a dedicated IP pool.
static interface	CfnConfigurationSet.ReputationOptionsProperty Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
static interface	CfnConfigurationSet.SendingOptionsProperty Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
static interface	CfnConfigurationSet.TagsProperty An object that defines the tags (keys and values) that you want to associate with the configuration set.
static interface	CfnConfigurationSet.TrackingOptionsProperty An object that defines the tracking options for a configuration set.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConfigurationSet(software.constructs.Construct scope, String id, CfnConfigurationSetProps props) Create a new `AWS::PinpointEmail::ConfigurationSet`.
protected	CfnConfigurationSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConfigurationSet(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
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.
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.
Object	getSendingOptions() An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
List<CfnConfigurationSet.TagsProperty>	getTags() An object that defines the tags (keys and values) that you want to associate with the configuration set.
Object	getTrackingOptions() An object that defines the open and click tracking options for emails that you send using the configuration set.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDeliveryOptions(CfnConfigurationSet.DeliveryOptionsProperty value) An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
void	setDeliveryOptions(IResolvable value) An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
void	setName(String value) The name of the configuration set.
void	setReputationOptions(CfnConfigurationSet.ReputationOptionsProperty value) An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
void	setReputationOptions(IResolvable value) An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
void	setSendingOptions(CfnConfigurationSet.SendingOptionsProperty value) An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
void	setSendingOptions(IResolvable value) An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
void	setTags(List<CfnConfigurationSet.TagsProperty> value) An object that defines the tags (keys and values) that you want to associate with the configuration set.
void	setTrackingOptions(CfnConfigurationSet.TrackingOptionsProperty value) An object that defines the open and click tracking options for emails that you send using the configuration set.
void	setTrackingOptions(IResolvable value) An object that defines the open and click tracking options for emails that you send using the configuration set.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConfigurationSet

protected CfnConfigurationSet(software.amazon.jsii.JsiiObjectRef objRef)

CfnConfigurationSet

protected CfnConfigurationSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnConfigurationSet

@Stability(value=Stable)
public CfnConfigurationSet(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    CfnConfigurationSetProps props)

Create a new `AWS::PinpointEmail::ConfigurationSet`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the configuration set.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the configuration set.

getDeliveryOptions

@Stability(value=Stable)
 @Nullable
public Object getDeliveryOptions()

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

setDeliveryOptions

@Stability(value=Stable)
public void setDeliveryOptions(@Nullable
                                                        CfnConfigurationSet.DeliveryOptionsProperty value)

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

setDeliveryOptions

@Stability(value=Stable)
public void setDeliveryOptions(@Nullable
                                                        IResolvable value)

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

getReputationOptions

@Stability(value=Stable)
 @Nullable
public 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.

setReputationOptions

@Stability(value=Stable)
public void setReputationOptions(@Nullable
                                                          CfnConfigurationSet.ReputationOptionsProperty value)

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

setReputationOptions

@Stability(value=Stable)
public void setReputationOptions(@Nullable
                                                          IResolvable value)

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

getSendingOptions

@Stability(value=Stable)
 @Nullable
public Object getSendingOptions()

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

setSendingOptions

@Stability(value=Stable)
public void setSendingOptions(@Nullable
                                                       CfnConfigurationSet.SendingOptionsProperty value)

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

setSendingOptions

@Stability(value=Stable)
public void setSendingOptions(@Nullable
                                                       IResolvable value)

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

getTags

@Stability(value=Stable)
 @Nullable
public List<CfnConfigurationSet.TagsProperty> getTags()

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

setTags

@Stability(value=Stable)
public void setTags(@Nullable
                                             List<CfnConfigurationSet.TagsProperty> value)

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

getTrackingOptions

@Stability(value=Stable)
 @Nullable
public Object getTrackingOptions()

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

setTrackingOptions

@Stability(value=Stable)
public void setTrackingOptions(@Nullable
                                                        CfnConfigurationSet.TrackingOptionsProperty value)

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

setTrackingOptions

@Stability(value=Stable)
public void setTrackingOptions(@Nullable
                                                        IResolvable value)

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