Microsoft.AwsConnector snsTopics 2024-12-01

2024-12-09

Bicep resource definition

The snsTopics resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AwsConnector/snsTopics resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AwsConnector/snsTopics@2024-12-01' = {
  location: 'string'
  name: 'string'
  properties: {
    arn: 'string'
    awsAccountId: 'string'
    awsProperties: {
      archivePolicy: any(...)
      contentBasedDeduplication: bool
      dataProtectionPolicy: any(...)
      deliveryStatusLogging: [
        {
          failureFeedbackRoleArn: 'string'
          protocol: 'string'
          successFeedbackRoleArn: 'string'
          successFeedbackSampleRate: 'string'
        }
      ]
      displayName: 'string'
      fifoTopic: bool
      kmsMasterKeyId: 'string'
      signatureVersion: 'string'
      subscription: [
        {
          endpoint: 'string'
          protocol: 'string'
        }
      ]
      tags: [
        {
          key: 'string'
          value: 'string'
        }
      ]
      topicArn: 'string'
      topicName: 'string'
      tracingConfig: 'string'
    }
    awsRegion: 'string'
    awsSourceSchema: 'string'
    awsTags: {
      {customized property}: 'string'
    }
    publicCloudConnectorsResourceId: 'string'
    publicCloudResourceName: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.AwsConnector/snsTopics

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = `^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#])` (required)
properties	The resource-specific properties for this resource.	SnsTopicProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

AwsSnsTopicProperties

Name	Description	Value
archivePolicy	The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.	any
contentBasedDeduplication	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`, 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.	bool
dataProtectionPolicy	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 30,720.	any
deliveryStatusLogging	Property deliveryStatusLogging	LoggingConfigAutoGenerated[]
displayName	The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.	string
fifoTopic	Set to true to create a FIFO topic.	bool
kmsMasterKeyId	The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see Key terms. For more examples, see `KeyId` in the API Reference. This property applies only to server-side-encryption.	string
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. By default, `SignatureVersion` is set to `1`.	string
subscription	The SNS subscriptions (endpoints) for this topic. If you specify the `Subscription` property in the `AWS::SNS::Topic` resource and it creates an associated subscription resource, the associated subscription is not deleted when the `AWS::SNS::Topic` resource is deleted.	Subscription[]
tags	The list of tags to add to a new topic. To be able to tag a topic on creation, you must have the `sns:CreateTopic` and `sns:TagResource` permissions.	TagAutoGenerated53[]
topicArn	Property topicArn	string
topicName	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, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see Name type. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.	string
tracingConfig	Tracing mode of an 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.	string

LoggingConfigAutoGenerated

Name	Description	Value
failureFeedbackRoleArn	Property failureFeedbackRoleArn	string
protocol	Property protocol	'application' 'firehose' 'http/s' 'lambda' 'sqs'
successFeedbackRoleArn	Property successFeedbackRoleArn	string
successFeedbackSampleRate	Property successFeedbackSampleRate	string

SnsTopicProperties

Name	Description	Value
arn	Amazon Resource Name (ARN)	string
awsAccountId	AWS Account ID	string
awsProperties	AWS Properties	AwsSnsTopicProperties
awsRegion	AWS Region	string
awsSourceSchema	AWS Source Schema	string
awsTags	AWS Tags	SnsTopicPropertiesAwsTags
publicCloudConnectorsResourceId	Public Cloud Connectors Resource ID	string
publicCloudResourceName	Public Cloud Resource Name	string

SnsTopicPropertiesAwsTags

Name	Description	Value

Subscription

Name	Description	Value
endpoint	The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the `Endpoint` parameter of the `Subscribe` action in the API Reference.	string
protocol	The subscription's protocol. For more information, see the `Protocol` parameter of the `Subscribe` action in the API Reference.	string

TagAutoGenerated53

Name	Description	Value
key	The required key portion of the tag.	string
value	The optional value portion of the tag.	string

TrackedResourceTags

Name	Description	Value

ARM template resource definition

The snsTopics resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AwsConnector/snsTopics resource, add the following JSON to your template.

{
  "type": "Microsoft.AwsConnector/snsTopics",
  "apiVersion": "2024-12-01",
  "name": "string",
  "location": "string",
  "properties": {
    "arn": "string",
    "awsAccountId": "string",
    "awsProperties": {
      "archivePolicy": {},
      "contentBasedDeduplication": "bool",
      "dataProtectionPolicy": {},
      "deliveryStatusLogging": [
        {
          "failureFeedbackRoleArn": "string",
          "protocol": "string",
          "successFeedbackRoleArn": "string",
          "successFeedbackSampleRate": "string"
        }
      ],
      "displayName": "string",
      "fifoTopic": "bool",
      "kmsMasterKeyId": "string",
      "signatureVersion": "string",
      "subscription": [
        {
          "endpoint": "string",
          "protocol": "string"
        }
      ],
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "topicArn": "string",
      "topicName": "string",
      "tracingConfig": "string"
    },
    "awsRegion": "string",
    "awsSourceSchema": "string",
    "awsTags": {
      "{customized property}": "string"
    },
    "publicCloudConnectorsResourceId": "string",
    "publicCloudResourceName": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.AwsConnector/snsTopics

Name	Description	Value
apiVersion	The api version	'2024-12-01'
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = `^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#])` (required)
properties	The resource-specific properties for this resource.	SnsTopicProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.AwsConnector/snsTopics'

AwsSnsTopicProperties

Name	Description	Value
archivePolicy	The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.	any
contentBasedDeduplication	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`, 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.	bool
dataProtectionPolicy	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 30,720.	any
deliveryStatusLogging	Property deliveryStatusLogging	LoggingConfigAutoGenerated[]
displayName	The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.	string
fifoTopic	Set to true to create a FIFO topic.	bool
kmsMasterKeyId	The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see Key terms. For more examples, see `KeyId` in the API Reference. This property applies only to server-side-encryption.	string
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. By default, `SignatureVersion` is set to `1`.	string
subscription	The SNS subscriptions (endpoints) for this topic. If you specify the `Subscription` property in the `AWS::SNS::Topic` resource and it creates an associated subscription resource, the associated subscription is not deleted when the `AWS::SNS::Topic` resource is deleted.	Subscription[]
tags	The list of tags to add to a new topic. To be able to tag a topic on creation, you must have the `sns:CreateTopic` and `sns:TagResource` permissions.	TagAutoGenerated53[]
topicArn	Property topicArn	string
topicName	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, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see Name type. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.	string
tracingConfig	Tracing mode of an 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.	string

LoggingConfigAutoGenerated

Name	Description	Value
failureFeedbackRoleArn	Property failureFeedbackRoleArn	string
protocol	Property protocol	'application' 'firehose' 'http/s' 'lambda' 'sqs'
successFeedbackRoleArn	Property successFeedbackRoleArn	string
successFeedbackSampleRate	Property successFeedbackSampleRate	string

SnsTopicProperties

Name	Description	Value
arn	Amazon Resource Name (ARN)	string
awsAccountId	AWS Account ID	string
awsProperties	AWS Properties	AwsSnsTopicProperties
awsRegion	AWS Region	string
awsSourceSchema	AWS Source Schema	string
awsTags	AWS Tags	SnsTopicPropertiesAwsTags
publicCloudConnectorsResourceId	Public Cloud Connectors Resource ID	string
publicCloudResourceName	Public Cloud Resource Name	string

SnsTopicPropertiesAwsTags

Name	Description	Value

Subscription

Name	Description	Value
endpoint	The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the `Endpoint` parameter of the `Subscribe` action in the API Reference.	string
protocol	The subscription's protocol. For more information, see the `Protocol` parameter of the `Subscribe` action in the API Reference.	string

TagAutoGenerated53

Name	Description	Value
key	The required key portion of the tag.	string
value	The optional value portion of the tag.	string

TrackedResourceTags

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The snsTopics resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AwsConnector/snsTopics resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AwsConnector/snsTopics@2024-12-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      arn = "string"
      awsAccountId = "string"
      awsProperties = {
        archivePolicy = ?
        contentBasedDeduplication = bool
        dataProtectionPolicy = ?
        deliveryStatusLogging = [
          {
            failureFeedbackRoleArn = "string"
            protocol = "string"
            successFeedbackRoleArn = "string"
            successFeedbackSampleRate = "string"
          }
        ]
        displayName = "string"
        fifoTopic = bool
        kmsMasterKeyId = "string"
        signatureVersion = "string"
        subscription = [
          {
            endpoint = "string"
            protocol = "string"
          }
        ]
        tags = [
          {
            key = "string"
            value = "string"
          }
        ]
        topicArn = "string"
        topicName = "string"
        tracingConfig = "string"
      }
      awsRegion = "string"
      awsSourceSchema = "string"
      awsTags = {
        {customized property} = "string"
      }
      publicCloudConnectorsResourceId = "string"
      publicCloudResourceName = "string"
    }
  }
}

Property Values

Microsoft.AwsConnector/snsTopics

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = `^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#])` (required)
properties	The resource-specific properties for this resource.	SnsTopicProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.AwsConnector/snsTopics@2024-12-01"

AwsSnsTopicProperties

Name	Description	Value
archivePolicy	The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.	any
contentBasedDeduplication	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`, 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.	bool
dataProtectionPolicy	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 30,720.	any
deliveryStatusLogging	Property deliveryStatusLogging	LoggingConfigAutoGenerated[]
displayName	The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.	string
fifoTopic	Set to true to create a FIFO topic.	bool
kmsMasterKeyId	The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see Key terms. For more examples, see `KeyId` in the API Reference. This property applies only to server-side-encryption.	string
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. By default, `SignatureVersion` is set to `1`.	string
subscription	The SNS subscriptions (endpoints) for this topic. If you specify the `Subscription` property in the `AWS::SNS::Topic` resource and it creates an associated subscription resource, the associated subscription is not deleted when the `AWS::SNS::Topic` resource is deleted.	Subscription[]
tags	The list of tags to add to a new topic. To be able to tag a topic on creation, you must have the `sns:CreateTopic` and `sns:TagResource` permissions.	TagAutoGenerated53[]
topicArn	Property topicArn	string
topicName	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, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see Name type. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.	string
tracingConfig	Tracing mode of an 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.	string

LoggingConfigAutoGenerated

Name	Description	Value
failureFeedbackRoleArn	Property failureFeedbackRoleArn	string
protocol	Property protocol	'application' 'firehose' 'http/s' 'lambda' 'sqs'
successFeedbackRoleArn	Property successFeedbackRoleArn	string
successFeedbackSampleRate	Property successFeedbackSampleRate	string

SnsTopicProperties

Name	Description	Value
arn	Amazon Resource Name (ARN)	string
awsAccountId	AWS Account ID	string
awsProperties	AWS Properties	AwsSnsTopicProperties
awsRegion	AWS Region	string
awsSourceSchema	AWS Source Schema	string
awsTags	AWS Tags	SnsTopicPropertiesAwsTags
publicCloudConnectorsResourceId	Public Cloud Connectors Resource ID	string
publicCloudResourceName	Public Cloud Resource Name	string

SnsTopicPropertiesAwsTags

Name	Description	Value

Subscription

Name	Description	Value
endpoint	The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the `Endpoint` parameter of the `Subscribe` action in the API Reference.	string
protocol	The subscription's protocol. For more information, see the `Protocol` parameter of the `Subscribe` action in the API Reference.	string

TagAutoGenerated53

Name	Description	Value
key	The required key portion of the tag.	string
value	The optional value portion of the tag.	string

TrackedResourceTags

Name	Description	Value

Share via

Microsoft.AwsConnector snsTopics 2024-12-01

Bicep resource definition

Resource format

Property Values

Microsoft.AwsConnector/snsTopics

AwsSnsTopicProperties

LoggingConfigAutoGenerated

SnsTopicProperties

SnsTopicPropertiesAwsTags

Subscription

TagAutoGenerated53

TrackedResourceTags

ARM template resource definition

Resource format

Property Values

Microsoft.AwsConnector/snsTopics

AwsSnsTopicProperties

LoggingConfigAutoGenerated

SnsTopicProperties

SnsTopicPropertiesAwsTags

Subscription

TagAutoGenerated53

TrackedResourceTags

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Microsoft.AwsConnector/snsTopics

AwsSnsTopicProperties

LoggingConfigAutoGenerated

SnsTopicProperties

SnsTopicPropertiesAwsTags

Subscription

TagAutoGenerated53

TrackedResourceTags

Feedback

Additional resources