Class: AWSCDK::CloudTrail::CfnDashboard::RefreshScheduleProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_trail/cfn_dashboard.rb

Overview

The schedule for a dashboard refresh.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(frequency: nil, status: nil, time_of_day: nil) ⇒ RefreshScheduleProperty

Returns a new instance of RefreshScheduleProperty.

Parameters:

  • frequency (AWSCDK::IResolvable, AWSCDK::CloudTrail::CfnDashboard::FrequencyProperty, nil) (defaults to: nil) —

    The frequency at which you want the dashboard refreshed.

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

    Specifies whether the refresh schedule is enabled.

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

    The time of day in UTC to run the schedule;



672
673
674
675
676
677
678
679
 
# File 'cloud_trail/cfn_dashboard.rb', line 672

def initialize(frequency: nil, status: nil, time_of_day: nil)
  @frequency = frequency.is_a?(Hash) ? ::AWSCDK::CloudTrail::CfnDashboard::FrequencyProperty.new(**frequency.transform_keys(&:to_sym)) : frequency
  Jsii::Type.check_type(@frequency, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZHRyYWlsLkNmbkRhc2hib2FyZC5GcmVxdWVuY3lQcm9wZXJ0eSJ9XX19")), "frequency") unless @frequency.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
  @time_of_day = time_of_day
  Jsii::Type.check_type(@time_of_day, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeOfDay") unless @time_of_day.nil?
end

Instance Attribute Details

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

The frequency at which you want the dashboard refreshed.

Returns:

See Also:



685
686
687
 
# File 'cloud_trail/cfn_dashboard.rb', line 685

def frequency
  @frequency
end

#status ⇒ String? (readonly)

Specifies whether the refresh schedule is enabled.

Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.

Returns:

  • (String, nil)

See Also:



692
693
694
 
# File 'cloud_trail/cfn_dashboard.rb', line 692

def status
  @status
end

#time_of_day ⇒ String? (readonly)

The time of day in UTC to run the schedule;

for hourly only refer to minutes; default is 00:00.

Returns:

  • (String, nil)

See Also:



699
700
701
 
# File 'cloud_trail/cfn_dashboard.rb', line 699

def time_of_day
  @time_of_day
end

Class Method Details

.jsii_properties ⇒ Object 



701
702
703
704
705
706
707
 
# File 'cloud_trail/cfn_dashboard.rb', line 701

def self.jsii_properties
  {
    :frequency => "frequency",
    :status => "status",
    :time_of_day => "timeOfDay",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



709
710
711
712
713
714
715
716
717
 
# File 'cloud_trail/cfn_dashboard.rb', line 709

def to_jsii
  result = {}
  result.merge!({
    "frequency" => @frequency,
    "status" => @status,
    "timeOfDay" => @time_of_day,
  })
  result.compact
end