Class: AWSCDK::KinesisFirehose::CfnDeliveryStreamProps

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

Overview

Properties for defining a CfnDeliveryStream.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(amazon_open_search_serverless_destination_configuration: nil, amazonopensearchservice_destination_configuration: nil, database_source_configuration: nil, delivery_stream_encryption_configuration_input: nil, delivery_stream_name: nil, delivery_stream_type: nil, direct_put_source_configuration: nil, elasticsearch_destination_configuration: nil, extended_s3_destination_configuration: nil, http_endpoint_destination_configuration: nil, iceberg_destination_configuration: nil, kinesis_stream_source_configuration: nil, msk_source_configuration: nil, redshift_destination_configuration: nil, s3_destination_configuration: nil, snowflake_destination_configuration: nil, splunk_destination_configuration: nil, tags: nil) ⇒ CfnDeliveryStreamProps

Returns a new instance of CfnDeliveryStreamProps.

Parameters:



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 27

def initialize(amazon_open_search_serverless_destination_configuration: nil, amazonopensearchservice_destination_configuration: nil, database_source_configuration: nil, delivery_stream_encryption_configuration_input: nil, delivery_stream_name: nil, delivery_stream_type: nil, direct_put_source_configuration: nil, elasticsearch_destination_configuration: nil, extended_s3_destination_configuration: nil, http_endpoint_destination_configuration: nil, iceberg_destination_configuration: nil, kinesis_stream_source_configuration: nil, msk_source_configuration: nil, redshift_destination_configuration: nil, s3_destination_configuration: nil, snowflake_destination_configuration: nil, splunk_destination_configuration: nil, tags: nil)
  @amazon_open_search_serverless_destination_configuration = amazon_open_search_serverless_destination_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::AmazonOpenSearchServerlessDestinationConfigurationProperty.new(**amazon_open_search_serverless_destination_configuration.transform_keys(&:to_sym)) : amazon_open_search_serverless_destination_configuration
  Jsii::Type.check_type(@amazon_open_search_serverless_destination_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uQW1hem9uT3BlblNlYXJjaFNlcnZlcmxlc3NEZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "amazonOpenSearchServerlessDestinationConfiguration") unless @amazon_open_search_serverless_destination_configuration.nil?
  @amazonopensearchservice_destination_configuration = amazonopensearchservice_destination_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::AmazonopensearchserviceDestinationConfigurationProperty.new(**amazonopensearchservice_destination_configuration.transform_keys(&:to_sym)) : amazonopensearchservice_destination_configuration
  Jsii::Type.check_type(@amazonopensearchservice_destination_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uQW1hem9ub3BlbnNlYXJjaHNlcnZpY2VEZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "amazonopensearchserviceDestinationConfiguration") unless @amazonopensearchservice_destination_configuration.nil?
  @database_source_configuration = database_source_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::DatabaseSourceConfigurationProperty.new(**database_source_configuration.transform_keys(&:to_sym)) : database_source_configuration
  Jsii::Type.check_type(@database_source_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uRGF0YWJhc2VTb3VyY2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "databaseSourceConfiguration") unless @database_source_configuration.nil?
  @delivery_stream_encryption_configuration_input = delivery_stream_encryption_configuration_input.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::DeliveryStreamEncryptionConfigurationInputProperty.new(**delivery_stream_encryption_configuration_input.transform_keys(&:to_sym)) : delivery_stream_encryption_configuration_input
  Jsii::Type.check_type(@delivery_stream_encryption_configuration_input, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uRGVsaXZlcnlTdHJlYW1FbmNyeXB0aW9uQ29uZmlndXJhdGlvbklucHV0UHJvcGVydHkifV19fQ==")), "deliveryStreamEncryptionConfigurationInput") unless @delivery_stream_encryption_configuration_input.nil?
  @delivery_stream_name = delivery_stream_name
  Jsii::Type.check_type(@delivery_stream_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19raW5lc2lzLklTdHJlYW1SZWYifV19fQ==")), "deliveryStreamName") unless @delivery_stream_name.nil?
  @delivery_stream_type = delivery_stream_type
  Jsii::Type.check_type(@delivery_stream_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deliveryStreamType") unless @delivery_stream_type.nil?
  @direct_put_source_configuration = direct_put_source_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::DirectPutSourceConfigurationProperty.new(**direct_put_source_configuration.transform_keys(&:to_sym)) : direct_put_source_configuration
  Jsii::Type.check_type(@direct_put_source_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uRGlyZWN0UHV0U291cmNlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "directPutSourceConfiguration") unless @direct_put_source_configuration.nil?
  @elasticsearch_destination_configuration = elasticsearch_destination_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::ElasticsearchDestinationConfigurationProperty.new(**elasticsearch_destination_configuration.transform_keys(&:to_sym)) : elasticsearch_destination_configuration
  Jsii::Type.check_type(@elasticsearch_destination_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uRWxhc3RpY3NlYXJjaERlc3RpbmF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "elasticsearchDestinationConfiguration") unless @elasticsearch_destination_configuration.nil?
  @extended_s3_destination_configuration = extended_s3_destination_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::ExtendedS3DestinationConfigurationProperty.new(**extended_s3_destination_configuration.transform_keys(&:to_sym)) : extended_s3_destination_configuration
  Jsii::Type.check_type(@extended_s3_destination_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uRXh0ZW5kZWRTM0Rlc3RpbmF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "extendedS3DestinationConfiguration") unless @extended_s3_destination_configuration.nil?
  @http_endpoint_destination_configuration = http_endpoint_destination_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::HttpEndpointDestinationConfigurationProperty.new(**http_endpoint_destination_configuration.transform_keys(&:to_sym)) : http_endpoint_destination_configuration
  Jsii::Type.check_type(@http_endpoint_destination_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uSHR0cEVuZHBvaW50RGVzdGluYXRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "httpEndpointDestinationConfiguration") unless @http_endpoint_destination_configuration.nil?
  @iceberg_destination_configuration = iceberg_destination_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::IcebergDestinationConfigurationProperty.new(**iceberg_destination_configuration.transform_keys(&:to_sym)) : iceberg_destination_configuration
  Jsii::Type.check_type(@iceberg_destination_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uSWNlYmVyZ0Rlc3RpbmF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "icebergDestinationConfiguration") unless @iceberg_destination_configuration.nil?
  @kinesis_stream_source_configuration = kinesis_stream_source_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::KinesisStreamSourceConfigurationProperty.new(**kinesis_stream_source_configuration.transform_keys(&:to_sym)) : kinesis_stream_source_configuration
  Jsii::Type.check_type(@kinesis_stream_source_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uS2luZXNpc1N0cmVhbVNvdXJjZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "kinesisStreamSourceConfiguration") unless @kinesis_stream_source_configuration.nil?
  @msk_source_configuration = msk_source_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::MSKSourceConfigurationProperty.new(**msk_source_configuration.transform_keys(&:to_sym)) : msk_source_configuration
  Jsii::Type.check_type(@msk_source_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uTVNLU291cmNlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "mskSourceConfiguration") unless @msk_source_configuration.nil?
  @redshift_destination_configuration = redshift_destination_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::RedshiftDestinationConfigurationProperty.new(**redshift_destination_configuration.transform_keys(&:to_sym)) : redshift_destination_configuration
  Jsii::Type.check_type(@redshift_destination_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uUmVkc2hpZnREZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "redshiftDestinationConfiguration") unless @redshift_destination_configuration.nil?
  @s3_destination_configuration = s3_destination_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::S3DestinationConfigurationProperty.new(**s3_destination_configuration.transform_keys(&:to_sym)) : s3_destination_configuration
  Jsii::Type.check_type(@s3_destination_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uUzNEZXN0aW5hdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "s3DestinationConfiguration") unless @s3_destination_configuration.nil?
  @snowflake_destination_configuration = snowflake_destination_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::SnowflakeDestinationConfigurationProperty.new(**snowflake_destination_configuration.transform_keys(&:to_sym)) : snowflake_destination_configuration
  Jsii::Type.check_type(@snowflake_destination_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uU25vd2ZsYWtlRGVzdGluYXRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "snowflakeDestinationConfiguration") unless @snowflake_destination_configuration.nil?
  @splunk_destination_configuration = splunk_destination_configuration.is_a?(Hash) ? ::AWSCDK::KinesisFirehose::CfnDeliveryStream::SplunkDestinationConfigurationProperty.new(**splunk_destination_configuration.transform_keys(&:to_sym)) : splunk_destination_configuration
  Jsii::Type.check_type(@splunk_destination_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19raW5lc2lzZmlyZWhvc2UuQ2ZuRGVsaXZlcnlTdHJlYW0uU3BsdW5rRGVzdGluYXRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "splunkDestinationConfiguration") unless @splunk_destination_configuration.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#amazon_open_search_serverless_destination_configurationAWSCDK::IResolvable, ... (readonly)

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.



70
71
72
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 70

def amazon_open_search_serverless_destination_configuration
  @amazon_open_search_serverless_destination_configuration
end

#amazonopensearchservice_destination_configurationAWSCDK::IResolvable, ... (readonly)

The destination in Amazon OpenSearch Service.

You can specify only one destination.



77
78
79
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 77

def amazonopensearchservice_destination_configuration
  @amazonopensearchservice_destination_configuration
end

#database_source_configurationAWSCDK::IResolvable, ... (readonly)

The top level object for configuring streams with database as a source.

Amazon Data Firehose is in preview release and is subject to change.



84
85
86
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 84

def database_source_configuration
  @database_source_configuration
end

#delivery_stream_encryption_configuration_inputAWSCDK::IResolvable, ... (readonly)

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).



89
90
91
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 89

def delivery_stream_encryption_configuration_input
  @delivery_stream_encryption_configuration_input
end

#delivery_stream_nameString, ... (readonly)

The name of the Firehose stream.



94
95
96
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 94

def delivery_stream_name
  @delivery_stream_name
end

#delivery_stream_typeString? (readonly)

The Firehose stream type. This can be one of the following values:.

  • DirectPut : Provider applications access the Firehose stream directly.
  • KinesisStreamAsSource : The Firehose stream uses a Kinesis data stream as a source.


102
103
104
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 102

def delivery_stream_type
  @delivery_stream_type
end

#direct_put_source_configurationAWSCDK::IResolvable, ... (readonly)

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.



107
108
109
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 107

def direct_put_source_configuration
  @direct_put_source_configuration
end

#elasticsearch_destination_configurationAWSCDK::IResolvable, ... (readonly)

An Amazon ES destination for the delivery stream.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon ES destination to an Amazon S3 or Amazon Redshift destination, update requires some interruptions .



116
117
118
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 116

def elasticsearch_destination_configuration
  @elasticsearch_destination_configuration
end

#extended_s3_destination_configurationAWSCDK::IResolvable, ... (readonly)

An Amazon S3 destination for the delivery stream.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon Extended S3 destination to an Amazon ES destination, update requires some interruptions .



125
126
127
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 125

def extended_s3_destination_configuration
  @extended_s3_destination_configuration
end

#http_endpoint_destination_configurationAWSCDK::IResolvable, ... (readonly)

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

You can specify only one destination.



132
133
134
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 132

def http_endpoint_destination_configuration
  @http_endpoint_destination_configuration
end

#iceberg_destination_configurationAWSCDK::IResolvable, ... (readonly)

Specifies the destination configure settings for Apache Iceberg Table.



137
138
139
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 137

def iceberg_destination_configuration
  @iceberg_destination_configuration
end

#kinesis_stream_source_configurationAWSCDK::IResolvable, ... (readonly)

When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.



142
143
144
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 142

def kinesis_stream_source_configuration
  @kinesis_stream_source_configuration
end

#msk_source_configurationAWSCDK::IResolvable, ... (readonly)

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.



147
148
149
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 147

def msk_source_configuration
  @msk_source_configuration
end

#redshift_destination_configurationAWSCDK::IResolvable, ... (readonly)

An Amazon Redshift destination for the delivery stream.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon Redshift destination to an Amazon ES destination, update requires some interruptions .



156
157
158
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 156

def redshift_destination_configuration
  @redshift_destination_configuration
end

#s3_destination_configurationAWSCDK::IResolvable, ... (readonly)

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon S3 destination to an Amazon ES destination, update requires some interruptions .



165
166
167
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 165

def s3_destination_configuration
  @s3_destination_configuration
end

#snowflake_destination_configurationAWSCDK::IResolvable, ... (readonly)

Configure Snowflake destination.



170
171
172
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 170

def snowflake_destination_configuration
  @snowflake_destination_configuration
end

#splunk_destination_configurationAWSCDK::IResolvable, ... (readonly)

The configuration of a destination in Splunk for the delivery stream.



175
176
177
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 175

def splunk_destination_configuration
  @splunk_destination_configuration
end

#tagsArray<AWSCDK::CfnTag>? (readonly)

A set of tags to assign to the Firehose stream.

A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

You can specify up to 50 tags when creating a Firehose stream.

If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose performs an additional authorization on the firehose:TagDeliveryStream action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an AccessDeniedException such as following.

AccessDeniedException

User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.

For an example IAM policy, see Tag example.



192
193
194
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 192

def tags
  @tags
end

Class Method Details

.jsii_propertiesObject



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 194

def self.jsii_properties
  {
    :amazon_open_search_serverless_destination_configuration => "amazonOpenSearchServerlessDestinationConfiguration",
    :amazonopensearchservice_destination_configuration => "amazonopensearchserviceDestinationConfiguration",
    :database_source_configuration => "databaseSourceConfiguration",
    :delivery_stream_encryption_configuration_input => "deliveryStreamEncryptionConfigurationInput",
    :delivery_stream_name => "deliveryStreamName",
    :delivery_stream_type => "deliveryStreamType",
    :direct_put_source_configuration => "directPutSourceConfiguration",
    :elasticsearch_destination_configuration => "elasticsearchDestinationConfiguration",
    :extended_s3_destination_configuration => "extendedS3DestinationConfiguration",
    :http_endpoint_destination_configuration => "httpEndpointDestinationConfiguration",
    :iceberg_destination_configuration => "icebergDestinationConfiguration",
    :kinesis_stream_source_configuration => "kinesisStreamSourceConfiguration",
    :msk_source_configuration => "mskSourceConfiguration",
    :redshift_destination_configuration => "redshiftDestinationConfiguration",
    :s3_destination_configuration => "s3DestinationConfiguration",
    :snowflake_destination_configuration => "snowflakeDestinationConfiguration",
    :splunk_destination_configuration => "splunkDestinationConfiguration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsiiObject



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'kinesis_firehose/cfn_delivery_stream_props.rb', line 217

def to_jsii
  result = {}
  result.merge!({
    "amazonOpenSearchServerlessDestinationConfiguration" => @amazon_open_search_serverless_destination_configuration,
    "amazonopensearchserviceDestinationConfiguration" => @amazonopensearchservice_destination_configuration,
    "databaseSourceConfiguration" => @database_source_configuration,
    "deliveryStreamEncryptionConfigurationInput" => @delivery_stream_encryption_configuration_input,
    "deliveryStreamName" => @delivery_stream_name,
    "deliveryStreamType" => @delivery_stream_type,
    "directPutSourceConfiguration" => @direct_put_source_configuration,
    "elasticsearchDestinationConfiguration" => @elasticsearch_destination_configuration,
    "extendedS3DestinationConfiguration" => @extended_s3_destination_configuration,
    "httpEndpointDestinationConfiguration" => @http_endpoint_destination_configuration,
    "icebergDestinationConfiguration" => @iceberg_destination_configuration,
    "kinesisStreamSourceConfiguration" => @kinesis_stream_source_configuration,
    "mskSourceConfiguration" => @msk_source_configuration,
    "redshiftDestinationConfiguration" => @redshift_destination_configuration,
    "s3DestinationConfiguration" => @s3_destination_configuration,
    "snowflakeDestinationConfiguration" => @snowflake_destination_configuration,
    "splunkDestinationConfiguration" => @splunk_destination_configuration,
    "tags" => @tags,
  })
  result.compact
end