aws-cdk-lib.aws_sns.TopicSubscriptionConfig

TopicSubscriptionConfig Struct

Subscription configuration.

TopicSubscriptionConfig

extends

• SubscriptionOptions

Source

aws-sns/lib/subscriber.ts

Type last changed

v2.45.0 · 6 Oct 2022

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',
};

Properties

deadLetterQueueIQueuedead_letter_queueIQueuedeadLetterQueueIQueueDeadLetterQueueIQueueDeadLetterQueueIQueue#

Queue to be used as dead letter queue.

Default: No dead letter queue enabled.

If not passed no dead letter queue is enabled.

deliveryPolicyDeliveryPolicydelivery_policyDeliveryPolicydeliveryPolicyDeliveryPolicyDeliveryPolicyDeliveryPolicyDeliveryPolicyDeliveryPolicy#

The delivery policy.

Default: if the initial delivery of the message fails, three retries with a delay between failed attempts set at 20 seconds

endpointstringendpointstrendpointStringEndpointstringEndpoint*stringrequired#

The subscription endpoint.

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

filterPolicy{ [key: string]: SubscriptionFilter }filter_policytyping.Mapping[str, SubscriptionFilter]filterPolicyMap<String, SubscriptionFilter>FilterPolicyIDictionary<string, SubscriptionFilter>FilterPolicy*map[string]SubscriptionFilter#

The filter policy.

Default: all messages are delivered

filterPolicyWithMessageBody{ [key: string]: FilterOrPolicy }filter_policy_with_message_bodytyping.Mapping[str, FilterOrPolicy]filterPolicyWithMessageBodyMap<String, FilterOrPolicy>FilterPolicyWithMessageBodyIDictionary<string, FilterOrPolicy>FilterPolicyWithMessageBody*map[string]FilterOrPolicy#

The filter policy that is applied on the message body.

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.

protocolSubscriptionProtocolprotocolSubscriptionProtocolprotocolSubscriptionProtocolProtocolSubscriptionProtocolProtocolSubscriptionProtocolrequired#

What type of subscription to add.

rawMessageDeliverybooleanraw_message_deliveryboolrawMessageDeliveryBooleanRawMessageDeliveryboolRawMessageDelivery*bool= false#

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.

regionstringregionstrregionStringRegionstringRegion*string#

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

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

subscriberIdstringsubscriber_idstrsubscriberIdStringSubscriberIdstringSubscriberId*stringrequired#

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.

subscriberScopeConstructsubscriber_scopeConstructsubscriberScopeConstructSubscriberScopeConstructSubscriberScopeConstruct#

The scope in which to create the SNS subscription resource.

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.

subscriptionDependencyIDependablesubscription_dependencyIDependablesubscriptionDependencyIDependableSubscriptionDependencyIDependableSubscriptionDependencyIDependable#

The resources that need to be created before the subscription can be safely created.

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.

subscriptionRoleArnstringsubscription_role_arnstrsubscriptionRoleArnStringSubscriptionRoleArnstringSubscriptionRoleArn*string#

Arn of role allowing access to firehose delivery stream.

Default: No subscription role is provided

Required for a firehose subscription protocol.