Network.AWS.Firehose.UpdateDestination

Updates the specified destination of the specified delivery stream.

This operation can be used to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a given destination (for example, to change the bucket name of the Amazon S3 destination). The update may 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 normally effective within a few minutes.

If the destination type is the same, Amazon Kinesis Firehose merges the configuration parameters specified in the UpdateDestination request with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the update request, then the existing configuration parameters 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, Amazon Kinesis Firehose does not merge any parameters. In this case, all parameters must be specified.

Amazon Kinesis Firehose uses the CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field in every request and the service only updates the configuration if the existing configuration matches the VersionId. After the update is applied successfully, the VersionId is updated, which can be retrieved with the DescribeDeliveryStream operation. The new VersionId should be uses to set CurrentDeliveryStreamVersionId in the next UpdateDestination operation.

See: AWS API Reference for UpdateDestination.

Creating a Request

updateDestination

Arguments

:: Text

udDeliveryStreamName

-> Text

udCurrentDeliveryStreamVersionId

-> Text

udDestinationId

-> UpdateDestination

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

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

• udS3DestinationUpdate
• udRedshiftDestinationUpdate
• udDeliveryStreamName
• udCurrentDeliveryStreamVersionId
• udDestinationId

data UpdateDestination

Contains the parameters for UpdateDestination.

See: updateDestination smart constructor.

Instances

Eq UpdateDestination

Data UpdateDestination

Read UpdateDestination

Show UpdateDestination

Generic UpdateDestination

ToJSON UpdateDestination

AWSRequest UpdateDestination

ToPath UpdateDestination

ToHeaders UpdateDestination

ToQuery UpdateDestination

type Rep UpdateDestination

type Rs UpdateDestination = UpdateDestinationResponse

Request Lenses

udS3DestinationUpdate :: Lens' UpdateDestination (Maybe S3DestinationUpdate)

Undocumented member.

udRedshiftDestinationUpdate :: Lens' UpdateDestination (Maybe RedshiftDestinationUpdate)

Undocumented member.

udDeliveryStreamName :: Lens' UpdateDestination Text

The name of the delivery stream.

udCurrentDeliveryStreamVersionId :: Lens' UpdateDestination Text

Obtain this value from the VersionId result of the DeliveryStreamDescription operation. This value is required, and helps the service to perform conditional operations. For example, if there is a 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.

udDestinationId :: Lens' UpdateDestination Text

The ID of the destination.

Destructuring the Response

updateDestinationResponse

Arguments

:: Int

udrsResponseStatus

-> UpdateDestinationResponse

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

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

• udrsResponseStatus

data UpdateDestinationResponse

Contains the output of UpdateDestination.

See: updateDestinationResponse smart constructor.

Instances

Eq UpdateDestinationResponse

Data UpdateDestinationResponse

Read UpdateDestinationResponse

Show UpdateDestinationResponse

Generic UpdateDestinationResponse

type Rep UpdateDestinationResponse

Response Lenses

udrsResponseStatus :: Lens' UpdateDestinationResponse Int

The response status code.