class ConfigurationSet (construct)

Language	Type name
.NET	Amazon.CDK.AWS.SES.ConfigurationSet
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsses#ConfigurationSet
Java	software.amazon.awscdk.services.ses.ConfigurationSet
Python	aws_cdk.aws_ses.ConfigurationSet
TypeScript (source)	aws-cdk-lib » aws_ses » ConfigurationSet

Implements IConstruct, IDependable, IResource, IConfigurationSet

A configuration set.

Example

import { Duration } from 'aws-cdk-lib';

declare const myPool: ses.IDedicatedIpPool;

new ses.ConfigurationSet(this, 'ConfigurationSet', {
  customTrackingRedirectDomain: 'track.cdk.dev',
  suppressionReasons: ses.SuppressionReasons.COMPLAINTS_ONLY,
  tlsPolicy: ses.ConfigurationSetTlsPolicy.REQUIRE,
  dedicatedIpPool: myPool,
  // Specify maximum delivery time
  // This configuration can be useful in such cases as time-sensitive emails (like those containing a one-time-password),
  // transactional emails, and email that you want to ensure isn't delivered during non-business hours.
  maxDeliveryDuration: Duration.minutes(10),
});

Initializer

new ConfigurationSet(scope: Construct, id: string, props?: ConfigurationSetProps)

Parameters

• scope Construct
• id string
• props ConfigurationSetProps

Construct Props

Name	Type	Description
configurationSetName?	string	A name for the configuration set.
customTrackingRedirectDomain?	string	The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
dedicatedIpPool?	IDedicatedIpPool	The dedicated IP pool to associate with the configuration set.
maxDeliveryDuration?	Duration	The maximum amount of time that Amazon SES API v2 will attempt delivery of email.
reputationMetrics?	boolean	Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
sendingEnabled?	boolean	Whether email sending is enabled.
suppressionReasons?	SuppressionReasons	The reasons for which recipient email addresses should be automatically added to your account's suppression list.
tlsPolicy?	ConfigurationSetTlsPolicy	Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
vdmOptions?	VdmOptions	The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

---

configurationSetName?

Type: string (optional, default: a CloudFormation generated name)

A name for the configuration set.

---

customTrackingRedirectDomain?

Type: string (optional, default: use the default awstrack.me domain)

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

---

dedicatedIpPool?

Type: IDedicatedIpPool (optional, default: do not use a dedicated IP pool)

The dedicated IP pool to associate with the configuration set.

---

maxDeliveryDuration?

Type: Duration (optional, default: undefined - SES defaults to 14 hours)

The maximum amount of time that Amazon SES API v2 will attempt delivery of email.

This value must be greater than or equal to 5 minutes and less than or equal to 14 hours.

---

reputationMetrics?

Type: boolean (optional, default: true)

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

---

sendingEnabled?

Type: boolean (optional, default: true)

Whether email sending is enabled.

---

suppressionReasons?

Type: SuppressionReasons (optional, default: use account level settings)

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

---

tlsPolicy?

Type: ConfigurationSetTlsPolicy (optional, default: ConfigurationSetTlsPolicy.OPTIONAL)

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

---

vdmOptions?

Type: VdmOptions (optional, 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.))

The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

Properties

Name	Type	Description
configurationSetName	string	The name of the configuration set.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

configurationSetName

Type: string

The name of the configuration set.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addEventDestination(id, options)	Adds an event destination to this configuration set.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromConfigurationSetName(scope, id, configurationSetName)	Use an existing configuration set.

---

addEventDestination(id, options)

public addEventDestination(id: string, options: ConfigurationSetEventDestinationOptions): ConfigurationSetEventDestination

Parameters

• id string
• options ConfigurationSetEventDestinationOptions

Returns

• ConfigurationSetEventDestination

Adds an event destination to this configuration set.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromConfigurationSetName(scope, id, configurationSetName)

public static fromConfigurationSetName(scope: Construct, id: string, configurationSetName: string): IConfigurationSet

Parameters

• scope Construct
• id string
• configurationSetName string

Returns

• IConfigurationSet

Use an existing configuration set.