software.amazon.awscdk.services.sns

Class TopicSubscriptionConfig.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.sns.TopicSubscriptionConfig.Jsii$Proxy

All Implemented Interfaces:

SubscriptionOptions, TopicSubscriptionConfig, software.amazon.jsii.JsiiSerializable

Enclosing interface:

TopicSubscriptionConfig

@Stability(value=Experimental)
 @Internal
public static final class TopicSubscriptionConfig.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements TopicSubscriptionConfig

An implementation for TopicSubscriptionConfig

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sns.TopicSubscriptionConfig

TopicSubscriptionConfig.Builder, TopicSubscriptionConfig.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(String subscriberId, software.constructs.Construct subscriberScope, String endpoint, SubscriptionProtocol protocol, IQueue deadLetterQueue, Map<String,? extends SubscriptionFilter> filterPolicy, Boolean rawMessageDelivery, String region) Constructor that initializes the object based on literal property values passed by the TopicSubscriptionConfig.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
IQueue	getDeadLetterQueue() (experimental) Queue to be used as dead letter queue.
String	getEndpoint() (experimental) The subscription endpoint.
Map<String,SubscriptionFilter>	getFilterPolicy() (experimental) The filter policy.
SubscriptionProtocol	getProtocol() (experimental) What type of subscription to add.
Boolean	getRawMessageDelivery() (experimental) true if raw message delivery is enabled for the subscription.
String	getRegion() (experimental) The region where the topic resides, in the case of cross-region subscriptions.
String	getSubscriberId() (experimental) The id of the SNS subscription resource created under `scope`.
software.constructs.Construct	getSubscriberScope() (experimental) The scope in which to create the SNS subscription resource.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.sns.TopicSubscriptionConfig

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(String subscriberId,
                     software.constructs.Construct subscriberScope,
                     String endpoint,
                     SubscriptionProtocol protocol,
                     IQueue deadLetterQueue,
                     Map<String,? extends SubscriptionFilter> filterPolicy,
                     Boolean rawMessageDelivery,
                     String region)

Constructor that initializes the object based on literal property values passed by the TopicSubscriptionConfig.Builder.

Method Detail

getSubscriberId

public final String getSubscriberId()

Description copied from interface: TopicSubscriptionConfig

(experimental) The id of the SNS subscription resource created under `scope`.

In most cases, it is recommended to use the uniqueId of the topic you are subscribing to.

Specified by:

getSubscriberId in interface TopicSubscriptionConfig

getSubscriberScope

public final software.constructs.Construct getSubscriberScope()

Description copied from interface: TopicSubscriptionConfig

(experimental) The scope in which to create the SNS subscription resource.

Normally you'd want the subscription to be created on the consuming stack because the topic is usually referenced by the consumer's resource policy (e.g. SQS queue policy). Otherwise, it will cause a cyclic reference.

If this is undefined, the subscription will be created on the topic's stack.

Default: - use the topic as the scope of the subscription, in which case `subscriberId` must be defined.

Specified by:

getSubscriberScope in interface TopicSubscriptionConfig

getEndpoint

public final String getEndpoint()

Description copied from interface: SubscriptionOptions

(experimental) The subscription endpoint.

The meaning of this value depends on the value for 'protocol'.

Specified by:

getEndpoint in interface SubscriptionOptions

getProtocol

public final SubscriptionProtocol getProtocol()

Description copied from interface: SubscriptionOptions

(experimental) What type of subscription to add.

Specified by:

getProtocol in interface SubscriptionOptions

getDeadLetterQueue

public final IQueue getDeadLetterQueue()

Description copied from interface: SubscriptionOptions

(experimental) Queue to be used as dead letter queue.

If not passed no dead letter queue is enabled.

Default: - No dead letter queue enabled.

Specified by:

getDeadLetterQueue in interface SubscriptionOptions

getFilterPolicy

public final Map<String,SubscriptionFilter> getFilterPolicy()

Description copied from interface: SubscriptionOptions

(experimental) The filter policy.

Default: - all messages are delivered

Specified by:

getFilterPolicy in interface SubscriptionOptions

getRawMessageDelivery

public final Boolean getRawMessageDelivery()

Description copied from interface: SubscriptionOptions

(experimental) true if raw message delivery is enabled for the subscription.

Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints. For more information, see GetSubscriptionAttributes in the Amazon Simple Notification Service API Reference.

Default: false

Specified by:

getRawMessageDelivery in interface SubscriptionOptions

getRegion

public final String getRegion()

Description copied from interface: SubscriptionOptions

(experimental) The region where the topic resides, in the case of cross-region subscriptions.

Default: - the region where the CloudFormation stack is being deployed.

Specified by:

getRegion in interface SubscriptionOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object