Class: AWSCDK::KinesisFirehose::DynamicPartitioningProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kinesis_firehose/dynamic_partitioning_props.rb

Overview

Props for defining dynamic partitioning.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled:, retry_duration: nil) ⇒ DynamicPartitioningProps

Returns a new instance of DynamicPartitioningProps.

Parameters:

  • enabled (Boolean) —

    Whether to enable the dynamic partitioning.

  • retry_duration (AWSCDK::Duration, nil) (defaults to: nil) —

    The total amount of time that Data Firehose spends on retries.



11
12
13
14
15
16
 
# File 'kinesis_firehose/dynamic_partitioning_props.rb', line 11

def initialize(enabled:, retry_duration: nil)
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "enabled")
  @retry_duration = retry_duration
  Jsii::Type.check_type(@retry_duration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "retryDuration") unless @retry_duration.nil?
end

Instance Attribute Details

#enabled ⇒ Boolean (readonly)

Whether to enable the dynamic partitioning.

You cannot enable dynamic partitioning for an existing Firehose stream that does not have dynamic partitioning already enabled.

Returns:

  • (Boolean)

See Also:



24
25
26
 
# File 'kinesis_firehose/dynamic_partitioning_props.rb', line 24

def enabled
  @enabled
end

#retry_duration ⇒ AWSCDK::Duration? (readonly)

Note:

Default: Duration.seconds(300)

The total amount of time that Data Firehose spends on retries.

Minimum: Duration.seconds(0) Maximum: Duration.seconds(7200)

Returns:



32
33
34
 
# File 'kinesis_firehose/dynamic_partitioning_props.rb', line 32

def retry_duration
  @retry_duration
end

Class Method Details

.jsii_properties ⇒ Object 



34
35
36
37
38
39
 
# File 'kinesis_firehose/dynamic_partitioning_props.rb', line 34

def self.jsii_properties
  {
    :enabled => "enabled",
    :retry_duration => "retryDuration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'kinesis_firehose/dynamic_partitioning_props.rb', line 41

def to_jsii
  result = {}
  result.merge!({
    "enabled" => @enabled,
    "retryDuration" => @retry_duration,
  })
  result.compact
end