@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
97 lines (96 loc) • 6.24 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* The ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.
* One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.
* The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
*/
export declare function getTopic(args: GetTopicArgs, opts?: pulumi.InvokeOptions): Promise<GetTopicResult>;
export interface GetTopicArgs {
/**
* Returns the ARN of an Amazon topic.
*/
topicArn: string;
}
export interface GetTopicResult {
/**
* The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::Topic` for more information about the expected schema for this property.
*/
readonly archivePolicy?: any;
/**
* Enables content-based deduplication for FIFO topics.
* + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action.
* + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message).
* (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action.
*/
readonly contentBasedDeduplication?: boolean;
/**
* The body of the policy document you want to use for this topic.
* You can only add one policy per topic.
* The policy must be in JSON string format.
* Length Constraints: Maximum length of 30,720.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::Topic` for more information about the expected schema for this property.
*/
readonly dataProtectionPolicy?: any;
/**
* The ``DeliveryStatusLogging`` configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols:
* + HTTP
* + Amazon Kinesis Data Firehose
* + AWS Lambda
* + Platform application endpoint
* + Amazon Simple Queue Service
*
* Once configured, log entries are sent to Amazon CloudWatch Logs.
*/
readonly deliveryStatusLogging?: outputs.sns.TopicLoggingConfig[];
/**
* The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
*/
readonly displayName?: string;
/**
* Specifies the throughput quota and deduplication behavior to apply for the FIFO topic. Valid values are `Topic` or `MessageGroup` .
*/
readonly fifoThroughputScope?: string;
/**
* The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*.
* This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).
*/
readonly kmsMasterKeyId?: string;
/**
* 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. By default, ``SignatureVersion`` is set to ``1``.
*/
readonly signatureVersion?: string;
/**
* The SNS subscriptions (endpoints) for this topic.
* If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted.
*/
readonly subscription?: outputs.sns.TopicSubscription[];
/**
* The list of tags to add to a new topic.
* To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions.
*/
readonly tags?: outputs.Tag[];
/**
* Returns the ARN of an Amazon topic.
*/
readonly topicArn?: string;
/**
* Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.
*/
readonly tracingConfig?: string;
}
/**
* The ``AWS::SNS::Topic`` resource creates a topic to which notifications can be published.
* One account can create a maximum of 100,000 standard topics and 1,000 FIFO topics. For more information, see [endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/sns.html) in the *General Reference*.
* The structure of ``AUTHPARAMS`` depends on the .signature of the API request. For more information, see [Examples of the complete Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/sigv4-signed-request-examples.html) in the *General Reference*.
*/
export declare function getTopicOutput(args: GetTopicOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTopicResult>;
export interface GetTopicOutputArgs {
/**
* Returns the ARN of an Amazon topic.
*/
topicArn: pulumi.Input<string>;
}