Package software.amazon.awscdk.services.sns

Interface HealthyRetryPolicy

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HealthyRetryPolicy.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:40:15.503Z")
@Stability(Stable)
public interface HealthyRetryPolicy
extends software.amazon.jsii.JsiiSerializable

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

Example:

 Topic myTopic = new Topic(this, "MyTopic");
 myTopic.addSubscription(
 UrlSubscription.Builder.create("https://foobar.com/")
         .deliveryPolicy(DeliveryPolicy.builder()
                 .healthyRetryPolicy(HealthyRetryPolicy.builder()
                         .minDelayTarget(Duration.seconds(5))
                         .maxDelayTarget(Duration.seconds(10))
                         .numRetries(6)
                         .backoffFunction(BackoffFunction.EXPONENTIAL)
                         .build())
                 .throttlePolicy(ThrottlePolicy.builder()
                         .maxReceivesPerSecond(10)
                         .build())
                 .requestPolicy(RequestPolicy.builder()
                         .headerContentType("application/json")
                         .build())
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HealthyRetryPolicy.Builder	builder()
default BackoffFunction	getBackoffFunction()	The model for backoff between retries.
default Duration	getMaxDelayTarget()	The maximum delay for a retry.
default Duration	getMinDelayTarget()	The minimum delay for a retry.
default Number	getNumMaxDelayRetries()	The number of retries in the post-backoff phase, with the maximum delay between them.
default Number	getNumMinDelayRetries()	The number of retries in the pre-backoff phase, with the specified minimum delay between them.
default Number	getNumNoDelayRetries()	The number of retries to be done immediately, with no delay between them.
default Number	getNumRetries()	The total number of retries, including immediate, pre-backoff, backoff, and post-backoff retries.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBackoffFunction

@Stability(Stable)
@Nullable
default BackoffFunction getBackoffFunction()

The model for backoff between retries.

Default: - linear

getMaxDelayTarget

@Stability(Stable)
@Nullable
default Duration getMaxDelayTarget()

The maximum delay for a retry.

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

Default: - 20 seconds

getMinDelayTarget

@Stability(Stable)
@Nullable
default Duration getMinDelayTarget()

The minimum delay for a retry.

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

Default: - 20 seconds

getNumMaxDelayRetries

@Stability(Stable)
@Nullable
default Number getNumMaxDelayRetries()

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

Must be zero or greater

Default: 0

getNumMinDelayRetries

@Stability(Stable)
@Nullable
default Number getNumMinDelayRetries()

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

Must be zero or greater

Default: 0

getNumNoDelayRetries

@Stability(Stable)
@Nullable
default Number getNumNoDelayRetries()

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

Must be zero or greater.

Default: 0

getNumRetries

@Stability(Stable)
@Nullable
default Number getNumRetries()

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.

Default: 3

builder

@Stability(Stable)
static HealthyRetryPolicy.Builder builder()

Returns:

a HealthyRetryPolicy.Builder of HealthyRetryPolicy