Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Firehose.CreateDeliveryStream

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Kinesis Data Firehose delivery stream.

By default, you can create up to 50 delivery streams per Amazon Web Services Region.

This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. If the delivery stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.

If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.

To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled.

A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.

When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.

A few notes about Amazon Redshift as a destination:

An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.

Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.

Synopsis

Creating a Request

data CreateDeliveryStream Source #

See: newCreateDeliveryStream smart constructor.

Constructors

CreateDeliveryStream'

Fields

amazonOpenSearchServerlessDestinationConfiguration :: Maybe AmazonOpenSearchServerlessDestinationConfiguration
The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.
amazonopensearchserviceDestinationConfiguration :: Maybe AmazonopensearchserviceDestinationConfiguration
The destination in Amazon OpenSearch Service. You can specify only one destination.
deliveryStreamEncryptionConfigurationInput :: Maybe DeliveryStreamEncryptionConfigurationInput
Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
deliveryStreamType :: Maybe DeliveryStreamType
The delivery stream type. This parameter can be one of the following values:
- DirectPut: Provider applications access the delivery stream directly.
- KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.
elasticsearchDestinationConfiguration :: Maybe ElasticsearchDestinationConfiguration
The destination in Amazon ES. You can specify only one destination.
extendedS3DestinationConfiguration :: Maybe ExtendedS3DestinationConfiguration
The destination in Amazon S3. You can specify only one destination.
httpEndpointDestinationConfiguration :: Maybe HttpEndpointDestinationConfiguration
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
kinesisStreamSourceConfiguration :: Maybe KinesisStreamSourceConfiguration
When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
redshiftDestinationConfiguration :: Maybe RedshiftDestinationConfiguration
The destination in Amazon Redshift. You can specify only one destination.
s3DestinationConfiguration :: Maybe S3DestinationConfiguration
Deprecated
The destination in Amazon S3. You can specify only one destination.
splunkDestinationConfiguration :: Maybe SplunkDestinationConfiguration
The destination in Splunk. You can specify only one destination.
tags :: Maybe (NonEmpty Tag)
A set of tags to assign to the delivery 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 delivery 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 delivery stream.
deliveryStreamName :: Text
The name of the delivery stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.

Instances

Instances details

ToJSON CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods toJSON :: CreateDeliveryStream -> Value # toEncoding :: CreateDeliveryStream -> Encoding # toJSONList :: [CreateDeliveryStream] -> Value # toEncodingList :: [CreateDeliveryStream] -> Encoding #
ToHeaders CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods toHeaders :: CreateDeliveryStream -> [Header] #
ToPath CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods toPath :: CreateDeliveryStream -> ByteString #
ToQuery CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods toQuery :: CreateDeliveryStream -> QueryString #
AWSRequest CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Associated Types type AWSResponse CreateDeliveryStream # Methods request :: (Service -> Service) -> CreateDeliveryStream -> Request CreateDeliveryStream # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDeliveryStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDeliveryStream))) #
Generic CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Associated Types type Rep CreateDeliveryStream :: Type -> Type # Methods from :: CreateDeliveryStream -> Rep CreateDeliveryStream x # to :: Rep CreateDeliveryStream x -> CreateDeliveryStream #
Show CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods showsPrec :: Int -> CreateDeliveryStream -> ShowS # show :: CreateDeliveryStream -> String # showList :: [CreateDeliveryStream] -> ShowS #
NFData CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods rnf :: CreateDeliveryStream -> () #
Eq CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods (==) :: CreateDeliveryStream -> CreateDeliveryStream -> Bool # (/=) :: CreateDeliveryStream -> CreateDeliveryStream -> Bool #
Hashable CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods hashWithSalt :: Int -> CreateDeliveryStream -> Int # hash :: CreateDeliveryStream -> Int #
type AWSResponse CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream type AWSResponse CreateDeliveryStream = CreateDeliveryStreamResponse
type Rep CreateDeliveryStream Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream type Rep CreateDeliveryStream = D1 ('MetaData "CreateDeliveryStream" "Amazonka.Firehose.CreateDeliveryStream" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "CreateDeliveryStream'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "amazonOpenSearchServerlessDestinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessDestinationConfiguration)) :: (S1 ('MetaSel ('Just "amazonopensearchserviceDestinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceDestinationConfiguration)) :: S1 ('MetaSel ('Just "deliveryStreamEncryptionConfigurationInput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliveryStreamEncryptionConfigurationInput)))) :: (S1 ('MetaSel ('Just "deliveryStreamType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliveryStreamType)) :: (S1 ('MetaSel ('Just "elasticsearchDestinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchDestinationConfiguration)) :: S1 ('MetaSel ('Just "extendedS3DestinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExtendedS3DestinationConfiguration))))) :: ((S1 ('MetaSel ('Just "httpEndpointDestinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointDestinationConfiguration)) :: (S1 ('MetaSel ('Just "kinesisStreamSourceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisStreamSourceConfiguration)) :: S1 ('MetaSel ('Just "redshiftDestinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftDestinationConfiguration)))) :: ((S1 ('MetaSel ('Just "s3DestinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationConfiguration)) :: S1 ('MetaSel ('Just "splunkDestinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SplunkDestinationConfiguration))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: S1 ('MetaSel ('Just "deliveryStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateDeliveryStream Source #

Arguments

:: Text	`CreateDeliveryStream`
-> CreateDeliveryStream

Create a value of CreateDeliveryStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:amazonOpenSearchServerlessDestinationConfiguration:CreateDeliveryStream', createDeliveryStream_amazonOpenSearchServerlessDestinationConfiguration - The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.

$sel:amazonopensearchserviceDestinationConfiguration:CreateDeliveryStream', createDeliveryStream_amazonopensearchserviceDestinationConfiguration - The destination in Amazon OpenSearch Service. You can specify only one destination.

$sel:deliveryStreamEncryptionConfigurationInput:CreateDeliveryStream', createDeliveryStream_deliveryStreamEncryptionConfigurationInput - Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

CreateDeliveryStream, createDeliveryStream_deliveryStreamType - The delivery stream type. This parameter can be one of the following values:

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

$sel:elasticsearchDestinationConfiguration:CreateDeliveryStream', createDeliveryStream_elasticsearchDestinationConfiguration - The destination in Amazon ES. You can specify only one destination.

$sel:extendedS3DestinationConfiguration:CreateDeliveryStream', createDeliveryStream_extendedS3DestinationConfiguration - The destination in Amazon S3. You can specify only one destination.

$sel:httpEndpointDestinationConfiguration:CreateDeliveryStream', createDeliveryStream_httpEndpointDestinationConfiguration - Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

$sel:kinesisStreamSourceConfiguration:CreateDeliveryStream', createDeliveryStream_kinesisStreamSourceConfiguration - When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.

$sel:redshiftDestinationConfiguration:CreateDeliveryStream', createDeliveryStream_redshiftDestinationConfiguration - The destination in Amazon Redshift. You can specify only one destination.

$sel:s3DestinationConfiguration:CreateDeliveryStream', createDeliveryStream_s3DestinationConfiguration - [Deprecated] The destination in Amazon S3. You can specify only one destination.

$sel:splunkDestinationConfiguration:CreateDeliveryStream', createDeliveryStream_splunkDestinationConfiguration - The destination in Splunk. You can specify only one destination.

$sel:tags:CreateDeliveryStream', createDeliveryStream_tags - A set of tags to assign to the delivery 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 delivery 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 delivery stream.

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

Request Lenses

createDeliveryStream_amazonOpenSearchServerlessDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe AmazonOpenSearchServerlessDestinationConfiguration) Source #

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

createDeliveryStream_amazonopensearchserviceDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe AmazonopensearchserviceDestinationConfiguration) Source #

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

createDeliveryStream_deliveryStreamEncryptionConfigurationInput :: Lens' CreateDeliveryStream (Maybe DeliveryStreamEncryptionConfigurationInput) Source #

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

createDeliveryStream_deliveryStreamType :: Lens' CreateDeliveryStream (Maybe DeliveryStreamType) Source #

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

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

createDeliveryStream_elasticsearchDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe ElasticsearchDestinationConfiguration) Source #

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

createDeliveryStream_extendedS3DestinationConfiguration :: Lens' CreateDeliveryStream (Maybe ExtendedS3DestinationConfiguration) Source #

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

createDeliveryStream_httpEndpointDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe HttpEndpointDestinationConfiguration) Source #

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

createDeliveryStream_kinesisStreamSourceConfiguration :: Lens' CreateDeliveryStream (Maybe KinesisStreamSourceConfiguration) Source #

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

createDeliveryStream_redshiftDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe RedshiftDestinationConfiguration) Source #

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

createDeliveryStream_s3DestinationConfiguration :: Lens' CreateDeliveryStream (Maybe S3DestinationConfiguration) Source #

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

createDeliveryStream_splunkDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe SplunkDestinationConfiguration) Source #

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

createDeliveryStream_tags :: Lens' CreateDeliveryStream (Maybe (NonEmpty Tag)) Source #

A set of tags to assign to the delivery 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 delivery 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 delivery stream.

createDeliveryStream_deliveryStreamName :: Lens' CreateDeliveryStream Text Source #

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

Destructuring the Response

data CreateDeliveryStreamResponse Source #

See: newCreateDeliveryStreamResponse smart constructor.

Constructors

CreateDeliveryStreamResponse'
Fields deliveryStreamARN :: Maybe Text The ARN of the delivery stream. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDeliveryStreamResponse Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Associated Types type Rep CreateDeliveryStreamResponse :: Type -> Type # Methods from :: CreateDeliveryStreamResponse -> Rep CreateDeliveryStreamResponse x # to :: Rep CreateDeliveryStreamResponse x -> CreateDeliveryStreamResponse #
Read CreateDeliveryStreamResponse Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods readsPrec :: Int -> ReadS CreateDeliveryStreamResponse # readList :: ReadS [CreateDeliveryStreamResponse] # readPrec :: ReadPrec CreateDeliveryStreamResponse # readListPrec :: ReadPrec [CreateDeliveryStreamResponse] #
Show CreateDeliveryStreamResponse Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods showsPrec :: Int -> CreateDeliveryStreamResponse -> ShowS # show :: CreateDeliveryStreamResponse -> String # showList :: [CreateDeliveryStreamResponse] -> ShowS #
NFData CreateDeliveryStreamResponse Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods rnf :: CreateDeliveryStreamResponse -> () #
Eq CreateDeliveryStreamResponse Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream Methods (==) :: CreateDeliveryStreamResponse -> CreateDeliveryStreamResponse -> Bool # (/=) :: CreateDeliveryStreamResponse -> CreateDeliveryStreamResponse -> Bool #
type Rep CreateDeliveryStreamResponse Source #
Instance details Defined in Amazonka.Firehose.CreateDeliveryStream type Rep CreateDeliveryStreamResponse = D1 ('MetaData "CreateDeliveryStreamResponse" "Amazonka.Firehose.CreateDeliveryStream" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "CreateDeliveryStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deliveryStreamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDeliveryStreamResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDeliveryStreamResponse'`
-> CreateDeliveryStreamResponse

Create a value of CreateDeliveryStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDeliveryStreamResponse, createDeliveryStreamResponse_deliveryStreamARN - The ARN of the delivery stream.

$sel:httpStatus:CreateDeliveryStreamResponse', createDeliveryStreamResponse_httpStatus - The response's http status code.

Response Lenses

createDeliveryStreamResponse_deliveryStreamARN :: Lens' CreateDeliveryStreamResponse (Maybe Text) Source #

The ARN of the delivery stream.

createDeliveryStreamResponse_httpStatus :: Lens' CreateDeliveryStreamResponse Int Source #

The response's http status code.