Class CfnConfigurationSet

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnConfigurationSet

Implements

IInspectable

IConfigurationSetRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnConfigurationSet : CfnResource, IInspectable, IConfigurationSetRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnConfigurationSet Inherits CfnResource Implements IInspectable, IConfigurationSetRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SES;

             var cfnConfigurationSet = new CfnConfigurationSet(this, "MyCfnConfigurationSet", new CfnConfigurationSetProps {
                 ArchivingOptions = new ArchivingOptionsProperty {
                     ArchiveArn = "archiveArn"
                 },
                 DeliveryOptions = new DeliveryOptionsProperty {
                     MaxDeliverySeconds = 123,
                     SendingPoolName = "sendingPoolName",
                     TlsPolicy = "tlsPolicy"
                 },
                 Name = "name",
                 ReputationOptions = new ReputationOptionsProperty {
                     ReputationMetricsEnabled = false
                 },
                 SendingOptions = new SendingOptionsProperty {
                     SendingEnabled = false
                 },
                 SuppressionOptions = new SuppressionOptionsProperty {
                     SuppressedReasons = new [] { "suppressedReasons" },
                     ValidationOptions = new ValidationOptionsProperty {
                         ConditionThreshold = new ConditionThresholdProperty {
                             ConditionThresholdEnabled = "conditionThresholdEnabled",

                             // the properties below are optional
                             OverallConfidenceThreshold = new OverallConfidenceThresholdProperty {
                                 ConfidenceVerdictThreshold = "confidenceVerdictThreshold"
                             }
                         }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TrackingOptions = new TrackingOptionsProperty {
                     CustomRedirectDomain = "customRedirectDomain",
                     HttpsPolicy = "httpsPolicy"
                 },
                 VdmOptions = new VdmOptionsProperty {
                     DashboardOptions = new DashboardOptionsProperty {
                         EngagementMetrics = "engagementMetrics"
                     },
                     GuardianOptions = new GuardianOptionsProperty {
                         OptimizedSharedDelivery = "optimizedSharedDelivery"
                     }
                 }
             });

Synopsis

Constructors

CfnConfigurationSet(Construct, string, ICfnConfigurationSetProps?)

Create a new AWS::SES::ConfigurationSet.

Properties

ArchivingOptions	An object that defines a MailManager archive that is used to preserve emails that you send using the configuration set.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.
CfnPropertyNames	Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.
ConfigurationSetRef	A reference to a ConfigurationSet resource.
DeliveryOptions	Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).
Name	The name of the configuration set.
ReputationOptions	An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
SendingOptions	An object that defines whether or not Amazon SES can send email that you send using the configuration set.
SuppressionOptions	An object that contains information about the suppression list preferences for your account.
Tags	An array of objects that define the tags (keys and values) that are associated with the configuration set.
TrackingOptions	An object that defines the open and click tracking options for emails that you send using the configuration set.
VdmOptions	The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

Methods

ArnForConfigurationSet(IConfigurationSetRef)	Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.
FromConfigurationSetName(Construct, string, string)	Creates a new IConfigurationSetRef from a configurationSetName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnConfigurationSet(object)	Checks whether the given object is a CfnConfigurationSet.
RenderProperties(IDictionary<string, object>)	Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.

Constructors

CfnConfigurationSet(Construct, string, ICfnConfigurationSetProps?)

Create a new AWS::SES::ConfigurationSet.

public CfnConfigurationSet(Construct scope, string id, ICfnConfigurationSetProps? props = null)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnConfigurationSetProps: Resource properties.

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

Properties

ArchivingOptions

An object that defines a MailManager archive that is used to preserve emails that you send using the configuration set.

public virtual object? ArchivingOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnConfigurationSet.IArchivingOptionsProperty

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

CfnProperties

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

CfnPropertyNames

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

ConfigurationSetRef

A reference to a ConfigurationSet resource.

public virtual IConfigurationSetReference ConfigurationSetRef { get; }

Property Value

IConfigurationSetReference

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

DeliveryOptions

Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).

public virtual object? DeliveryOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnConfigurationSet.IDeliveryOptionsProperty

Name

The name of the configuration set.

public virtual string? Name { get; set; }

Property Value

string

Remarks

The name must meet the following requirements:.

ReputationOptions

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

public virtual object? ReputationOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnConfigurationSet.IReputationOptionsProperty

SendingOptions

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

public virtual object? SendingOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnConfigurationSet.ISendingOptionsProperty

SuppressionOptions

An object that contains information about the suppression list preferences for your account.

public virtual object? SuppressionOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnConfigurationSet.ISuppressionOptionsProperty

TrackingOptions

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

public virtual object? TrackingOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnConfigurationSet.ITrackingOptionsProperty

VdmOptions

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

public virtual object? VdmOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnConfigurationSet.IVdmOptionsProperty

Methods

ArnForConfigurationSet(IConfigurationSetRef)

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.

public static string ArnForConfigurationSet(IConfigurationSetRef resource)

Parameters

resource IConfigurationSetRef

Returns

string

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SES;

             var cfnConfigurationSet = new CfnConfigurationSet(this, "MyCfnConfigurationSet", new CfnConfigurationSetProps {
                 ArchivingOptions = new ArchivingOptionsProperty {
                     ArchiveArn = "archiveArn"
                 },
                 DeliveryOptions = new DeliveryOptionsProperty {
                     MaxDeliverySeconds = 123,
                     SendingPoolName = "sendingPoolName",
                     TlsPolicy = "tlsPolicy"
                 },
                 Name = "name",
                 ReputationOptions = new ReputationOptionsProperty {
                     ReputationMetricsEnabled = false
                 },
                 SendingOptions = new SendingOptionsProperty {
                     SendingEnabled = false
                 },
                 SuppressionOptions = new SuppressionOptionsProperty {
                     SuppressedReasons = new [] { "suppressedReasons" },
                     ValidationOptions = new ValidationOptionsProperty {
                         ConditionThreshold = new ConditionThresholdProperty {
                             ConditionThresholdEnabled = "conditionThresholdEnabled",

                             // the properties below are optional
                             OverallConfidenceThreshold = new OverallConfidenceThresholdProperty {
                                 ConfidenceVerdictThreshold = "confidenceVerdictThreshold"
                             }
                         }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TrackingOptions = new TrackingOptionsProperty {
                     CustomRedirectDomain = "customRedirectDomain",
                     HttpsPolicy = "httpsPolicy"
                 },
                 VdmOptions = new VdmOptionsProperty {
                     DashboardOptions = new DashboardOptionsProperty {
                         EngagementMetrics = "engagementMetrics"
                     },
                     GuardianOptions = new GuardianOptionsProperty {
                         OptimizedSharedDelivery = "optimizedSharedDelivery"
                     }
                 }
             });

FromConfigurationSetName(Construct, string, string)

Creates a new IConfigurationSetRef from a configurationSetName.

public static IConfigurationSetRef FromConfigurationSetName(Construct scope, string id, string configurationSetName)

Parameters

scope Construct
id string
configurationSetName string

Returns

IConfigurationSetRef

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

IsCfnConfigurationSet(object)

Checks whether the given object is a CfnConfigurationSet.

public static bool IsCfnConfigurationSet(object x)

Parameters

x object

Returns

bool

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .

<em>Required permissions:</em>

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html

CloudformationResource: AWS::SES::ConfigurationSet

ExampleMetadata: fixture=_generated

Implements

IInspectable

IConfigurationSetRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2