Class: AWSCDK::KinesisFirehose::CommonDestinationProps

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

Overview

Generic properties for defining a delivery stream destination.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(logging_config: nil, processor: nil, processors: nil, role: nil, s3_backup: nil) ⇒ CommonDestinationProps

Returns a new instance of CommonDestinationProps.

Parameters:



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

def initialize(logging_config: nil, processor: nil, processors: nil, role: nil, s3_backup: nil)
  @logging_config = logging_config
  Jsii::Type.check_type(@logging_config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2luZXNpc2ZpcmVob3NlLklMb2dnaW5nQ29uZmlnIn0=")), "loggingConfig") unless @logging_config.nil?
  @processor = processor
  Jsii::Type.check_type(@processor, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2luZXNpc2ZpcmVob3NlLklEYXRhUHJvY2Vzc29yIn0=")), "processor") unless @processor.nil?
  @processors = processors
  Jsii::Type.check_type(@processors, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuSURhdGFQcm9jZXNzb3IifSwia2luZCI6ImFycmF5In19")), "processors") unless @processors.nil?
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role") unless @role.nil?
  @s3_backup = s3_backup.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::DestinationS3BackupProps.new(**s3_backup.transform_keys(&:to_sym)) : s3_backup
  Jsii::Type.check_type(@s3_backup, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2luZXNpc2ZpcmVob3NlLkRlc3RpbmF0aW9uUzNCYWNrdXBQcm9wcyJ9")), "s3Backup") unless @s3_backup.nil?
end

Instance Attribute Details

#logging_config ⇒ AWSCDK::KinesisFirehose::ILoggingConfig? (readonly)

Note:

Default: - errors will be logged and a log group will be created for you.

Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.

Returns:



29
30
31
 
# File 'kinesis_firehose/common_destination_props.rb', line 29

def logging_config
  @logging_config
end

#processor ⇒ AWSCDK::KinesisFirehose::IDataProcessor? (readonly)

Deprecated.

Use processors instead.

Note:

Default: - no data transformation will occur.

The data transformation that should be performed on the data before writing to the destination.

Returns:



35
36
37
 
# File 'kinesis_firehose/common_destination_props.rb', line 35

def processor
  @processor
end

#processors ⇒ Array<AWSCDK::KinesisFirehose::IDataProcessor>? (readonly)

Note:

Default: - no data transformation will occur.

The data transformation that should be performed on the data before writing to the destination.

Returns:



40
41
42
 
# File 'kinesis_firehose/common_destination_props.rb', line 40

def processors
  @processors
end

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

Note:

Default: - a role will be created with default permissions.

The IAM role associated with this destination.

Assumed by Amazon Data Firehose to invoke processors and write to destinations

Returns:



47
48
49
 
# File 'kinesis_firehose/common_destination_props.rb', line 47

def role
  @role
end

#s3_backup ⇒ AWSCDK::KinesisFirehose::DestinationS3BackupProps? (readonly)

Note:

Default: - source records will not be backed up to S3.

The configuration for backing up source records to S3.

Returns:



52
53
54
 
# File 'kinesis_firehose/common_destination_props.rb', line 52

def s3_backup
  @s3_backup
end

Class Method Details

.jsii_properties ⇒ Object 



54
55
56
57
58
59
60
61
62
 
# File 'kinesis_firehose/common_destination_props.rb', line 54

def self.jsii_properties
  {
    :logging_config => "loggingConfig",
    :processor => "processor",
    :processors => "processors",
    :role => "role",
    :s3_backup => "s3Backup",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
 
# File 'kinesis_firehose/common_destination_props.rb', line 64

def to_jsii
  result = {}
  result.merge!({
    "loggingConfig" => @logging_config,
    "processor" => @processor,
    "processors" => @processors,
    "role" => @role,
    "s3Backup" => @s3_backup,
  })
  result.compact
end