This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

sns¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.sns.AwaitableGetTopicResult(arn=None, id=None, name=None)¶

class pulumi_aws.sns.GetTopicResult(arn=None, id=None, name=None)¶

A collection of values returned by getTopic.

arn = None¶: Set to the ARN of the found topic, suitable for referencing in other resources that support SNS topics.

id = None¶: The provider-assigned unique ID for this managed resource.

class pulumi_aws.sns.PlatformApplication(resource_name, opts=None, event_delivery_failure_topic_arn=None, event_endpoint_created_topic_arn=None, event_endpoint_deleted_topic_arn=None, event_endpoint_updated_topic_arn=None, failure_feedback_role_arn=None, name=None, platform=None, platform_credential=None, platform_principal=None, success_feedback_role_arn=None, success_feedback_sample_rate=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SNS platform application resource

import pulumi
import pulumi_aws as aws

apns_application = aws.sns.PlatformApplication("apnsApplication",
    platform="APNS",
    platform_credential="<APNS PRIVATE KEY>",
    platform_principal="<APNS CERTIFICATE>")

import pulumi
import pulumi_aws as aws

gcm_application = aws.sns.PlatformApplication("gcmApplication",
    platform="GCM",
    platform_credential="<GCM API KEY>")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
event_delivery_failure_topic_arn (pulumi.Input[str]) – SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.
event_endpoint_created_topic_arn (pulumi.Input[str]) – SNS Topic triggered when a new platform endpoint is added to your platform application.
event_endpoint_deleted_topic_arn (pulumi.Input[str]) – SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
event_endpoint_updated_topic_arn (pulumi.Input[str]) – SNS Topic triggered when an existing platform endpoint is changed from your platform application.
failure_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive failure feedback for this application.
name (pulumi.Input[str]) – The friendly name for the SNS platform application
platform (pulumi.Input[str]) – The platform that the app is registered with. See Platform for supported platforms.
platform_credential (pulumi.Input[str]) – Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
platform_principal (pulumi.Input[str]) – Application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
success_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive success feedback for this application.
success_feedback_sample_rate (pulumi.Input[str]) – The percentage of success to sample (0-100)

arn: pulumi.Output[str] = None¶: The ARN of the SNS platform application

event_delivery_failure_topic_arn: pulumi.Output[str] = None¶: SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.

event_endpoint_created_topic_arn: pulumi.Output[str] = None¶: SNS Topic triggered when a new platform endpoint is added to your platform application.

event_endpoint_deleted_topic_arn: pulumi.Output[str] = None¶: SNS Topic triggered when an existing platform endpoint is deleted from your platform application.

event_endpoint_updated_topic_arn: pulumi.Output[str] = None¶: SNS Topic triggered when an existing platform endpoint is changed from your platform application.

failure_feedback_role_arn: pulumi.Output[str] = None¶: The IAM role permitted to receive failure feedback for this application.

name: pulumi.Output[str] = None¶: The friendly name for the SNS platform application

platform: pulumi.Output[str] = None¶: The platform that the app is registered with. See Platform for supported platforms.

platform_credential: pulumi.Output[str] = None¶: Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.

platform_principal: pulumi.Output[str] = None¶: Application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.

success_feedback_role_arn: pulumi.Output[str] = None¶: The IAM role permitted to receive success feedback for this application.

success_feedback_sample_rate: pulumi.Output[str] = None¶: The percentage of success to sample (0-100)

static get(resource_name, id, opts=None, arn=None, event_delivery_failure_topic_arn=None, event_endpoint_created_topic_arn=None, event_endpoint_deleted_topic_arn=None, event_endpoint_updated_topic_arn=None, failure_feedback_role_arn=None, name=None, platform=None, platform_credential=None, platform_principal=None, success_feedback_role_arn=None, success_feedback_sample_rate=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the SNS platform application
event_delivery_failure_topic_arn (pulumi.Input[str]) – SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.
event_endpoint_created_topic_arn (pulumi.Input[str]) – SNS Topic triggered when a new platform endpoint is added to your platform application.
event_endpoint_deleted_topic_arn (pulumi.Input[str]) – SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
event_endpoint_updated_topic_arn (pulumi.Input[str]) – SNS Topic triggered when an existing platform endpoint is changed from your platform application.
failure_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive failure feedback for this application.
name (pulumi.Input[str]) – The friendly name for the SNS platform application
platform (pulumi.Input[str]) –
The platform that the app is registered with. See Platform for supported platforms.
platform_credential (pulumi.Input[str]) –
Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
platform_principal (pulumi.Input[str]) –
Application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
success_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive success feedback for this application.
success_feedback_sample_rate (pulumi.Input[str]) – The percentage of success to sample (0-100)

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.sns.SmsPreferences(resource_name, opts=None, default_sender_id=None, default_sms_type=None, delivery_status_iam_role_arn=None, delivery_status_success_sampling_rate=None, monthly_spend_limit=None, usage_report_s3_bucket=None, __props__=None, __name__=None, __opts__=None)¶

Provides a way to set SNS SMS preferences.

import pulumi
import pulumi_aws as aws

update_sms_prefs = aws.sns.SmsPreferences("updateSmsPrefs")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
default_sender_id (pulumi.Input[str]) – A string, such as your business brand, that is displayed as the sender on the receiving device.
default_sms_type (pulumi.Input[str]) – The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
delivery_status_iam_role_arn (pulumi.Input[str]) – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
delivery_status_success_sampling_rate (pulumi.Input[str]) – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value must be between 0 and 100.
monthly_spend_limit (pulumi.Input[str]) – The maximum amount in USD that you are willing to spend each month to send SMS messages.
usage_report_s3_bucket (pulumi.Input[str]) – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.

default_sender_id: pulumi.Output[str] = None¶: A string, such as your business brand, that is displayed as the sender on the receiving device.

default_sms_type: pulumi.Output[str] = None¶: The type of SMS message that you will send by default. Possible values are: Promotional, Transactional

delivery_status_iam_role_arn: pulumi.Output[str] = None¶: The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.

delivery_status_success_sampling_rate: pulumi.Output[str] = None¶: The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value must be between 0 and 100.

monthly_spend_limit: pulumi.Output[str] = None¶: The maximum amount in USD that you are willing to spend each month to send SMS messages.

usage_report_s3_bucket: pulumi.Output[str] = None¶: The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.

static get(resource_name, id, opts=None, default_sender_id=None, default_sms_type=None, delivery_status_iam_role_arn=None, delivery_status_success_sampling_rate=None, monthly_spend_limit=None, usage_report_s3_bucket=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
default_sender_id (pulumi.Input[str]) – A string, such as your business brand, that is displayed as the sender on the receiving device.
default_sms_type (pulumi.Input[str]) – The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
delivery_status_iam_role_arn (pulumi.Input[str]) – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
delivery_status_success_sampling_rate (pulumi.Input[str]) – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value must be between 0 and 100.
monthly_spend_limit (pulumi.Input[str]) – The maximum amount in USD that you are willing to spend each month to send SMS messages.
usage_report_s3_bucket (pulumi.Input[str]) – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.sns.Topic(resource_name, opts=None, application_failure_feedback_role_arn=None, application_success_feedback_role_arn=None, application_success_feedback_sample_rate=None, delivery_policy=None, display_name=None, http_failure_feedback_role_arn=None, http_success_feedback_role_arn=None, http_success_feedback_sample_rate=None, kms_master_key_id=None, lambda_failure_feedback_role_arn=None, lambda_success_feedback_role_arn=None, lambda_success_feedback_sample_rate=None, name=None, name_prefix=None, policy=None, sqs_failure_feedback_role_arn=None, sqs_success_feedback_role_arn=None, sqs_success_feedback_sample_rate=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SNS topic resource

import pulumi
import pulumi_aws as aws

user_updates = aws.sns.Topic("userUpdates")

import pulumi
import pulumi_aws as aws

user_updates = aws.sns.Topic("userUpdates", delivery_policy="""{
  "http": {
    "defaultHealthyRetryPolicy": {
      "minDelayTarget": 20,
      "maxDelayTarget": 20,
      "numRetries": 3,
      "numMaxDelayRetries": 0,
      "numNoDelayRetries": 0,
      "numMinDelayRetries": 0,
      "backoffFunction": "linear"
    },
    "disableSubscriptionOverrides": false,
    "defaultThrottlePolicy": {
      "maxReceivesPerSecond": 1
    }
  }
}

""")

import pulumi
import pulumi_aws as aws

user_updates = aws.sns.Topic("userUpdates", kms_master_key_id="alias/aws/sns")

The <endpoint>_success_feedback_role_arn and <endpoint>_failure_feedback_role_arn arguments are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <endpoint>_success_feedback_sample_rate argument is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <endpoint>_failure_feedback_role_arn argument, then all failed message deliveries generate CloudWatch Logs.

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
application_failure_feedback_role_arn (pulumi.Input[str]) – IAM role for failure feedback
application_success_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive success feedback for this topic
application_success_feedback_sample_rate (pulumi.Input[float]) – Percentage of success to sample
delivery_policy (pulumi.Input[str]) – The SNS delivery policy. More on AWS documentation
display_name (pulumi.Input[str]) – The display name for the SNS topic
http_failure_feedback_role_arn (pulumi.Input[str]) – IAM role for failure feedback
http_success_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive success feedback for this topic
http_success_feedback_sample_rate (pulumi.Input[float]) – Percentage of success to sample
kms_master_key_id (pulumi.Input[str]) – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms
lambda_failure_feedback_role_arn (pulumi.Input[str]) – IAM role for failure feedback
lambda_success_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive success feedback for this topic
lambda_success_feedback_sample_rate (pulumi.Input[float]) – Percentage of success to sample
name (pulumi.Input[str]) – The friendly name for the SNS topic. By default generated by this provider.
name_prefix (pulumi.Input[str]) – The friendly name for the SNS topic. Conflicts with name.
policy (pulumi.Input[str]) – The fully-formed AWS policy as JSON.
sqs_failure_feedback_role_arn (pulumi.Input[str]) – IAM role for failure feedback
sqs_success_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive success feedback for this topic
sqs_success_feedback_sample_rate (pulumi.Input[float]) – Percentage of success to sample
tags (pulumi.Input[dict]) – Key-value map of resource tags

application_failure_feedback_role_arn: pulumi.Output[str] = None¶: IAM role for failure feedback

application_success_feedback_role_arn: pulumi.Output[str] = None¶: The IAM role permitted to receive success feedback for this topic

application_success_feedback_sample_rate: pulumi.Output[float] = None¶: Percentage of success to sample

arn: pulumi.Output[str] = None¶: The ARN of the SNS topic, as a more obvious property (clone of id)

delivery_policy: pulumi.Output[str] = None¶: The SNS delivery policy. More on AWS documentation

display_name: pulumi.Output[str] = None¶: The display name for the SNS topic

http_failure_feedback_role_arn: pulumi.Output[str] = None¶: IAM role for failure feedback

http_success_feedback_role_arn: pulumi.Output[str] = None¶: The IAM role permitted to receive success feedback for this topic

http_success_feedback_sample_rate: pulumi.Output[float] = None¶: Percentage of success to sample

kms_master_key_id: pulumi.Output[str] = None¶: The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms

lambda_failure_feedback_role_arn: pulumi.Output[str] = None¶: IAM role for failure feedback

lambda_success_feedback_role_arn: pulumi.Output[str] = None¶: The IAM role permitted to receive success feedback for this topic

lambda_success_feedback_sample_rate: pulumi.Output[float] = None¶: Percentage of success to sample

name: pulumi.Output[str] = None¶: The friendly name for the SNS topic. By default generated by this provider.

name_prefix: pulumi.Output[str] = None¶: The friendly name for the SNS topic. Conflicts with name.

policy: pulumi.Output[str] = None¶: The fully-formed AWS policy as JSON.

sqs_failure_feedback_role_arn: pulumi.Output[str] = None¶: IAM role for failure feedback

sqs_success_feedback_role_arn: pulumi.Output[str] = None¶: The IAM role permitted to receive success feedback for this topic

sqs_success_feedback_sample_rate: pulumi.Output[float] = None¶: Percentage of success to sample

tags: pulumi.Output[dict] = None¶: Key-value map of resource tags

static get(resource_name, id, opts=None, application_failure_feedback_role_arn=None, application_success_feedback_role_arn=None, application_success_feedback_sample_rate=None, arn=None, delivery_policy=None, display_name=None, http_failure_feedback_role_arn=None, http_success_feedback_role_arn=None, http_success_feedback_sample_rate=None, kms_master_key_id=None, lambda_failure_feedback_role_arn=None, lambda_success_feedback_role_arn=None, lambda_success_feedback_sample_rate=None, name=None, name_prefix=None, policy=None, sqs_failure_feedback_role_arn=None, sqs_success_feedback_role_arn=None, sqs_success_feedback_sample_rate=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
application_failure_feedback_role_arn (pulumi.Input[str]) – IAM role for failure feedback
application_success_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive success feedback for this topic
application_success_feedback_sample_rate (pulumi.Input[float]) – Percentage of success to sample
arn (pulumi.Input[str]) – The ARN of the SNS topic, as a more obvious property (clone of id)
delivery_policy (pulumi.Input[str]) –
The SNS delivery policy. More on AWS documentation
display_name (pulumi.Input[str]) – The display name for the SNS topic
http_failure_feedback_role_arn (pulumi.Input[str]) – IAM role for failure feedback
http_success_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive success feedback for this topic
http_success_feedback_sample_rate (pulumi.Input[float]) – Percentage of success to sample
kms_master_key_id (pulumi.Input[str]) –
The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms
lambda_failure_feedback_role_arn (pulumi.Input[str]) – IAM role for failure feedback
lambda_success_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive success feedback for this topic
lambda_success_feedback_sample_rate (pulumi.Input[float]) – Percentage of success to sample
name (pulumi.Input[str]) – The friendly name for the SNS topic. By default generated by this provider.
name_prefix (pulumi.Input[str]) – The friendly name for the SNS topic. Conflicts with name.
policy (pulumi.Input[str]) – The fully-formed AWS policy as JSON.
sqs_failure_feedback_role_arn (pulumi.Input[str]) – IAM role for failure feedback
sqs_success_feedback_role_arn (pulumi.Input[str]) – The IAM role permitted to receive success feedback for this topic
sqs_success_feedback_sample_rate (pulumi.Input[float]) – Percentage of success to sample
tags (pulumi.Input[dict]) – Key-value map of resource tags

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.sns.TopicPolicy(resource_name, opts=None, arn=None, policy=None, __props__=None, __name__=None, __opts__=None)¶

Provides an SNS topic policy resource

NOTE: If a Principal is specified as just an AWS account ID rather than an ARN, AWS silently converts it to the ARN for the root user, causing future deployments to differ. To avoid this problem, just specify the full ARN, e.g. arn:aws:iam::123456789012:root

import pulumi
import pulumi_aws as aws

test = aws.sns.Topic("test")
sns_topic_policy = test.arn.apply(lambda arn: aws.iam.get_policy_document(policy_id="__default_policy_ID",
    statements=[{
        "actions": [
            "SNS:Subscribe",
            "SNS:SetTopicAttributes",
            "SNS:RemovePermission",
            "SNS:Receive",
            "SNS:Publish",
            "SNS:ListSubscriptionsByTopic",
            "SNS:GetTopicAttributes",
            "SNS:DeleteTopic",
            "SNS:AddPermission",
        ],
        "condition": [{
            "test": "StringEquals",
            "values": [var["account-id"]],
            "variable": "AWS:SourceOwner",
        }],
        "effect": "Allow",
        "principals": [{
            "identifiers": ["*"],
            "type": "AWS",
        }],
        "resources": [arn],
        "sid": "__default_statement_ID",
    }]))
default = aws.sns.TopicPolicy("default",
    arn=test.arn,
    policy=sns_topic_policy.json)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the SNS topic
policy (pulumi.Input[str]) – The fully-formed AWS policy as JSON.

arn: pulumi.Output[str] = None¶: The ARN of the SNS topic

policy: pulumi.Output[str] = None¶: The fully-formed AWS policy as JSON.

static get(resource_name, id, opts=None, arn=None, policy=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the SNS topic
policy (pulumi.Input[str]) – The fully-formed AWS policy as JSON.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.sns.TopicSubscription(resource_name, opts=None, confirmation_timeout_in_minutes=None, delivery_policy=None, endpoint=None, endpoint_auto_confirms=None, filter_policy=None, protocol=None, raw_message_delivery=None, topic=None, __props__=None, __name__=None, __opts__=None)¶

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 will probably be SQS queues.

NOTE: If the SNS topic and SQS queue are in different AWS regions, it is important for the “sns.TopicSubscription” to use an AWS provider that is in the same region of the SNS topic. If the “sns.TopicSubscription” is using a provider with a different region than the SNS topic, the subscription will fail to create.
NOTE: Setup of cross-account subscriptions from SNS topics to SQS queues requires the provider to have access to BOTH accounts.
NOTE: If SNS topic and SQS queue are in different AWS accounts but the same region it is important for the “sns.TopicSubscription” to use the AWS provider of the account with the SQS queue. If “sns.TopicSubscription” is using a Provider with a different account than the SQS queue, the provider creates the subscriptions but does not keep state and tries to re-create the subscription at every apply.
NOTE: If SNS topic and SQS queue are in different AWS accounts and different AWS regions it is important to recognize that the subscription needs to be initiated from the account with the SQS queue but in the region of the SNS topic.

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")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
confirmation_timeout_in_minutes (pulumi.Input[float]) – Integer indicating number of minutes to wait in retying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols (default is 1 minute).
delivery_policy (pulumi.Input[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 (pulumi.Input[str]) – The endpoint to send data to, the contents will vary with the protocol. (see below for more information)
endpoint_auto_confirms (pulumi.Input[bool]) – Boolean indicating whether the end point is capable of auto confirming subscription e.g., PagerDuty (default is false)
filter_policy (pulumi.Input[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.
protocol (pulumi.Input[str]) – The protocol to use. The possible values for this are: sqs, sms, lambda, application. (http or https are partially supported, see below) (email is an option but is unsupported, see below).
raw_message_delivery (pulumi.Input[bool]) – Boolean indicating whether or not 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).
topic (pulumi.Input[dict]) – The ARN of the SNS topic to subscribe to

arn: pulumi.Output[str] = None¶: The ARN of the subscription stored as a more user-friendly property

confirmation_timeout_in_minutes: pulumi.Output[float] = None¶: Integer indicating number of minutes to wait in retying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols (default is 1 minute).

delivery_policy: pulumi.Output[str] = None¶: 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: pulumi.Output[str] = None¶: The endpoint to send data to, the contents will vary with the protocol. (see below for more information)

endpoint_auto_confirms: pulumi.Output[bool] = None¶: Boolean indicating whether the end point is capable of auto confirming subscription e.g., PagerDuty (default is false)

filter_policy: pulumi.Output[str] = None¶: 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.

protocol: pulumi.Output[str] = None¶: The protocol to use. The possible values for this are: sqs, sms, lambda, application. (http or https are partially supported, see below) (email is an option but is unsupported, see below).

raw_message_delivery: pulumi.Output[bool] = None¶: Boolean indicating whether or not 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).

topic: pulumi.Output[str] = None¶: The ARN of the SNS topic to subscribe to

static get(resource_name, id, opts=None, arn=None, confirmation_timeout_in_minutes=None, delivery_policy=None, endpoint=None, endpoint_auto_confirms=None, filter_policy=None, protocol=None, raw_message_delivery=None, topic=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the subscription stored as a more user-friendly property
confirmation_timeout_in_minutes (pulumi.Input[float]) – Integer indicating number of minutes to wait in retying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols (default is 1 minute).
delivery_policy (pulumi.Input[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 (pulumi.Input[str]) – The endpoint to send data to, the contents will vary with the protocol. (see below for more information)
endpoint_auto_confirms (pulumi.Input[bool]) –
Boolean indicating whether the end point is capable of auto confirming subscription e.g., PagerDuty (default is false)
filter_policy (pulumi.Input[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.
protocol (pulumi.Input[str]) – The protocol to use. The possible values for this are: sqs, sms, lambda, application. (http or https are partially supported, see below) (email is an option but is unsupported, see below).
raw_message_delivery (pulumi.Input[bool]) – Boolean indicating whether or not 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).
topic (pulumi.Input[dict]) – The ARN of the SNS topic to subscribe to

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_aws.sns.get_topic(name=None, opts=None)¶

Use this data source to get the ARN of a topic in AWS Simple Notification Service (SNS). By using this data source, you can reference SNS topics without having to hard code the ARNs as input.

import pulumi
import pulumi_aws as aws

example = aws.sns.get_topic(name="an_example_topic")

Parameters: name (str) – The friendly name of the topic to match.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

sns¶

On This Page