interface HealthyRetryPolicy

Language	Type name
.NET	Amazon.CDK.AWS.SNS.HealthyRetryPolicy
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssns#HealthyRetryPolicy
Java	software.amazon.awscdk.services.sns.HealthyRetryPolicy
Python	aws_cdk.aws_sns.HealthyRetryPolicy
TypeScript (source)	aws-cdk-lib » aws_sns » HealthyRetryPolicy

Options for customising the retry policy of the delivery of SNS messages to HTTP/S endpoints.

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

Name	Type	Description
backoffFunction?	BackoffFunction	The model for backoff between retries.
maxDelayTarget?	Duration	The maximum delay for a retry.
minDelayTarget?	Duration	The minimum delay for a retry.
numMaxDelayRetries?	number	The number of retries in the post-backoff phase, with the maximum delay between them.
numMinDelayRetries?	number	The number of retries in the pre-backoff phase, with the specified minimum delay between them.
numNoDelayRetries?	number	The number of retries to be done immediately, with no delay between them.
numRetries?	number	The total number of retries, including immediate, pre-backoff, backoff, and post-backoff retries.

---

backoffFunction?

Type: BackoffFunction (optional, default: linear)

The model for backoff between retries.

---

maxDelayTarget?

Type: Duration (optional, default: 20 seconds)

The maximum delay for a retry.

Must be at least minDelayTarget less than 3,600 seconds, and correspond to a whole number of seconds,

---

minDelayTarget?

Type: Duration (optional, default: 20 seconds)

The minimum delay for a retry.

Must be at least one second, not exceed maxDelayTarget, and correspond to a whole number of seconds.

---

numMaxDelayRetries?

Type: number (optional, default: 0)

The number of retries in the post-backoff phase, with the maximum delay between them.

Must be zero or greater

---

numMinDelayRetries?

Type: number (optional, default: 0)

The number of retries in the pre-backoff phase, with the specified minimum delay between them.

Must be zero or greater

---

numNoDelayRetries?

Type: number (optional, default: 0)

The number of retries to be done immediately, with no delay between them.

Must be zero or greater.

---

numRetries?

Type: number (optional, default: 3)

The total number of retries, including immediate, pre-backoff, backoff, and post-backoff retries.

Must be greater than or equal to zero and not exceed 100.