@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)
142 lines (141 loc) • 7.25 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource Type definition for AWS::SNS::Subscription
*/
export declare class Subscription extends pulumi.CustomResource {
/**
* Get an existing Subscription resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Subscription;
/**
* Returns true if the given object is an instance of Subscription. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Subscription;
/**
* Arn of the subscription
*/
readonly arn: pulumi.Output<string>;
/**
* The delivery policy JSON assigned to the subscription. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::Subscription` for more information about the expected schema for this property.
*/
readonly deliveryPolicy: pulumi.Output<any | undefined>;
/**
* The subscription's endpoint. The endpoint value depends on the protocol that you specify.
*/
readonly endpoint: pulumi.Output<string | undefined>;
/**
* The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::Subscription` for more information about the expected schema for this property.
*/
readonly filterPolicy: pulumi.Output<any | undefined>;
/**
* This attribute lets you choose the filtering scope by using one of the following string value types: MessageAttributes (default) and MessageBody.
*/
readonly filterPolicyScope: pulumi.Output<string | undefined>;
/**
* The subscription's protocol.
*/
readonly protocol: pulumi.Output<string>;
/**
* When set to true, enables raw message delivery. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints.
*/
readonly rawMessageDelivery: pulumi.Output<boolean | undefined>;
/**
* When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors are held in the dead-letter queue for further analysis or reprocessing.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::Subscription` for more information about the expected schema for this property.
*/
readonly redrivePolicy: pulumi.Output<any | undefined>;
/**
* For cross-region subscriptions, the region in which the topic resides.If no region is specified, AWS CloudFormation uses the region of the caller as the default.
*/
readonly region: pulumi.Output<string | undefined>;
/**
* Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::Subscription` for more information about the expected schema for this property.
*/
readonly replayPolicy: pulumi.Output<any | undefined>;
/**
* This property applies only to Amazon Data Firehose delivery stream subscriptions.
*/
readonly subscriptionRoleArn: pulumi.Output<string | undefined>;
/**
* The ARN of the topic to subscribe to.
*/
readonly topicArn: pulumi.Output<string>;
/**
* Create a Subscription resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: SubscriptionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Subscription resource.
*/
export interface SubscriptionArgs {
/**
* The delivery policy JSON assigned to the subscription. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::Subscription` for more information about the expected schema for this property.
*/
deliveryPolicy?: any;
/**
* The subscription's endpoint. The endpoint value depends on the protocol that you specify.
*/
endpoint?: pulumi.Input<string>;
/**
* The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::Subscription` for more information about the expected schema for this property.
*/
filterPolicy?: any;
/**
* This attribute lets you choose the filtering scope by using one of the following string value types: MessageAttributes (default) and MessageBody.
*/
filterPolicyScope?: pulumi.Input<string>;
/**
* The subscription's protocol.
*/
protocol: pulumi.Input<string>;
/**
* When set to true, enables raw message delivery. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints.
*/
rawMessageDelivery?: pulumi.Input<boolean>;
/**
* When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors are held in the dead-letter queue for further analysis or reprocessing.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::Subscription` for more information about the expected schema for this property.
*/
redrivePolicy?: any;
/**
* For cross-region subscriptions, the region in which the topic resides.If no region is specified, AWS CloudFormation uses the region of the caller as the default.
*/
region?: pulumi.Input<string>;
/**
* Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.
*
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::SNS::Subscription` for more information about the expected schema for this property.
*/
replayPolicy?: any;
/**
* This property applies only to Amazon Data Firehose delivery stream subscriptions.
*/
subscriptionRoleArn?: pulumi.Input<string>;
/**
* The ARN of the topic to subscribe to.
*/
topicArn: pulumi.Input<string>;
}