/AWS1/CL_FRH=>UPDATEDESTINATION()

About UpdateDestination

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 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 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, Firehose does not merge any parameters. In this case, all parameters must be specified.

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.

Method Signature

IMPORTING

Required arguments:

IV_DELIVERYSTREAMNAME TYPE /AWS1/FRHDELIVERYSTREAMNAME /AWS1/FRHDELIVERYSTREAMNAME

The name of the delivery stream.

IV_CURRENTDELIVERYSTRMVRSID TYPE /AWS1/FRHDELIVERYSTREAMVRSID /AWS1/FRHDELIVERYSTREAMVRSID

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.

IV_DESTINATIONID TYPE /AWS1/FRHDESTINATIONID /AWS1/FRHDESTINATIONID

The ID of the destination.

Optional arguments:

IO_S3DESTINATIONUPDATE TYPE REF TO /AWS1/CL_FRHS3DSTUPDATE /AWS1/CL_FRHS3DSTUPDATE

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

IO_EXTENDEDS3DSTUPDATE TYPE REF TO /AWS1/CL_FRHEXTENDEDS3DSTUPD /AWS1/CL_FRHEXTENDEDS3DSTUPD

Describes an update for a destination in Amazon S3.

IO_REDSHIFTDESTINATIONUPDATE TYPE REF TO /AWS1/CL_FRHREDSHIFTDSTUPDATE /AWS1/CL_FRHREDSHIFTDSTUPDATE

Describes an update for a destination in Amazon Redshift.

IO_ELASTICSEARCHDSTUPDATE TYPE REF TO /AWS1/CL_FRHELASTICSRCHDSTUPD /AWS1/CL_FRHELASTICSRCHDSTUPD

Describes an update for a destination in Amazon ES.

IO_AMAZONOPENSRCHSVCDSTUPD TYPE REF TO /AWS1/CL_FRHAMAZONOPENSRCHSV04 /AWS1/CL_FRHAMAZONOPENSRCHSV04

Describes an update for a destination in Amazon OpenSearch Service.

IO_SPLUNKDESTINATIONUPDATE TYPE REF TO /AWS1/CL_FRHSPLUNKDSTUPDATE /AWS1/CL_FRHSPLUNKDSTUPDATE

Describes an update for a destination in Splunk.

IO_HTTPENDPOINTDSTUPDATE TYPE REF TO /AWS1/CL_FRHHTTPENDPTDSTUPDATE /AWS1/CL_FRHHTTPENDPTDSTUPDATE

Describes an update to the specified HTTP endpoint destination.

IO_AMAZONOPENSRCHSERVERLES02 TYPE REF TO /AWS1/CL_FRHAMAZONOPENSRCHSE04 /AWS1/CL_FRHAMAZONOPENSRCHSE04

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

IO_SNOWFLAKEDSTUPDATE TYPE REF TO /AWS1/CL_FRHSNOWFLAKEDSTUPDATE /AWS1/CL_FRHSNOWFLAKEDSTUPDATE

Update to the Snowflake destination configuration settings.

IO_ICEBERGDESTINATIONUPDATE TYPE REF TO /AWS1/CL_FRHICEBERGDSTUPDATE /AWS1/CL_FRHICEBERGDSTUPDATE

Describes an update for a destination in Apache Iceberg Tables.

Amazon Data Firehose is in preview release and is subject to change.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_FRHUPDATEDSTOUTPUT /AWS1/CL_FRHUPDATEDSTOUTPUT