Class: AWSCDK::QuickSight::CfnRefreshSchedule::RefreshScheduleMapProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnRefreshSchedule::RefreshScheduleMapProperty

Defined in:

quick_sight/cfn_refresh_schedule.rb

Overview

A summary of a configured refresh schedule for a dataset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html

Instance Attribute Summary

• #refresh_type ⇒ String^? readonly

  The type of refresh that a dataset undergoes.

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

  The frequency for the refresh schedule.

• #schedule_id ⇒ String^? readonly

  An identifier for the refresh schedule.

• #start_after_date_time ⇒ String^? readonly

  Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(refresh_type: nil, schedule_frequency: nil, schedule_id: nil, start_after_date_time: nil) ⇒ RefreshScheduleMapProperty constructor

  A new instance of RefreshScheduleMapProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(refresh_type: nil, schedule_frequency: nil, schedule_id: nil, start_after_date_time: nil) ⇒ RefreshScheduleMapProperty

Returns a new instance of RefreshScheduleMapProperty.

Parameters:

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

  The type of refresh that a dataset undergoes. Valid values are as follows:.

• schedule_frequency (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnRefreshSchedule::ScheduleFrequencyProperty, nil) (defaults to: nil) —

  The frequency for the refresh schedule.

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

  An identifier for the refresh schedule.

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

  Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

# File 'quick_sight/cfn_refresh_schedule.rb', line 584

def initialize(refresh_type: nil, schedule_frequency: nil, schedule_id: nil, start_after_date_time: nil)
  @refresh_type = refresh_type
  Jsii::Type.check_type(@refresh_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "refreshType") unless @refresh_type.nil?
  @schedule_frequency = schedule_frequency.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnRefreshSchedule::ScheduleFrequencyProperty.new(**schedule_frequency.transform_keys(&:to_sym)) : schedule_frequency
  Jsii::Type.check_type(@schedule_frequency, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblJlZnJlc2hTY2hlZHVsZS5TY2hlZHVsZUZyZXF1ZW5jeVByb3BlcnR5In1dfX0=")), "scheduleFrequency") unless @schedule_frequency.nil?
  @schedule_id = schedule_id
  Jsii::Type.check_type(@schedule_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scheduleId") unless @schedule_id.nil?
  @start_after_date_time = start_after_date_time
  Jsii::Type.check_type(@start_after_date_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startAfterDateTime") unless @start_after_date_time.nil?
end

Instance Attribute Details

#refresh_type ⇒ String^? (readonly)

The type of refresh that a dataset undergoes. Valid values are as follows:.

• FULL_REFRESH : A complete refresh of a dataset.
• INCREMENTAL_REFRESH : A partial refresh of some rows of a dataset, based on the time window specified.

For more information on full and incremental refreshes, see Refreshing SPICE data in the Quick User Guide .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-refreshtype

# File 'quick_sight/cfn_refresh_schedule.rb', line 604

def refresh_type
  @refresh_type
end

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

The frequency for the refresh schedule.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnRefreshSchedule::ScheduleFrequencyProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-schedulefrequency

# File 'quick_sight/cfn_refresh_schedule.rb', line 609

def schedule_frequency
  @schedule_frequency
end

#schedule_id ⇒ String^? (readonly)

An identifier for the refresh schedule.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-scheduleid

# File 'quick_sight/cfn_refresh_schedule.rb', line 614

def schedule_id
  @schedule_id
end

#start_after_date_time ⇒ String^? (readonly)

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-startafterdatetime

# File 'quick_sight/cfn_refresh_schedule.rb', line 619

def start_after_date_time
  @start_after_date_time
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_refresh_schedule.rb', line 621

def self.jsii_properties
  {
    :refresh_type => "refreshType",
    :schedule_frequency => "scheduleFrequency",
    :schedule_id => "scheduleId",
    :start_after_date_time => "startAfterDateTime",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_refresh_schedule.rb', line 630

def to_jsii
  result = {}
  result.merge!({
    "refreshType" => @refresh_type,
    "scheduleFrequency" => @schedule_frequency,
    "scheduleId" => @schedule_id,
    "startAfterDateTime" => @start_after_date_time,
  })
  result.compact
end