UpdateDestinationCommand

Use a bare-bones client and the command you need to make an API call.

UpdateDestinationCommandInput

[UpdateDestinationCommandInput](@aws-sdk/client-firehose!UpdateDestinationCommandInput:Interface)

Updates the specified destination of the specified Firehose 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 Firehose stream remains active while the configurations are updated, so data writes to the Firehose stream can continue during this process. The updated configurations are usually effective within a few minutes. Switching between Amazon OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination. If the destination type is the same, 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 <code>EncryptionConfiguration</code> is maintained on the destination. If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In this case, all parameters must be specified. Firehose uses <code>CurrentDeliveryStreamVersionId</code> 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 <code>CurrentDeliveryStreamVersionId</code> in the next call.

CurrentDeliveryStreamVersionId

Obtain this value from the <code>VersionId</code> 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 <code>VersionId</code> value is updated. The service then performs a merge of the old configuration with the new configuration.

DeliveryStreamName

DestinationId

AmazonOpenSearchServerlessDestinationUpdate

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

AmazonopensearchserviceDestinationUpdate

Describes an update for a destination in Amazon OpenSearch Service.

ElasticsearchDestinationUpdate

ExtendedS3DestinationUpdate

Describes an update for a destination in Amazon S3.

HttpEndpointDestinationUpdate

Describes an update to the specified HTTP endpoint destination.

IcebergDestinationUpdate

Describes an update for a destination in Apache Iceberg Tables.

RedshiftDestinationUpdate

Describes an update for a destination in Amazon Redshift.

S3DestinationUpdate

[Deprecated] Describes an update for a destination in Amazon S3.

SnowflakeDestinationUpdate

Update to the Snowflake destination configuration settings.

SplunkDestinationUpdate

Describes an update for a destination in Splunk.

The input for [UpdateDestinationCommand](@aws-sdk/client-firehose!UpdateDestinationCommand:Class).

$metadata

UpdateDestinationCommandOutput

The output of [UpdateDestinationCommand](@aws-sdk/client-firehose!UpdateDestinationCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

[Symbol.hasInstance]

instance

Custom instanceof check to support the operator for ServiceException base class

isInstance

value

Checks if a value is an instance of ServiceException (duck typed)

name

ConcurrentModificationException

Another modification has already happened. Fetch <code>VersionId</code> again and use it to update the destination.

InvalidArgumentException

The specified input parameter has a value that is not valid.

ResourceInUseException

The resource is already in use and not available for this operation.

ResourceNotFoundException

The specified resource could not be found.

FirehoseServiceException

Base exception class for all service exceptions from Firehose service.