Class CfnContactList
A list that contains contacts that have subscribed to a particular topic or topics.
Inherited Members
Namespace: Amazon.CDK.AWS.SES
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnContactList : CfnResource, IInspectable, IContactListRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnContactList Inherits CfnResource Implements IInspectable, IContactListRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
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 cfnContactList = new CfnContactList(this, "MyCfnContactList", new CfnContactListProps {
ContactListName = "contactListName",
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Topics = new [] { new TopicProperty {
DefaultSubscriptionStatus = "defaultSubscriptionStatus",
DisplayName = "displayName",
TopicName = "topicName",
// the properties below are optional
Description = "description"
} }
});
Synopsis
Constructors
| CfnContactList(Construct, string, ICfnContactListProps?) | Create a new |
Properties
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | A list that contains contacts that have subscribed to a particular topic or topics. |
| ContactListName | The name of the contact list. |
| ContactListRef | A reference to a ContactList resource. |
| Description | A description of what the contact list is about. |
| Tags | Tag Manager which manages the tags for this resource. |
| TagsRaw | The tags associated with a contact list. |
| Topics | An interest group, theme, or label within a list. |
Methods
| ArnForContactList(IContactListRef) | A list that contains contacts that have subscribed to a particular topic or topics. |
| FromContactListName(Construct, string, string) | Creates a new IContactListRef from a contactListName. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnContactList(object) | Checks whether the given object is a CfnContactList. |
| RenderProperties(IDictionary<string, object>) | A list that contains contacts that have subscribed to a particular topic or topics. |
Constructors
CfnContactList(Construct, string, ICfnContactListProps?)
Create a new AWS::SES::ContactList.
public CfnContactList(Construct scope, string id, ICfnContactListProps? props = null)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnContactListProps
Resource properties.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
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
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
ExampleMetadata: fixture=_generated
CfnProperties
A list that contains contacts that have subscribed to a particular topic or topics.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
ExampleMetadata: fixture=_generated
ContactListName
The name of the contact list.
public virtual string? ContactListName { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
ExampleMetadata: fixture=_generated
ContactListRef
A reference to a ContactList resource.
public virtual IContactListReference ContactListRef { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
ExampleMetadata: fixture=_generated
Description
A description of what the contact list is about.
public virtual string? Description { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
ExampleMetadata: fixture=_generated
TagsRaw
The tags associated with a contact list.
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
ExampleMetadata: fixture=_generated
Topics
An interest group, theme, or label within a list.
public virtual object? Topics { get; set; }
Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnContactList.ITopicProperty)[]
Methods
ArnForContactList(IContactListRef)
A list that contains contacts that have subscribed to a particular topic or topics.
public static string ArnForContactList(IContactListRef resource)
Parameters
- resource IContactListRef
Returns
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
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 cfnContactList = new CfnContactList(this, "MyCfnContactList", new CfnContactListProps {
ContactListName = "contactListName",
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Topics = new [] { new TopicProperty {
DefaultSubscriptionStatus = "defaultSubscriptionStatus",
DisplayName = "displayName",
TopicName = "topicName",
// the properties below are optional
Description = "description"
} }
});
FromContactListName(Construct, string, string)
Creates a new IContactListRef from a contactListName.
public static IContactListRef FromContactListName(Construct scope, string id, string contactListName)
Parameters
Returns
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
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
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
ExampleMetadata: fixture=_generated
IsCfnContactList(object)
Checks whether the given object is a CfnContactList.
public static bool IsCfnContactList(object x)
Parameters
- x object
Returns
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
A list that contains contacts that have subscribed to a particular topic or topics.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-contactlist.html
CloudformationResource: AWS::SES::ContactList
ExampleMetadata: fixture=_generated