aws.sns.Topic
Explore with Pulumi AI
Provides an SNS topic resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const userUpdates = new aws.sns.Topic("user_updates", {name: "user-updates-topic"});
import pulumi
import pulumi_aws as aws
user_updates = aws.sns.Topic("user_updates", name="user-updates-topic")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sns.NewTopic(ctx, "user_updates", &sns.TopicArgs{
Name: pulumi.String("user-updates-topic"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var userUpdates = new Aws.Sns.Topic("user_updates", new()
{
Name = "user-updates-topic",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.Topic;
import com.pulumi.aws.sns.TopicArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var userUpdates = new Topic("userUpdates", TopicArgs.builder()
.name("user-updates-topic")
.build());
}
}
resources:
userUpdates:
type: aws:sns:Topic
name: user_updates
properties:
name: user-updates-topic
Example with Delivery Policy
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const userUpdates = new aws.sns.Topic("user_updates", {
name: "user-updates-topic",
deliveryPolicy: `{
"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("user_updates",
name="user-updates-topic",
delivery_policy="""{
"http": {
"defaultHealthyRetryPolicy": {
"minDelayTarget": 20,
"maxDelayTarget": 20,
"numRetries": 3,
"numMaxDelayRetries": 0,
"numNoDelayRetries": 0,
"numMinDelayRetries": 0,
"backoffFunction": "linear"
},
"disableSubscriptionOverrides": false,
"defaultThrottlePolicy": {
"maxReceivesPerSecond": 1
}
}
}
""")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sns.NewTopic(ctx, "user_updates", &sns.TopicArgs{
Name: pulumi.String("user-updates-topic"),
DeliveryPolicy: pulumi.String(`{
"http": {
"defaultHealthyRetryPolicy": {
"minDelayTarget": 20,
"maxDelayTarget": 20,
"numRetries": 3,
"numMaxDelayRetries": 0,
"numNoDelayRetries": 0,
"numMinDelayRetries": 0,
"backoffFunction": "linear"
},
"disableSubscriptionOverrides": false,
"defaultThrottlePolicy": {
"maxReceivesPerSecond": 1
}
}
}
`),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var userUpdates = new Aws.Sns.Topic("user_updates", new()
{
Name = "user-updates-topic",
DeliveryPolicy = @"{
""http"": {
""defaultHealthyRetryPolicy"": {
""minDelayTarget"": 20,
""maxDelayTarget"": 20,
""numRetries"": 3,
""numMaxDelayRetries"": 0,
""numNoDelayRetries"": 0,
""numMinDelayRetries"": 0,
""backoffFunction"": ""linear""
},
""disableSubscriptionOverrides"": false,
""defaultThrottlePolicy"": {
""maxReceivesPerSecond"": 1
}
}
}
",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.Topic;
import com.pulumi.aws.sns.TopicArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var userUpdates = new Topic("userUpdates", TopicArgs.builder()
.name("user-updates-topic")
.deliveryPolicy("""
{
"http": {
"defaultHealthyRetryPolicy": {
"minDelayTarget": 20,
"maxDelayTarget": 20,
"numRetries": 3,
"numMaxDelayRetries": 0,
"numNoDelayRetries": 0,
"numMinDelayRetries": 0,
"backoffFunction": "linear"
},
"disableSubscriptionOverrides": false,
"defaultThrottlePolicy": {
"maxReceivesPerSecond": 1
}
}
}
""")
.build());
}
}
resources:
userUpdates:
type: aws:sns:Topic
name: user_updates
properties:
name: user-updates-topic
deliveryPolicy: |
{
"http": {
"defaultHealthyRetryPolicy": {
"minDelayTarget": 20,
"maxDelayTarget": 20,
"numRetries": 3,
"numMaxDelayRetries": 0,
"numNoDelayRetries": 0,
"numMinDelayRetries": 0,
"backoffFunction": "linear"
},
"disableSubscriptionOverrides": false,
"defaultThrottlePolicy": {
"maxReceivesPerSecond": 1
}
}
}
Example with Server-side encryption (SSE)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const userUpdates = new aws.sns.Topic("user_updates", {
name: "user-updates-topic",
kmsMasterKeyId: "alias/aws/sns",
});
import pulumi
import pulumi_aws as aws
user_updates = aws.sns.Topic("user_updates",
name="user-updates-topic",
kms_master_key_id="alias/aws/sns")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sns.NewTopic(ctx, "user_updates", &sns.TopicArgs{
Name: pulumi.String("user-updates-topic"),
KmsMasterKeyId: pulumi.String("alias/aws/sns"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var userUpdates = new Aws.Sns.Topic("user_updates", new()
{
Name = "user-updates-topic",
KmsMasterKeyId = "alias/aws/sns",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.Topic;
import com.pulumi.aws.sns.TopicArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var userUpdates = new Topic("userUpdates", TopicArgs.builder()
.name("user-updates-topic")
.kmsMasterKeyId("alias/aws/sns")
.build());
}
}
resources:
userUpdates:
type: aws:sns:Topic
name: user_updates
properties:
name: user-updates-topic
kmsMasterKeyId: alias/aws/sns
Example with First-In-First-Out (FIFO)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const userUpdates = new aws.sns.Topic("user_updates", {
name: "user-updates-topic.fifo",
fifoTopic: true,
contentBasedDeduplication: true,
});
import pulumi
import pulumi_aws as aws
user_updates = aws.sns.Topic("user_updates",
name="user-updates-topic.fifo",
fifo_topic=True,
content_based_deduplication=True)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sns.NewTopic(ctx, "user_updates", &sns.TopicArgs{
Name: pulumi.String("user-updates-topic.fifo"),
FifoTopic: pulumi.Bool(true),
ContentBasedDeduplication: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var userUpdates = new Aws.Sns.Topic("user_updates", new()
{
Name = "user-updates-topic.fifo",
FifoTopic = true,
ContentBasedDeduplication = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.Topic;
import com.pulumi.aws.sns.TopicArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var userUpdates = new Topic("userUpdates", TopicArgs.builder()
.name("user-updates-topic.fifo")
.fifoTopic(true)
.contentBasedDeduplication(true)
.build());
}
}
resources:
userUpdates:
type: aws:sns:Topic
name: user_updates
properties:
name: user-updates-topic.fifo
fifoTopic: true
contentBasedDeduplication: true
Message Delivery Status Arguments
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.
Create Topic Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Topic(name: string, args?: TopicArgs, opts?: CustomResourceOptions);
@overload
def Topic(resource_name: str,
args: Optional[TopicArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Topic(resource_name: str,
opts: Optional[ResourceOptions] = None,
application_failure_feedback_role_arn: Optional[str] = None,
application_success_feedback_role_arn: Optional[str] = None,
application_success_feedback_sample_rate: Optional[int] = None,
archive_policy: Optional[str] = None,
content_based_deduplication: Optional[bool] = None,
delivery_policy: Optional[str] = None,
display_name: Optional[str] = None,
fifo_topic: Optional[bool] = None,
firehose_failure_feedback_role_arn: Optional[str] = None,
firehose_success_feedback_role_arn: Optional[str] = None,
firehose_success_feedback_sample_rate: Optional[int] = None,
http_failure_feedback_role_arn: Optional[str] = None,
http_success_feedback_role_arn: Optional[str] = None,
http_success_feedback_sample_rate: Optional[int] = None,
kms_master_key_id: Optional[str] = None,
lambda_failure_feedback_role_arn: Optional[str] = None,
lambda_success_feedback_role_arn: Optional[str] = None,
lambda_success_feedback_sample_rate: Optional[int] = None,
name: Optional[str] = None,
name_prefix: Optional[str] = None,
policy: Optional[str] = None,
signature_version: Optional[int] = None,
sqs_failure_feedback_role_arn: Optional[str] = None,
sqs_success_feedback_role_arn: Optional[str] = None,
sqs_success_feedback_sample_rate: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
tracing_config: Optional[str] = None)
func NewTopic(ctx *Context, name string, args *TopicArgs, opts ...ResourceOption) (*Topic, error)
public Topic(string name, TopicArgs? args = null, CustomResourceOptions? opts = null)
type: aws:sns:Topic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args TopicArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TopicArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TopicArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TopicArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TopicArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var topicResource = new Aws.Sns.Topic("topicResource", new()
{
ApplicationFailureFeedbackRoleArn = "string",
ApplicationSuccessFeedbackRoleArn = "string",
ApplicationSuccessFeedbackSampleRate = 0,
ArchivePolicy = "string",
ContentBasedDeduplication = false,
DeliveryPolicy = "string",
DisplayName = "string",
FifoTopic = false,
FirehoseFailureFeedbackRoleArn = "string",
FirehoseSuccessFeedbackRoleArn = "string",
FirehoseSuccessFeedbackSampleRate = 0,
HttpFailureFeedbackRoleArn = "string",
HttpSuccessFeedbackRoleArn = "string",
HttpSuccessFeedbackSampleRate = 0,
KmsMasterKeyId = "string",
LambdaFailureFeedbackRoleArn = "string",
LambdaSuccessFeedbackRoleArn = "string",
LambdaSuccessFeedbackSampleRate = 0,
Name = "string",
NamePrefix = "string",
Policy = "string",
SignatureVersion = 0,
SqsFailureFeedbackRoleArn = "string",
SqsSuccessFeedbackRoleArn = "string",
SqsSuccessFeedbackSampleRate = 0,
Tags =
{
{ "string", "string" },
},
TracingConfig = "string",
});
example, err := sns.NewTopic(ctx, "topicResource", &sns.TopicArgs{
ApplicationFailureFeedbackRoleArn: pulumi.String("string"),
ApplicationSuccessFeedbackRoleArn: pulumi.String("string"),
ApplicationSuccessFeedbackSampleRate: pulumi.Int(0),
ArchivePolicy: pulumi.String("string"),
ContentBasedDeduplication: pulumi.Bool(false),
DeliveryPolicy: pulumi.String("string"),
DisplayName: pulumi.String("string"),
FifoTopic: pulumi.Bool(false),
FirehoseFailureFeedbackRoleArn: pulumi.String("string"),
FirehoseSuccessFeedbackRoleArn: pulumi.String("string"),
FirehoseSuccessFeedbackSampleRate: pulumi.Int(0),
HttpFailureFeedbackRoleArn: pulumi.String("string"),
HttpSuccessFeedbackRoleArn: pulumi.String("string"),
HttpSuccessFeedbackSampleRate: pulumi.Int(0),
KmsMasterKeyId: pulumi.String("string"),
LambdaFailureFeedbackRoleArn: pulumi.String("string"),
LambdaSuccessFeedbackRoleArn: pulumi.String("string"),
LambdaSuccessFeedbackSampleRate: pulumi.Int(0),
Name: pulumi.String("string"),
NamePrefix: pulumi.String("string"),
Policy: pulumi.String("string"),
SignatureVersion: pulumi.Int(0),
SqsFailureFeedbackRoleArn: pulumi.String("string"),
SqsSuccessFeedbackRoleArn: pulumi.String("string"),
SqsSuccessFeedbackSampleRate: pulumi.Int(0),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TracingConfig: pulumi.String("string"),
})
var topicResource = new Topic("topicResource", TopicArgs.builder()
.applicationFailureFeedbackRoleArn("string")
.applicationSuccessFeedbackRoleArn("string")
.applicationSuccessFeedbackSampleRate(0)
.archivePolicy("string")
.contentBasedDeduplication(false)
.deliveryPolicy("string")
.displayName("string")
.fifoTopic(false)
.firehoseFailureFeedbackRoleArn("string")
.firehoseSuccessFeedbackRoleArn("string")
.firehoseSuccessFeedbackSampleRate(0)
.httpFailureFeedbackRoleArn("string")
.httpSuccessFeedbackRoleArn("string")
.httpSuccessFeedbackSampleRate(0)
.kmsMasterKeyId("string")
.lambdaFailureFeedbackRoleArn("string")
.lambdaSuccessFeedbackRoleArn("string")
.lambdaSuccessFeedbackSampleRate(0)
.name("string")
.namePrefix("string")
.policy("string")
.signatureVersion(0)
.sqsFailureFeedbackRoleArn("string")
.sqsSuccessFeedbackRoleArn("string")
.sqsSuccessFeedbackSampleRate(0)
.tags(Map.of("string", "string"))
.tracingConfig("string")
.build());
topic_resource = aws.sns.Topic("topicResource",
application_failure_feedback_role_arn="string",
application_success_feedback_role_arn="string",
application_success_feedback_sample_rate=0,
archive_policy="string",
content_based_deduplication=False,
delivery_policy="string",
display_name="string",
fifo_topic=False,
firehose_failure_feedback_role_arn="string",
firehose_success_feedback_role_arn="string",
firehose_success_feedback_sample_rate=0,
http_failure_feedback_role_arn="string",
http_success_feedback_role_arn="string",
http_success_feedback_sample_rate=0,
kms_master_key_id="string",
lambda_failure_feedback_role_arn="string",
lambda_success_feedback_role_arn="string",
lambda_success_feedback_sample_rate=0,
name="string",
name_prefix="string",
policy="string",
signature_version=0,
sqs_failure_feedback_role_arn="string",
sqs_success_feedback_role_arn="string",
sqs_success_feedback_sample_rate=0,
tags={
"string": "string",
},
tracing_config="string")
const topicResource = new aws.sns.Topic("topicResource", {
applicationFailureFeedbackRoleArn: "string",
applicationSuccessFeedbackRoleArn: "string",
applicationSuccessFeedbackSampleRate: 0,
archivePolicy: "string",
contentBasedDeduplication: false,
deliveryPolicy: "string",
displayName: "string",
fifoTopic: false,
firehoseFailureFeedbackRoleArn: "string",
firehoseSuccessFeedbackRoleArn: "string",
firehoseSuccessFeedbackSampleRate: 0,
httpFailureFeedbackRoleArn: "string",
httpSuccessFeedbackRoleArn: "string",
httpSuccessFeedbackSampleRate: 0,
kmsMasterKeyId: "string",
lambdaFailureFeedbackRoleArn: "string",
lambdaSuccessFeedbackRoleArn: "string",
lambdaSuccessFeedbackSampleRate: 0,
name: "string",
namePrefix: "string",
policy: "string",
signatureVersion: 0,
sqsFailureFeedbackRoleArn: "string",
sqsSuccessFeedbackRoleArn: "string",
sqsSuccessFeedbackSampleRate: 0,
tags: {
string: "string",
},
tracingConfig: "string",
});
type: aws:sns:Topic
properties:
applicationFailureFeedbackRoleArn: string
applicationSuccessFeedbackRoleArn: string
applicationSuccessFeedbackSampleRate: 0
archivePolicy: string
contentBasedDeduplication: false
deliveryPolicy: string
displayName: string
fifoTopic: false
firehoseFailureFeedbackRoleArn: string
firehoseSuccessFeedbackRoleArn: string
firehoseSuccessFeedbackSampleRate: 0
httpFailureFeedbackRoleArn: string
httpSuccessFeedbackRoleArn: string
httpSuccessFeedbackSampleRate: 0
kmsMasterKeyId: string
lambdaFailureFeedbackRoleArn: string
lambdaSuccessFeedbackRoleArn: string
lambdaSuccessFeedbackSampleRate: 0
name: string
namePrefix: string
policy: string
signatureVersion: 0
sqsFailureFeedbackRoleArn: string
sqsSuccessFeedbackRoleArn: string
sqsSuccessFeedbackSampleRate: 0
tags:
string: string
tracingConfig: string
Topic Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Topic resource accepts the following input properties:
- Application
Failure stringFeedback Role Arn - IAM role for failure feedback
- Application
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Application
Success intFeedback Sample Rate - Percentage of success to sample
- Archive
Policy string - The message archive policy for FIFO topics. More details in the AWS documentation.
- Content
Based boolDeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- Delivery
Policy string - The SNS delivery policy. More details in the AWS documentation.
- Display
Name string - The display name for the topic
- Fifo
Topic bool - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - Firehose
Failure stringFeedback Role Arn - IAM role for failure feedback
- Firehose
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Firehose
Success intFeedback Sample Rate - Percentage of success to sample
- Http
Failure stringFeedback Role Arn - IAM role for failure feedback
- Http
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Http
Success intFeedback Sample Rate - Percentage of success to sample
- Kms
Master stringKey Id - 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 stringFeedback Role Arn - IAM role for failure feedback
- Lambda
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Lambda
Success intFeedback Sample Rate - Percentage of success to sample
- Name string
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
- Policy string
- The fully-formed AWS policy as JSON.
- Signature
Version int - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - Sqs
Failure stringFeedback Role Arn - IAM role for failure feedback
- Sqs
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Sqs
Success intFeedback Sample Rate - Percentage of success to sample
- Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Tracing
Config string - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
- Application
Failure stringFeedback Role Arn - IAM role for failure feedback
- Application
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Application
Success intFeedback Sample Rate - Percentage of success to sample
- Archive
Policy string - The message archive policy for FIFO topics. More details in the AWS documentation.
- Content
Based boolDeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- Delivery
Policy string - The SNS delivery policy. More details in the AWS documentation.
- Display
Name string - The display name for the topic
- Fifo
Topic bool - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - Firehose
Failure stringFeedback Role Arn - IAM role for failure feedback
- Firehose
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Firehose
Success intFeedback Sample Rate - Percentage of success to sample
- Http
Failure stringFeedback Role Arn - IAM role for failure feedback
- Http
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Http
Success intFeedback Sample Rate - Percentage of success to sample
- Kms
Master stringKey Id - 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 stringFeedback Role Arn - IAM role for failure feedback
- Lambda
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Lambda
Success intFeedback Sample Rate - Percentage of success to sample
- Name string
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
- Policy string
- The fully-formed AWS policy as JSON.
- Signature
Version int - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - Sqs
Failure stringFeedback Role Arn - IAM role for failure feedback
- Sqs
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Sqs
Success intFeedback Sample Rate - Percentage of success to sample
- map[string]string
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Tracing
Config string - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
- application
Failure StringFeedback Role Arn - IAM role for failure feedback
- application
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- application
Success IntegerFeedback Sample Rate - Percentage of success to sample
- archive
Policy String - The message archive policy for FIFO topics. More details in the AWS documentation.
- content
Based BooleanDeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- delivery
Policy String - The SNS delivery policy. More details in the AWS documentation.
- display
Name String - The display name for the topic
- fifo
Topic Boolean - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - firehose
Failure StringFeedback Role Arn - IAM role for failure feedback
- firehose
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- firehose
Success IntegerFeedback Sample Rate - Percentage of success to sample
- http
Failure StringFeedback Role Arn - IAM role for failure feedback
- http
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- http
Success IntegerFeedback Sample Rate - Percentage of success to sample
- kms
Master StringKey Id - 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 StringFeedback Role Arn - IAM role for failure feedback
- lambda
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- lambda
Success IntegerFeedback Sample Rate - Percentage of success to sample
- name String
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
- policy String
- The fully-formed AWS policy as JSON.
- signature
Version Integer - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - sqs
Failure StringFeedback Role Arn - IAM role for failure feedback
- sqs
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- sqs
Success IntegerFeedback Sample Rate - Percentage of success to sample
- Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - tracing
Config String - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
- application
Failure stringFeedback Role Arn - IAM role for failure feedback
- application
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- application
Success numberFeedback Sample Rate - Percentage of success to sample
- archive
Policy string - The message archive policy for FIFO topics. More details in the AWS documentation.
- content
Based booleanDeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- delivery
Policy string - The SNS delivery policy. More details in the AWS documentation.
- display
Name string - The display name for the topic
- fifo
Topic boolean - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - firehose
Failure stringFeedback Role Arn - IAM role for failure feedback
- firehose
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- firehose
Success numberFeedback Sample Rate - Percentage of success to sample
- http
Failure stringFeedback Role Arn - IAM role for failure feedback
- http
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- http
Success numberFeedback Sample Rate - Percentage of success to sample
- kms
Master stringKey Id - 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 stringFeedback Role Arn - IAM role for failure feedback
- lambda
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- lambda
Success numberFeedback Sample Rate - Percentage of success to sample
- name string
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
- policy string
- The fully-formed AWS policy as JSON.
- signature
Version number - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - sqs
Failure stringFeedback Role Arn - IAM role for failure feedback
- sqs
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- sqs
Success numberFeedback Sample Rate - Percentage of success to sample
- {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - tracing
Config string - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
- application_
failure_ strfeedback_ role_ arn - IAM role for failure feedback
- application_
success_ strfeedback_ role_ arn - The IAM role permitted to receive success feedback for this topic
- application_
success_ intfeedback_ sample_ rate - Percentage of success to sample
- archive_
policy str - The message archive policy for FIFO topics. More details in the AWS documentation.
- content_
based_ booldeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- delivery_
policy str - The SNS delivery policy. More details in the AWS documentation.
- display_
name str - The display name for the topic
- fifo_
topic bool - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - firehose_
failure_ strfeedback_ role_ arn - IAM role for failure feedback
- firehose_
success_ strfeedback_ role_ arn - The IAM role permitted to receive success feedback for this topic
- firehose_
success_ intfeedback_ sample_ rate - Percentage of success to sample
- http_
failure_ strfeedback_ role_ arn - IAM role for failure feedback
- http_
success_ strfeedback_ role_ arn - The IAM role permitted to receive success feedback for this topic
- http_
success_ intfeedback_ sample_ rate - Percentage of success to sample
- kms_
master_ strkey_ id - 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_ strfeedback_ role_ arn - IAM role for failure feedback
- lambda_
success_ strfeedback_ role_ arn - The IAM role permitted to receive success feedback for this topic
- lambda_
success_ intfeedback_ sample_ rate - Percentage of success to sample
- name str
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- name_
prefix str - Creates a unique name beginning with the specified prefix. Conflicts with
name
- policy str
- The fully-formed AWS policy as JSON.
- signature_
version int - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - sqs_
failure_ strfeedback_ role_ arn - IAM role for failure feedback
- sqs_
success_ strfeedback_ role_ arn - The IAM role permitted to receive success feedback for this topic
- sqs_
success_ intfeedback_ sample_ rate - Percentage of success to sample
- Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - tracing_
config str - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
- application
Failure StringFeedback Role Arn - IAM role for failure feedback
- application
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- application
Success NumberFeedback Sample Rate - Percentage of success to sample
- archive
Policy String - The message archive policy for FIFO topics. More details in the AWS documentation.
- content
Based BooleanDeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- delivery
Policy String - The SNS delivery policy. More details in the AWS documentation.
- display
Name String - The display name for the topic
- fifo
Topic Boolean - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - firehose
Failure StringFeedback Role Arn - IAM role for failure feedback
- firehose
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- firehose
Success NumberFeedback Sample Rate - Percentage of success to sample
- http
Failure StringFeedback Role Arn - IAM role for failure feedback
- http
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- http
Success NumberFeedback Sample Rate - Percentage of success to sample
- kms
Master StringKey Id - 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 StringFeedback Role Arn - IAM role for failure feedback
- lambda
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- lambda
Success NumberFeedback Sample Rate - Percentage of success to sample
- name String
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
- policy String
- The fully-formed AWS policy as JSON.
- signature
Version Number - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - sqs
Failure StringFeedback Role Arn - IAM role for failure feedback
- sqs
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- sqs
Success NumberFeedback Sample Rate - Percentage of success to sample
- Map<String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - tracing
Config String - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
Outputs
All input properties are implicitly available as output properties. Additionally, the Topic resource produces the following output properties:
- Arn string
- The ARN of the SNS topic, as a more obvious property (clone of id)
- Beginning
Archive stringTime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- Id string
- The provider-assigned unique ID for this managed resource.
- Owner string
- The AWS Account ID of the SNS topic owner
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- The ARN of the SNS topic, as a more obvious property (clone of id)
- Beginning
Archive stringTime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- Id string
- The provider-assigned unique ID for this managed resource.
- Owner string
- The AWS Account ID of the SNS topic owner
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The ARN of the SNS topic, as a more obvious property (clone of id)
- beginning
Archive StringTime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- id String
- The provider-assigned unique ID for this managed resource.
- owner String
- The AWS Account ID of the SNS topic owner
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn ARN
- The ARN of the SNS topic, as a more obvious property (clone of id)
- beginning
Archive stringTime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- id string
- The provider-assigned unique ID for this managed resource.
- owner string
- The AWS Account ID of the SNS topic owner
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- The ARN of the SNS topic, as a more obvious property (clone of id)
- beginning_
archive_ strtime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- id str
- The provider-assigned unique ID for this managed resource.
- owner str
- The AWS Account ID of the SNS topic owner
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn
- The ARN of the SNS topic, as a more obvious property (clone of id)
- beginning
Archive StringTime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- id String
- The provider-assigned unique ID for this managed resource.
- owner String
- The AWS Account ID of the SNS topic owner
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing Topic Resource
Get an existing Topic 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?: TopicState, opts?: CustomResourceOptions): Topic
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
application_failure_feedback_role_arn: Optional[str] = None,
application_success_feedback_role_arn: Optional[str] = None,
application_success_feedback_sample_rate: Optional[int] = None,
archive_policy: Optional[str] = None,
arn: Optional[str] = None,
beginning_archive_time: Optional[str] = None,
content_based_deduplication: Optional[bool] = None,
delivery_policy: Optional[str] = None,
display_name: Optional[str] = None,
fifo_topic: Optional[bool] = None,
firehose_failure_feedback_role_arn: Optional[str] = None,
firehose_success_feedback_role_arn: Optional[str] = None,
firehose_success_feedback_sample_rate: Optional[int] = None,
http_failure_feedback_role_arn: Optional[str] = None,
http_success_feedback_role_arn: Optional[str] = None,
http_success_feedback_sample_rate: Optional[int] = None,
kms_master_key_id: Optional[str] = None,
lambda_failure_feedback_role_arn: Optional[str] = None,
lambda_success_feedback_role_arn: Optional[str] = None,
lambda_success_feedback_sample_rate: Optional[int] = None,
name: Optional[str] = None,
name_prefix: Optional[str] = None,
owner: Optional[str] = None,
policy: Optional[str] = None,
signature_version: Optional[int] = None,
sqs_failure_feedback_role_arn: Optional[str] = None,
sqs_success_feedback_role_arn: Optional[str] = None,
sqs_success_feedback_sample_rate: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
tracing_config: Optional[str] = None) -> Topic
func GetTopic(ctx *Context, name string, id IDInput, state *TopicState, opts ...ResourceOption) (*Topic, error)
public static Topic Get(string name, Input<string> id, TopicState? state, CustomResourceOptions? opts = null)
public static Topic get(String name, Output<String> id, TopicState 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.
- Application
Failure stringFeedback Role Arn - IAM role for failure feedback
- Application
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Application
Success intFeedback Sample Rate - Percentage of success to sample
- Archive
Policy string - The message archive policy for FIFO topics. More details in the AWS documentation.
- Arn string
- The ARN of the SNS topic, as a more obvious property (clone of id)
- Beginning
Archive stringTime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- Content
Based boolDeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- Delivery
Policy string - The SNS delivery policy. More details in the AWS documentation.
- Display
Name string - The display name for the topic
- Fifo
Topic bool - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - Firehose
Failure stringFeedback Role Arn - IAM role for failure feedback
- Firehose
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Firehose
Success intFeedback Sample Rate - Percentage of success to sample
- Http
Failure stringFeedback Role Arn - IAM role for failure feedback
- Http
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Http
Success intFeedback Sample Rate - Percentage of success to sample
- Kms
Master stringKey Id - 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 stringFeedback Role Arn - IAM role for failure feedback
- Lambda
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Lambda
Success intFeedback Sample Rate - Percentage of success to sample
- Name string
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
- Owner string
- The AWS Account ID of the SNS topic owner
- Policy string
- The fully-formed AWS policy as JSON.
- Signature
Version int - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - Sqs
Failure stringFeedback Role Arn - IAM role for failure feedback
- Sqs
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Sqs
Success intFeedback Sample Rate - Percentage of success to sample
- Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Tracing
Config string - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
- Application
Failure stringFeedback Role Arn - IAM role for failure feedback
- Application
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Application
Success intFeedback Sample Rate - Percentage of success to sample
- Archive
Policy string - The message archive policy for FIFO topics. More details in the AWS documentation.
- Arn string
- The ARN of the SNS topic, as a more obvious property (clone of id)
- Beginning
Archive stringTime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- Content
Based boolDeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- Delivery
Policy string - The SNS delivery policy. More details in the AWS documentation.
- Display
Name string - The display name for the topic
- Fifo
Topic bool - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - Firehose
Failure stringFeedback Role Arn - IAM role for failure feedback
- Firehose
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Firehose
Success intFeedback Sample Rate - Percentage of success to sample
- Http
Failure stringFeedback Role Arn - IAM role for failure feedback
- Http
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Http
Success intFeedback Sample Rate - Percentage of success to sample
- Kms
Master stringKey Id - 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 stringFeedback Role Arn - IAM role for failure feedback
- Lambda
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Lambda
Success intFeedback Sample Rate - Percentage of success to sample
- Name string
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- Name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
- Owner string
- The AWS Account ID of the SNS topic owner
- Policy string
- The fully-formed AWS policy as JSON.
- Signature
Version int - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - Sqs
Failure stringFeedback Role Arn - IAM role for failure feedback
- Sqs
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- Sqs
Success intFeedback Sample Rate - Percentage of success to sample
- map[string]string
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Tracing
Config string - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
- application
Failure StringFeedback Role Arn - IAM role for failure feedback
- application
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- application
Success IntegerFeedback Sample Rate - Percentage of success to sample
- archive
Policy String - The message archive policy for FIFO topics. More details in the AWS documentation.
- arn String
- The ARN of the SNS topic, as a more obvious property (clone of id)
- beginning
Archive StringTime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- content
Based BooleanDeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- delivery
Policy String - The SNS delivery policy. More details in the AWS documentation.
- display
Name String - The display name for the topic
- fifo
Topic Boolean - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - firehose
Failure StringFeedback Role Arn - IAM role for failure feedback
- firehose
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- firehose
Success IntegerFeedback Sample Rate - Percentage of success to sample
- http
Failure StringFeedback Role Arn - IAM role for failure feedback
- http
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- http
Success IntegerFeedback Sample Rate - Percentage of success to sample
- kms
Master StringKey Id - 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 StringFeedback Role Arn - IAM role for failure feedback
- lambda
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- lambda
Success IntegerFeedback Sample Rate - Percentage of success to sample
- name String
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
- owner String
- The AWS Account ID of the SNS topic owner
- policy String
- The fully-formed AWS policy as JSON.
- signature
Version Integer - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - sqs
Failure StringFeedback Role Arn - IAM role for failure feedback
- sqs
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- sqs
Success IntegerFeedback Sample Rate - Percentage of success to sample
- Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - tracing
Config String - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
- application
Failure stringFeedback Role Arn - IAM role for failure feedback
- application
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- application
Success numberFeedback Sample Rate - Percentage of success to sample
- archive
Policy string - The message archive policy for FIFO topics. More details in the AWS documentation.
- arn ARN
- The ARN of the SNS topic, as a more obvious property (clone of id)
- beginning
Archive stringTime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- content
Based booleanDeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- delivery
Policy string - The SNS delivery policy. More details in the AWS documentation.
- display
Name string - The display name for the topic
- fifo
Topic boolean - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - firehose
Failure stringFeedback Role Arn - IAM role for failure feedback
- firehose
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- firehose
Success numberFeedback Sample Rate - Percentage of success to sample
- http
Failure stringFeedback Role Arn - IAM role for failure feedback
- http
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- http
Success numberFeedback Sample Rate - Percentage of success to sample
- kms
Master stringKey Id - 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 stringFeedback Role Arn - IAM role for failure feedback
- lambda
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- lambda
Success numberFeedback Sample Rate - Percentage of success to sample
- name string
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix string - Creates a unique name beginning with the specified prefix. Conflicts with
name
- owner string
- The AWS Account ID of the SNS topic owner
- policy string
- The fully-formed AWS policy as JSON.
- signature
Version number - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - sqs
Failure stringFeedback Role Arn - IAM role for failure feedback
- sqs
Success stringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- sqs
Success numberFeedback Sample Rate - Percentage of success to sample
- {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - tracing
Config string - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
- application_
failure_ strfeedback_ role_ arn - IAM role for failure feedback
- application_
success_ strfeedback_ role_ arn - The IAM role permitted to receive success feedback for this topic
- application_
success_ intfeedback_ sample_ rate - Percentage of success to sample
- archive_
policy str - The message archive policy for FIFO topics. More details in the AWS documentation.
- arn str
- The ARN of the SNS topic, as a more obvious property (clone of id)
- beginning_
archive_ strtime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- content_
based_ booldeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- delivery_
policy str - The SNS delivery policy. More details in the AWS documentation.
- display_
name str - The display name for the topic
- fifo_
topic bool - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - firehose_
failure_ strfeedback_ role_ arn - IAM role for failure feedback
- firehose_
success_ strfeedback_ role_ arn - The IAM role permitted to receive success feedback for this topic
- firehose_
success_ intfeedback_ sample_ rate - Percentage of success to sample
- http_
failure_ strfeedback_ role_ arn - IAM role for failure feedback
- http_
success_ strfeedback_ role_ arn - The IAM role permitted to receive success feedback for this topic
- http_
success_ intfeedback_ sample_ rate - Percentage of success to sample
- kms_
master_ strkey_ id - 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_ strfeedback_ role_ arn - IAM role for failure feedback
- lambda_
success_ strfeedback_ role_ arn - The IAM role permitted to receive success feedback for this topic
- lambda_
success_ intfeedback_ sample_ rate - Percentage of success to sample
- name str
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- name_
prefix str - Creates a unique name beginning with the specified prefix. Conflicts with
name
- owner str
- The AWS Account ID of the SNS topic owner
- policy str
- The fully-formed AWS policy as JSON.
- signature_
version int - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - sqs_
failure_ strfeedback_ role_ arn - IAM role for failure feedback
- sqs_
success_ strfeedback_ role_ arn - The IAM role permitted to receive success feedback for this topic
- sqs_
success_ intfeedback_ sample_ rate - Percentage of success to sample
- Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - tracing_
config str - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
- application
Failure StringFeedback Role Arn - IAM role for failure feedback
- application
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- application
Success NumberFeedback Sample Rate - Percentage of success to sample
- archive
Policy String - The message archive policy for FIFO topics. More details in the AWS documentation.
- arn
- The ARN of the SNS topic, as a more obvious property (clone of id)
- beginning
Archive StringTime - The oldest timestamp at which a FIFO topic subscriber can start a replay.
- content
Based BooleanDeduplication - Enables content-based deduplication for FIFO topics. For more information, see the related documentation
- delivery
Policy String - The SNS delivery policy. More details in the AWS documentation.
- display
Name String - The display name for the topic
- fifo
Topic Boolean - Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is
false
. - firehose
Failure StringFeedback Role Arn - IAM role for failure feedback
- firehose
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- firehose
Success NumberFeedback Sample Rate - Percentage of success to sample
- http
Failure StringFeedback Role Arn - IAM role for failure feedback
- http
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- http
Success NumberFeedback Sample Rate - Percentage of success to sample
- kms
Master StringKey Id - 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 StringFeedback Role Arn - IAM role for failure feedback
- lambda
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- lambda
Success NumberFeedback Sample Rate - Percentage of success to sample
- name String
- The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the
.fifo
suffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix String - Creates a unique name beginning with the specified prefix. Conflicts with
name
- owner String
- The AWS Account ID of the SNS topic owner
- policy String
- The fully-formed AWS policy as JSON.
- signature
Version Number - If
SignatureVersion
should be 1 (SHA1) or 2 (SHA256). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. - sqs
Failure StringFeedback Role Arn - IAM role for failure feedback
- sqs
Success StringFeedback Role Arn - The IAM role permitted to receive success feedback for this topic
- sqs
Success NumberFeedback Sample Rate - Percentage of success to sample
- Map<String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - tracing
Config String - Tracing mode of an Amazon SNS topic. Valid values:
"PassThrough"
,"Active"
.
Import
Using pulumi import
, import SNS Topics using the topic arn
. For example:
$ pulumi import aws:sns/topic:Topic user_updates arn:aws:sns:us-west-2:0123456789012:my-topic
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.