Class: AWSCDK::BCMDataExports::CfnExport::S3DestinationProperty

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

Overview

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a data exports file.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(s3_bucket:, s3_output_configurations:, s3_prefix:, s3_region:, s3_bucket_owner: nil) ⇒ S3DestinationProperty

Returns a new instance of S3DestinationProperty.

Parameters:

  • s3_bucket (String) —

    The name of the Amazon S3 bucket used as the destination of a data export file.

  • s3_output_configurations (AWSCDK::IResolvable, AWSCDK::BCMDataExports::CfnExport::S3OutputConfigurationsProperty) —

    The output configuration for the data export.

  • s3_prefix (String) —

    The S3 path prefix you want prepended to the name of your data export.

  • s3_region (String) —

    The S3 bucket Region.

  • s3_bucket_owner (String, nil) (defaults to: nil) 


784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'bcm_data_exports/cfn_export.rb', line 784

def initialize(s3_bucket:, s3_output_configurations:, s3_prefix:, s3_region:, s3_bucket_owner: nil)
  @s3_bucket = s3_bucket
  Jsii::Type.check_type(@s3_bucket, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3Bucket")
  @s3_output_configurations = s3_output_configurations.is_a?(Hash) ? ::AWSCDK::BCMDataExports::CfnExport::S3OutputConfigurationsProperty.new(**s3_output_configurations.transform_keys(&:to_sym)) : s3_output_configurations
  Jsii::Type.check_type(@s3_output_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iY21kYXRhZXhwb3J0cy5DZm5FeHBvcnQuUzNPdXRwdXRDb25maWd1cmF0aW9uc1Byb3BlcnR5In1dfX0=")), "s3OutputConfigurations")
  @s3_prefix = s3_prefix
  Jsii::Type.check_type(@s3_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3Prefix")
  @s3_region = s3_region
  Jsii::Type.check_type(@s3_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3Region")
  @s3_bucket_owner = s3_bucket_owner
  Jsii::Type.check_type(@s3_bucket_owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3BucketOwner") unless @s3_bucket_owner.nil?
end

Instance Attribute Details

#s3_bucket ⇒ String (readonly)

The name of the Amazon S3 bucket used as the destination of a data export file.

Returns:

  • (String)

See Also:



801
802
803
 
# File 'bcm_data_exports/cfn_export.rb', line 801

def s3_bucket
  @s3_bucket
end

#s3_bucket_owner ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



819
820
821
 
# File 'bcm_data_exports/cfn_export.rb', line 819

def s3_bucket_owner
  @s3_bucket_owner
end

#s3_output_configurations ⇒ AWSCDK::IResolvable, AWSCDK::BCMDataExports::CfnExport::S3OutputConfigurationsProperty (readonly)

The output configuration for the data export.

Returns:

See Also:



806
807
808
 
# File 'bcm_data_exports/cfn_export.rb', line 806

def s3_output_configurations
  @s3_output_configurations
end

#s3_prefix ⇒ String (readonly)

The S3 path prefix you want prepended to the name of your data export.

Returns:

  • (String)

See Also:



811
812
813
 
# File 'bcm_data_exports/cfn_export.rb', line 811

def s3_prefix
  @s3_prefix
end

#s3_region ⇒ String (readonly)

The S3 bucket Region.

Returns:

  • (String)

See Also:



816
817
818
 
# File 'bcm_data_exports/cfn_export.rb', line 816

def s3_region
  @s3_region
end

Class Method Details

.jsii_properties ⇒ Object 



821
822
823
824
825
826
827
828
829
 
# File 'bcm_data_exports/cfn_export.rb', line 821

def self.jsii_properties
  {
    :s3_bucket => "s3Bucket",
    :s3_output_configurations => "s3OutputConfigurations",
    :s3_prefix => "s3Prefix",
    :s3_region => "s3Region",
    :s3_bucket_owner => "s3BucketOwner",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



831
832
833
834
835
836
837
838
839
840
841
 
# File 'bcm_data_exports/cfn_export.rb', line 831

def to_jsii
  result = {}
  result.merge!({
    "s3Bucket" => @s3_bucket,
    "s3OutputConfigurations" => @s3_output_configurations,
    "s3Prefix" => @s3_prefix,
    "s3Region" => @s3_region,
    "s3BucketOwner" => @s3_bucket_owner,
  })
  result.compact
end