Class: Aws::Firehose::Types::CreateDeliveryStreamInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-firehose/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#amazon_open_search_serverless_destination_configuration ⇒ Types::AmazonOpenSearchServerlessDestinationConfiguration

The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#amazonopensearchservice_destination_configuration ⇒ Types::AmazonopensearchserviceDestinationConfiguration

The destination in Amazon OpenSearch Service. You can specify only one destination.

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#database_source_configuration ⇒ Types::DatabaseSourceConfiguration

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

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_stream_encryption_configuration_input ⇒ Types::DeliveryStreamEncryptionConfigurationInput

Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_stream_name ⇒ String

The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name.

Returns:

  • (String) 


871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_stream_type ⇒ String

The Firehose stream type. This parameter 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.

Returns:

  • (String) 


871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#elasticsearch_destination_configuration ⇒ Types::ElasticsearchDestinationConfiguration

The destination in Amazon ES. You can specify only one destination.

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#extended_s3_destination_configuration ⇒ Types::ExtendedS3DestinationConfiguration

The destination in Amazon S3. You can specify only one destination.

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#http_endpoint_destination_configuration ⇒ Types::HttpEndpointDestinationConfiguration

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#iceberg_destination_configuration ⇒ Types::IcebergDestinationConfiguration

Configure Apache Iceberg Tables destination.

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis_stream_source_configuration ⇒ Types::KinesisStreamSourceConfiguration

When a Kinesis data stream is used as the source for the Firehose stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#msk_source_configuration ⇒ Types::MSKSourceConfiguration

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

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#redshift_destination_configuration ⇒ Types::RedshiftDestinationConfiguration

The destination in Amazon Redshift. You can specify only one destination.

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#s3_destination_configuration ⇒ Types::S3DestinationConfiguration

[Deprecated] The destination in Amazon S3. You can specify only one destination.

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#snowflake_destination_configuration ⇒ Types::SnowflakeDestinationConfiguration

Configure Snowflake destination

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#splunk_destination_configuration ⇒ Types::SplunkDestinationConfiguration

The destination in Splunk. You can specify only one destination.

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services 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 Amazon Web Services 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 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.]

[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html [2]: docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples

Returns:



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/aws-sdk-firehose/types.rb', line 871

class CreateDeliveryStreamInput < Struct.new(
  :delivery_stream_name,
  :delivery_stream_type,
  :kinesis_stream_source_configuration,
  :delivery_stream_encryption_configuration_input,
  :s3_destination_configuration,
  :extended_s3_destination_configuration,
  :redshift_destination_configuration,
  :elasticsearch_destination_configuration,
  :amazonopensearchservice_destination_configuration,
  :splunk_destination_configuration,
  :http_endpoint_destination_configuration,
  :tags,
  :amazon_open_search_serverless_destination_configuration,
  :msk_source_configuration,
  :snowflake_destination_configuration,
  :iceberg_destination_configuration,
  :database_source_configuration)
  SENSITIVE = []
  include Aws::Structure
end