TopicSubscriptionConfig Struct
Subscription configuration.
| Source | aws-sns/lib/subscriber.ts |
|---|---|
| Type last changed |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_sns as sns } from 'aws-cdk-lib';
import { aws_sqs as sqs } from 'aws-cdk-lib';
import * as constructs from 'constructs';
declare const construct: constructs.Construct;
declare const dependable: constructs.IDependable;
declare const filterOrPolicy: sns.FilterOrPolicy;
declare const queue: sqs.Queue;
declare const subscriptionFilter: sns.SubscriptionFilter;
const topicSubscriptionConfig: sns.TopicSubscriptionConfig = {
endpoint: 'endpoint',
protocol: sns.SubscriptionProtocol.HTTP,
subscriberId: 'subscriberId',
// the properties below are optional
deadLetterQueue: queue,
deliveryPolicy: {
healthyRetryPolicy: {
backoffFunction: sns.BackoffFunction.ARITHMETIC,
maxDelayTarget: cdk.Duration.minutes(30),
minDelayTarget: cdk.Duration.minutes(30),
numMaxDelayRetries: 123,
numMinDelayRetries: 123,
numNoDelayRetries: 123,
numRetries: 123,
},
requestPolicy: {
headerContentType: 'headerContentType',
},
throttlePolicy: {
maxReceivesPerSecond: 123,
},
},
filterPolicy: {
filterPolicyKey: subscriptionFilter,
},
filterPolicyWithMessageBody: {
filterPolicyWithMessageBodyKey: filterOrPolicy,
},
rawMessageDelivery: false,
region: 'region',
subscriberScope: construct,
subscriptionDependency: dependable,
subscriptionRoleArn: 'subscriptionRoleArn',
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_sns as sns
from aws_cdk import aws_sqs as sqs
import constructs as constructs
# construct: constructs.Construct
# dependable: constructs.IDependable
# filter_or_policy: sns.FilterOrPolicy
# queue: sqs.Queue
# subscription_filter: sns.SubscriptionFilter
topic_subscription_config = sns.TopicSubscriptionConfig(
endpoint="endpoint",
protocol=sns.SubscriptionProtocol.HTTP,
subscriber_id="subscriberId",
# the properties below are optional
dead_letter_queue=queue,
delivery_policy=sns.DeliveryPolicy(
healthy_retry_policy=sns.HealthyRetryPolicy(
backoff_function=sns.BackoffFunction.ARITHMETIC,
max_delay_target=cdk.Duration.minutes(30),
min_delay_target=cdk.Duration.minutes(30),
num_max_delay_retries=123,
num_min_delay_retries=123,
num_no_delay_retries=123,
num_retries=123
),
request_policy=sns.RequestPolicy(
header_content_type="headerContentType"
),
throttle_policy=sns.ThrottlePolicy(
max_receives_per_second=123
)
),
filter_policy={
"filter_policy_key": subscription_filter
},
filter_policy_with_message_body={
"filter_policy_with_message_body_key": filter_or_policy
},
raw_message_delivery=False,
region="region",
subscriber_scope=construct,
subscription_dependency=dependable,
subscription_role_arn="subscriptionRoleArn"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.sns.*;
import software.amazon.awscdk.services.sqs.*;
import software.constructs.*;
Construct construct;
IDependable dependable;
FilterOrPolicy filterOrPolicy;
Queue queue;
SubscriptionFilter subscriptionFilter;
TopicSubscriptionConfig topicSubscriptionConfig = TopicSubscriptionConfig.builder()
.endpoint("endpoint")
.protocol(SubscriptionProtocol.HTTP)
.subscriberId("subscriberId")
// the properties below are optional
.deadLetterQueue(queue)
.deliveryPolicy(DeliveryPolicy.builder()
.healthyRetryPolicy(HealthyRetryPolicy.builder()
.backoffFunction(BackoffFunction.ARITHMETIC)
.maxDelayTarget(Duration.minutes(30))
.minDelayTarget(Duration.minutes(30))
.numMaxDelayRetries(123)
.numMinDelayRetries(123)
.numNoDelayRetries(123)
.numRetries(123)
.build())
.requestPolicy(RequestPolicy.builder()
.headerContentType("headerContentType")
.build())
.throttlePolicy(ThrottlePolicy.builder()
.maxReceivesPerSecond(123)
.build())
.build())
.filterPolicy(Map.of(
"filterPolicyKey", subscriptionFilter))
.filterPolicyWithMessageBody(Map.of(
"filterPolicyWithMessageBodyKey", filterOrPolicy))
.rawMessageDelivery(false)
.region("region")
.subscriberScope(construct)
.subscriptionDependency(dependable)
.subscriptionRoleArn("subscriptionRoleArn")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.SNS;
using Amazon.CDK.AWS.SQS;
using Constructs;
Construct construct;
IDependable dependable;
FilterOrPolicy filterOrPolicy;
Queue queue;
SubscriptionFilter subscriptionFilter;
var topicSubscriptionConfig = new TopicSubscriptionConfig {
Endpoint = "endpoint",
Protocol = SubscriptionProtocol.HTTP,
SubscriberId = "subscriberId",
// the properties below are optional
DeadLetterQueue = queue,
DeliveryPolicy = new DeliveryPolicy {
HealthyRetryPolicy = new HealthyRetryPolicy {
BackoffFunction = BackoffFunction.ARITHMETIC,
MaxDelayTarget = Duration.Minutes(30),
MinDelayTarget = Duration.Minutes(30),
NumMaxDelayRetries = 123,
NumMinDelayRetries = 123,
NumNoDelayRetries = 123,
NumRetries = 123
},
RequestPolicy = new RequestPolicy {
HeaderContentType = "headerContentType"
},
ThrottlePolicy = new ThrottlePolicy {
MaxReceivesPerSecond = 123
}
},
FilterPolicy = new Dictionary<string, SubscriptionFilter> {
{ "filterPolicyKey", subscriptionFilter }
},
FilterPolicyWithMessageBody = new Dictionary<string, FilterOrPolicy> {
{ "filterPolicyWithMessageBodyKey", filterOrPolicy }
},
RawMessageDelivery = false,
Region = "region",
SubscriberScope = construct,
SubscriptionDependency = dependable,
SubscriptionRoleArn = "subscriptionRoleArn"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import constructs "github.com/aws/constructs-go/constructs"
var construct Construct
var dependable IDependable
var filterOrPolicy FilterOrPolicy
var queue Queue
var subscriptionFilter SubscriptionFilter
topicSubscriptionConfig := &TopicSubscriptionConfig{
Endpoint: jsii.String("endpoint"),
Protocol: awscdk.Aws_sns.SubscriptionProtocol_HTTP,
SubscriberId: jsii.String("subscriberId"),
// the properties below are optional
DeadLetterQueue: queue,
DeliveryPolicy: &DeliveryPolicy{
HealthyRetryPolicy: &HealthyRetryPolicy{
BackoffFunction: awscdk.*Aws_sns.BackoffFunction_ARITHMETIC,
MaxDelayTarget: cdk.Duration_Minutes(jsii.Number(30)),
MinDelayTarget: cdk.Duration_*Minutes(jsii.Number(30)),
NumMaxDelayRetries: jsii.Number(123),
NumMinDelayRetries: jsii.Number(123),
NumNoDelayRetries: jsii.Number(123),
NumRetries: jsii.Number(123),
},
RequestPolicy: &RequestPolicy{
HeaderContentType: jsii.String("headerContentType"),
},
ThrottlePolicy: &ThrottlePolicy{
MaxReceivesPerSecond: jsii.Number(123),
},
},
FilterPolicy: map[string]SubscriptionFilter{
"filterPolicyKey": subscriptionFilter,
},
FilterPolicyWithMessageBody: map[string]FilterOrPolicy{
"filterPolicyWithMessageBodyKey": filterOrPolicy,
},
RawMessageDelivery: jsii.Boolean(false),
Region: jsii.String("region"),
SubscriberScope: construct,
SubscriptionDependency: dependable,
SubscriptionRoleArn: jsii.String("subscriptionRoleArn"),
}
Properties
deadLetterQueueoptionalIQueuedead_letter_queueoptionalIQueuedeadLetterQueueoptionalIQueueDeadLetterQueueoptionalIQueueDeadLetterQueueoptionalIQueue #Default: No dead letter queue enabled.
If not passed no dead letter queue is enabled.
deliveryPolicyoptionalDeliveryPolicydelivery_policyoptionalDeliveryPolicydeliveryPolicyoptionalDeliveryPolicyDeliveryPolicyoptionalDeliveryPolicyDeliveryPolicyoptionalDeliveryPolicy #Default: if the initial delivery of the message fails, three retries with a delay between failed attempts set at 20 seconds
The meaning of this value depends on the value for 'protocol'.
filterPolicyoptional{ [key: string]: SubscriptionFilter }filter_policyoptionaltyping.Mapping[str, SubscriptionFilter]filterPolicyoptionalMap<String, SubscriptionFilter>FilterPolicyoptionalIDictionary<string, SubscriptionFilter>FilterPolicyoptional*map[string]SubscriptionFilter #Default: all messages are delivered
filterPolicyWithMessageBodyoptional{ [key: string]: FilterOrPolicy }filter_policy_with_message_bodyoptionaltyping.Mapping[str, FilterOrPolicy]filterPolicyWithMessageBodyoptionalMap<String, FilterOrPolicy>FilterPolicyWithMessageBodyoptionalIDictionary<string, FilterOrPolicy>FilterPolicyWithMessageBodyoptional*map[string]FilterOrPolicy #Default: all messages are delivered
To apply a filter policy to the message attributes, use filterPolicy. A maximum of one of filterPolicyWithMessageBody and filterPolicy may be used.
protocolSubscriptionProtocolprotocolSubscriptionProtocolprotocolSubscriptionProtocolProtocolSubscriptionProtocolProtocolSubscriptionProtocol required #rawMessageDeliveryoptionalbooleanraw_message_deliveryoptionalboolrawMessageDeliveryoptionalBooleanRawMessageDeliveryoptionalboolRawMessageDeliveryoptional*bool = false #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.
regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string #Default: the region where the CloudFormation stack is being deployed.
subscriberIdstringsubscriber_idstrsubscriberIdStringSubscriberIdstringSubscriberId*string required #In most cases, it is recommended to use the uniqueId of the topic you are subscribing to.
subscriberScopeoptionalConstructsubscriber_scopeoptionalConstructsubscriberScopeoptionalConstructSubscriberScopeoptionalConstructSubscriberScopeoptionalConstruct #Default: use the topic as the scope of the subscription, in which case subscriberId must be defined.
notes
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.
subscriptionDependencyoptionalIDependablesubscription_dependencyoptionalIDependablesubscriptionDependencyoptionalIDependableSubscriptionDependencyoptionalIDependableSubscriptionDependencyoptionalIDependable #Default: empty list
For example for SQS subscription, the subscription needs to have a dependency on the SQS queue policy in order for the subscription to successfully deliver messages.
subscriptionRoleArnoptionalstringsubscription_role_arnoptionalstrsubscriptionRoleArnoptionalStringSubscriptionRoleArnoptionalstringSubscriptionRoleArnoptional*string #Default: No subscription role is provided
Required for a firehose subscription protocol.