aws-cdk-lib.aws_ses.ConfigurationSet

class ConfigurationSet (construct)

LanguageType name
.NETAmazon.CDK.AWS.SES.ConfigurationSet
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsses#ConfigurationSet
Javasoftware.amazon.awscdk.services.ses.ConfigurationSet
Pythonaws_cdk.aws_ses.ConfigurationSet
TypeScript (source)aws-cdk-lib » aws_ses » ConfigurationSet

Implements IConstruct, IDependable, IResource, IConfigurationSet

A configuration set.

Example

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,
});

Initializer

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

Parameters

  • scope Construct
  • id string
  • props ConfigurationSetProps

Construct Props

NameTypeDescription
configurationSetName?stringA name for the configuration set.
customTrackingRedirectDomain?stringThe custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
dedicatedIpPool?IDedicatedIpPoolThe dedicated IP pool to associate with the configuration set.
reputationMetrics?booleanWhether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
sendingEnabled?booleanWhether email sending is enabled.
suppressionReasons?SuppressionReasonsThe reasons for which recipient email addresses should be automatically added to your account's suppression list.
tlsPolicy?ConfigurationSetTlsPolicySpecifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

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.


reputationMetrics?

Type: boolean (optional, default: false)

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).

Properties

NameTypeDescription
configurationSetNamestringThe name of the configuration set.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe 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

NameDescription
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.