Package software.amazon.awscdk.services.sns.subscriptions

Interface SqsSubscriptionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SubscriptionProps

All Known Implementing Classes:

SqsSubscriptionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:09.918Z")
@Stability(Stable)
public interface SqsSubscriptionProps
extends software.amazon.jsii.JsiiSerializable, SubscriptionProps

Properties for an SQS subscription.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sns.*;
 import software.amazon.awscdk.services.sns.subscriptions.*;
 import software.amazon.awscdk.services.sqs.*;
 FilterOrPolicy filterOrPolicy;
 Queue queue;
 SubscriptionFilter subscriptionFilter;
 SqsSubscriptionProps sqsSubscriptionProps = SqsSubscriptionProps.builder()
         .deadLetterQueue(queue)
         .filterPolicy(Map.of(
                 "filterPolicyKey", subscriptionFilter))
         .filterPolicyWithMessageBody(Map.of(
                 "filterPolicyWithMessageBodyKey", filterOrPolicy))
         .rawMessageDelivery(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SqsSubscriptionProps.Builder	A builder for SqsSubscriptionProps
static final class	SqsSubscriptionProps.Jsii$Proxy	An implementation for SqsSubscriptionProps

Method Summary

Modifier and Type	Method	Description
static SqsSubscriptionProps.Builder	builder()
default Boolean	getRawMessageDelivery()	The message to the queue is the same as it was sent to the topic.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.sns.subscriptions.SubscriptionProps

getDeadLetterQueue, getFilterPolicy, getFilterPolicyWithMessageBody

Method Details

getRawMessageDelivery

@Stability(Stable)
@Nullable
default Boolean getRawMessageDelivery()

The message to the queue is the same as it was sent to the topic.

If false, the message will be wrapped in an SNS envelope.

Default: false

builder

@Stability(Stable)
static SqsSubscriptionProps.Builder builder()

Returns:

a SqsSubscriptionProps.Builder of SqsSubscriptionProps