Show / Hide Table of Contents

Class CfnConfigurationSet

Create a configuration set.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnConfigurationSet
Implements
IInspectable
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.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.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.

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

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(Construct, string, ICfnConfigurationSetProps)

Create a configuration set.

Properties

AttrId

Create a 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

Create a configuration set.

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

Create a configuration set.

Constructors

CfnConfigurationSet(Construct, string, ICfnConfigurationSetProps)

Create a configuration set.

public CfnConfigurationSet(Construct scope, string id, ICfnConfigurationSetProps props)
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

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.

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

CloudformationResource: AWS::PinpointEmail::ConfigurationSet

ExampleMetadata: fixture=_generated

Properties

AttrId

Create a configuration set.

public virtual string AttrId { get; }
Property Value

string

Remarks

CloudformationAttribute: Id

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

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.

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

CloudformationResource: AWS::PinpointEmail::ConfigurationSet

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

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.

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

CloudformationResource: AWS::PinpointEmail::ConfigurationSet

ExampleMetadata: fixture=_generated

CfnProperties

Create a configuration set.

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

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
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.

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

CloudformationResource: AWS::PinpointEmail::ConfigurationSet

ExampleMetadata: fixture=_generated

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

object

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.

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

CloudformationResource: AWS::PinpointEmail::ConfigurationSet

ExampleMetadata: fixture=_generated

Name

The name of the configuration set.

public virtual string Name { get; set; }
Property Value

string

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.

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

CloudformationResource: AWS::PinpointEmail::ConfigurationSet

ExampleMetadata: fixture=_generated

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

object

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.

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

CloudformationResource: AWS::PinpointEmail::ConfigurationSet

ExampleMetadata: fixture=_generated

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

object

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.

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

CloudformationResource: AWS::PinpointEmail::ConfigurationSet

ExampleMetadata: fixture=_generated

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[]

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.

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

CloudformationResource: AWS::PinpointEmail::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

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.

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

CloudformationResource: AWS::PinpointEmail::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

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.

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

CloudformationResource: AWS::PinpointEmail::ConfigurationSet

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Create a configuration set.

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

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.

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

CloudformationResource: AWS::PinpointEmail::ConfigurationSet

ExampleMetadata: fixture=_generated

Implements

IInspectable
ITaggableV2
Back to top Generated by DocFX