AWS Native v0.63.0, May 25 23

aws-native.sns.Topic

Explore with Pulumi AI

Resource Type definition for AWS::SNS::Topic

Create Topic Resource

new Topic(name: string, args?: TopicArgs, opts?: CustomResourceOptions);

@overload
def Topic(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          content_based_deduplication: Optional[bool] = None,
          data_protection_policy: Optional[Any] = None,
          display_name: Optional[str] = None,
          fifo_topic: Optional[bool] = None,
          kms_master_key_id: Optional[str] = None,
          signature_version: Optional[str] = None,
          subscription: Optional[Sequence[TopicSubscriptionArgs]] = None,
          tags: Optional[Sequence[TopicTagArgs]] = None,
          topic_name: Optional[str] = None,
          tracing_config: Optional[str] = None)
@overload
def Topic(resource_name: str,
          args: Optional[TopicArgs] = None,
          opts: Optional[ResourceOptions] = None)

func NewTopic(ctx *Context, name string, args *TopicArgs, opts ...ResourceOption) (*Topic, error)

public Topic(string name, TopicArgs? args = null, CustomResourceOptions? opts = null)

public Topic(String name, TopicArgs args)
public Topic(String name, TopicArgs args, CustomResourceOptions options)

type: aws-native:sns:Topic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Topic Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Topic resource accepts the following input properties:

ContentBasedDeduplication bool

Enables content-based deduplication for FIFO topics. By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.

DataProtectionPolicy object

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

You can only add one policy per topic.

The policy must be in JSON string format.

Length Constraints: Maximum length of 30720

DisplayName string

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

FifoTopic bool

Set to true to create a FIFO topic.

KmsMasterKeyId string

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

This property applies only to server-side-encryption.

SignatureVersion string

Version of the Amazon SNS signature used. If the SignatureVersion is 1, Signature is a Base64-encoded SHA1withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values. If the SignatureVersion is 2, Signature is a Base64-encoded SHA256withRSA signature of the Message, MessageId, Type, Timestamp, and TopicArn values.

Subscription List<Pulumi.AwsNative.SNS.Inputs.TopicSubscriptionArgs>

The SNS subscriptions (endpoints) for this topic.

Tags List<Pulumi.AwsNative.SNS.Inputs.TopicTagArgs>

TopicName string

The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with .fifo.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.

TracingConfig string

Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to Active, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. Only supported on standard topics.

ContentBasedDeduplication bool

When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.

DataProtectionPolicy interface{}

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

You can only add one policy per topic.

The policy must be in JSON string format.

Length Constraints: Maximum length of 30720

DisplayName string

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

FifoTopic bool

Set to true to create a FIFO topic.

KmsMasterKeyId string

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

This property applies only to server-side-encryption.

SignatureVersion string

Subscription []TopicSubscriptionArgs

The SNS subscriptions (endpoints) for this topic.

Tags []TopicTagArgs

TopicName string

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.

TracingConfig string

contentBasedDeduplication Boolean

When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.

dataProtectionPolicy Object

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

You can only add one policy per topic.

The policy must be in JSON string format.

Length Constraints: Maximum length of 30720

displayName String

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

fifoTopic Boolean

Set to true to create a FIFO topic.

kmsMasterKeyId String

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

This property applies only to server-side-encryption.

signatureVersion String

subscription List<TopicSubscriptionArgs>

The SNS subscriptions (endpoints) for this topic.

tags List<TopicTagArgs>

topicName String

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.

tracingConfig String

contentBasedDeduplication boolean

When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.

dataProtectionPolicy any

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

You can only add one policy per topic.

The policy must be in JSON string format.

Length Constraints: Maximum length of 30720

displayName string

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

fifoTopic boolean

Set to true to create a FIFO topic.

kmsMasterKeyId string

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

This property applies only to server-side-encryption.

signatureVersion string

subscription TopicSubscriptionArgs[]

The SNS subscriptions (endpoints) for this topic.

tags TopicTagArgs[]

topicName string

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.

tracingConfig string

content_based_deduplication bool

When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.

data_protection_policy Any

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

You can only add one policy per topic.

The policy must be in JSON string format.

Length Constraints: Maximum length of 30720

display_name str

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

fifo_topic bool

Set to true to create a FIFO topic.

kms_master_key_id str

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

This property applies only to server-side-encryption.

signature_version str

subscription Sequence[TopicSubscriptionArgs]

The SNS subscriptions (endpoints) for this topic.

tags Sequence[TopicTagArgs]

topic_name str

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.

tracing_config str

contentBasedDeduplication Boolean

When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

(Optional) To override the generated value, you can specify a value for the the MessageDeduplicationId parameter for the Publish action.

dataProtectionPolicy Any

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

You can only add one policy per topic.

The policy must be in JSON string format.

Length Constraints: Maximum length of 30720

displayName String

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

fifoTopic Boolean

Set to true to create a FIFO topic.

kmsMasterKeyId String

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

This property applies only to server-side-encryption.

signatureVersion String

subscription List<Property Map>

The SNS subscriptions (endpoints) for this topic.

tags List<Property Map>

topicName String

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.

tracingConfig String

Outputs

All input properties are implicitly available as output properties. Additionally, the Topic resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
TopicArn string

Id string: The provider-assigned unique ID for this managed resource.
TopicArn string

id String: The provider-assigned unique ID for this managed resource.
topicArn String

id string: The provider-assigned unique ID for this managed resource.
topicArn string

id str: The provider-assigned unique ID for this managed resource.
topic_arn str

id String: The provider-assigned unique ID for this managed resource.
topicArn String

Supporting Types

TopicSubscription

Endpoint string
Protocol string

Endpoint string
Protocol string

endpoint String
protocol String

endpoint string
protocol string

endpoint str
protocol str

endpoint String
protocol String

TopicTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 characters in length.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 characters in length.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 characters in length.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 characters in length.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 characters in length.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 characters in length.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

aws-native.sns.Topic

Create Topic Resource

Topic Resource Properties

Inputs

Outputs

Supporting Types

TopicSubscription

TopicTag

Package Details

On this page