pulumi-aws-kotlin/com.pulumi.aws.sns.kotlin/Topic

Topic

class Topic : KotlinCustomResource

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

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

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

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

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

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

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)

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

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.

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:123456789012:my-topic

Properties

applicationFailureFeedbackRoleArn

val applicationFailureFeedbackRoleArn: Output<String>?

IAM role for failure feedback

applicationSuccessFeedbackRoleArn

val applicationSuccessFeedbackRoleArn: Output<String>?

The IAM role permitted to receive success feedback for this topic

applicationSuccessFeedbackSampleRate

val applicationSuccessFeedbackSampleRate: Output<Int>?

Percentage of success to sample

archivePolicy

val archivePolicy: Output<String>?

The message archive policy for FIFO topics. More details in the AWS documentation.

arn

val arn: Output<String>

The ARN of the SNS topic, as a more obvious property (clone of id)

beginningArchiveTime

val beginningArchiveTime: Output<String>

The oldest timestamp at which a FIFO topic subscriber can start a replay.

contentBasedDeduplication

val contentBasedDeduplication: Output<Boolean>?

Enables content-based deduplication for FIFO topics. For more information, see the related documentation

deliveryPolicy

val deliveryPolicy: Output<String>?

The SNS delivery policy. More details in the AWS documentation.

displayName

val displayName: Output<String>?

The display name for the topic

fifoTopic

val fifoTopic: Output<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.

firehoseFailureFeedbackRoleArn

val firehoseFailureFeedbackRoleArn: Output<String>?

IAM role for failure feedback

firehoseSuccessFeedbackRoleArn

val firehoseSuccessFeedbackRoleArn: Output<String>?

The IAM role permitted to receive success feedback for this topic

firehoseSuccessFeedbackSampleRate

val firehoseSuccessFeedbackSampleRate: Output<Int>?

Percentage of success to sample

httpFailureFeedbackRoleArn

val httpFailureFeedbackRoleArn: Output<String>?

IAM role for failure feedback

httpSuccessFeedbackRoleArn

val httpSuccessFeedbackRoleArn: Output<String>?

The IAM role permitted to receive success feedback for this topic

httpSuccessFeedbackSampleRate

val httpSuccessFeedbackSampleRate: Output<Int>?

Percentage of success to sample

val id: Output<String>

kmsMasterKeyId

val kmsMasterKeyId: Output<String>?

The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms

lambdaFailureFeedbackRoleArn

val lambdaFailureFeedbackRoleArn: Output<String>?

IAM role for failure feedback

lambdaSuccessFeedbackRoleArn

val lambdaSuccessFeedbackRoleArn: Output<String>?

The IAM role permitted to receive success feedback for this topic

lambdaSuccessFeedbackSampleRate

val lambdaSuccessFeedbackSampleRate: Output<Int>?

Percentage of success to sample

name

val name: Output<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 with name_prefix

namePrefix

val namePrefix: Output<String>

Creates a unique name beginning with the specified prefix. Conflicts with name

owner

val owner: Output<String>

The AWS Account ID of the SNS topic owner

policy

val policy: Output<String>

The fully-formed AWS policy as JSON.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

signatureVersion

val signatureVersion: Output<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.

sqsFailureFeedbackRoleArn

val sqsFailureFeedbackRoleArn: Output<String>?

IAM role for failure feedback

sqsSuccessFeedbackRoleArn

val sqsSuccessFeedbackRoleArn: Output<String>?

The IAM role permitted to receive success feedback for this topic

sqsSuccessFeedbackSampleRate

val sqsSuccessFeedbackSampleRate: Output<Int>?

Percentage of success to sample