Class: AWSCDK::StepFunctions::ItemBatcherProps

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

Overview

Interface for ItemBatcher configuration properties.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(batch_input: nil, max_input_bytes_per_batch: nil, max_input_bytes_per_batch_path: nil, max_items_per_batch: nil, max_items_per_batch_path: nil) ⇒ ItemBatcherProps

Returns a new instance of ItemBatcherProps.

Parameters:

  • batch_input (Hash, nil) (defaults to: nil)

    BatchInput.

  • max_input_bytes_per_batch (Numeric, nil) (defaults to: nil)

    MaxInputBytesPerBatch.

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

    MaxInputBytesPerBatchPath.

  • max_items_per_batch (Numeric, nil) (defaults to: nil)

    MaxItemsPerBatch.

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

    MaxItemsPerBatchPath.



12
13
14
15
16
17
18
19
20
21
22
23
# File 'step_functions/item_batcher_props.rb', line 12

def initialize(batch_input: nil, max_input_bytes_per_batch: nil, max_input_bytes_per_batch_path: nil, max_items_per_batch: nil, max_items_per_batch_path: nil)
  @batch_input = batch_input
  Jsii::Type.check_type(@batch_input, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJqc29uIn0=")), "batchInput") unless @batch_input.nil?
  @max_input_bytes_per_batch = max_input_bytes_per_batch
  Jsii::Type.check_type(@max_input_bytes_per_batch, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxInputBytesPerBatch") unless @max_input_bytes_per_batch.nil?
  @max_input_bytes_per_batch_path = max_input_bytes_per_batch_path
  Jsii::Type.check_type(@max_input_bytes_per_batch_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "maxInputBytesPerBatchPath") unless @max_input_bytes_per_batch_path.nil?
  @max_items_per_batch = max_items_per_batch
  Jsii::Type.check_type(@max_items_per_batch, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxItemsPerBatch") unless @max_items_per_batch.nil?
  @max_items_per_batch_path = max_items_per_batch_path
  Jsii::Type.check_type(@max_items_per_batch_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "maxItemsPerBatchPath") unless @max_items_per_batch_path.nil?
end

Instance Attribute Details

#batch_inputHash? (readonly)

Note:

Default: - No batchInput

BatchInput.

Fixed JSON input to include in each batch passed to each child workflow execution

Returns:

  • (Hash, nil)


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

def batch_input
  @batch_input
end

#max_input_bytes_per_batchNumeric? (readonly)

Note:

Default: - uses value of maxInputBytesPerBatchPath as the max size per batch, no limits on the batch size under the 256KB limit if that property was also not provided

MaxInputBytesPerBatch.

Specifies the maximum number of bytes that each child workflow execution processes, as static number

Returns:

  • (Numeric, nil)


38
39
40
# File 'step_functions/item_batcher_props.rb', line 38

def max_input_bytes_per_batch
  @max_input_bytes_per_batch
end

#max_input_bytes_per_batch_pathString? (readonly)

Note:

Default: - uses value of maxInputBytesPerBatch as the max size per batch, no limits on the batch size under the 256KB limit if that property was also not provided

MaxInputBytesPerBatchPath.

Specifies the maximum number of bytes that each child workflow execution processes, as JsonPath

Returns:

  • (String, nil)


45
46
47
# File 'step_functions/item_batcher_props.rb', line 45

def max_input_bytes_per_batch_path
  @max_input_bytes_per_batch_path
end

#max_items_per_batchNumeric? (readonly)

Note:

Default: - uses value of maxItemsPerBatchPath as the max items per batch, no limits on the number of items in a batch under the 256KB limit if that property was also not provided

MaxItemsPerBatch.

Specifies the maximum number of items that each child workflow execution processes, as static number

Returns:

  • (Numeric, nil)


52
53
54
# File 'step_functions/item_batcher_props.rb', line 52

def max_items_per_batch
  @max_items_per_batch
end

#max_items_per_batch_pathString? (readonly)

Note:

Default: - uses value of maxItemsPerBatch as the max items per batch, no limits on the number of items in a batch under the 256KB limit if that property was also not provided

MaxItemsPerBatchPath.

Specifies the maximum number of items that each child workflow execution processes, as JsonPath

Returns:

  • (String, nil)


59
60
61
# File 'step_functions/item_batcher_props.rb', line 59

def max_items_per_batch_path
  @max_items_per_batch_path
end

Class Method Details

.jsii_propertiesObject



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

def self.jsii_properties
  {
    :batch_input => "batchInput",
    :max_input_bytes_per_batch => "maxInputBytesPerBatch",
    :max_input_bytes_per_batch_path => "maxInputBytesPerBatchPath",
    :max_items_per_batch => "maxItemsPerBatch",
    :max_items_per_batch_path => "maxItemsPerBatchPath",
  }
end

Instance Method Details

#to_jsiiObject



71
72
73
74
75
76
77
78
79
80
81
# File 'step_functions/item_batcher_props.rb', line 71

def to_jsii
  result = {}
  result.merge!({
    "batchInput" => @batch_input,
    "maxInputBytesPerBatch" => @max_input_bytes_per_batch,
    "maxInputBytesPerBatchPath" => @max_input_bytes_per_batch_path,
    "maxItemsPerBatch" => @max_items_per_batch,
    "maxItemsPerBatchPath" => @max_items_per_batch_path,
  })
  result.compact
end