Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sns
  5. TopicSubscription
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.sns.TopicSubscription

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Provides a resource for subscribing to SNS topics. Requires that an SNS topic exist for the subscription to attach to. This resource allows you to automatically place messages sent to SNS topics in SQS queues, send them as HTTP(S) POST requests to a given endpoint, send SMS messages, or notify devices / applications. The most likely use case for provider users will probably be SQS queues.

NOTE: If the SNS topic and SQS queue are in different AWS regions, the aws.sns.TopicSubscription must use an AWS provider that is in the same region as the SNS topic. If the aws.sns.TopicSubscription uses a provider with a different region than the SNS topic, this provider will fail to create the subscription.

NOTE: Setup of cross-account subscriptions from SNS topics to SQS queues requires the provider to have access to BOTH accounts.

NOTE: If an SNS topic and SQS queue are in different AWS accounts but the same region, the aws.sns.TopicSubscription must use the AWS provider for the account with the SQS queue. If aws.sns.TopicSubscription uses a Provider with a different account than the SQS queue, this provider creates the subscription but does not keep state and tries to re-create the subscription at every apply.

NOTE: If an SNS topic and SQS queue are in different AWS accounts and different AWS regions, the subscription needs to be initiated from the account with the SQS queue but in the region of the SNS topic.

NOTE: You cannot unsubscribe to a subscription that is pending confirmation. If you use email, email-json, or http/https (without auto-confirmation enabled), until the subscription is confirmed (e.g., outside of this provider), AWS does not allow this provider to delete / unsubscribe the subscription. If you destroy an unconfirmed subscription, this provider will remove the subscription from its state but the subscription will still exist in AWS. However, if you delete an SNS topic, SNS deletes all the subscriptions associated with the topic. Also, you can import a subscription after confirmation and then have the capability to delete it.

Example Usage

You can directly supply a topic and ARN by hand in the topic_arn property along with the queue ARN:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const userUpdatesSqsTarget = new aws.sns.TopicSubscription("user_updates_sqs_target", {
    topic: "arn:aws:sns:us-west-2:432981146916:user-updates-topic",
    protocol: "sqs",
    endpoint: "arn:aws:sqs:us-west-2:432981146916:queue-too",
});
Copy
import pulumi
import pulumi_aws as aws

user_updates_sqs_target = aws.sns.TopicSubscription("user_updates_sqs_target",
    topic="arn:aws:sns:us-west-2:432981146916:user-updates-topic",
    protocol="sqs",
    endpoint="arn:aws:sqs:us-west-2:432981146916:queue-too")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sns.NewTopicSubscription(ctx, "user_updates_sqs_target", &sns.TopicSubscriptionArgs{
			Topic:    pulumi.Any("arn:aws:sns:us-west-2:432981146916:user-updates-topic"),
			Protocol: pulumi.String("sqs"),
			Endpoint: pulumi.String("arn:aws:sqs:us-west-2:432981146916:queue-too"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var userUpdatesSqsTarget = new Aws.Sns.TopicSubscription("user_updates_sqs_target", new()
    {
        Topic = "arn:aws:sns:us-west-2:432981146916:user-updates-topic",
        Protocol = "sqs",
        Endpoint = "arn:aws:sqs:us-west-2:432981146916:queue-too",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.TopicSubscription;
import com.pulumi.aws.sns.TopicSubscriptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var userUpdatesSqsTarget = new TopicSubscription("userUpdatesSqsTarget", TopicSubscriptionArgs.builder()
            .topic("arn:aws:sns:us-west-2:432981146916:user-updates-topic")
            .protocol("sqs")
            .endpoint("arn:aws:sqs:us-west-2:432981146916:queue-too")
            .build());

    }
}
Copy
resources:
  userUpdatesSqsTarget:
    type: aws:sns:TopicSubscription
    name: user_updates_sqs_target
    properties:
      topic: arn:aws:sns:us-west-2:432981146916:user-updates-topic
      protocol: sqs
      endpoint: arn:aws:sqs:us-west-2:432981146916:queue-too
Copy

Alternatively you can use the ARN properties of a managed SNS topic and SQS queue:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const userUpdates = new aws.sns.Topic("user_updates", {name: "user-updates-topic"});
const userUpdatesQueue = new aws.sqs.Queue("user_updates_queue", {name: "user-updates-queue"});
const userUpdatesSqsTarget = new aws.sns.TopicSubscription("user_updates_sqs_target", {
    topic: userUpdates.arn,
    protocol: "sqs",
    endpoint: userUpdatesQueue.arn,
});
Copy
import pulumi
import pulumi_aws as aws

user_updates = aws.sns.Topic("user_updates", name="user-updates-topic")
user_updates_queue = aws.sqs.Queue("user_updates_queue", name="user-updates-queue")
user_updates_sqs_target = aws.sns.TopicSubscription("user_updates_sqs_target",
    topic=user_updates.arn,
    protocol="sqs",
    endpoint=user_updates_queue.arn)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		userUpdates, err := sns.NewTopic(ctx, "user_updates", &sns.TopicArgs{
			Name: pulumi.String("user-updates-topic"),
		})
		if err != nil {
			return err
		}
		userUpdatesQueue, err := sqs.NewQueue(ctx, "user_updates_queue", &sqs.QueueArgs{
			Name: pulumi.String("user-updates-queue"),
		})
		if err != nil {
			return err
		}
		_, err = sns.NewTopicSubscription(ctx, "user_updates_sqs_target", &sns.TopicSubscriptionArgs{
			Topic:    userUpdates.Arn,
			Protocol: pulumi.String("sqs"),
			Endpoint: userUpdatesQueue.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var userUpdates = new Aws.Sns.Topic("user_updates", new()
    {
        Name = "user-updates-topic",
    });

    var userUpdatesQueue = new Aws.Sqs.Queue("user_updates_queue", new()
    {
        Name = "user-updates-queue",
    });

    var userUpdatesSqsTarget = new Aws.Sns.TopicSubscription("user_updates_sqs_target", new()
    {
        Topic = userUpdates.Arn,
        Protocol = "sqs",
        Endpoint = userUpdatesQueue.Arn,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.Topic;
import com.pulumi.aws.sns.TopicArgs;
import com.pulumi.aws.sqs.Queue;
import com.pulumi.aws.sqs.QueueArgs;
import com.pulumi.aws.sns.TopicSubscription;
import com.pulumi.aws.sns.TopicSubscriptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var userUpdates = new Topic("userUpdates", TopicArgs.builder()
            .name("user-updates-topic")
            .build());

        var userUpdatesQueue = new Queue("userUpdatesQueue", QueueArgs.builder()
            .name("user-updates-queue")
            .build());

        var userUpdatesSqsTarget = new TopicSubscription("userUpdatesSqsTarget", TopicSubscriptionArgs.builder()
            .topic(userUpdates.arn())
            .protocol("sqs")
            .endpoint(userUpdatesQueue.arn())
            .build());

    }
}
Copy
resources:
  userUpdates:
    type: aws:sns:Topic
    name: user_updates
    properties:
      name: user-updates-topic
  userUpdatesQueue:
    type: aws:sqs:Queue
    name: user_updates_queue
    properties:
      name: user-updates-queue
  userUpdatesSqsTarget:
    type: aws:sns:TopicSubscription
    name: user_updates_sqs_target
    properties:
      topic: ${userUpdates.arn}
      protocol: sqs
      endpoint: ${userUpdatesQueue.arn}
Copy

You can subscribe SNS topics to SQS queues in different Amazon accounts and regions:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const config = new pulumi.Config();
const sns = config.getObject<any>("sns") || {
    "account-id": "111111111111",
    displayName: "example",
    name: "example-sns-topic",
    region: "us-west-1",
    "role-name": "service/service",
};
const sqs = config.getObject<any>("sqs") || {
    "account-id": "222222222222",
    name: "example-sqs-queue",
    region: "us-east-1",
    "role-name": "service/service",
};
const sns_topic_policy = aws.iam.getPolicyDocument({
    policyId: "__default_policy_ID",
    statements: [
        {
            actions: [
                "SNS:Subscribe",
                "SNS:SetTopicAttributes",
                "SNS:RemovePermission",
                "SNS:Publish",
                "SNS:ListSubscriptionsByTopic",
                "SNS:GetTopicAttributes",
                "SNS:DeleteTopic",
                "SNS:AddPermission",
            ],
            conditions: [{
                test: "StringEquals",
                variable: "AWS:SourceOwner",
                values: [sns["account-id"]],
            }],
            effect: "Allow",
            principals: [{
                type: "AWS",
                identifiers: ["*"],
            }],
            resources: [`arn:aws:sns:${sns.region}:${sns["account-id"]}:${sns.name}`],
            sid: "__default_statement_ID",
        },
        {
            actions: [
                "SNS:Subscribe",
                "SNS:Receive",
            ],
            conditions: [{
                test: "StringLike",
                variable: "SNS:Endpoint",
                values: [`arn:aws:sqs:${sqs.region}:${sqs["account-id"]}:${sqs.name}`],
            }],
            effect: "Allow",
            principals: [{
                type: "AWS",
                identifiers: ["*"],
            }],
            resources: [`arn:aws:sns:${sns.region}:${sns["account-id"]}:${sns.name}`],
            sid: "__console_sub_0",
        },
    ],
});
const sqs_queue_policy = aws.iam.getPolicyDocument({
    policyId: `arn:aws:sqs:${sqs.region}:${sqs["account-id"]}:${sqs.name}/SQSDefaultPolicy`,
    statements: [{
        sid: "example-sns-topic",
        effect: "Allow",
        principals: [{
            type: "AWS",
            identifiers: ["*"],
        }],
        actions: ["SQS:SendMessage"],
        resources: [`arn:aws:sqs:${sqs.region}:${sqs["account-id"]}:${sqs.name}`],
        conditions: [{
            test: "ArnEquals",
            variable: "aws:SourceArn",
            values: [`arn:aws:sns:${sns.region}:${sns["account-id"]}:${sns.name}`],
        }],
    }],
});
const sns_topic = new aws.sns.Topic("sns-topic", {
    name: sns.name,
    displayName: sns.display_name,
    policy: sns_topic_policy.then(sns_topic_policy => sns_topic_policy.json),
});
const sqs_queue = new aws.sqs.Queue("sqs-queue", {
    name: sqs.name,
    policy: sqs_queue_policy.then(sqs_queue_policy => sqs_queue_policy.json),
});
const sns_topicTopicSubscription = new aws.sns.TopicSubscription("sns-topic", {
    topic: sns_topic.arn,
    protocol: "sqs",
    endpoint: sqs_queue.arn,
});
Copy
import pulumi
import pulumi_aws as aws

config = pulumi.Config()
sns = config.get_object("sns")
if sns is None:
    sns = {
        "account-id": "111111111111",
        "displayName": "example",
        "name": "example-sns-topic",
        "region": "us-west-1",
        "role-name": "service/service",
    }
sqs = config.get_object("sqs")
if sqs is None:
    sqs = {
        "account-id": "222222222222",
        "name": "example-sqs-queue",
        "region": "us-east-1",
        "role-name": "service/service",
    }
sns_topic_policy = aws.iam.get_policy_document(policy_id="__default_policy_ID",
    statements=[
        {
            "actions": [
                "SNS:Subscribe",
                "SNS:SetTopicAttributes",
                "SNS:RemovePermission",
                "SNS:Publish",
                "SNS:ListSubscriptionsByTopic",
                "SNS:GetTopicAttributes",
                "SNS:DeleteTopic",
                "SNS:AddPermission",
            ],
            "conditions": [{
                "test": "StringEquals",
                "variable": "AWS:SourceOwner",
                "values": [sns["account-id"]],
            }],
            "effect": "Allow",
            "principals": [{
                "type": "AWS",
                "identifiers": ["*"],
            }],
            "resources": [f"arn:aws:sns:{sns['region']}:{sns['account-id']}:{sns['name']}"],
            "sid": "__default_statement_ID",
        },
        {
            "actions": [
                "SNS:Subscribe",
                "SNS:Receive",
            ],
            "conditions": [{
                "test": "StringLike",
                "variable": "SNS:Endpoint",
                "values": [f"arn:aws:sqs:{sqs['region']}:{sqs['account-id']}:{sqs['name']}"],
            }],
            "effect": "Allow",
            "principals": [{
                "type": "AWS",
                "identifiers": ["*"],
            }],
            "resources": [f"arn:aws:sns:{sns['region']}:{sns['account-id']}:{sns['name']}"],
            "sid": "__console_sub_0",
        },
    ])
sqs_queue_policy = aws.iam.get_policy_document(policy_id=f"arn:aws:sqs:{sqs['region']}:{sqs['account-id']}:{sqs['name']}/SQSDefaultPolicy",
    statements=[{
        "sid": "example-sns-topic",
        "effect": "Allow",
        "principals": [{
            "type": "AWS",
            "identifiers": ["*"],
        }],
        "actions": ["SQS:SendMessage"],
        "resources": [f"arn:aws:sqs:{sqs['region']}:{sqs['account-id']}:{sqs['name']}"],
        "conditions": [{
            "test": "ArnEquals",
            "variable": "aws:SourceArn",
            "values": [f"arn:aws:sns:{sns['region']}:{sns['account-id']}:{sns['name']}"],
        }],
    }])
sns_topic = aws.sns.Topic("sns-topic",
    name=sns["name"],
    display_name=sns["display_name"],
    policy=sns_topic_policy.json)
sqs_queue = aws.sqs.Queue("sqs-queue",
    name=sqs["name"],
    policy=sqs_queue_policy.json)
sns_topic_topic_subscription = aws.sns.TopicSubscription("sns-topic",
    topic=sns_topic.arn,
    protocol="sqs",
    endpoint=sqs_queue.arn)
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
sns := map[string]interface{}{
"account-id": "111111111111",
"displayName": "example",
"name": "example-sns-topic",
"region": "us-west-1",
"role-name": "service/service",
};
if param := cfg.GetObject("sns"); param != nil {
sns = param
}
sqs := map[string]interface{}{
"account-id": "222222222222",
"name": "example-sqs-queue",
"region": "us-east-1",
"role-name": "service/service",
};
if param := cfg.GetObject("sqs"); param != nil {
sqs = param
}
sns_topic_policy, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
PolicyId: pulumi.StringRef("__default_policy_ID"),
Statements: []iam.GetPolicyDocumentStatement{
{
Actions: []string{
"SNS:Subscribe",
"SNS:SetTopicAttributes",
"SNS:RemovePermission",
"SNS:Publish",
"SNS:ListSubscriptionsByTopic",
"SNS:GetTopicAttributes",
"SNS:DeleteTopic",
"SNS:AddPermission",
},
Conditions: []iam.GetPolicyDocumentStatementCondition{
{
Test: "StringEquals",
Variable: "AWS:SourceOwner",
Values: interface{}{
sns.AccountId,
},
},
},
Effect: pulumi.StringRef("Allow"),
Principals: []iam.GetPolicyDocumentStatementPrincipal{
{
Type: "AWS",
Identifiers: []string{
"*",
},
},
},
Resources: []string{
fmt.Sprintf("arn:aws:sns:%v:%v:%v", sns.Region, sns.AccountId, sns.Name),
},
Sid: pulumi.StringRef("__default_statement_ID"),
},
{
Actions: []string{
"SNS:Subscribe",
"SNS:Receive",
},
Conditions: []iam.GetPolicyDocumentStatementCondition{
{
Test: "StringLike",
Variable: "SNS:Endpoint",
Values: []string{
fmt.Sprintf("arn:aws:sqs:%v:%v:%v", sqs.Region, sqs.AccountId, sqs.Name),
},
},
},
Effect: pulumi.StringRef("Allow"),
Principals: []iam.GetPolicyDocumentStatementPrincipal{
{
Type: "AWS",
Identifiers: []string{
"*",
},
},
},
Resources: []string{
fmt.Sprintf("arn:aws:sns:%v:%v:%v", sns.Region, sns.AccountId, sns.Name),
},
Sid: pulumi.StringRef("__console_sub_0"),
},
},
}, nil);
if err != nil {
return err
}
sqs_queue_policy, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
PolicyId: pulumi.StringRef(fmt.Sprintf("arn:aws:sqs:%v:%v:%v/SQSDefaultPolicy", sqs.Region, sqs.AccountId, sqs.Name)),
Statements: []iam.GetPolicyDocumentStatement{
{
Sid: pulumi.StringRef("example-sns-topic"),
Effect: pulumi.StringRef("Allow"),
Principals: []iam.GetPolicyDocumentStatementPrincipal{
{
Type: "AWS",
Identifiers: []string{
"*",
},
},
},
Actions: []string{
"SQS:SendMessage",
},
Resources: []string{
fmt.Sprintf("arn:aws:sqs:%v:%v:%v", sqs.Region, sqs.AccountId, sqs.Name),
},
Conditions: []iam.GetPolicyDocumentStatementCondition{
{
Test: "ArnEquals",
Variable: "aws:SourceArn",
Values: []string{
fmt.Sprintf("arn:aws:sns:%v:%v:%v", sns.Region, sns.AccountId, sns.Name),
},
},
},
},
},
}, nil);
if err != nil {
return err
}
sns_topic, err := sns.NewTopic(ctx, "sns-topic", &sns.TopicArgs{
Name: pulumi.Any(sns.Name),
DisplayName: pulumi.Any(sns.Display_name),
Policy: pulumi.String(sns_topic_policy.Json),
})
if err != nil {
return err
}
sqs_queue, err := sqs.NewQueue(ctx, "sqs-queue", &sqs.QueueArgs{
Name: pulumi.Any(sqs.Name),
Policy: pulumi.String(sqs_queue_policy.Json),
})
if err != nil {
return err
}
_, err = sns.NewTopicSubscription(ctx, "sns-topic", &sns.TopicSubscriptionArgs{
Topic: sns_topic.Arn,
Protocol: pulumi.String("sqs"),
Endpoint: sqs_queue.Arn,
})
if err != nil {
return err
}
return nil
})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var sns = config.GetObject<dynamic>("sns") ?? 
    {
        { "account-id", "111111111111" },
        { "displayName", "example" },
        { "name", "example-sns-topic" },
        { "region", "us-west-1" },
        { "role-name", "service/service" },
    };
    var sqs = config.GetObject<dynamic>("sqs") ?? 
    {
        { "account-id", "222222222222" },
        { "name", "example-sqs-queue" },
        { "region", "us-east-1" },
        { "role-name", "service/service" },
    };
    var sns_topic_policy = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        PolicyId = "__default_policy_ID",
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Actions = new[]
                {
                    "SNS:Subscribe",
                    "SNS:SetTopicAttributes",
                    "SNS:RemovePermission",
                    "SNS:Publish",
                    "SNS:ListSubscriptionsByTopic",
                    "SNS:GetTopicAttributes",
                    "SNS:DeleteTopic",
                    "SNS:AddPermission",
                },
                Conditions = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
                    {
                        Test = "StringEquals",
                        Variable = "AWS:SourceOwner",
                        Values = new[]
                        {
                            sns.Account_id,
                        },
                    },
                },
                Effect = "Allow",
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "AWS",
                        Identifiers = new[]
                        {
                            "*",
                        },
                    },
                },
                Resources = new[]
                {
                    $"arn:aws:sns:{sns.Region}:{sns.Account_id}:{sns.Name}",
                },
                Sid = "__default_statement_ID",
            },
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Actions = new[]
                {
                    "SNS:Subscribe",
                    "SNS:Receive",
                },
                Conditions = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
                    {
                        Test = "StringLike",
                        Variable = "SNS:Endpoint",
                        Values = new[]
                        {
                            $"arn:aws:sqs:{sqs.Region}:{sqs.Account_id}:{sqs.Name}",
                        },
                    },
                },
                Effect = "Allow",
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "AWS",
                        Identifiers = new[]
                        {
                            "*",
                        },
                    },
                },
                Resources = new[]
                {
                    $"arn:aws:sns:{sns.Region}:{sns.Account_id}:{sns.Name}",
                },
                Sid = "__console_sub_0",
            },
        },
    });

    var sqs_queue_policy = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        PolicyId = $"arn:aws:sqs:{sqs.Region}:{sqs.Account_id}:{sqs.Name}/SQSDefaultPolicy",
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Sid = "example-sns-topic",
                Effect = "Allow",
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "AWS",
                        Identifiers = new[]
                        {
                            "*",
                        },
                    },
                },
                Actions = new[]
                {
                    "SQS:SendMessage",
                },
                Resources = new[]
                {
                    $"arn:aws:sqs:{sqs.Region}:{sqs.Account_id}:{sqs.Name}",
                },
                Conditions = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
                    {
                        Test = "ArnEquals",
                        Variable = "aws:SourceArn",
                        Values = new[]
                        {
                            $"arn:aws:sns:{sns.Region}:{sns.Account_id}:{sns.Name}",
                        },
                    },
                },
            },
        },
    });

    var sns_topic = new Aws.Sns.Topic("sns-topic", new()
    {
        Name = sns.Name,
        DisplayName = sns.Display_name,
        Policy = sns_topic_policy.Apply(sns_topic_policy => sns_topic_policy.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json)),
    });

    var sqs_queue = new Aws.Sqs.Queue("sqs-queue", new()
    {
        Name = sqs.Name,
        Policy = sqs_queue_policy.Apply(sqs_queue_policy => sqs_queue_policy.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json)),
    });

    var sns_topicTopicSubscription = new Aws.Sns.TopicSubscription("sns-topic", new()
    {
        Topic = sns_topic.Arn,
        Protocol = "sqs",
        Endpoint = sqs_queue.Arn,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.sns.Topic;
import com.pulumi.aws.sns.TopicArgs;
import com.pulumi.aws.sqs.Queue;
import com.pulumi.aws.sqs.QueueArgs;
import com.pulumi.aws.sns.TopicSubscription;
import com.pulumi.aws.sns.TopicSubscriptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var sns = config.get("sns").orElse(Map.ofEntries(
            Map.entry("account-id", "111111111111"),
            Map.entry("displayName", "example"),
            Map.entry("name", "example-sns-topic"),
            Map.entry("region", "us-west-1"),
            Map.entry("role-name", "service/service")
        ));
        final var sqs = config.get("sqs").orElse(Map.ofEntries(
            Map.entry("account-id", "222222222222"),
            Map.entry("name", "example-sqs-queue"),
            Map.entry("region", "us-east-1"),
            Map.entry("role-name", "service/service")
        ));
        final var sns-topic-policy = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .policyId("__default_policy_ID")
            .statements(            
                GetPolicyDocumentStatementArgs.builder()
                    .actions(                    
                        "SNS:Subscribe",
                        "SNS:SetTopicAttributes",
                        "SNS:RemovePermission",
                        "SNS:Publish",
                        "SNS:ListSubscriptionsByTopic",
                        "SNS:GetTopicAttributes",
                        "SNS:DeleteTopic",
                        "SNS:AddPermission")
                    .conditions(GetPolicyDocumentStatementConditionArgs.builder()
                        .test("StringEquals")
                        .variable("AWS:SourceOwner")
                        .values(sns.account-id())
                        .build())
                    .effect("Allow")
                    .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                        .type("AWS")
                        .identifiers("*")
                        .build())
                    .resources(String.format("arn:aws:sns:%s:%s:%s", sns.region(),sns.account-id(),sns.name()))
                    .sid("__default_statement_ID")
                    .build(),
                GetPolicyDocumentStatementArgs.builder()
                    .actions(                    
                        "SNS:Subscribe",
                        "SNS:Receive")
                    .conditions(GetPolicyDocumentStatementConditionArgs.builder()
                        .test("StringLike")
                        .variable("SNS:Endpoint")
                        .values(String.format("arn:aws:sqs:%s:%s:%s", sqs.region(),sqs.account-id(),sqs.name()))
                        .build())
                    .effect("Allow")
                    .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                        .type("AWS")
                        .identifiers("*")
                        .build())
                    .resources(String.format("arn:aws:sns:%s:%s:%s", sns.region(),sns.account-id(),sns.name()))
                    .sid("__console_sub_0")
                    .build())
            .build());

        final var sqs-queue-policy = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .policyId(String.format("arn:aws:sqs:%s:%s:%s/SQSDefaultPolicy", sqs.region(),sqs.account-id(),sqs.name()))
            .statements(GetPolicyDocumentStatementArgs.builder()
                .sid("example-sns-topic")
                .effect("Allow")
                .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                    .type("AWS")
                    .identifiers("*")
                    .build())
                .actions("SQS:SendMessage")
                .resources(String.format("arn:aws:sqs:%s:%s:%s", sqs.region(),sqs.account-id(),sqs.name()))
                .conditions(GetPolicyDocumentStatementConditionArgs.builder()
                    .test("ArnEquals")
                    .variable("aws:SourceArn")
                    .values(String.format("arn:aws:sns:%s:%s:%s", sns.region(),sns.account-id(),sns.name()))
                    .build())
                .build())
            .build());

        var sns_topic = new Topic("sns-topic", TopicArgs.builder()
            .name(sns.name())
            .displayName(sns.display_name())
            .policy(sns_topic_policy.json())
            .build());

        var sqs_queue = new Queue("sqs-queue", QueueArgs.builder()
            .name(sqs.name())
            .policy(sqs_queue_policy.json())
            .build());

        var sns_topicTopicSubscription = new TopicSubscription("sns-topicTopicSubscription", TopicSubscriptionArgs.builder()
            .topic(sns_topic.arn())
            .protocol("sqs")
            .endpoint(sqs_queue.arn())
            .build());

    }
}
Copy
configuration:
  sns:
    type: dynamic
    default:
      account-id: '111111111111'
      displayName: example
      name: example-sns-topic
      region: us-west-1
      role-name: service/service
  sqs:
    type: dynamic
    default:
      account-id: '222222222222'
      name: example-sqs-queue
      region: us-east-1
      role-name: service/service
resources:
  sns-topic:
    type: aws:sns:Topic
    properties:
      name: ${sns.name}
      displayName: ${sns.display_name}
      policy: ${["sns-topic-policy"].json}
  sqs-queue:
    type: aws:sqs:Queue
    properties:
      name: ${sqs.name}
      policy: ${["sqs-queue-policy"].json}
  sns-topicTopicSubscription:
    type: aws:sns:TopicSubscription
    name: sns-topic
    properties:
      topic: ${["sns-topic"].arn}
      protocol: sqs
      endpoint: ${["sqs-queue"].arn}
variables:
  sns-topic-policy:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        policyId: __default_policy_ID
        statements:
          - actions:
              - SNS:Subscribe
              - SNS:SetTopicAttributes
              - SNS:RemovePermission
              - SNS:Publish
              - SNS:ListSubscriptionsByTopic
              - SNS:GetTopicAttributes
              - SNS:DeleteTopic
              - SNS:AddPermission
            conditions:
              - test: StringEquals
                variable: AWS:SourceOwner
                values:
                  - ${sns"account-id"[%!s(MISSING)]}
            effect: Allow
            principals:
              - type: AWS
                identifiers:
                  - '*'
            resources:
              - arn:aws:sns:${sns.region}:${sns"account-id"[%!s(MISSING)]}:${sns.name}
            sid: __default_statement_ID
          - actions:
              - SNS:Subscribe
              - SNS:Receive
            conditions:
              - test: StringLike
                variable: SNS:Endpoint
                values:
                  - arn:aws:sqs:${sqs.region}:${sqs"account-id"[%!s(MISSING)]}:${sqs.name}
            effect: Allow
            principals:
              - type: AWS
                identifiers:
                  - '*'
            resources:
              - arn:aws:sns:${sns.region}:${sns"account-id"[%!s(MISSING)]}:${sns.name}
            sid: __console_sub_0
  sqs-queue-policy:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        policyId: arn:aws:sqs:${sqs.region}:${sqs"account-id"[%!s(MISSING)]}:${sqs.name}/SQSDefaultPolicy
        statements:
          - sid: example-sns-topic
            effect: Allow
            principals:
              - type: AWS
                identifiers:
                  - '*'
            actions:
              - SQS:SendMessage
            resources:
              - arn:aws:sqs:${sqs.region}:${sqs"account-id"[%!s(MISSING)]}:${sqs.name}
            conditions:
              - test: ArnEquals
                variable: aws:SourceArn
                values:
                  - arn:aws:sns:${sns.region}:${sns"account-id"[%!s(MISSING)]}:${sns.name}
Copy

Example with Delivery Policy

This example demonstrates how to define a delivery_policy for an HTTPS subscription. Unlike the aws.sns.Topic resource, the delivery_policy for aws.sns.TopicSubscription should not be wrapped in an "http" object.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleWithDeliveryPolicy = new aws.sns.TopicSubscription("example_with_delivery_policy", {
    topic: "arn:aws:sns:us-west-2:123456789012:my-topic",
    protocol: "https",
    endpoint: "https://example.com/endpoint",
    rawMessageDelivery: true,
    deliveryPolicy: `{
  "healthyRetryPolicy": {
    "minDelayTarget": 20,
    "maxDelayTarget": 20,
    "numRetries": 3,
    "numMaxDelayRetries": 0,
    "numNoDelayRetries": 0,
    "numMinDelayRetries": 0,
    "backoffFunction": "linear"
  },
  "sicklyRetryPolicy": null,
  "throttlePolicy": null,
  "requestPolicy": {
    "headerContentType": "text/plain; application/json"
  },
  "guaranteed": false
}
`,
});
Copy
import pulumi
import pulumi_aws as aws

example_with_delivery_policy = aws.sns.TopicSubscription("example_with_delivery_policy",
    topic="arn:aws:sns:us-west-2:123456789012:my-topic",
    protocol="https",
    endpoint="https://example.com/endpoint",
    raw_message_delivery=True,
    delivery_policy="""{
  "healthyRetryPolicy": {
    "minDelayTarget": 20,
    "maxDelayTarget": 20,
    "numRetries": 3,
    "numMaxDelayRetries": 0,
    "numNoDelayRetries": 0,
    "numMinDelayRetries": 0,
    "backoffFunction": "linear"
  },
  "sicklyRetryPolicy": null,
  "throttlePolicy": null,
  "requestPolicy": {
    "headerContentType": "text/plain; application/json"
  },
  "guaranteed": false
}
""")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sns.NewTopicSubscription(ctx, "example_with_delivery_policy", &sns.TopicSubscriptionArgs{
			Topic:              pulumi.Any("arn:aws:sns:us-west-2:123456789012:my-topic"),
			Protocol:           pulumi.String("https"),
			Endpoint:           pulumi.String("https://example.com/endpoint"),
			RawMessageDelivery: pulumi.Bool(true),
			DeliveryPolicy: pulumi.String(`{
  "healthyRetryPolicy": {
    "minDelayTarget": 20,
    "maxDelayTarget": 20,
    "numRetries": 3,
    "numMaxDelayRetries": 0,
    "numNoDelayRetries": 0,
    "numMinDelayRetries": 0,
    "backoffFunction": "linear"
  },
  "sicklyRetryPolicy": null,
  "throttlePolicy": null,
  "requestPolicy": {
    "headerContentType": "text/plain; application/json"
  },
  "guaranteed": false
}
`),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var exampleWithDeliveryPolicy = new Aws.Sns.TopicSubscription("example_with_delivery_policy", new()
    {
        Topic = "arn:aws:sns:us-west-2:123456789012:my-topic",
        Protocol = "https",
        Endpoint = "https://example.com/endpoint",
        RawMessageDelivery = true,
        DeliveryPolicy = @"{
  ""healthyRetryPolicy"": {
    ""minDelayTarget"": 20,
    ""maxDelayTarget"": 20,
    ""numRetries"": 3,
    ""numMaxDelayRetries"": 0,
    ""numNoDelayRetries"": 0,
    ""numMinDelayRetries"": 0,
    ""backoffFunction"": ""linear""
  },
  ""sicklyRetryPolicy"": null,
  ""throttlePolicy"": null,
  ""requestPolicy"": {
    ""headerContentType"": ""text/plain; application/json""
  },
  ""guaranteed"": false
}
",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.TopicSubscription;
import com.pulumi.aws.sns.TopicSubscriptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleWithDeliveryPolicy = new TopicSubscription("exampleWithDeliveryPolicy", TopicSubscriptionArgs.builder()
            .topic("arn:aws:sns:us-west-2:123456789012:my-topic")
            .protocol("https")
            .endpoint("https://example.com/endpoint")
            .rawMessageDelivery(true)
            .deliveryPolicy("""
{
  "healthyRetryPolicy": {
    "minDelayTarget": 20,
    "maxDelayTarget": 20,
    "numRetries": 3,
    "numMaxDelayRetries": 0,
    "numNoDelayRetries": 0,
    "numMinDelayRetries": 0,
    "backoffFunction": "linear"
  },
  "sicklyRetryPolicy": null,
  "throttlePolicy": null,
  "requestPolicy": {
    "headerContentType": "text/plain; application/json"
  },
  "guaranteed": false
}
            """)
            .build());

    }
}
Copy
resources:
  exampleWithDeliveryPolicy:
    type: aws:sns:TopicSubscription
    name: example_with_delivery_policy
    properties:
      topic: arn:aws:sns:us-west-2:123456789012:my-topic
      protocol: https
      endpoint: https://example.com/endpoint
      rawMessageDelivery: true
      deliveryPolicy: |
        {
          "healthyRetryPolicy": {
            "minDelayTarget": 20,
            "maxDelayTarget": 20,
            "numRetries": 3,
            "numMaxDelayRetries": 0,
            "numNoDelayRetries": 0,
            "numMinDelayRetries": 0,
            "backoffFunction": "linear"
          },
          "sicklyRetryPolicy": null,
          "throttlePolicy": null,
          "requestPolicy": {
            "headerContentType": "text/plain; application/json"
          },
          "guaranteed": false
        }
Copy

Create TopicSubscription Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TopicSubscription(name: string, args: TopicSubscriptionArgs, opts?: CustomResourceOptions);
@overload
def TopicSubscription(resource_name: str,
                      args: TopicSubscriptionArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def TopicSubscription(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      endpoint: Optional[str] = None,
                      protocol: Optional[str] = None,
                      topic: Optional[str] = None,
                      confirmation_timeout_in_minutes: Optional[int] = None,
                      delivery_policy: Optional[str] = None,
                      endpoint_auto_confirms: Optional[bool] = None,
                      filter_policy: Optional[str] = None,
                      filter_policy_scope: Optional[str] = None,
                      raw_message_delivery: Optional[bool] = None,
                      redrive_policy: Optional[str] = None,
                      replay_policy: Optional[str] = None,
                      subscription_role_arn: Optional[str] = None)
func NewTopicSubscription(ctx *Context, name string, args TopicSubscriptionArgs, opts ...ResourceOption) (*TopicSubscription, error)
public TopicSubscription(string name, TopicSubscriptionArgs args, CustomResourceOptions? opts = null)
public TopicSubscription(String name, TopicSubscriptionArgs args)
public TopicSubscription(String name, TopicSubscriptionArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TopicSubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TopicSubscriptionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TopicSubscriptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TopicSubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TopicSubscriptionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var topicSubscriptionResource = new Aws.Sns.TopicSubscription("topicSubscriptionResource", new()
{
    Endpoint = "string",
    Protocol = "string",
    Topic = "string",
    ConfirmationTimeoutInMinutes = 0,
    DeliveryPolicy = "string",
    EndpointAutoConfirms = false,
    FilterPolicy = "string",
    FilterPolicyScope = "string",
    RawMessageDelivery = false,
    RedrivePolicy = "string",
    ReplayPolicy = "string",
    SubscriptionRoleArn = "string",
});
Copy
example, err := sns.NewTopicSubscription(ctx, "topicSubscriptionResource", &sns.TopicSubscriptionArgs{
	Endpoint:                     pulumi.String("string"),
	Protocol:                     pulumi.String("string"),
	Topic:                        pulumi.Any("string"),
	ConfirmationTimeoutInMinutes: pulumi.Int(0),
	DeliveryPolicy:               pulumi.String("string"),
	EndpointAutoConfirms:         pulumi.Bool(false),
	FilterPolicy:                 pulumi.String("string"),
	FilterPolicyScope:            pulumi.String("string"),
	RawMessageDelivery:           pulumi.Bool(false),
	RedrivePolicy:                pulumi.String("string"),
	ReplayPolicy:                 pulumi.String("string"),
	SubscriptionRoleArn:          pulumi.String("string"),
})
Copy
var topicSubscriptionResource = new TopicSubscription("topicSubscriptionResource", TopicSubscriptionArgs.builder()
    .endpoint("string")
    .protocol("string")
    .topic("string")
    .confirmationTimeoutInMinutes(0)
    .deliveryPolicy("string")
    .endpointAutoConfirms(false)
    .filterPolicy("string")
    .filterPolicyScope("string")
    .rawMessageDelivery(false)
    .redrivePolicy("string")
    .replayPolicy("string")
    .subscriptionRoleArn("string")
    .build());
Copy
topic_subscription_resource = aws.sns.TopicSubscription("topicSubscriptionResource",
    endpoint="string",
    protocol="string",
    topic="string",
    confirmation_timeout_in_minutes=0,
    delivery_policy="string",
    endpoint_auto_confirms=False,
    filter_policy="string",
    filter_policy_scope="string",
    raw_message_delivery=False,
    redrive_policy="string",
    replay_policy="string",
    subscription_role_arn="string")
Copy
const topicSubscriptionResource = new aws.sns.TopicSubscription("topicSubscriptionResource", {
    endpoint: "string",
    protocol: "string",
    topic: "string",
    confirmationTimeoutInMinutes: 0,
    deliveryPolicy: "string",
    endpointAutoConfirms: false,
    filterPolicy: "string",
    filterPolicyScope: "string",
    rawMessageDelivery: false,
    redrivePolicy: "string",
    replayPolicy: "string",
    subscriptionRoleArn: "string",
});
Copy
type: aws:sns:TopicSubscription
properties:
    confirmationTimeoutInMinutes: 0
    deliveryPolicy: string
    endpoint: string
    endpointAutoConfirms: false
    filterPolicy: string
    filterPolicyScope: string
    protocol: string
    rawMessageDelivery: false
    redrivePolicy: string
    replayPolicy: string
    subscriptionRoleArn: string
    topic: string
Copy

TopicSubscription Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TopicSubscription resource accepts the following input properties:

Endpoint
This property is required.
Changes to this property will trigger replacement.
string
Endpoint to send data to. The contents vary with the protocol. See details below.
Protocol
This property is required.
Changes to this property will trigger replacement.
string
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
Topic
This property is required.
Changes to this property will trigger replacement.
string | string

ARN of the SNS topic to subscribe to.

The following arguments are optional:

ConfirmationTimeoutInMinutes int
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
DeliveryPolicy string
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
EndpointAutoConfirms bool
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
FilterPolicy string
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
FilterPolicyScope string
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
RawMessageDelivery bool
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
RedrivePolicy string
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
ReplayPolicy string
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
SubscriptionRoleArn string
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
Endpoint
This property is required.
Changes to this property will trigger replacement.
string
Endpoint to send data to. The contents vary with the protocol. See details below.
Protocol
This property is required.
Changes to this property will trigger replacement.
string
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
Topic
This property is required.
Changes to this property will trigger replacement.
string | string

ARN of the SNS topic to subscribe to.

The following arguments are optional:

ConfirmationTimeoutInMinutes int
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
DeliveryPolicy string
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
EndpointAutoConfirms bool
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
FilterPolicy string
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
FilterPolicyScope string
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
RawMessageDelivery bool
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
RedrivePolicy string
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
ReplayPolicy string
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
SubscriptionRoleArn string
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
endpoint
This property is required.
Changes to this property will trigger replacement.
String
Endpoint to send data to. The contents vary with the protocol. See details below.
protocol
This property is required.
Changes to this property will trigger replacement.
String
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
topic
This property is required.
Changes to this property will trigger replacement.
String | String

ARN of the SNS topic to subscribe to.

The following arguments are optional:

confirmationTimeoutInMinutes Integer
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
deliveryPolicy String
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
endpointAutoConfirms Boolean
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
filterPolicy String
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
filterPolicyScope String
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
rawMessageDelivery Boolean
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
redrivePolicy String
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
replayPolicy String
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
subscriptionRoleArn String
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
endpoint
This property is required.
Changes to this property will trigger replacement.
string
Endpoint to send data to. The contents vary with the protocol. See details below.
protocol
This property is required.
Changes to this property will trigger replacement.
string
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
topic
This property is required.
Changes to this property will trigger replacement.
string | Topic

ARN of the SNS topic to subscribe to.

The following arguments are optional:

confirmationTimeoutInMinutes number
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
deliveryPolicy string
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
endpointAutoConfirms boolean
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
filterPolicy string
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
filterPolicyScope string
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
rawMessageDelivery boolean
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
redrivePolicy string
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
replayPolicy string
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
subscriptionRoleArn string
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
endpoint
This property is required.
Changes to this property will trigger replacement.
str
Endpoint to send data to. The contents vary with the protocol. See details below.
protocol
This property is required.
Changes to this property will trigger replacement.
str
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
topic
This property is required.
Changes to this property will trigger replacement.
str | str

ARN of the SNS topic to subscribe to.

The following arguments are optional:

confirmation_timeout_in_minutes int
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
delivery_policy str
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
endpoint_auto_confirms bool
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
filter_policy str
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
filter_policy_scope str
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
raw_message_delivery bool
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
redrive_policy str
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
replay_policy str
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
subscription_role_arn str
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
endpoint
This property is required.
Changes to this property will trigger replacement.
String
Endpoint to send data to. The contents vary with the protocol. See details below.
protocol
This property is required.
Changes to this property will trigger replacement.
String
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
topic
This property is required.
Changes to this property will trigger replacement.
String |

ARN of the SNS topic to subscribe to.

The following arguments are optional:

confirmationTimeoutInMinutes Number
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
deliveryPolicy String
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
endpointAutoConfirms Boolean
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
filterPolicy String
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
filterPolicyScope String
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
rawMessageDelivery Boolean
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
redrivePolicy String
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
replayPolicy String
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
subscriptionRoleArn String
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

Outputs

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

Arn string
ARN of the subscription.
ConfirmationWasAuthenticated bool
Whether the subscription confirmation request was authenticated.
Id string
The provider-assigned unique ID for this managed resource.
OwnerId string
AWS account ID of the subscription's owner.
PendingConfirmation bool
Whether the subscription has not been confirmed.
Arn string
ARN of the subscription.
ConfirmationWasAuthenticated bool
Whether the subscription confirmation request was authenticated.
Id string
The provider-assigned unique ID for this managed resource.
OwnerId string
AWS account ID of the subscription's owner.
PendingConfirmation bool
Whether the subscription has not been confirmed.
arn String
ARN of the subscription.
confirmationWasAuthenticated Boolean
Whether the subscription confirmation request was authenticated.
id String
The provider-assigned unique ID for this managed resource.
ownerId String
AWS account ID of the subscription's owner.
pendingConfirmation Boolean
Whether the subscription has not been confirmed.
arn string
ARN of the subscription.
confirmationWasAuthenticated boolean
Whether the subscription confirmation request was authenticated.
id string
The provider-assigned unique ID for this managed resource.
ownerId string
AWS account ID of the subscription's owner.
pendingConfirmation boolean
Whether the subscription has not been confirmed.
arn str
ARN of the subscription.
confirmation_was_authenticated bool
Whether the subscription confirmation request was authenticated.
id str
The provider-assigned unique ID for this managed resource.
owner_id str
AWS account ID of the subscription's owner.
pending_confirmation bool
Whether the subscription has not been confirmed.
arn String
ARN of the subscription.
confirmationWasAuthenticated Boolean
Whether the subscription confirmation request was authenticated.
id String
The provider-assigned unique ID for this managed resource.
ownerId String
AWS account ID of the subscription's owner.
pendingConfirmation Boolean
Whether the subscription has not been confirmed.

Look up Existing TopicSubscription Resource

Get an existing TopicSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TopicSubscriptionState, opts?: CustomResourceOptions): TopicSubscription
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        confirmation_timeout_in_minutes: Optional[int] = None,
        confirmation_was_authenticated: Optional[bool] = None,
        delivery_policy: Optional[str] = None,
        endpoint: Optional[str] = None,
        endpoint_auto_confirms: Optional[bool] = None,
        filter_policy: Optional[str] = None,
        filter_policy_scope: Optional[str] = None,
        owner_id: Optional[str] = None,
        pending_confirmation: Optional[bool] = None,
        protocol: Optional[str] = None,
        raw_message_delivery: Optional[bool] = None,
        redrive_policy: Optional[str] = None,
        replay_policy: Optional[str] = None,
        subscription_role_arn: Optional[str] = None,
        topic: Optional[str] = None) -> TopicSubscription
func GetTopicSubscription(ctx *Context, name string, id IDInput, state *TopicSubscriptionState, opts ...ResourceOption) (*TopicSubscription, error)
public static TopicSubscription Get(string name, Input<string> id, TopicSubscriptionState? state, CustomResourceOptions? opts = null)
public static TopicSubscription get(String name, Output<String> id, TopicSubscriptionState state, CustomResourceOptions options)
resources:  _:    type: aws:sns:TopicSubscription    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
ARN of the subscription.
ConfirmationTimeoutInMinutes int
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
ConfirmationWasAuthenticated bool
Whether the subscription confirmation request was authenticated.
DeliveryPolicy string
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
Endpoint Changes to this property will trigger replacement. string
Endpoint to send data to. The contents vary with the protocol. See details below.
EndpointAutoConfirms bool
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
FilterPolicy string
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
FilterPolicyScope string
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
OwnerId string
AWS account ID of the subscription's owner.
PendingConfirmation bool
Whether the subscription has not been confirmed.
Protocol Changes to this property will trigger replacement. string
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
RawMessageDelivery bool
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
RedrivePolicy string
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
ReplayPolicy string
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
SubscriptionRoleArn string
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
Topic Changes to this property will trigger replacement. string | string

ARN of the SNS topic to subscribe to.

The following arguments are optional:

Arn string
ARN of the subscription.
ConfirmationTimeoutInMinutes int
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
ConfirmationWasAuthenticated bool
Whether the subscription confirmation request was authenticated.
DeliveryPolicy string
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
Endpoint Changes to this property will trigger replacement. string
Endpoint to send data to. The contents vary with the protocol. See details below.
EndpointAutoConfirms bool
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
FilterPolicy string
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
FilterPolicyScope string
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
OwnerId string
AWS account ID of the subscription's owner.
PendingConfirmation bool
Whether the subscription has not been confirmed.
Protocol Changes to this property will trigger replacement. string
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
RawMessageDelivery bool
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
RedrivePolicy string
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
ReplayPolicy string
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
SubscriptionRoleArn string
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
Topic Changes to this property will trigger replacement. string | string

ARN of the SNS topic to subscribe to.

The following arguments are optional:

arn String
ARN of the subscription.
confirmationTimeoutInMinutes Integer
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
confirmationWasAuthenticated Boolean
Whether the subscription confirmation request was authenticated.
deliveryPolicy String
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
endpoint Changes to this property will trigger replacement. String
Endpoint to send data to. The contents vary with the protocol. See details below.
endpointAutoConfirms Boolean
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
filterPolicy String
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
filterPolicyScope String
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
ownerId String
AWS account ID of the subscription's owner.
pendingConfirmation Boolean
Whether the subscription has not been confirmed.
protocol Changes to this property will trigger replacement. String
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
rawMessageDelivery Boolean
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
redrivePolicy String
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
replayPolicy String
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
subscriptionRoleArn String
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
topic Changes to this property will trigger replacement. String | String

ARN of the SNS topic to subscribe to.

The following arguments are optional:

arn string
ARN of the subscription.
confirmationTimeoutInMinutes number
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
confirmationWasAuthenticated boolean
Whether the subscription confirmation request was authenticated.
deliveryPolicy string
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
endpoint Changes to this property will trigger replacement. string
Endpoint to send data to. The contents vary with the protocol. See details below.
endpointAutoConfirms boolean
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
filterPolicy string
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
filterPolicyScope string
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
ownerId string
AWS account ID of the subscription's owner.
pendingConfirmation boolean
Whether the subscription has not been confirmed.
protocol Changes to this property will trigger replacement. string
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
rawMessageDelivery boolean
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
redrivePolicy string
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
replayPolicy string
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
subscriptionRoleArn string
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
topic Changes to this property will trigger replacement. string | Topic

ARN of the SNS topic to subscribe to.

The following arguments are optional:

arn str
ARN of the subscription.
confirmation_timeout_in_minutes int
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
confirmation_was_authenticated bool
Whether the subscription confirmation request was authenticated.
delivery_policy str
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
endpoint Changes to this property will trigger replacement. str
Endpoint to send data to. The contents vary with the protocol. See details below.
endpoint_auto_confirms bool
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
filter_policy str
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
filter_policy_scope str
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
owner_id str
AWS account ID of the subscription's owner.
pending_confirmation bool
Whether the subscription has not been confirmed.
protocol Changes to this property will trigger replacement. str
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
raw_message_delivery bool
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
redrive_policy str
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
replay_policy str
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
subscription_role_arn str
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
topic Changes to this property will trigger replacement. str | str

ARN of the SNS topic to subscribe to.

The following arguments are optional:

arn String
ARN of the subscription.
confirmationTimeoutInMinutes Number
Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is 1.
confirmationWasAuthenticated Boolean
Whether the subscription confirmation request was authenticated.
deliveryPolicy String
JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the SNS docs for more details.
endpoint Changes to this property will trigger replacement. String
Endpoint to send data to. The contents vary with the protocol. See details below.
endpointAutoConfirms Boolean
Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.
filterPolicy String
JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the SNS docs for more details.
filterPolicyScope String
Whether the filter_policy applies to MessageAttributes (default) or MessageBody.
ownerId String
AWS account ID of the subscription's owner.
pendingConfirmation Boolean
Whether the subscription has not been confirmed.
protocol Changes to this property will trigger replacement. String
Protocol to use. Valid values are: sqs, sms, lambda, firehose, and application. Protocols email, email-json, http and https are also valid but partially supported. See details below.
rawMessageDelivery Boolean
Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is false.
redrivePolicy String
JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.
replayPolicy String
JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.
subscriptionRoleArn String
ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.
topic Changes to this property will trigger replacement. String |

ARN of the SNS topic to subscribe to.

The following arguments are optional:

Import

Using pulumi import, import SNS Topic Subscriptions using the subscription arn. For example:

$ pulumi import aws:sns/topicSubscription:TopicSubscription user_updates_sqs_target arn:aws:sns:us-west-2:123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws