Docs Packages
  1. Pulumi Registry
  2. AWS Classic
  3. API Docs
  4. sns
  5. TopicSubscription
aws logo
AWS Classic v5.41.0, May 15 23

aws.sns.TopicSubscription

Explore with Pulumi AI

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

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

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

});

package main

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

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

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()        
            .endpoint("arn:aws:sqs:us-west-2:432981146916:queue-too")
            .protocol("sqs")
            .topic("arn:aws:sns:us-west-2:432981146916:user-updates-topic")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

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

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

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

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

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

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var userUpdates = new Aws.Sns.Topic("userUpdates");

    var userUpdatesQueue = new Aws.Sqs.Queue("userUpdatesQueue");

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

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sns"
	"github.com/pulumi/pulumi-aws/sdk/v5/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, "userUpdates", nil)
		if err != nil {
			return err
		}
		userUpdatesQueue, err := sqs.NewQueue(ctx, "userUpdatesQueue", nil)
		if err != nil {
			return err
		}
		_, err = sns.NewTopicSubscription(ctx, "userUpdatesSqsTarget", &sns.TopicSubscriptionArgs{
			Topic:    userUpdates.Arn,
			Protocol: pulumi.String("sqs"),
			Endpoint: userUpdatesQueue.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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.sqs.Queue;
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");

        var userUpdatesQueue = new Queue("userUpdatesQueue");

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

    }
}

import pulumi
import pulumi_aws as aws

user_updates = aws.sns.Topic("userUpdates")
user_updates_queue = aws.sqs.Queue("userUpdatesQueue")
user_updates_sqs_target = aws.sns.TopicSubscription("userUpdatesSqsTarget",
    topic=user_updates.arn,
    protocol="sqs",
    endpoint=user_updates_queue.arn)

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

const userUpdates = new aws.sns.Topic("userUpdates", {});
const userUpdatesQueue = new aws.sqs.Queue("userUpdatesQueue", {});
const userUpdatesSqsTarget = new aws.sns.TopicSubscription("userUpdatesSqsTarget", {
    topic: userUpdates.arn,
    protocol: "sqs",
    endpoint: userUpdatesQueue.arn,
});

resources:
  userUpdates:
    type: aws:sns:Topic
  userUpdatesQueue:
    type: aws:sqs:Queue
  userUpdatesSqsTarget:
    type: aws:sns:TopicSubscription
    properties:
      topic: ${userUpdates.arn}
      protocol: sqs
      endpoint: ${userUpdatesQueue.arn}

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

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" },
        { "role-name", "service/service" },
        { "name", "example-sns-topic" },
        { "display_name", "example" },
        { "region", "us-west-1" },
    };
    var sqs = config.GetObject<dynamic>("sqs") ?? 
    {
        { "account-id", "222222222222" },
        { "role-name", "service/service" },
        { "name", "example-sqs-queue" },
        { "region", "us-east-1" },
    };
    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}",
                        },
                    },
                },
            },
        },
    });

    // provider to manage SNS topics
    var awsSns = new Aws.Provider("awsSns", new()
    {
        Region = sns.Region,
        AssumeRole = new Aws.Inputs.ProviderAssumeRoleArgs
        {
            RoleArn = $"arn:aws:iam::{sns.Account_id}:role/{sns.Role_name}",
            SessionName = $"sns-{sns.Region}",
        },
    });

    // provider to manage SQS queues
    var awsSqs = new Aws.Provider("awsSqs", new()
    {
        Region = sqs.Region,
        AssumeRole = new Aws.Inputs.ProviderAssumeRoleArgs
        {
            RoleArn = $"arn:aws:iam::{sqs.Account_id}:role/{sqs.Role_name}",
            SessionName = $"sqs-{sqs.Region}",
        },
    });

    // provider to subscribe SQS to SNS (using the SQS account but the SNS region)
    var sns2sqs = new Aws.Provider("sns2sqs", new()
    {
        Region = sns.Region,
        AssumeRole = new Aws.Inputs.ProviderAssumeRoleArgs
        {
            RoleArn = $"arn:aws:iam::{sqs.Account_id}:role/{sqs.Role_name}",
            SessionName = $"sns2sqs-{sns.Region}",
        },
    });

    var sns_topicTopic = new Aws.Sns.Topic("sns-topicTopic", new()
    {
        DisplayName = sns.Display_name,
        Policy = sns_topic_policy.Apply(sns_topic_policy => sns_topic_policy.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json)),
    }, new CustomResourceOptions
    {
        Provider = "aws.sns",
    });

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

    var sns_topicTopicSubscription = new Aws.Sns.TopicSubscription("sns-topicTopicSubscription", new()
    {
        Topic = sns_topicTopic.Arn,
        Protocol = "sqs",
        Endpoint = sqs_queue.Arn,
    }, new CustomResourceOptions
    {
        Provider = "aws.sns2sqs",
    });

});

Coming soon!

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.Provider;
import com.pulumi.aws.ProviderArgs;
import com.pulumi.aws.inputs.ProviderAssumeRoleArgs;
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 com.pulumi.resources.CustomResourceOptions;
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(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference));
        final var sqs = config.get("sqs").orElse(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference));
        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 awsSns = new Provider("awsSns", ProviderArgs.builder()        
            .region(sns.region())
            .assumeRole(ProviderAssumeRoleArgs.builder()
                .roleArn(String.format("arn:aws:iam::%s:role/%s", sns.account-id(),sns.role-name()))
                .sessionName(String.format("sns-%s", sns.region()))
                .build())
            .build());

        var awsSqs = new Provider("awsSqs", ProviderArgs.builder()        
            .region(sqs.region())
            .assumeRole(ProviderAssumeRoleArgs.builder()
                .roleArn(String.format("arn:aws:iam::%s:role/%s", sqs.account-id(),sqs.role-name()))
                .sessionName(String.format("sqs-%s", sqs.region()))
                .build())
            .build());

        var sns2sqs = new Provider("sns2sqs", ProviderArgs.builder()        
            .region(sns.region())
            .assumeRole(ProviderAssumeRoleArgs.builder()
                .roleArn(String.format("arn:aws:iam::%s:role/%s", sqs.account-id(),sqs.role-name()))
                .sessionName(String.format("sns2sqs-%s", sns.region()))
                .build())
            .build());

        var sns_topicTopic = new Topic("sns-topicTopic", TopicArgs.builder()        
            .displayName(sns.display_name())
            .policy(sns_topic_policy.json())
            .build(), CustomResourceOptions.builder()
                .provider("aws.sns")
                .build());

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

        var sns_topicTopicSubscription = new TopicSubscription("sns-topicTopicSubscription", TopicSubscriptionArgs.builder()        
            .topic(sns_topicTopic.arn())
            .protocol("sqs")
            .endpoint(sqs_queue.arn())
            .build(), CustomResourceOptions.builder()
                .provider("aws.sns2sqs")
                .build());

    }
}

import pulumi
import pulumi_aws as aws

config = pulumi.Config()
sns = config.get_object("sns")
if sns is None:
    sns = {
        "account-id": "111111111111",
        "role-name": "service/service",
        "name": "example-sns-topic",
        "display_name": "example",
        "region": "us-west-1",
    }
sqs = config.get_object("sqs")
if sqs is None:
    sqs = {
        "account-id": "222222222222",
        "role-name": "service/service",
        "name": "example-sqs-queue",
        "region": "us-east-1",
    }
sns_topic_policy = aws.iam.get_policy_document(policy_id="__default_policy_ID",
    statements=[
        aws.iam.GetPolicyDocumentStatementArgs(
            actions=[
                "SNS:Subscribe",
                "SNS:SetTopicAttributes",
                "SNS:RemovePermission",
                "SNS:Publish",
                "SNS:ListSubscriptionsByTopic",
                "SNS:GetTopicAttributes",
                "SNS:DeleteTopic",
                "SNS:AddPermission",
            ],
            conditions=[aws.iam.GetPolicyDocumentStatementConditionArgs(
                test="StringEquals",
                variable="AWS:SourceOwner",
                values=[sns["account-id"]],
            )],
            effect="Allow",
            principals=[aws.iam.GetPolicyDocumentStatementPrincipalArgs(
                type="AWS",
                identifiers=["*"],
            )],
            resources=[f"arn:aws:sns:{sns['region']}:{sns['account-id']}:{sns['name']}"],
            sid="__default_statement_ID",
        ),
        aws.iam.GetPolicyDocumentStatementArgs(
            actions=[
                "SNS:Subscribe",
                "SNS:Receive",
            ],
            conditions=[aws.iam.GetPolicyDocumentStatementConditionArgs(
                test="StringLike",
                variable="SNS:Endpoint",
                values=[f"arn:aws:sqs:{sqs['region']}:{sqs['account-id']}:{sqs['name']}"],
            )],
            effect="Allow",
            principals=[aws.iam.GetPolicyDocumentStatementPrincipalArgs(
                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=[aws.iam.GetPolicyDocumentStatementArgs(
        sid="example-sns-topic",
        effect="Allow",
        principals=[aws.iam.GetPolicyDocumentStatementPrincipalArgs(
            type="AWS",
            identifiers=["*"],
        )],
        actions=["SQS:SendMessage"],
        resources=[f"arn:aws:sqs:{sqs['region']}:{sqs['account-id']}:{sqs['name']}"],
        conditions=[aws.iam.GetPolicyDocumentStatementConditionArgs(
            test="ArnEquals",
            variable="aws:SourceArn",
            values=[f"arn:aws:sns:{sns['region']}:{sns['account-id']}:{sns['name']}"],
        )],
    )])
# provider to manage SNS topics
aws_sns = aws.Provider("awsSns",
    region=sns["region"],
    assume_role=aws.ProviderAssumeRoleArgs(
        role_arn=f"arn:aws:iam::{sns['account-id']}:role/{sns['role-name']}",
        session_name=f"sns-{sns['region']}",
    ))
# provider to manage SQS queues
aws_sqs = aws.Provider("awsSqs",
    region=sqs["region"],
    assume_role=aws.ProviderAssumeRoleArgs(
        role_arn=f"arn:aws:iam::{sqs['account-id']}:role/{sqs['role-name']}",
        session_name=f"sqs-{sqs['region']}",
    ))
# provider to subscribe SQS to SNS (using the SQS account but the SNS region)
sns2sqs = aws.Provider("sns2sqs",
    region=sns["region"],
    assume_role=aws.ProviderAssumeRoleArgs(
        role_arn=f"arn:aws:iam::{sqs['account-id']}:role/{sqs['role-name']}",
        session_name=f"sns2sqs-{sns['region']}",
    ))
sns_topic_topic = aws.sns.Topic("sns-topicTopic",
    display_name=sns["display_name"],
    policy=sns_topic_policy.json,
    opts=pulumi.ResourceOptions(provider="aws.sns"))
sqs_queue = aws.sqs.Queue("sqs-queue", policy=sqs_queue_policy.json,
opts=pulumi.ResourceOptions(provider="aws.sqs"))
sns_topic_topic_subscription = aws.sns.TopicSubscription("sns-topicTopicSubscription",
    topic=sns_topic_topic.arn,
    protocol="sqs",
    endpoint=sqs_queue.arn,
    opts=pulumi.ResourceOptions(provider="aws.sns2sqs"))

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

const config = new pulumi.Config();
const sns = config.getObject("sns") || {
    "account-id": "111111111111",
    "role-name": "service/service",
    name: "example-sns-topic",
    display_name: "example",
    region: "us-west-1",
};
const sqs = config.getObject("sqs") || {
    "account-id": "222222222222",
    "role-name": "service/service",
    name: "example-sqs-queue",
    region: "us-east-1",
};
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}`],
        }],
    }],
});
// provider to manage SNS topics
const awsSns = new aws.Provider("awsSns", {
    region: sns.region,
    assumeRole: {
        roleArn: `arn:aws:iam::${sns["account-id"]}:role/${sns["role-name"]}`,
        sessionName: `sns-${sns.region}`,
    },
});
// provider to manage SQS queues
const awsSqs = new aws.Provider("awsSqs", {
    region: sqs.region,
    assumeRole: {
        roleArn: `arn:aws:iam::${sqs["account-id"]}:role/${sqs["role-name"]}`,
        sessionName: `sqs-${sqs.region}`,
    },
});
// provider to subscribe SQS to SNS (using the SQS account but the SNS region)
const sns2sqs = new aws.Provider("sns2sqs", {
    region: sns.region,
    assumeRole: {
        roleArn: `arn:aws:iam::${sqs["account-id"]}:role/${sqs["role-name"]}`,
        sessionName: `sns2sqs-${sns.region}`,
    },
});
const sns_topicTopic = new aws.sns.Topic("sns-topicTopic", {
    displayName: sns.display_name,
    policy: sns_topic_policy.then(sns_topic_policy => sns_topic_policy.json),
}, {
    provider: "aws.sns",
});
const sqs_queue = new aws.sqs.Queue("sqs-queue", {policy: sqs_queue_policy.then(sqs_queue_policy => sqs_queue_policy.json)}, {
    provider: "aws.sqs",
});
const sns_topicTopicSubscription = new aws.sns.TopicSubscription("sns-topicTopicSubscription", {
    topic: sns_topicTopic.arn,
    protocol: "sqs",
    endpoint: sqs_queue.arn,
}, {
    provider: "aws.sns2sqs",
});

configuration:
  sns:
    type: object({account-id = union(none, string), display_name = union(none, string), name = union(none, string), region = union(none, string), role-name = union(none, string)})
    default:
      account-id: '111111111111'
      role-name: service/service
      name: example-sns-topic
      display_name: example
      region: us-west-1
  sqs:
    type: object({account-id = union(none, string), name = union(none, string), region = union(none, string), role-name = union(none, string)})
    default:
      account-id: '222222222222'
      role-name: service/service
      name: example-sqs-queue
      region: us-east-1
resources:
  # provider to manage SNS topics
  awsSns:
    type: pulumi:providers:aws
    properties:
      region: ${sns.region}
      assumeRole:
        roleArn: arn:aws:iam::${sns"account-id"[%!s(MISSING)]}:role/${sns"role-name"[%!s(MISSING)]}
        sessionName: sns-${sns.region}
  # provider to manage SQS queues
  awsSqs:
    type: pulumi:providers:aws
    properties:
      region: ${sqs.region}
      assumeRole:
        roleArn: arn:aws:iam::${sqs"account-id"[%!s(MISSING)]}:role/${sqs"role-name"[%!s(MISSING)]}
        sessionName: sqs-${sqs.region}
  # provider to subscribe SQS to SNS (using the SQS account but the SNS region)
  sns2sqs:
    type: pulumi:providers:aws
    properties:
      region: ${sns.region}
      assumeRole:
        roleArn: arn:aws:iam::${sqs"account-id"[%!s(MISSING)]}:role/${sqs"role-name"[%!s(MISSING)]}
        sessionName: sns2sqs-${sns.region}
  sns-topicTopic:
    type: aws:sns:Topic
    properties:
      displayName: ${sns.display_name}
      policy: ${["sns-topic-policy"].json}
    options:
      provider: aws.sns
  sqs-queue:
    type: aws:sqs:Queue
    properties:
      policy: ${["sqs-queue-policy"].json}
    options:
      provider: aws.sqs
  sns-topicTopicSubscription:
    type: aws:sns:TopicSubscription
    properties:
      topic: ${["sns-topicTopic"].arn}
      protocol: sqs
      endpoint: ${["sqs-queue"].arn}
    options:
      provider: aws.sns2sqs
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}

Create TopicSubscription Resource

new TopicSubscription(name: string, args: TopicSubscriptionArgs, opts?: CustomResourceOptions);
@overload
def TopicSubscription(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      confirmation_timeout_in_minutes: Optional[int] = 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,
                      protocol: Optional[str] = None,
                      raw_message_delivery: Optional[bool] = None,
                      redrive_policy: Optional[str] = None,
                      subscription_role_arn: Optional[str] = None,
                      topic: Optional[str] = None)
@overload
def TopicSubscription(resource_name: str,
                      args: TopicSubscriptionArgs,
                      opts: Optional[ResourceOptions] = 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.
name string
The unique name of the resource.
args TopicSubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args TopicSubscriptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args TopicSubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args TopicSubscriptionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The TopicSubscription resource accepts the following input properties:

Endpoint string

Endpoint to send data to. The contents vary with the protocol. See details below.

Protocol 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 string | string

ARN of the SNS topic to subscribe to.

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.

SubscriptionRoleArn string

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

Endpoint string

Endpoint to send data to. The contents vary with the protocol. See details below.

Protocol 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 string | string

ARN of the SNS topic to subscribe to.

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.

SubscriptionRoleArn string

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

endpoint String

Endpoint to send data to. The contents vary with the protocol. See details below.

protocol 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 String | String

ARN of the SNS topic to subscribe to.

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.

subscriptionRoleArn String

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

endpoint string

Endpoint to send data to. The contents vary with the protocol. See details below.

protocol 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 string | Topic

ARN of the SNS topic to subscribe to.

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.

subscriptionRoleArn string

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

endpoint str

Endpoint to send data to. The contents vary with the protocol. See details below.

protocol 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 str | str

ARN of the SNS topic to subscribe to.

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.

subscription_role_arn str

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

endpoint String

Endpoint to send data to. The contents vary with the protocol. See details below.

protocol 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 String |

ARN of the SNS topic to subscribe to.

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.

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,
        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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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 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 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.

SubscriptionRoleArn string

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

Topic string | string

ARN of the SNS topic to subscribe to.

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

SubscriptionRoleArn string

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

Topic string | string

ARN of the SNS topic to subscribe to.

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

subscriptionRoleArn String

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

topic String | String

ARN of the SNS topic to subscribe to.

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

subscriptionRoleArn string

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

topic string | Topic

ARN of the SNS topic to subscribe to.

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

subscription_role_arn str

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

topic str | str

ARN of the SNS topic to subscribe to.

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

subscriptionRoleArn String

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

topic String |

ARN of the SNS topic to subscribe to.

Import

SNS Topic Subscriptions can be imported using the subscription arn, e.g.,

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

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.