Class: AWSCDK::AppFlow::CfnFlow::S3SourcePropertiesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_flow/cfn_flow.rb

Overview

The properties that are applied when Amazon S3 is being used as the flow source.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name:, bucket_prefix:, s3_input_format_config: nil) ⇒ S3SourcePropertiesProperty

Returns a new instance of S3SourcePropertiesProperty.

Parameters:

  • bucket_name (String)

    The Amazon S3 bucket name where the source files are stored.

  • bucket_prefix (String)

    The object key for the Amazon S3 bucket in which the source files are stored.

  • s3_input_format_config (AWSCDK::IResolvable, AWSCDK::AppFlow::CfnFlow::S3InputFormatConfigProperty, nil) (defaults to: nil)

    When you use Amazon S3 as the source, the configuration format that you provide the flow input data.



2084
2085
2086
2087
2088
2089
2090
2091
# File 'app_flow/cfn_flow.rb', line 2084

def initialize(bucket_name:, bucket_prefix:, s3_input_format_config: nil)
  @bucket_name = bucket_name
  Jsii::Type.check_type(@bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketName")
  @bucket_prefix = bucket_prefix
  Jsii::Type.check_type(@bucket_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketPrefix")
  @s3_input_format_config = s3_input_format_config.is_a?(Hash) ? ::AWSCDK::AppFlow::CfnFlow::S3InputFormatConfigProperty.new(**s3_input_format_config.transform_keys(&:to_sym)) : s3_input_format_config
  Jsii::Type.check_type(@s3_input_format_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBmbG93LkNmbkZsb3cuUzNJbnB1dEZvcm1hdENvbmZpZ1Byb3BlcnR5In1dfX0=")), "s3InputFormatConfig") unless @s3_input_format_config.nil?
end

Instance Attribute Details

#bucket_nameString (readonly)

The Amazon S3 bucket name where the source files are stored.



2097
2098
2099
# File 'app_flow/cfn_flow.rb', line 2097

def bucket_name
  @bucket_name
end

#bucket_prefixString (readonly)

The object key for the Amazon S3 bucket in which the source files are stored.



2102
2103
2104
# File 'app_flow/cfn_flow.rb', line 2102

def bucket_prefix
  @bucket_prefix
end

#s3_input_format_configAWSCDK::IResolvable, ... (readonly)

When you use Amazon S3 as the source, the configuration format that you provide the flow input data.



2107
2108
2109
# File 'app_flow/cfn_flow.rb', line 2107

def s3_input_format_config
  @s3_input_format_config
end

Class Method Details

.jsii_propertiesObject



2109
2110
2111
2112
2113
2114
2115
# File 'app_flow/cfn_flow.rb', line 2109

def self.jsii_properties
  {
    :bucket_name => "bucketName",
    :bucket_prefix => "bucketPrefix",
    :s3_input_format_config => "s3InputFormatConfig",
  }
end

Instance Method Details

#to_jsiiObject



2117
2118
2119
2120
2121
2122
2123
2124
2125
# File 'app_flow/cfn_flow.rb', line 2117

def to_jsii
  result = {}
  result.merge!({
    "bucketName" => @bucket_name,
    "bucketPrefix" => @bucket_prefix,
    "s3InputFormatConfig" => @s3_input_format_config,
  })
  result.compact
end