Class: AWSCDK::BCMDataExports::CfnExport::ExportProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bcm_data_exports/cfn_export.rb

Overview

The details that are available for an export.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_query:, destination_configurations:, name:, refresh_cadence:, description: nil, export_arn: nil) ⇒ ExportProperty

Returns a new instance of ExportProperty.

Parameters:



624
625
626
627
628
629
630
631
632
633
634
635
636
637
# File 'bcm_data_exports/cfn_export.rb', line 624

def initialize(data_query:, destination_configurations:, name:, refresh_cadence:, description: nil, export_arn: nil)
  @data_query = data_query.is_a?(Hash) ? ::AWSCDK::BCMDataExports::CfnExport::DataQueryProperty.new(**data_query.transform_keys(&:to_sym)) : data_query
  Jsii::Type.check_type(@data_query, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iY21kYXRhZXhwb3J0cy5DZm5FeHBvcnQuRGF0YVF1ZXJ5UHJvcGVydHkifV19fQ==")), "dataQuery")
  @destination_configurations = destination_configurations.is_a?(Hash) ? ::AWSCDK::BCMDataExports::CfnExport::DestinationConfigurationsProperty.new(**destination_configurations.transform_keys(&:to_sym)) : destination_configurations
  Jsii::Type.check_type(@destination_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iY21kYXRhZXhwb3J0cy5DZm5FeHBvcnQuRGVzdGluYXRpb25Db25maWd1cmF0aW9uc1Byb3BlcnR5In1dfX0=")), "destinationConfigurations")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @refresh_cadence = refresh_cadence.is_a?(Hash) ? ::AWSCDK::BCMDataExports::CfnExport::RefreshCadenceProperty.new(**refresh_cadence.transform_keys(&:to_sym)) : refresh_cadence
  Jsii::Type.check_type(@refresh_cadence, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iY21kYXRhZXhwb3J0cy5DZm5FeHBvcnQuUmVmcmVzaENhZGVuY2VQcm9wZXJ0eSJ9XX19")), "refreshCadence")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @export_arn = export_arn
  Jsii::Type.check_type(@export_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "exportArn") unless @export_arn.nil?
end

Instance Attribute Details

#descriptionString? (readonly)

The description for this specific data export.



663
664
665
# File 'bcm_data_exports/cfn_export.rb', line 663

def description
  @description
end

#destination_configurationsAWSCDK::IResolvable, AWSCDK::BCMDataExports::CfnExport::DestinationConfigurationsProperty (readonly)

The destination configuration for this specific data export.



648
649
650
# File 'bcm_data_exports/cfn_export.rb', line 648

def destination_configurations
  @destination_configurations
end

#export_arnString? (readonly)

The Amazon Resource Name (ARN) for this export.



668
669
670
# File 'bcm_data_exports/cfn_export.rb', line 668

def export_arn
  @export_arn
end

#nameString (readonly)

The name of this specific data export.



653
654
655
# File 'bcm_data_exports/cfn_export.rb', line 653

def name
  @name
end

#refresh_cadenceAWSCDK::IResolvable, AWSCDK::BCMDataExports::CfnExport::RefreshCadenceProperty (readonly)

The cadence for AWS to update the export in your S3 bucket.



658
659
660
# File 'bcm_data_exports/cfn_export.rb', line 658

def refresh_cadence
  @refresh_cadence
end

Class Method Details

.jsii_propertiesObject



670
671
672
673
674
675
676
677
678
679
# File 'bcm_data_exports/cfn_export.rb', line 670

def self.jsii_properties
  {
    :data_query => "dataQuery",
    :destination_configurations => "destinationConfigurations",
    :name => "name",
    :refresh_cadence => "refreshCadence",
    :description => "description",
    :export_arn => "exportArn",
  }
end

Instance Method Details

#to_jsiiObject



681
682
683
684
685
686
687
688
689
690
691
692
# File 'bcm_data_exports/cfn_export.rb', line 681

def to_jsii
  result = {}
  result.merge!({
    "dataQuery" => @data_query,
    "destinationConfigurations" => @destination_configurations,
    "name" => @name,
    "refreshCadence" => @refresh_cadence,
    "description" => @description,
    "exportArn" => @export_arn,
  })
  result.compact
end