Class CfnTopic

The AWS::SNS::Topic resource creates a topic to which notifications can be published.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnTopic

Implements

IInspectable

ITopicRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

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

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.SNS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTopic : CfnResource, IInspectable, ITopicRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnTopic Inherits CfnResource Implements IInspectable, ITopicRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

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.SNS;

             var archivePolicy;
             var dataProtectionPolicy;

             var cfnTopic = new CfnTopic(this, "MyCfnTopic", new CfnTopicProps {
                 ArchivePolicy = archivePolicy,
                 ContentBasedDeduplication = false,
                 DataProtectionPolicy = dataProtectionPolicy,
                 DeliveryStatusLogging = new [] { new LoggingConfigProperty {
                     Protocol = "protocol",

                     // the properties below are optional
                     FailureFeedbackRoleArn = "failureFeedbackRoleArn",
                     SuccessFeedbackRoleArn = "successFeedbackRoleArn",
                     SuccessFeedbackSampleRate = "successFeedbackSampleRate"
                 } },
                 DisplayName = "displayName",
                 FifoThroughputScope = "fifoThroughputScope",
                 FifoTopic = false,
                 KmsMasterKeyId = "kmsMasterKeyId",
                 SignatureVersion = "signatureVersion",
                 Subscription = new [] { new SubscriptionProperty {
                     Endpoint = "endpoint",
                     Protocol = "protocol"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TopicName = "topicName",
                 TracingConfig = "tracingConfig"
             });

Synopsis

Constructors

CfnTopic(Construct, string, ICfnTopicProps?)

Create a new AWS::SNS::Topic.

Properties

ArchivePolicy	The `ArchivePolicy` determines the number of days Amazon retains messages in FIFO topics.
AttrTopicArn	Returns the ARN of an Amazon topic.
AttrTopicName	Returns the name of an Amazon topic.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The `AWS::SNS::Topic` resource creates a topic to which notifications can be published.
ContentBasedDeduplication	`ContentBasedDeduplication` enables deduplication of messages based on their content for FIFO topics.
DataProtectionPolicy	The body of the policy document you want to use for this topic.
DeliveryStatusLogging	The `DeliveryStatusLogging` configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols:.
DisplayName	The display name to use for an Amazon topic with SMS subscriptions.
FifoThroughputScope	Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.
FifoTopic	Set to true to create a FIFO topic.
KmsMasterKeyId	The ID of an AWS managed customer master key (CMK) for Amazon or a custom CMK.
SignatureVersion	The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.
Subscription	The Amazon subscriptions (endpoints) for this topic.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	The list of tags to add to a new topic.
TopicName	The name of the topic you want to create.
TopicRef	A reference to a Topic resource.
TracingConfig	Tracing mode of an Amazon topic.

Methods

ArnForTopic(ITopicRef)	The `AWS::SNS::Topic` resource creates a topic to which notifications can be published.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnTopic(object)	Checks whether the given object is a CfnTopic.
RenderProperties(IDictionary<string, object>)	The `AWS::SNS::Topic` resource creates a topic to which notifications can be published.

Constructors

CfnTopic(Construct, string, ICfnTopicProps?)

Create a new AWS::SNS::Topic.

public CfnTopic(Construct scope, string id, ICfnTopicProps? props = null)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnTopicProps: Resource properties.

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

Properties

ArchivePolicy

The ArchivePolicy determines the number of days Amazon retains messages in FIFO topics.

public virtual object? ArchivePolicy { get; set; }

Property Value

object

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

AttrTopicArn

Returns the ARN of an Amazon topic.

public virtual string AttrTopicArn { get; }

Property Value

string

Remarks

CloudformationAttribute: TopicArn

AttrTopicName

Returns the name of an Amazon topic.

public virtual string AttrTopicName { get; }

Property Value

string

Remarks

CloudformationAttribute: TopicName

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

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::SNS::Topic resource creates a topic to which notifications can be published.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

ContentBasedDeduplication

ContentBasedDeduplication enables deduplication of messages based on their content for FIFO topics.

public virtual object? ContentBasedDeduplication { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

DataProtectionPolicy

The body of the policy document you want to use for this topic.

public virtual object? DataProtectionPolicy { get; set; }

Property Value

object

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

DeliveryStatusLogging

The DeliveryStatusLogging configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols:.

public virtual object? DeliveryStatusLogging { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnTopic.ILoggingConfigProperty)[]

DisplayName

The display name to use for an Amazon topic with SMS subscriptions.

public virtual string? DisplayName { get; set; }

Property Value

string

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

FifoThroughputScope

Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.

public virtual string? FifoThroughputScope { get; set; }

Property Value

string

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

FifoTopic

Set to true to create a FIFO topic.

public virtual object? FifoTopic { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

KmsMasterKeyId

The ID of an AWS managed customer master key (CMK) for Amazon or a custom CMK.

public virtual string? KmsMasterKeyId { get; set; }

Property Value

string

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

SignatureVersion

The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.

public virtual string? SignatureVersion { get; set; }

Property Value

string

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

Subscription

The Amazon subscriptions (endpoints) for this topic.

public virtual object? Subscription { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnTopic.ISubscriptionProperty)[]

TagsRaw

The list of tags to add to a new topic.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

TopicName

The name of the topic you want to create.

public virtual string? TopicName { get; set; }

Property Value

string

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

TopicRef

A reference to a Topic resource.

public virtual ITopicReference TopicRef { get; }

Property Value

ITopicReference

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

TracingConfig

Tracing mode of an Amazon topic.

public virtual string? TracingConfig { get; set; }

Property Value

string

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

Methods

ArnForTopic(ITopicRef)

The AWS::SNS::Topic resource creates a topic to which notifications can be published.

public static string ArnForTopic(ITopicRef resource)

Parameters

resource ITopicRef

Returns

string

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

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.SNS;

             var archivePolicy;
             var dataProtectionPolicy;

             var cfnTopic = new CfnTopic(this, "MyCfnTopic", new CfnTopicProps {
                 ArchivePolicy = archivePolicy,
                 ContentBasedDeduplication = false,
                 DataProtectionPolicy = dataProtectionPolicy,
                 DeliveryStatusLogging = new [] { new LoggingConfigProperty {
                     Protocol = "protocol",

                     // the properties below are optional
                     FailureFeedbackRoleArn = "failureFeedbackRoleArn",
                     SuccessFeedbackRoleArn = "successFeedbackRoleArn",
                     SuccessFeedbackSampleRate = "successFeedbackSampleRate"
                 } },
                 DisplayName = "displayName",
                 FifoThroughputScope = "fifoThroughputScope",
                 FifoTopic = false,
                 KmsMasterKeyId = "kmsMasterKeyId",
                 SignatureVersion = "signatureVersion",
                 Subscription = new [] { new SubscriptionProperty {
                     Endpoint = "endpoint",
                     Protocol = "protocol"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TopicName = "topicName",
                 TracingConfig = "tracingConfig"
             });

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

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

IsCfnTopic(object)

Checks whether the given object is a CfnTopic.

public static bool IsCfnTopic(object x)

Parameters

x object

Returns

bool

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::SNS::Topic resource creates a topic to which notifications can be published.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/sns.html">Amazon  endpoints and quotas</a> in the <em>AWS General Reference</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html

CloudformationResource: AWS::SNS::Topic

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITopicRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable