Package software.amazon.awscdk.services.sns

Interface CfnTopic.SubscriptionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopic.SubscriptionProperty.Jsii$Proxy

Enclosing class:

CfnTopic

@Stability(Stable)
public static interface CfnTopic.SubscriptionProperty
extends software.amazon.jsii.JsiiSerializable

Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.

For full control over subscription behavior (for example, delivery policy, filtering, raw message delivery, and cross-region subscriptions), use the AWS::SNS::Subscription resource.

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.*;
 SubscriptionProperty subscriptionProperty = SubscriptionProperty.builder()
         .endpoint("endpoint")
         .protocol("protocol")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopic.SubscriptionProperty.Builder	builder()
String	getEndpoint()	The endpoint that receives notifications from the Amazon SNS topic.
String	getProtocol()	The subscription's protocol.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpoint

@Stability(Stable)
@NotNull
String getEndpoint()

The endpoint that receives notifications from the Amazon SNS topic.

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 SNS API Reference .

See Also:

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

getProtocol

@Stability(Stable)
@NotNull
String getProtocol()

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 SNS API Reference .

See Also:

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

builder

@Stability(Stable)
static CfnTopic.SubscriptionProperty.Builder builder()

Returns:

a CfnTopic.SubscriptionProperty.Builder of CfnTopic.SubscriptionProperty