software.amazon.awscdk.services.ses

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.ses.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:42.177Z")
 @Stability(value=Stable)
public class CfnConfigurationSet
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SES::ConfigurationSet`.

The name of the configuration set.

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

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.ses.*;
 CfnConfigurationSet cfnConfigurationSet = CfnConfigurationSet.Builder.create(this, "MyCfnConfigurationSet")
         .deliveryOptions(DeliveryOptionsProperty.builder()
                 .sendingPoolName("sendingPoolName")
                 .tlsPolicy("tlsPolicy")
                 .build())
         .name("name")
         .reputationOptions(ReputationOptionsProperty.builder()
                 .reputationMetricsEnabled(false)
                 .build())
         .sendingOptions(SendingOptionsProperty.builder()
                 .sendingEnabled(false)
                 .build())
         .suppressionOptions(SuppressionOptionsProperty.builder()
                 .suppressedReasons(List.of("suppressedReasons"))
                 .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 Example:
static interface	CfnConfigurationSet.ReputationOptionsProperty Example:
static interface	CfnConfigurationSet.SendingOptionsProperty Example:
static interface	CfnConfigurationSet.SuppressionOptionsProperty Example:
static interface	CfnConfigurationSet.TrackingOptionsProperty Example:

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) Create a new `AWS::SES::ConfigurationSet`.
	CfnConfigurationSet(software.constructs.Construct scope, String id, CfnConfigurationSetProps props) Create a new `AWS::SES::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() `AWS::SES::ConfigurationSet.DeliveryOptions`.
String	getName() The name of the configuration set.
Object	getReputationOptions() `AWS::SES::ConfigurationSet.ReputationOptions`.
Object	getSendingOptions() `AWS::SES::ConfigurationSet.SendingOptions`.
Object	getSuppressionOptions() `AWS::SES::ConfigurationSet.SuppressionOptions`.
Object	getTrackingOptions() `AWS::SES::ConfigurationSet.TrackingOptions`.
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) `AWS::SES::ConfigurationSet.DeliveryOptions`.
void	setDeliveryOptions(IResolvable value) `AWS::SES::ConfigurationSet.DeliveryOptions`.
void	setName(String value) The name of the configuration set.
void	setReputationOptions(CfnConfigurationSet.ReputationOptionsProperty value) `AWS::SES::ConfigurationSet.ReputationOptions`.
void	setReputationOptions(IResolvable value) `AWS::SES::ConfigurationSet.ReputationOptions`.
void	setSendingOptions(CfnConfigurationSet.SendingOptionsProperty value) `AWS::SES::ConfigurationSet.SendingOptions`.
void	setSendingOptions(IResolvable value) `AWS::SES::ConfigurationSet.SendingOptions`.
void	setSuppressionOptions(CfnConfigurationSet.SuppressionOptionsProperty value) `AWS::SES::ConfigurationSet.SuppressionOptions`.
void	setSuppressionOptions(IResolvable value) `AWS::SES::ConfigurationSet.SuppressionOptions`.
void	setTrackingOptions(CfnConfigurationSet.TrackingOptionsProperty value) `AWS::SES::ConfigurationSet.TrackingOptions`.
void	setTrackingOptions(IResolvable value) `AWS::SES::ConfigurationSet.TrackingOptions`.

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,
                                                    @Nullable
                                                    CfnConfigurationSetProps props)

Create a new `AWS::SES::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.

CfnConfigurationSet

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

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

Parameters:

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

id - - scoped id of the resource. 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

getDeliveryOptions

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

`AWS::SES::ConfigurationSet.DeliveryOptions`.

setDeliveryOptions

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

`AWS::SES::ConfigurationSet.DeliveryOptions`.

setDeliveryOptions

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

`AWS::SES::ConfigurationSet.DeliveryOptions`.

getName

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

The name of the configuration set. The name must meet the following requirements:.

• Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
• Contain 64 characters or fewer.

setName

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

The name of the configuration set. The name must meet the following requirements:.

• Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
• Contain 64 characters or fewer.

getReputationOptions

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

`AWS::SES::ConfigurationSet.ReputationOptions`.

setReputationOptions

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

`AWS::SES::ConfigurationSet.ReputationOptions`.

setReputationOptions

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

`AWS::SES::ConfigurationSet.ReputationOptions`.

getSendingOptions

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

`AWS::SES::ConfigurationSet.SendingOptions`.

setSendingOptions

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

`AWS::SES::ConfigurationSet.SendingOptions`.

setSendingOptions

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

`AWS::SES::ConfigurationSet.SendingOptions`.

getSuppressionOptions

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

`AWS::SES::ConfigurationSet.SuppressionOptions`.

setSuppressionOptions

@Stability(value=Stable)
public void setSuppressionOptions(@Nullable
                                                           CfnConfigurationSet.SuppressionOptionsProperty value)

`AWS::SES::ConfigurationSet.SuppressionOptions`.

setSuppressionOptions

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

`AWS::SES::ConfigurationSet.SuppressionOptions`.

getTrackingOptions

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

`AWS::SES::ConfigurationSet.TrackingOptions`.

setTrackingOptions

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

`AWS::SES::ConfigurationSet.TrackingOptions`.

setTrackingOptions

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

`AWS::SES::ConfigurationSet.TrackingOptions`.