Class: AWSCDK::StepFunctions::ResultWriterV2

Inherits:
Jsii::Object
  • Object
show all
Defined in:
step_functions/result_writer_v2.rb

Overview

Configuration for writing Distributed Map state results to S3 The ResultWriter field cannot be empty.

You must specify one of these sets of sub-fields. writerConfig - to preview the formatted output, without saving the results to Amazon S3. bucket and prefix - to save the results to Amazon S3 without additional formatting. All three fields: writerConfig, bucket and prefix - to format the output and save it to Amazon S3.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(props) ⇒ ResultWriterV2

Returns a new instance of ResultWriterV2.

Parameters:



14
15
16
17
18
 
# File 'step_functions/result_writer_v2.rb', line 14

def initialize(props)
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::ResultWriterV2Props.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5SZXN1bHRXcml0ZXJWMlByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
 
# File 'step_functions/result_writer_v2.rb', line 20

def self.jsii_overridable_methods
  {
    :bucket => { kind: :property, name: "bucket", is_optional: true },
    :bucket_name_path => { kind: :property, name: "bucketNamePath", is_optional: true },
    :prefix => { kind: :property, name: "prefix", is_optional: true },
    :writer_config => { kind: :property, name: "writerConfig", is_optional: true },
    :provide_policy_statements => { kind: :method, name: "providePolicyStatements", is_optional: false },
    :render => { kind: :method, name: "render", is_optional: false },
    :validate_result_writer => { kind: :method, name: "validateResultWriter", is_optional: false },
  }
end

Instance Method Details

#bucket ⇒ AWSCDK::S3::IBucket?

S3 Bucket in which to save Map Run results.

Returns:



35
36
37
 
# File 'step_functions/result_writer_v2.rb', line 35

def bucket()
  jsii_get_property("bucket")
end

#bucket_name_path ⇒ String?

S3 bucket name in which to save Map Run results, as JsonPath.

Returns:

  • (String, nil) 


42
43
44
 
# File 'step_functions/result_writer_v2.rb', line 42

def bucket_name_path()
  jsii_get_property("bucketNamePath")
end

#prefix ⇒ String?

Note:

Default: - No prefix

S3 prefix in which to save Map Run results.

Returns:

  • (String, nil) 


50
51
52
 
# File 'step_functions/result_writer_v2.rb', line 50

def prefix()
  jsii_get_property("prefix")
end

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

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

Returns:



64
65
66
 
# File 'step_functions/result_writer_v2.rb', line 64

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

#render(query_language = nil) ⇒ Object

Render ResultWriter in ASL JSON format.

Parameters:

Returns:

  • (Object) 


72
73
74
75
 
# File 'step_functions/result_writer_v2.rb', line 72

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

#validate_result_writer ⇒ Array<String>

Validate that ResultWriter contains exactly either.

Returns:

  • (Array<String>)

See Also:

  • bucketNamePath


81
82
83
 
# File 'step_functions/result_writer_v2.rb', line 81

def validate_result_writer()
  jsii_call_method("validateResultWriter", [])
end

#writer_config ⇒ AWSCDK::StepFunctions::WriterConfig?

Configuration to format the output of the Child Workflow executions.

Returns:



57
58
59
 
# File 'step_functions/result_writer_v2.rb', line 57

def writer_config()
  jsii_get_property("writerConfig")
end