Module: AWSCDK::StepFunctions::IItemReader

Included in:
S3CsvItemReader, S3JsonItemReader, S3JsonLItemReader, S3ManifestItemReader, S3ObjectsItemReader
Defined in:
step_functions/i_item_reader.rb

Overview

Base interface for Item Reader configurations.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
 
# File 'step_functions/i_item_reader.rb', line 60

def self.jsii_overridable_methods
  {
    :bucket => { kind: :property, name: "bucket", is_optional: false },
    :resource => { kind: :property, name: "resource", is_optional: false },
    :bucket_name_path => { kind: :property, name: "bucketNamePath", is_optional: true },
    :max_items => { kind: :property, name: "maxItems", is_optional: true },
    :provide_policy_statements => { kind: :method, name: "providePolicyStatements", is_optional: false },
    :render => { kind: :method, name: "render", is_optional: false },
    :validate_item_reader => { kind: :method, name: "validateItemReader", is_optional: false },
  }
end

Instance Method Details

#bucket ⇒ AWSCDK::S3::IBucket

S3 Bucket containing objects to iterate over or a file with a list to iterate over.

Returns:



10
11
12
 
# File 'step_functions/i_item_reader.rb', line 10

def bucket()
  jsii_get_property("bucket")
end

#bucket_name_path ⇒ String?

S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.

Returns:

  • (String, nil) 


24
25
26
 
# File 'step_functions/i_item_reader.rb', line 24

def bucket_name_path()
  jsii_get_property("bucketNamePath")
end

#max_items ⇒ Numeric?

Note:

Default: - Distributed Map state will iterate over all items provided by the ItemReader

Limits the number of items passed to the Distributed Map state.

Returns:

  • (Numeric, nil) 


32
33
34
 
# File 'step_functions/i_item_reader.rb', line 32

def max_items()
  jsii_get_property("maxItems")
end

#provide_policy_statements ⇒ Array<AWSCDK::IAM::PolicyStatement>

Compile policy statements to provide relevent permissions to the state machine.

Returns:



39
40
41
 
# File 'step_functions/i_item_reader.rb', line 39

def provide_policy_statements()
  jsii_call_method("providePolicyStatements", [])
end

#render(query_language = nil) ⇒ Object

Render the ItemReader as JSON object.

Parameters:

Returns:

  • (Object) 


47
48
49
50
 
# File 'step_functions/i_item_reader.rb', line 47

def render(query_language = nil)
  Jsii::Type.check_type(query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "queryLanguage") unless query_language.nil?
  jsii_call_method("render", [query_language])
end

#resource ⇒ String

The Amazon S3 API action that Step Functions must invoke depending on the specified dataset.

Returns:

  • (String) 


17
18
19
 
# File 'step_functions/i_item_reader.rb', line 17

def resource()
  jsii_get_property("resource")
end

#validate_item_reader ⇒ Array<String>

Validate that ItemReader contains exactly either.

Returns:

  • (Array<String>)

See Also:

  • bucketNamePath


56
57
58
 
# File 'step_functions/i_item_reader.rb', line 56

def validate_item_reader()
  jsii_call_method("validateItemReader", [])
end