AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the UpdateDestination operation. 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.
Namespace: Amazon.KinesisFirehose.Model
Assembly: AWSSDK.KinesisFirehose.dll
Version: 3.x.y.z
public class UpdateDestinationRequest : AmazonKinesisFirehoseRequest IAmazonWebServiceRequest
The UpdateDestinationRequest type exposes the following members
Name | Description | |
---|---|---|
UpdateDestinationRequest() |
Name | Type | Description | |
---|---|---|---|
AmazonOpenSearchServerlessDestinationUpdate | Amazon.KinesisFirehose.Model.AmazonOpenSearchServerlessDestinationUpdate |
Gets and sets the property AmazonOpenSearchServerlessDestinationUpdate. Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service. |
|
AmazonopensearchserviceDestinationUpdate | Amazon.KinesisFirehose.Model.AmazonopensearchserviceDestinationUpdate |
Gets and sets the property AmazonopensearchserviceDestinationUpdate. Describes an update for a destination in Amazon OpenSearch Service. |
|
CurrentDeliveryStreamVersionId | System.String |
Gets and sets the property CurrentDeliveryStreamVersionId.
Obtain this value from the |
|
DeliveryStreamName | System.String |
Gets and sets the property DeliveryStreamName. The name of the delivery stream. |
|
DestinationId | System.String |
Gets and sets the property DestinationId. The ID of the destination. |
|
ElasticsearchDestinationUpdate | Amazon.KinesisFirehose.Model.ElasticsearchDestinationUpdate |
Gets and sets the property ElasticsearchDestinationUpdate. Describes an update for a destination in Amazon ES. |
|
ExtendedS3DestinationUpdate | Amazon.KinesisFirehose.Model.ExtendedS3DestinationUpdate |
Gets and sets the property ExtendedS3DestinationUpdate. Describes an update for a destination in Amazon S3. |
|
HttpEndpointDestinationUpdate | Amazon.KinesisFirehose.Model.HttpEndpointDestinationUpdate |
Gets and sets the property HttpEndpointDestinationUpdate. Describes an update to the specified HTTP endpoint destination. |
|
RedshiftDestinationUpdate | Amazon.KinesisFirehose.Model.RedshiftDestinationUpdate |
Gets and sets the property RedshiftDestinationUpdate. Describes an update for a destination in Amazon Redshift. |
|
S3DestinationUpdate | Amazon.KinesisFirehose.Model.S3DestinationUpdate |
Gets and sets the property S3DestinationUpdate. [Deprecated] Describes an update for a destination in Amazon S3. |
|
SnowflakeDestinationUpdate | Amazon.KinesisFirehose.Model.SnowflakeDestinationUpdate |
Gets and sets the property SnowflakeDestinationUpdate. Update to the Snowflake destination condiguration settings |
|
SplunkDestinationUpdate | Amazon.KinesisFirehose.Model.SplunkDestinationUpdate |
Gets and sets the property SplunkDestinationUpdate. Describes an update for a destination in Splunk. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5