Class: AWSCDK::Synthetics::CfnCanary::ScheduleProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Synthetics::CfnCanary::ScheduleProperty

Defined in:

synthetics/cfn_canary.rb

Overview

This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.

See Also:

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

Instance Attribute Summary

• #duration_in_seconds ⇒ String^? readonly

  How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

• #expression ⇒ String readonly

  A rate expression or a cron expression that defines how often the canary is to run.

• #retry_config ⇒ AWSCDK::IResolvable, ... readonly

  The canary's retry configuration information.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(expression:, duration_in_seconds: nil, retry_config: nil) ⇒ ScheduleProperty constructor

  A new instance of ScheduleProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(expression:, duration_in_seconds: nil, retry_config: nil) ⇒ ScheduleProperty

Returns a new instance of ScheduleProperty.

Parameters:

• expression (String) —

  A rate expression or a cron expression that defines how often the canary is to run.

• duration_in_seconds (String, nil) (defaults to: nil) —

  How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

• retry_config (AWSCDK::IResolvable, AWSCDK::Synthetics::CfnCanary::RetryConfigProperty, nil) (defaults to: nil) —

  The canary's retry configuration information.

# File 'synthetics/cfn_canary.rb', line 1269

def initialize(expression:, duration_in_seconds: nil, retry_config: nil)
  @expression = expression
  Jsii::Type.check_type(@expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "expression")
  @duration_in_seconds = duration_in_seconds
  Jsii::Type.check_type(@duration_in_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "durationInSeconds") unless @duration_in_seconds.nil?
  @retry_config = retry_config.is_a?(Hash) ? ::AWSCDK::Synthetics::CfnCanary::RetryConfigProperty.new(**retry_config.transform_keys(&:to_sym)) : retry_config
  Jsii::Type.check_type(@retry_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zeW50aGV0aWNzLkNmbkNhbmFyeS5SZXRyeUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "retryConfig") unless @retry_config.nil?
end

Instance Attribute Details

#duration_in_seconds ⇒ String^? (readonly)

How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-schedule.html#cfn-synthetics-canary-schedule-durationinseconds

# File 'synthetics/cfn_canary.rb', line 1297

def duration_in_seconds
  @duration_in_seconds
end

#expression ⇒ String (readonly)

A rate expression or a cron expression that defines how often the canary is to run.

For a rate expression, The syntax is rate( *number unit* ) . unit can be minute , minutes , or hour .

For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour) .

Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

Use cron( *expression* ) to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-schedule.html#cfn-synthetics-canary-schedule-expression

# File 'synthetics/cfn_canary.rb', line 1290

def expression
  @expression
end

#retry_config ⇒ AWSCDK::IResolvable, ... (readonly)

The canary's retry configuration information.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Synthetics::CfnCanary::RetryConfigProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-schedule.html#cfn-synthetics-canary-schedule-retryconfig

# File 'synthetics/cfn_canary.rb', line 1302

def retry_config
  @retry_config
end

Class Method Details

.jsii_properties ⇒ Object

# File 'synthetics/cfn_canary.rb', line 1304

def self.jsii_properties
  {
    :expression => "expression",
    :duration_in_seconds => "durationInSeconds",
    :retry_config => "retryConfig",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'synthetics/cfn_canary.rb', line 1312

def to_jsii
  result = {}
  result.merge!({
    "expression" => @expression,
    "durationInSeconds" => @duration_in_seconds,
    "retryConfig" => @retry_config,
  })
  result.compact
end