Class CfnConfigurationSet
Create a configuration set.
Inherited Members
Namespace: Amazon.CDK.AWS.PinpointEmail
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnConfigurationSet : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnConfigurationSet
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
CloudformationResource: AWS::PinpointEmail::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.PinpointEmail;
var cfnConfigurationSet = new CfnConfigurationSet(this, "MyCfnConfigurationSet", new CfnConfigurationSetProps {
Name = "name",
// the properties below are optional
DeliveryOptions = new DeliveryOptionsProperty {
SendingPoolName = "sendingPoolName"
},
ReputationOptions = new ReputationOptionsProperty {
ReputationMetricsEnabled = false
},
SendingOptions = new SendingOptionsProperty {
SendingEnabled = false
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TrackingOptions = new TrackingOptionsProperty {
CustomRedirectDomain = "customRedirectDomain"
}
});
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
AttrId | |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DeliveryOptions | An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. |
Name | The name of the configuration set. |
ReputationOptions | An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set. |
SendingOptions | An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set. |
Tags | An object that defines the tags (keys and values) that you want to associate with the configuration set. |
TrackingOptions | An object that defines the open and click tracking options for emails that you send using 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)
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
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
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
An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
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
ReputationOptions
An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.
public virtual object ReputationOptions { get; set; }
Property Value
System.Object
SendingOptions
An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
public virtual object SendingOptions { get; set; }
Property Value
System.Object
Tags
An object that defines the tags (keys and values) that you want to associate with the configuration set.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
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
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>