Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Firehose.Types.DeliveryStreamDescription

Description

Synopsis

Documentation

data DeliveryStreamDescription Source #

Contains information about a delivery stream.

See: newDeliveryStreamDescription smart constructor.

Constructors

DeliveryStreamDescription'

Fields

failureDescription :: Maybe FailureDescription
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
deliveryStreamEncryptionConfiguration :: Maybe DeliveryStreamEncryptionConfiguration
Indicates the server-side encryption (SSE) status for the delivery stream.
createTimestamp :: Maybe POSIX
The date and time that the delivery stream was created.
source :: Maybe SourceDescription
If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.
lastUpdateTimestamp :: Maybe POSIX
The date and time that the delivery stream was last updated.
deliveryStreamName :: Text
The name of the delivery stream.
deliveryStreamARN :: Text
The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
deliveryStreamStatus :: DeliveryStreamStatus
The status of the delivery stream. 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.
deliveryStreamType :: DeliveryStreamType
The delivery stream type. This 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.
versionId :: Text
Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.
destinations :: [DestinationDescription]
The destinations.
hasMoreDestinations :: Bool
Indicates whether there are more destinations available to list.

Instances

Instances details

Eq DeliveryStreamDescription Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamDescription Methods (==) :: DeliveryStreamDescription -> DeliveryStreamDescription -> Bool # (/=) :: DeliveryStreamDescription -> DeliveryStreamDescription -> Bool #
Show DeliveryStreamDescription Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamDescription Methods showsPrec :: Int -> DeliveryStreamDescription -> ShowS # show :: DeliveryStreamDescription -> String # showList :: [DeliveryStreamDescription] -> ShowS #
Generic DeliveryStreamDescription Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamDescription Associated Types type Rep DeliveryStreamDescription :: Type -> Type # Methods from :: DeliveryStreamDescription -> Rep DeliveryStreamDescription x # to :: Rep DeliveryStreamDescription x -> DeliveryStreamDescription #
NFData DeliveryStreamDescription Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamDescription Methods rnf :: DeliveryStreamDescription -> () #
Hashable DeliveryStreamDescription Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamDescription Methods hashWithSalt :: Int -> DeliveryStreamDescription -> Int # hash :: DeliveryStreamDescription -> Int #
FromJSON DeliveryStreamDescription Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamDescription Methods parseJSON :: Value -> Parser DeliveryStreamDescription # parseJSONList :: Value -> Parser [DeliveryStreamDescription] #
type Rep DeliveryStreamDescription Source #
Instance details Defined in Amazonka.Firehose.Types.DeliveryStreamDescription type Rep DeliveryStreamDescription = D1 ('MetaData "DeliveryStreamDescription" "Amazonka.Firehose.Types.DeliveryStreamDescription" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "DeliveryStreamDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "failureDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureDescription)) :: (S1 ('MetaSel ('Just "deliveryStreamEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliveryStreamEncryptionConfiguration)) :: S1 ('MetaSel ('Just "createTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceDescription)) :: (S1 ('MetaSel ('Just "lastUpdateTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "deliveryStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "deliveryStreamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "deliveryStreamStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeliveryStreamStatus) :: S1 ('MetaSel ('Just "deliveryStreamType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeliveryStreamType))) :: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "destinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DestinationDescription]) :*: S1 ('MetaSel ('Just "hasMoreDestinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))

newDeliveryStreamDescription Source #

Arguments

:: Text	`$sel:deliveryStreamName:DeliveryStreamDescription'`
-> Text	`$sel:deliveryStreamARN:DeliveryStreamDescription'`
-> DeliveryStreamStatus	`$sel:deliveryStreamStatus:DeliveryStreamDescription'`
-> DeliveryStreamType	`$sel:deliveryStreamType:DeliveryStreamDescription'`
-> Text	`$sel:versionId:DeliveryStreamDescription'`
-> Bool	`$sel:hasMoreDestinations:DeliveryStreamDescription'`
-> DeliveryStreamDescription

Create a value of DeliveryStreamDescription 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:failureDescription:DeliveryStreamDescription', deliveryStreamDescription_failureDescription - Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

$sel:deliveryStreamEncryptionConfiguration:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamEncryptionConfiguration - Indicates the server-side encryption (SSE) status for the delivery stream.

$sel:createTimestamp:DeliveryStreamDescription', deliveryStreamDescription_createTimestamp - The date and time that the delivery stream was created.

$sel:source:DeliveryStreamDescription', deliveryStreamDescription_source - If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

$sel:lastUpdateTimestamp:DeliveryStreamDescription', deliveryStreamDescription_lastUpdateTimestamp - The date and time that the delivery stream was last updated.

$sel:deliveryStreamName:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamName - The name of the delivery stream.

$sel:deliveryStreamARN:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamARN - The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

$sel:deliveryStreamStatus:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamStatus - The status of the delivery stream. 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.

$sel:deliveryStreamType:DeliveryStreamDescription', deliveryStreamDescription_deliveryStreamType - The delivery stream type. This 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:versionId:DeliveryStreamDescription', deliveryStreamDescription_versionId - Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.

$sel:destinations:DeliveryStreamDescription', deliveryStreamDescription_destinations - The destinations.

$sel:hasMoreDestinations:DeliveryStreamDescription', deliveryStreamDescription_hasMoreDestinations - Indicates whether there are more destinations available to list.

deliveryStreamDescription_failureDescription :: Lens' DeliveryStreamDescription (Maybe FailureDescription) Source #

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

deliveryStreamDescription_deliveryStreamEncryptionConfiguration :: Lens' DeliveryStreamDescription (Maybe DeliveryStreamEncryptionConfiguration) Source #

Indicates the server-side encryption (SSE) status for the delivery stream.

deliveryStreamDescription_createTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #

The date and time that the delivery stream was created.

deliveryStreamDescription_source :: Lens' DeliveryStreamDescription (Maybe SourceDescription) Source #

If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

deliveryStreamDescription_lastUpdateTimestamp :: Lens' DeliveryStreamDescription (Maybe UTCTime) Source #

The date and time that the delivery stream was last updated.

deliveryStreamDescription_deliveryStreamName :: Lens' DeliveryStreamDescription Text Source #

The name of the delivery stream.

deliveryStreamDescription_deliveryStreamARN :: Lens' DeliveryStreamDescription Text Source #

The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

deliveryStreamDescription_deliveryStreamStatus :: Lens' DeliveryStreamDescription DeliveryStreamStatus Source #

The status of the delivery stream. 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.

deliveryStreamDescription_deliveryStreamType :: Lens' DeliveryStreamDescription DeliveryStreamType Source #

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

deliveryStreamDescription_versionId :: Lens' DeliveryStreamDescription Text Source #

Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.

deliveryStreamDescription_destinations :: Lens' DeliveryStreamDescription [DestinationDescription] Source #

The destinations.

deliveryStreamDescription_hasMoreDestinations :: Lens' DeliveryStreamDescription Bool Source #

Indicates whether there are more destinations available to list.