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

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.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

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

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnConfigurationSet : CfnResource, IInspectable

Syntax (vb)

Public Class CfnConfigurationSet Inherits CfnResource Implements IInspectable

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 {
                 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" }
                 },
                 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?)

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

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.
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.
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

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
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?)

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

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

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

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

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

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

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

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

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

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

SuppressionOptions

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

public virtual object? SuppressionOptions { get; set; }

Property Value

object

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

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

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

VdmOptions

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

public virtual object? VdmOptions { get; set; }

Property Value

object

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

Methods

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

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)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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