Class: AWSCDK::Scheduler::CfnSchedule::RetryPolicyProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Scheduler::CfnSchedule::RetryPolicyProperty

Defined in:

scheduler/cfn_schedule.rb

Overview

A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

See Also:

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

Instance Attribute Summary

• #maximum_event_age_in_seconds ⇒ Numeric^? readonly

  The maximum amount of time, in seconds, to continue to make retry attempts.

• #maximum_retry_attempts ⇒ Numeric^? readonly

  The maximum number of retry attempts to make before the request fails.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(maximum_event_age_in_seconds: nil, maximum_retry_attempts: nil) ⇒ RetryPolicyProperty constructor

  A new instance of RetryPolicyProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(maximum_event_age_in_seconds: nil, maximum_retry_attempts: nil) ⇒ RetryPolicyProperty

Returns a new instance of RetryPolicyProperty.

Parameters:

• maximum_event_age_in_seconds (Numeric, nil) (defaults to: nil) —

  The maximum amount of time, in seconds, to continue to make retry attempts.

• maximum_retry_attempts (Numeric, nil) (defaults to: nil) —

  The maximum number of retry attempts to make before the request fails.

# File 'scheduler/cfn_schedule.rb', line 1242

def initialize(maximum_event_age_in_seconds: nil, maximum_retry_attempts: nil)
  @maximum_event_age_in_seconds = maximum_event_age_in_seconds
  Jsii::Type.check_type(@maximum_event_age_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumEventAgeInSeconds") unless @maximum_event_age_in_seconds.nil?
  @maximum_retry_attempts = maximum_retry_attempts
  Jsii::Type.check_type(@maximum_retry_attempts, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumRetryAttempts") unless @maximum_retry_attempts.nil?
end

Instance Attribute Details

#maximum_event_age_in_seconds ⇒ Numeric^? (readonly)

The maximum amount of time, in seconds, to continue to make retry attempts.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-retrypolicy.html#cfn-scheduler-schedule-retrypolicy-maximumeventageinseconds

# File 'scheduler/cfn_schedule.rb', line 1253

def maximum_event_age_in_seconds
  @maximum_event_age_in_seconds
end

#maximum_retry_attempts ⇒ Numeric^? (readonly)

The maximum number of retry attempts to make before the request fails.

Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-retrypolicy.html#cfn-scheduler-schedule-retrypolicy-maximumretryattempts

# File 'scheduler/cfn_schedule.rb', line 1260

def maximum_retry_attempts
  @maximum_retry_attempts
end

Class Method Details

.jsii_properties ⇒ Object

# File 'scheduler/cfn_schedule.rb', line 1262

def self.jsii_properties
  {
    :maximum_event_age_in_seconds => "maximumEventAgeInSeconds",
    :maximum_retry_attempts => "maximumRetryAttempts",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'scheduler/cfn_schedule.rb', line 1269

def to_jsii
  result = {}
  result.merge!({
    "maximumEventAgeInSeconds" => @maximum_event_age_in_seconds,
    "maximumRetryAttempts" => @maximum_retry_attempts,
  })
  result.compact
end