Package software.amazon.awscdk.cfnpropertymixins.services.sns

Class CfnSubscriptionMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.sns.CfnSubscriptionMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnSubscriptionMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnSubscriptionMixinProps

@Stability(Stable)
@Internal
public static final class CfnSubscriptionMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnSubscriptionMixinProps

An implementation for CfnSubscriptionMixinProps

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.cfnpropertymixins.services.sns.CfnSubscriptionMixinProps

CfnSubscriptionMixinProps.Builder, CfnSubscriptionMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnSubscriptionMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnSubscriptionMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getDeliveryPolicy()	The delivery policy JSON assigned to the subscription.
final Object	getEndpoint()	The subscription's endpoint.
final Object	getFilterPolicy()	The filter policy JSON assigned to the subscription.
final String	getFilterPolicyScope()	This attribute lets you choose the filtering scope by using one of the following string value types:.
final String	getProtocol()	The subscription's protocol.
final Object	getRawMessageDelivery()	When set to true , enables raw message delivery.
final Object	getRedrivePolicy()	When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.
final String	getRegion()	For cross-region subscriptions, the region in which the topic resides.
final Object	getReplayPolicy()	Specifies whether Amazon resends the notification to the subscription when a message's attribute changes.
final Object	getSubscriptionRoleArn()	This property applies only to Amazon Data Firehose delivery stream subscriptions.
final Object	getTopicArn()	The ARN of the topic to subscribe to.
final 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

Constructor Details

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

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

Method Details

getDeliveryPolicy

public final Object getDeliveryPolicy()

Description copied from interface: CfnSubscriptionMixinProps

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. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon API Reference and Message delivery retries in the Amazon Developer Guide .

Specified by:

getDeliveryPolicy in interface CfnSubscriptionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-deliverypolicy

getEndpoint

public final Object getEndpoint()

Description copied from interface: CfnSubscriptionMixinProps

The subscription's endpoint.

The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .

Returns union: either String or IDeliveryStreamRef or IFunctionRef or IVersionRef or IQueueRef

Specified by:

getEndpoint in interface CfnSubscriptionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-endpoint

getFilterPolicy

public final Object getFilterPolicy()

Description copied from interface: CfnSubscriptionMixinProps

The filter policy JSON assigned to the subscription.

Enables the subscriber to filter out unwanted messages. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon API Reference and Message filtering in the Amazon Developer Guide .

Specified by:

getFilterPolicy in interface CfnSubscriptionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicy

getFilterPolicyScope

public final String getFilterPolicyScope()

Description copied from interface: CfnSubscriptionMixinProps

This attribute lets you choose the filtering scope by using one of the following string value types:.

• MessageAttributes (default) - The filter is applied on the message attributes.
• MessageBody - The filter is applied on the message body.

Null is not a valid value for FilterPolicyScope . To delete a filter policy, delete the FilterPolicy property but keep FilterPolicyScope property as is.

Specified by:

getFilterPolicyScope in interface CfnSubscriptionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-filterpolicyscope

getProtocol

public final String getProtocol()

Description copied from interface: CfnSubscriptionMixinProps

The subscription's protocol.

For more information, see the Protocol parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .

Specified by:

getProtocol in interface CfnSubscriptionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-protocol

getRawMessageDelivery

public final Object getRawMessageDelivery()

Description copied from interface: CfnSubscriptionMixinProps

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. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon API Reference .

Returns union: either Boolean or IResolvable

Specified by:

getRawMessageDelivery in interface CfnSubscriptionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-rawmessagedelivery

getRedrivePolicy

public final Object getRedrivePolicy()

Description copied from interface: CfnSubscriptionMixinProps

When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue.

Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

For more information about the redrive policy and dead-letter queues, see Amazon SQS dead-letter queues in the Amazon SQS Developer Guide .

Specified by:

getRedrivePolicy in interface CfnSubscriptionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-redrivepolicy

getRegion

public final String getRegion()

Description copied from interface: CfnSubscriptionMixinProps

For cross-region subscriptions, the region in which the topic resides.

If no region is specified, CloudFormation uses the region of the caller as the default.

If you perform an update operation that only updates the Region property of a AWS::SNS::Subscription resource, that operation will fail unless you are either:

• Updating the Region from NULL to the caller region.
• Updating the Region from the caller region to NULL .

Specified by:

getRegion in interface CfnSubscriptionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-region

getReplayPolicy

public final Object getReplayPolicy()

Description copied from interface: CfnSubscriptionMixinProps

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

Specified by:

getReplayPolicy in interface CfnSubscriptionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-replaypolicy

getSubscriptionRoleArn

public final Object getSubscriptionRoleArn()

Description copied from interface: CfnSubscriptionMixinProps

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

Specify the ARN of the IAM role that has the following:

• Permission to write to the Amazon Data Firehose delivery stream
• Amazon listed as a trusted entity

Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Amazon Data Firehose delivery streams in the Amazon Developer Guide.

Returns union: either String or IRoleRef

Specified by:

getSubscriptionRoleArn in interface CfnSubscriptionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-subscriptionrolearn

getTopicArn

public final Object getTopicArn()

Description copied from interface: CfnSubscriptionMixinProps

The ARN of the topic to subscribe to.

Returns union: either String or ITopicRef

Specified by:

getTopicArn in interface CfnSubscriptionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html#cfn-sns-subscription-topicarn

$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