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

Interface UrlSubscriptionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SubscriptionProps

All Known Implementing Classes:

UrlSubscriptionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:41.462Z")
@Stability(Stable)
public interface UrlSubscriptionProps
extends software.amazon.jsii.JsiiSerializable, SubscriptionProps

Options for URL subscriptions.

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.*;
 Queue queue;
 SubscriptionFilter subscriptionFilter;
 UrlSubscriptionProps urlSubscriptionProps = UrlSubscriptionProps.builder()
         .deadLetterQueue(queue)
         .filterPolicy(Map.of(
                 "filterPolicyKey", subscriptionFilter))
         .protocol(SubscriptionProtocol.HTTP)
         .rawMessageDelivery(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UrlSubscriptionProps.Builder	builder()
default SubscriptionProtocol	getProtocol()	The subscription's protocol.
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

Method Details

getProtocol

@Stability(Stable)
@Nullable
default SubscriptionProtocol getProtocol()

The subscription's protocol.

Default: - Protocol is derived from url

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 UrlSubscriptionProps.Builder builder()

Returns:

a UrlSubscriptionProps.Builder of UrlSubscriptionProps