Package software.amazon.awscdk.services.eventsv2

Interface CfnSubscriber.RetryPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSubscriber.RetryPolicyProperty.Jsii$Proxy

Enclosing class:

CfnSubscriber

@Stability(Stable)
public static interface CfnSubscriber.RetryPolicyProperty
extends software.amazon.jsii.JsiiSerializable

The retry policy for failed deliveries.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.eventsv2.*;
 RetryPolicyProperty retryPolicyProperty = RetryPolicyProperty.builder()
         .maxEventAgeInSeconds(123)
         .maxRetryAttempts(123)
         .retryStrategy("retryStrategy")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-subscriber-retrypolicy.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSubscriber.RetryPolicyProperty.Builder	builder()
default Number	getMaxEventAgeInSeconds()	The maximum age of an event in seconds, 60-86400 (24 hours).
default Number	getMaxRetryAttempts()	The maximum number of retry attempts, 0-185.
default String	getRetryStrategy()	Which errors are retried.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaxEventAgeInSeconds

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

The maximum age of an event in seconds, 60-86400 (24 hours).

When an event reaches this age, retries stop; if OnFailureConfiguration is set, the event is delivered to that destination, otherwise it is dropped. The default is 300.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-subscriber-retrypolicy.html#cfn-eventsv2-subscriber-retrypolicy-maxeventageinseconds

getMaxRetryAttempts

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

The maximum number of retry attempts, 0-185.

When the attempts are exhausted, retries stop; if OnFailureConfiguration is set, the event is delivered to that destination, otherwise it is dropped. The default is 5.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-subscriber-retrypolicy.html#cfn-eventsv2-subscriber-retrypolicy-maxretryattempts

getRetryStrategy

@Stability(Stable)
@Nullable
default String getRetryStrategy()

Which errors are retried.

ALL retries all errors. The default is ALL.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-subscriber-retrypolicy.html#cfn-eventsv2-subscriber-retrypolicy-retrystrategy

builder

@Stability(Stable)
static CfnSubscriber.RetryPolicyProperty.Builder builder()

Returns:

a CfnSubscriber.RetryPolicyProperty.Builder of CfnSubscriber.RetryPolicyProperty