aws-cdk-lib.aws_sns.ThrottlePolicy

ThrottlePolicy Struct

Options for customising AWS SNS HTTP/S delivery throttling.

Source

aws-sns/lib/delivery-policy.ts

Type last changed

v2.169.0 · 21 Nov 2024

Example

const myTopic = new sns.Topic(this, 'MyTopic');

myTopic.addSubscription(
  new subscriptions.UrlSubscription(
    'https://foobar.com/',
    {
      deliveryPolicy: {
        healthyRetryPolicy: {
          minDelayTarget: Duration.seconds(5),
          maxDelayTarget: Duration.seconds(10),
          numRetries: 6,
          backoffFunction: sns.BackoffFunction.EXPONENTIAL,
        },
        throttlePolicy: {
          maxReceivesPerSecond: 10,
        },
        requestPolicy: {
          headerContentType: 'application/json',
        },
      },
    },
  ),
);

Properties

maxReceivesPerSecond?optionalnumbermax_receives_per_second?optionalint | floatmaxReceivesPerSecond?optionalNumberMaxReceivesPerSecond?optionaldoubleMaxReceivesPerSecond?optional*float64#

The maximum number of deliveries per second, per subscription.

Default: no throttling