Class: AWSCDK::KinesisFirehose::DataProcessorBindOptions

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

Overview

Options when binding a DataProcessor to a delivery stream destination.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(role:, dynamic_partitioning_enabled: nil, prefix: nil) ⇒ DataProcessorBindOptions

Returns a new instance of DataProcessorBindOptions.

Parameters:

  • role (AWSCDK::IAM::IRole) —

    The IAM role assumed by Amazon Data Firehose to write to the destination that this DataProcessor will bind to.

  • dynamic_partitioning_enabled (Boolean, nil) (defaults to: nil) —

    Whether the dynamic partitioning is enabled.

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

    S3 bucket prefix.



10
11
12
13
14
15
16
17
 
# File 'kinesis_firehose/data_processor_bind_options.rb', line 10

def initialize(role:, dynamic_partitioning_enabled: nil, prefix: nil)
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role")
  @dynamic_partitioning_enabled = dynamic_partitioning_enabled
  Jsii::Type.check_type(@dynamic_partitioning_enabled, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "dynamicPartitioningEnabled") unless @dynamic_partitioning_enabled.nil?
  @prefix = prefix
  Jsii::Type.check_type(@prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix") unless @prefix.nil?
end

Instance Attribute Details

#dynamic_partitioning_enabled ⇒ Boolean? (readonly)

Note:

Default: false

Whether the dynamic partitioning is enabled.

Returns:

  • (Boolean, nil) 


27
28
29
 
# File 'kinesis_firehose/data_processor_bind_options.rb', line 27

def dynamic_partitioning_enabled
  @dynamic_partitioning_enabled
end

#prefix ⇒ String? (readonly)

Note:

Default: - No prefix

S3 bucket prefix.

Returns:

  • (String, nil) 


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

def prefix
  @prefix
end

#role ⇒ AWSCDK::IAM::IRole (readonly)

The IAM role assumed by Amazon Data Firehose to write to the destination that this DataProcessor will bind to.

Returns:



22
23
24
 
# File 'kinesis_firehose/data_processor_bind_options.rb', line 22

def role
  @role
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :role => "role",
    :dynamic_partitioning_enabled => "dynamicPartitioningEnabled",
    :prefix => "prefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



42
43
44
45
46
47
48
49
50
 
# File 'kinesis_firehose/data_processor_bind_options.rb', line 42

def to_jsii
  result = {}
  result.merge!({
    "role" => @role,
    "dynamicPartitioningEnabled" => @dynamic_partitioning_enabled,
    "prefix" => @prefix,
  })
  result.compact
end