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.UpdateDestination

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the specified destination of the specified delivery stream.

Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.

Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.

If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination.

If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.

Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.

Synopsis

Creating a Request

data UpdateDestination Source #

See: newUpdateDestination smart constructor.

Constructors

UpdateDestination'

Fields

amazonOpenSearchServerlessDestinationUpdate :: Maybe AmazonOpenSearchServerlessDestinationUpdate
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
amazonopensearchserviceDestinationUpdate :: Maybe AmazonopensearchserviceDestinationUpdate
Describes an update for a destination in Amazon OpenSearch Service.
elasticsearchDestinationUpdate :: Maybe ElasticsearchDestinationUpdate
Describes an update for a destination in Amazon ES.
extendedS3DestinationUpdate :: Maybe ExtendedS3DestinationUpdate
Describes an update for a destination in Amazon S3.
httpEndpointDestinationUpdate :: Maybe HttpEndpointDestinationUpdate
Describes an update to the specified HTTP endpoint destination.
redshiftDestinationUpdate :: Maybe RedshiftDestinationUpdate
Describes an update for a destination in Amazon Redshift.
s3DestinationUpdate :: Maybe S3DestinationUpdate
Deprecated
Describes an update for a destination in Amazon S3.
splunkDestinationUpdate :: Maybe SplunkDestinationUpdate
Describes an update for a destination in Splunk.
deliveryStreamName :: Text
The name of the delivery stream.
currentDeliveryStreamVersionId :: Text
Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.
destinationId :: Text
The ID of the destination.

Instances

Instances details

ToJSON UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination Methods toJSON :: UpdateDestination -> Value # toEncoding :: UpdateDestination -> Encoding # toJSONList :: [UpdateDestination] -> Value # toEncodingList :: [UpdateDestination] -> Encoding #
ToHeaders UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination Methods toHeaders :: UpdateDestination -> [Header] #
ToPath UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination Methods toPath :: UpdateDestination -> ByteString #
ToQuery UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination Methods toQuery :: UpdateDestination -> QueryString #
AWSRequest UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination Associated Types type AWSResponse UpdateDestination # Methods request :: (Service -> Service) -> UpdateDestination -> Request UpdateDestination # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDestination -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDestination))) #
Generic UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination Associated Types type Rep UpdateDestination :: Type -> Type # Methods from :: UpdateDestination -> Rep UpdateDestination x # to :: Rep UpdateDestination x -> UpdateDestination #
Show UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination Methods showsPrec :: Int -> UpdateDestination -> ShowS # show :: UpdateDestination -> String # showList :: [UpdateDestination] -> ShowS #
NFData UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination Methods rnf :: UpdateDestination -> () #
Eq UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination Methods (==) :: UpdateDestination -> UpdateDestination -> Bool # (/=) :: UpdateDestination -> UpdateDestination -> Bool #
Hashable UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination Methods hashWithSalt :: Int -> UpdateDestination -> Int # hash :: UpdateDestination -> Int #
type AWSResponse UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination type AWSResponse UpdateDestination = UpdateDestinationResponse
type Rep UpdateDestination Source #
Instance details Defined in Amazonka.Firehose.UpdateDestination type Rep UpdateDestination = D1 ('MetaData "UpdateDestination" "Amazonka.Firehose.UpdateDestination" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "UpdateDestination'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "amazonOpenSearchServerlessDestinationUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessDestinationUpdate)) :: S1 ('MetaSel ('Just "amazonopensearchserviceDestinationUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceDestinationUpdate))) :: (S1 ('MetaSel ('Just "elasticsearchDestinationUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchDestinationUpdate)) :: (S1 ('MetaSel ('Just "extendedS3DestinationUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExtendedS3DestinationUpdate)) :: S1 ('MetaSel ('Just "httpEndpointDestinationUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointDestinationUpdate))))) :: ((S1 ('MetaSel ('Just "redshiftDestinationUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftDestinationUpdate)) :: (S1 ('MetaSel ('Just "s3DestinationUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationUpdate)) :: S1 ('MetaSel ('Just "splunkDestinationUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SplunkDestinationUpdate)))) :: (S1 ('MetaSel ('Just "deliveryStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "currentDeliveryStreamVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "destinationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateDestination Source #

Arguments

:: Text	`UpdateDestination`
-> Text	`$sel:currentDeliveryStreamVersionId:UpdateDestination'`
-> Text	`UpdateDestination`
-> UpdateDestination

Create a value of UpdateDestination 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:amazonOpenSearchServerlessDestinationUpdate:UpdateDestination', updateDestination_amazonOpenSearchServerlessDestinationUpdate - Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.

$sel:amazonopensearchserviceDestinationUpdate:UpdateDestination', updateDestination_amazonopensearchserviceDestinationUpdate - Describes an update for a destination in Amazon OpenSearch Service.

$sel:elasticsearchDestinationUpdate:UpdateDestination', updateDestination_elasticsearchDestinationUpdate - Describes an update for a destination in Amazon ES.

$sel:extendedS3DestinationUpdate:UpdateDestination', updateDestination_extendedS3DestinationUpdate - Describes an update for a destination in Amazon S3.

$sel:httpEndpointDestinationUpdate:UpdateDestination', updateDestination_httpEndpointDestinationUpdate - Describes an update to the specified HTTP endpoint destination.

$sel:redshiftDestinationUpdate:UpdateDestination', updateDestination_redshiftDestinationUpdate - Describes an update for a destination in Amazon Redshift.

$sel:s3DestinationUpdate:UpdateDestination', updateDestination_s3DestinationUpdate - [Deprecated] Describes an update for a destination in Amazon S3.

$sel:splunkDestinationUpdate:UpdateDestination', updateDestination_splunkDestinationUpdate - Describes an update for a destination in Splunk.

UpdateDestination, updateDestination_deliveryStreamName - The name of the delivery stream.

$sel:currentDeliveryStreamVersionId:UpdateDestination', updateDestination_currentDeliveryStreamVersionId - Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.

UpdateDestination, updateDestination_destinationId - The ID of the destination.

Request Lenses

updateDestination_amazonOpenSearchServerlessDestinationUpdate :: Lens' UpdateDestination (Maybe AmazonOpenSearchServerlessDestinationUpdate) Source #

Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.

updateDestination_amazonopensearchserviceDestinationUpdate :: Lens' UpdateDestination (Maybe AmazonopensearchserviceDestinationUpdate) Source #

Describes an update for a destination in Amazon OpenSearch Service.

updateDestination_elasticsearchDestinationUpdate :: Lens' UpdateDestination (Maybe ElasticsearchDestinationUpdate) Source #

Describes an update for a destination in Amazon ES.

updateDestination_extendedS3DestinationUpdate :: Lens' UpdateDestination (Maybe ExtendedS3DestinationUpdate) Source #

Describes an update for a destination in Amazon S3.

updateDestination_httpEndpointDestinationUpdate :: Lens' UpdateDestination (Maybe HttpEndpointDestinationUpdate) Source #

Describes an update to the specified HTTP endpoint destination.

updateDestination_redshiftDestinationUpdate :: Lens' UpdateDestination (Maybe RedshiftDestinationUpdate) Source #

Describes an update for a destination in Amazon Redshift.

updateDestination_s3DestinationUpdate :: Lens' UpdateDestination (Maybe S3DestinationUpdate) Source #

Deprecated: Describes an update for a destination in Amazon S3.

updateDestination_splunkDestinationUpdate :: Lens' UpdateDestination (Maybe SplunkDestinationUpdate) Source #

Describes an update for a destination in Splunk.

updateDestination_deliveryStreamName :: Lens' UpdateDestination Text Source #

The name of the delivery stream.

updateDestination_currentDeliveryStreamVersionId :: Lens' UpdateDestination Text Source #

Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.

updateDestination_destinationId :: Lens' UpdateDestination Text Source #

The ID of the destination.

Destructuring the Response

data UpdateDestinationResponse Source #

See: newUpdateDestinationResponse smart constructor.

Constructors

UpdateDestinationResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateDestinationResponse Source #

Arguments

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

Create a value of UpdateDestinationResponse 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:httpStatus:UpdateDestinationResponse', updateDestinationResponse_httpStatus - The response's http status code.

Response Lenses

updateDestinationResponse_httpStatus :: Lens' UpdateDestinationResponse Int Source #

The response's http status code.