Class: AWSCDK::StepFunctions::ResultWriterV2Props

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

Overview

Interface for Result Writer configuration props.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket: nil, bucket_name_path: nil, prefix: nil, writer_config: nil) ⇒ ResultWriterV2Props

Returns a new instance of ResultWriterV2Props.

Parameters:

  • bucket (AWSCDK::S3::IBucket, nil) (defaults to: nil) —

    S3 Bucket in which to save Map Run results.

  • bucket_name_path (String, nil) (defaults to: nil) —

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

  • prefix (String, nil) (defaults to: nil) —

    S3 prefix in which to save Map Run results.

  • writer_config (AWSCDK::StepFunctions::WriterConfig, nil) (defaults to: nil) —

    Configuration to format the output of the Child Workflow executions.



11
12
13
14
15
16
17
18
19
20
 
# File 'step_functions/result_writer_v2_props.rb', line 11

def initialize(bucket: nil, bucket_name_path: nil, prefix: nil, writer_config: nil)
  @bucket = bucket
  Jsii::Type.check_type(@bucket, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczMuSUJ1Y2tldCJ9")), "bucket") unless @bucket.nil?
  @bucket_name_path = bucket_name_path
  Jsii::Type.check_type(@bucket_name_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketNamePath") unless @bucket_name_path.nil?
  @prefix = prefix
  Jsii::Type.check_type(@prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix") unless @prefix.nil?
  @writer_config = writer_config
  Jsii::Type.check_type(@writer_config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5Xcml0ZXJDb25maWcifQ==")), "writerConfig") unless @writer_config.nil?
end

Instance Attribute Details

#bucket ⇒ AWSCDK::S3::IBucket? (readonly)

Note:

Default: - specify a bucket

S3 Bucket in which to save Map Run results.

Returns:



26
27
28
 
# File 'step_functions/result_writer_v2_props.rb', line 26

def bucket
  @bucket
end

#bucket_name_path ⇒ String? (readonly)

Note:

Default: - no bucket path

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

Returns:

  • (String, nil) 


31
32
33
 
# File 'step_functions/result_writer_v2_props.rb', line 31

def bucket_name_path
  @bucket_name_path
end

#prefix ⇒ String? (readonly)

Note:

Default: - No prefix

S3 prefix in which to save Map Run results.

Returns:

  • (String, nil) 


36
37
38
 
# File 'step_functions/result_writer_v2_props.rb', line 36

def prefix
  @prefix
end

#writer_config ⇒ AWSCDK::StepFunctions::WriterConfig? (readonly)

Note:

Default: - Specify both Transformation and OutputType

Configuration to format the output of the Child Workflow executions.

Returns:



41
42
43
 
# File 'step_functions/result_writer_v2_props.rb', line 41

def writer_config
  @writer_config
end

Class Method Details

.jsii_properties ⇒ Object 



43
44
45
46
47
48
49
50
 
# File 'step_functions/result_writer_v2_props.rb', line 43

def self.jsii_properties
  {
    :bucket => "bucket",
    :bucket_name_path => "bucketNamePath",
    :prefix => "prefix",
    :writer_config => "writerConfig",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



52
53
54
55
56
57
58
59
60
61
 
# File 'step_functions/result_writer_v2_props.rb', line 52

def to_jsii
  result = {}
  result.merge!({
    "bucket" => @bucket,
    "bucketNamePath" => @bucket_name_path,
    "prefix" => @prefix,
    "writerConfig" => @writer_config,
  })
  result.compact
end