Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. sns
  5. getSubscription

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.sns.getSubscription

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SNS::Subscription

    Using getSubscription

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSubscription(args: GetSubscriptionArgs, opts?: InvokeOptions): Promise<GetSubscriptionResult>
function getSubscriptionOutput(args: GetSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetSubscriptionResult>
    def get_subscription(arn: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSubscriptionResult
def get_subscription_output(arn: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSubscriptionResult]
    func LookupSubscription(ctx *Context, args *LookupSubscriptionArgs, opts ...InvokeOption) (*LookupSubscriptionResult, error)
func LookupSubscriptionOutput(ctx *Context, args *LookupSubscriptionOutputArgs, opts ...InvokeOption) LookupSubscriptionResultOutput

    > Note: This function is named LookupSubscription in the Go SDK.

    public static class GetSubscription 
{
    public static Task<GetSubscriptionResult> InvokeAsync(GetSubscriptionArgs args, InvokeOptions? opts = null)
    public static Output<GetSubscriptionResult> Invoke(GetSubscriptionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSubscriptionResult> getSubscription(GetSubscriptionArgs args, InvokeOptions options)
public static Output<GetSubscriptionResult> getSubscription(GetSubscriptionArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:sns:getSubscription
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    Arn of the subscription
    Arn string
    Arn of the subscription
    arn String
    Arn of the subscription
    arn string
    Arn of the subscription
    arn str
    Arn of the subscription
    arn String
    Arn of the subscription

    getSubscription Result

    The following output properties are available:

    Arn string
    Arn of the subscription
    DeliveryPolicy object

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    FilterPolicy object

    The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    FilterPolicyScope string
    This attribute lets you choose the filtering scope by using one of the following string value types: MessageAttributes (default) and MessageBody.
    RawMessageDelivery bool
    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.
    RedrivePolicy object

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    ReplayPolicy object

    Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    SubscriptionRoleArn string
    This property applies only to Amazon Data Firehose delivery stream subscriptions.
    Arn string
    Arn of the subscription
    DeliveryPolicy interface{}

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    FilterPolicy interface{}

    The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    FilterPolicyScope string
    This attribute lets you choose the filtering scope by using one of the following string value types: MessageAttributes (default) and MessageBody.
    RawMessageDelivery bool
    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.
    RedrivePolicy interface{}

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    ReplayPolicy interface{}

    Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    SubscriptionRoleArn string
    This property applies only to Amazon Data Firehose delivery stream subscriptions.
    arn String
    Arn of the subscription
    deliveryPolicy Object

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    filterPolicy Object

    The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    filterPolicyScope String
    This attribute lets you choose the filtering scope by using one of the following string value types: MessageAttributes (default) and MessageBody.
    rawMessageDelivery Boolean
    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.
    redrivePolicy Object

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    replayPolicy Object

    Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    subscriptionRoleArn String
    This property applies only to Amazon Data Firehose delivery stream subscriptions.
    arn string
    Arn of the subscription
    deliveryPolicy any

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    filterPolicy any

    The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    filterPolicyScope string
    This attribute lets you choose the filtering scope by using one of the following string value types: MessageAttributes (default) and MessageBody.
    rawMessageDelivery boolean
    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.
    redrivePolicy any

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    replayPolicy any

    Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    subscriptionRoleArn string
    This property applies only to Amazon Data Firehose delivery stream subscriptions.
    arn str
    Arn of the subscription
    delivery_policy Any

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    filter_policy Any

    The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    filter_policy_scope str
    This attribute lets you choose the filtering scope by using one of the following string value types: MessageAttributes (default) and MessageBody.
    raw_message_delivery bool
    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.
    redrive_policy Any

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    replay_policy Any

    Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    subscription_role_arn str
    This property applies only to Amazon Data Firehose delivery stream subscriptions.
    arn String
    Arn of the subscription
    deliveryPolicy Any

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    filterPolicy Any

    The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    filterPolicyScope String
    This attribute lets you choose the filtering scope by using one of the following string value types: MessageAttributes (default) and MessageBody.
    rawMessageDelivery Boolean
    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.
    redrivePolicy Any

    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 for AWS::SNS::Subscription for more information about the expected schema for this property.

    replayPolicy Any

    Specifies whether Amazon SNS resends the notification to the subscription when a message's attribute changes.

    Search the CloudFormation User Guide for AWS::SNS::Subscription for more information about the expected schema for this property.

    subscriptionRoleArn String
    This property applies only to Amazon Data Firehose delivery stream subscriptions.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native