Class: AWSCDK::QuickSight::CfnDataSet::IngestionWaitPolicyProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnDataSet::IngestionWaitPolicyProperty

Defined in:

quick_sight/cfn_data_set.rb

Overview

The wait policy to use when creating or updating a Dataset.

The default is to wait for SPICE ingestion to finish with timeout of 36 hours.

See Also:

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

Instance Attribute Summary

• #ingestion_wait_time_in_hours ⇒ Numeric^? readonly

  The maximum time (in hours) to wait for Ingestion to complete.

• #wait_for_spice_ingestion ⇒ Boolean, ... readonly

  Wait for SPICE ingestion to finish to mark dataset creation or update as successful.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(ingestion_wait_time_in_hours: nil, wait_for_spice_ingestion: nil) ⇒ IngestionWaitPolicyProperty constructor

  A new instance of IngestionWaitPolicyProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(ingestion_wait_time_in_hours: nil, wait_for_spice_ingestion: nil) ⇒ IngestionWaitPolicyProperty

Returns a new instance of IngestionWaitPolicyProperty.

Parameters:

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

  The maximum time (in hours) to wait for Ingestion to complete.

• wait_for_spice_ingestion (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  Wait for SPICE ingestion to finish to mark dataset creation or update as successful.

# File 'quick_sight/cfn_data_set.rb', line 3397

def initialize(ingestion_wait_time_in_hours: nil, wait_for_spice_ingestion: nil)
  @ingestion_wait_time_in_hours = ingestion_wait_time_in_hours
  Jsii::Type.check_type(@ingestion_wait_time_in_hours, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ingestionWaitTimeInHours") unless @ingestion_wait_time_in_hours.nil?
  @wait_for_spice_ingestion = wait_for_spice_ingestion
  Jsii::Type.check_type(@wait_for_spice_ingestion, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "waitForSpiceIngestion") unless @wait_for_spice_ingestion.nil?
end

Instance Attribute Details

#ingestion_wait_time_in_hours ⇒ Numeric^? (readonly)

Note:

Default: - 36

The maximum time (in hours) to wait for Ingestion to complete.

Default timeout is 36 hours. Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-ingestionwaitpolicy.html#cfn-quicksight-dataset-ingestionwaitpolicy-ingestionwaittimeinhours

# File 'quick_sight/cfn_data_set.rb', line 3411

def ingestion_wait_time_in_hours
  @ingestion_wait_time_in_hours
end

#wait_for_spice_ingestion ⇒ Boolean, ... (readonly)

Note:

Default: - true

Wait for SPICE ingestion to finish to mark dataset creation or update as successful.

Default (true). Applicable only when DataSetImportMode mode is set to SPICE.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-ingestionwaitpolicy.html#cfn-quicksight-dataset-ingestionwaitpolicy-waitforspiceingestion

# File 'quick_sight/cfn_data_set.rb', line 3419

def wait_for_spice_ingestion
  @wait_for_spice_ingestion
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_data_set.rb', line 3421

def self.jsii_properties
  {
    :ingestion_wait_time_in_hours => "ingestionWaitTimeInHours",
    :wait_for_spice_ingestion => "waitForSpiceIngestion",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_data_set.rb', line 3428

def to_jsii
  result = {}
  result.merge!({
    "ingestionWaitTimeInHours" => @ingestion_wait_time_in_hours,
    "waitForSpiceIngestion" => @wait_for_spice_ingestion,
  })
  result.compact
end