AWS SDK Version 3 for .NET
API Reference

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.

You can 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.

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

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.KinesisFirehose.AmazonKinesisFirehoseRequest
      Amazon.KinesisFirehose.Model.UpdateDestinationRequest

Namespace: Amazon.KinesisFirehose.Model
Assembly: AWSSDK.KinesisFirehose.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateDestinationRequest : AmazonKinesisFirehoseRequest
         IAmazonWebServiceRequest

The UpdateDestinationRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateDestinationRequest()

Properties

NameTypeDescription
Public Property CurrentDeliveryStreamVersionId System.String

Gets and sets the property CurrentDeliveryStreamVersionId.

Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service to 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.

Public Property DeliveryStreamName System.String

Gets and sets the property DeliveryStreamName.

The name of the delivery stream.

Public Property DestinationId System.String

Gets and sets the property DestinationId.

The ID of the destination.

Public Property ElasticsearchDestinationUpdate Amazon.KinesisFirehose.Model.ElasticsearchDestinationUpdate

Gets and sets the property ElasticsearchDestinationUpdate.

Describes an update for a destination in Amazon ES.

Public Property ExtendedS3DestinationUpdate Amazon.KinesisFirehose.Model.ExtendedS3DestinationUpdate

Gets and sets the property ExtendedS3DestinationUpdate.

Describes an update for a destination in Amazon S3.

Public Property RedshiftDestinationUpdate Amazon.KinesisFirehose.Model.RedshiftDestinationUpdate

Gets and sets the property RedshiftDestinationUpdate.

Describes an update for a destination in Amazon Redshift.

Public Property S3DestinationUpdate Amazon.KinesisFirehose.Model.S3DestinationUpdate

Gets and sets the property S3DestinationUpdate.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone