Network.AWS.Firehose.CreateDeliveryStream

Creates a Kinesis Data Firehose delivery stream.

By default, you can create up to 50 delivery streams per AWS 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. 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 .

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.

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 .

Creating a Request

createDeliveryStream

Arguments

:: Text

cdsDeliveryStreamName

-> CreateDeliveryStream

Creates a value of CreateDeliveryStream with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cdsS3DestinationConfiguration - [Deprecated] The destination in Amazon S3. You can specify only one destination.
• cdsRedshiftDestinationConfiguration - The destination in Amazon Redshift. You can specify only one destination.
• cdsElasticsearchDestinationConfiguration - The destination in Amazon ES. You can specify only one destination.
• cdsExtendedS3DestinationConfiguration - The destination in Amazon S3. You can specify only one destination.
• cdsKinesisStreamSourceConfiguration - 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.
• cdsDeliveryStreamType - 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.
• cdsSplunkDestinationConfiguration - The destination in Splunk. You can specify only one destination.
• cdsDeliveryStreamName - The name of the delivery stream. This name must be unique per AWS account in the same AWS Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.

data CreateDeliveryStream

See: createDeliveryStream smart constructor.

Instances

Eq CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

(==) :: CreateDeliveryStream -> CreateDeliveryStream -> Bool

(/=) :: CreateDeliveryStream -> CreateDeliveryStream -> Bool

Data CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDeliveryStream -> c CreateDeliveryStream

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDeliveryStream

toConstr :: CreateDeliveryStream -> Constr

dataTypeOf :: CreateDeliveryStream -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateDeliveryStream)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDeliveryStream)

gmapT :: (forall b. Data b => b -> b) -> CreateDeliveryStream -> CreateDeliveryStream

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDeliveryStream -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDeliveryStream -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateDeliveryStream -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDeliveryStream -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDeliveryStream -> m CreateDeliveryStream

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDeliveryStream -> m CreateDeliveryStream

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDeliveryStream -> m CreateDeliveryStream

Show CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

showsPrec :: Int -> CreateDeliveryStream -> ShowS

show :: CreateDeliveryStream -> String

showList :: [CreateDeliveryStream] -> ShowS

Generic CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

Associated Types

type Rep CreateDeliveryStream :: Type -> Type

Methods

from :: CreateDeliveryStream -> Rep CreateDeliveryStream x

to :: Rep CreateDeliveryStream x -> CreateDeliveryStream

Hashable CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

hashWithSalt :: Int -> CreateDeliveryStream -> Int

hash :: CreateDeliveryStream -> Int

ToJSON CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

toJSON :: CreateDeliveryStream -> Value

toEncoding :: CreateDeliveryStream -> Encoding

toJSONList :: [CreateDeliveryStream] -> Value

toEncodingList :: [CreateDeliveryStream] -> Encoding

AWSRequest CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

Associated Types

type Rs CreateDeliveryStream :: Type

Methods

request :: CreateDeliveryStream -> Request CreateDeliveryStream

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateDeliveryStream -> ClientResponse -> m (Response CreateDeliveryStream)

ToHeaders CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

toHeaders :: CreateDeliveryStream -> [Header]

ToPath CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

toPath :: CreateDeliveryStream -> ByteString

ToQuery CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

toQuery :: CreateDeliveryStream -> QueryString

NFData CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

rnf :: CreateDeliveryStream -> ()

type Rep CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

type Rep CreateDeliveryStream = D1 (MetaData "CreateDeliveryStream" "Network.AWS.Firehose.CreateDeliveryStream" "amazonka-kinesis-firehose-1.6.1-IIrhAXaawLd9hcHz2LzLHx" False) (C1 (MetaCons "CreateDeliveryStream'" PrefixI True) (((S1 (MetaSel (Just "_cdsS3DestinationConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe S3DestinationConfiguration)) :*: S1 (MetaSel (Just "_cdsRedshiftDestinationConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RedshiftDestinationConfiguration))) :*: (S1 (MetaSel (Just "_cdsElasticsearchDestinationConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ElasticsearchDestinationConfiguration)) :*: S1 (MetaSel (Just "_cdsExtendedS3DestinationConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ExtendedS3DestinationConfiguration)))) :*: ((S1 (MetaSel (Just "_cdsKinesisStreamSourceConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe KinesisStreamSourceConfiguration)) :*: S1 (MetaSel (Just "_cdsDeliveryStreamType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DeliveryStreamType))) :*: (S1 (MetaSel (Just "_cdsSplunkDestinationConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SplunkDestinationConfiguration)) :*: S1 (MetaSel (Just "_cdsDeliveryStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs CreateDeliveryStream

Defined in Network.AWS.Firehose.CreateDeliveryStream

type Rs CreateDeliveryStream = CreateDeliveryStreamResponse

Request Lenses

cdsS3DestinationConfiguration :: Lens' CreateDeliveryStream (Maybe S3DestinationConfiguration)

Deprecated

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

cdsRedshiftDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe RedshiftDestinationConfiguration)

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

cdsElasticsearchDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe ElasticsearchDestinationConfiguration)

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

cdsExtendedS3DestinationConfiguration :: Lens' CreateDeliveryStream (Maybe ExtendedS3DestinationConfiguration)

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

cdsKinesisStreamSourceConfiguration :: Lens' CreateDeliveryStream (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.

cdsDeliveryStreamType :: Lens' CreateDeliveryStream (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.

cdsSplunkDestinationConfiguration :: Lens' CreateDeliveryStream (Maybe SplunkDestinationConfiguration)

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

cdsDeliveryStreamName :: Lens' CreateDeliveryStream Text

The name of the delivery stream. This name must be unique per AWS account in the same AWS 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

createDeliveryStreamResponse

Arguments

:: Int

cdsrsResponseStatus

-> CreateDeliveryStreamResponse

Creates a value of CreateDeliveryStreamResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cdsrsDeliveryStreamARN - The ARN of the delivery stream.
• cdsrsResponseStatus - -- | The response status code.

data CreateDeliveryStreamResponse

See: createDeliveryStreamResponse smart constructor.

Instances

Eq CreateDeliveryStreamResponse

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

(==) :: CreateDeliveryStreamResponse -> CreateDeliveryStreamResponse -> Bool

(/=) :: CreateDeliveryStreamResponse -> CreateDeliveryStreamResponse -> Bool

Data CreateDeliveryStreamResponse

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDeliveryStreamResponse -> c CreateDeliveryStreamResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDeliveryStreamResponse

toConstr :: CreateDeliveryStreamResponse -> Constr

dataTypeOf :: CreateDeliveryStreamResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateDeliveryStreamResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDeliveryStreamResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateDeliveryStreamResponse -> CreateDeliveryStreamResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDeliveryStreamResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDeliveryStreamResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateDeliveryStreamResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDeliveryStreamResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDeliveryStreamResponse -> m CreateDeliveryStreamResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDeliveryStreamResponse -> m CreateDeliveryStreamResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDeliveryStreamResponse -> m CreateDeliveryStreamResponse

Read CreateDeliveryStreamResponse

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

readsPrec :: Int -> ReadS CreateDeliveryStreamResponse

readList :: ReadS [CreateDeliveryStreamResponse]

readPrec :: ReadPrec CreateDeliveryStreamResponse

readListPrec :: ReadPrec [CreateDeliveryStreamResponse]

Show CreateDeliveryStreamResponse

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

showsPrec :: Int -> CreateDeliveryStreamResponse -> ShowS

show :: CreateDeliveryStreamResponse -> String

showList :: [CreateDeliveryStreamResponse] -> ShowS

Generic CreateDeliveryStreamResponse

Defined in Network.AWS.Firehose.CreateDeliveryStream

Associated Types

type Rep CreateDeliveryStreamResponse :: Type -> Type

Methods

from :: CreateDeliveryStreamResponse -> Rep CreateDeliveryStreamResponse x

to :: Rep CreateDeliveryStreamResponse x -> CreateDeliveryStreamResponse

NFData CreateDeliveryStreamResponse

Defined in Network.AWS.Firehose.CreateDeliveryStream

Methods

rnf :: CreateDeliveryStreamResponse -> ()

type Rep CreateDeliveryStreamResponse

Defined in Network.AWS.Firehose.CreateDeliveryStream

type Rep CreateDeliveryStreamResponse = D1 (MetaData "CreateDeliveryStreamResponse" "Network.AWS.Firehose.CreateDeliveryStream" "amazonka-kinesis-firehose-1.6.1-IIrhAXaawLd9hcHz2LzLHx" False) (C1 (MetaCons "CreateDeliveryStreamResponse'" PrefixI True) (S1 (MetaSel (Just "_cdsrsDeliveryStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cdsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

cdsrsDeliveryStreamARN :: Lens' CreateDeliveryStreamResponse (Maybe Text)

The ARN of the delivery stream.

cdsrsResponseStatus :: Lens' CreateDeliveryStreamResponse Int

• - | The response status code.