Class CfnConfigurationSet
Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES.
Implements
Inherited Members
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 .
Required permissions:
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 {
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"
},
VdmOptions = new VdmOptionsProperty {
DashboardOptions = new DashboardOptionsProperty {
EngagementMetrics = "engagementMetrics"
},
GuardianOptions = new GuardianOptionsProperty {
OptimizedSharedDelivery = "optimizedSharedDelivery"
}
}
});
Synopsis
Constructors
CfnConfigurationSet(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnConfigurationSet(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnConfigurationSet(Construct, String, ICfnConfigurationSetProps) |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DeliveryOptions | Specifies 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 represents the reputation settings for 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 | The name of the custom open and click tracking domain associated with 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>) |
Constructors
CfnConfigurationSet(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnConfigurationSet(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnConfigurationSet(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnConfigurationSet(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnConfigurationSet(Construct, String, ICfnConfigurationSetProps)
public CfnConfigurationSet(Construct scope, string id, ICfnConfigurationSetProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnConfigurationSetProps
Resource properties.
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DeliveryOptions
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
public virtual object DeliveryOptions { get; set; }
Property Value
System.Object
Name
The name of the configuration set.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
The name must meet the following requirements:.
ReputationOptions
An object that represents the reputation settings for the configuration set.
public virtual object ReputationOptions { get; set; }
Property Value
System.Object
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
System.Object
SuppressionOptions
An object that contains information about the suppression list preferences for your account.
public virtual object SuppressionOptions { get; set; }
Property Value
System.Object
TrackingOptions
The name of the custom open and click tracking domain associated with the configuration set.
public virtual object TrackingOptions { get; set; }
Property Value
System.Object
VdmOptions
The Virtual Deliverability Manager (VDM) options that apply to the configuration set.
public virtual object VdmOptions { get; set; }
Property Value
System.Object
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>