Menu
Amazon Kinesis Firehose API Reference
API Reference (API Version 2015-08-04)

UpdateDestination

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.

Request Syntax

{
   "CurrentDeliveryStreamVersionId": "string",
   "DeliveryStreamName": "string",
   "DestinationId": "string",
   "ElasticsearchDestinationUpdate": { 
      "BufferingHints": { 
         "IntervalInSeconds": number,
         "SizeInMBs": number
      },
      "CloudWatchLoggingOptions": { 
         "Enabled": boolean,
         "LogGroupName": "string",
         "LogStreamName": "string"
      },
      "DomainARN": "string",
      "IndexName": "string",
      "IndexRotationPeriod": "string",
      "ProcessingConfiguration": { 
         "Enabled": boolean,
         "Processors": [ 
            { 
               "Parameters": [ 
                  { 
                     "ParameterName": "string",
                     "ParameterValue": "string"
                  }
               ],
               "Type": "string"
            }
         ]
      },
      "RetryOptions": { 
         "DurationInSeconds": number
      },
      "RoleARN": "string",
      "S3Update": { 
         "BucketARN": "string",
         "BufferingHints": { 
            "IntervalInSeconds": number,
            "SizeInMBs": number
         },
         "CloudWatchLoggingOptions": { 
            "Enabled": boolean,
            "LogGroupName": "string",
            "LogStreamName": "string"
         },
         "CompressionFormat": "string",
         "EncryptionConfiguration": { 
            "KMSEncryptionConfig": { 
               "AWSKMSKeyARN": "string"
            },
            "NoEncryptionConfig": "string"
         },
         "Prefix": "string",
         "RoleARN": "string"
      },
      "TypeName": "string"
   },
   "ExtendedS3DestinationUpdate": { 
      "BucketARN": "string",
      "BufferingHints": { 
         "IntervalInSeconds": number,
         "SizeInMBs": number
      },
      "CloudWatchLoggingOptions": { 
         "Enabled": boolean,
         "LogGroupName": "string",
         "LogStreamName": "string"
      },
      "CompressionFormat": "string",
      "EncryptionConfiguration": { 
         "KMSEncryptionConfig": { 
            "AWSKMSKeyARN": "string"
         },
         "NoEncryptionConfig": "string"
      },
      "Prefix": "string",
      "ProcessingConfiguration": { 
         "Enabled": boolean,
         "Processors": [ 
            { 
               "Parameters": [ 
                  { 
                     "ParameterName": "string",
                     "ParameterValue": "string"
                  }
               ],
               "Type": "string"
            }
         ]
      },
      "RoleARN": "string",
      "S3BackupMode": "string",
      "S3BackupUpdate": { 
         "BucketARN": "string",
         "BufferingHints": { 
            "IntervalInSeconds": number,
            "SizeInMBs": number
         },
         "CloudWatchLoggingOptions": { 
            "Enabled": boolean,
            "LogGroupName": "string",
            "LogStreamName": "string"
         },
         "CompressionFormat": "string",
         "EncryptionConfiguration": { 
            "KMSEncryptionConfig": { 
               "AWSKMSKeyARN": "string"
            },
            "NoEncryptionConfig": "string"
         },
         "Prefix": "string",
         "RoleARN": "string"
      }
   },
   "RedshiftDestinationUpdate": { 
      "CloudWatchLoggingOptions": { 
         "Enabled": boolean,
         "LogGroupName": "string",
         "LogStreamName": "string"
      },
      "ClusterJDBCURL": "string",
      "CopyCommand": { 
         "CopyOptions": "string",
         "DataTableColumns": "string",
         "DataTableName": "string"
      },
      "Password": "string",
      "ProcessingConfiguration": { 
         "Enabled": boolean,
         "Processors": [ 
            { 
               "Parameters": [ 
                  { 
                     "ParameterName": "string",
                     "ParameterValue": "string"
                  }
               ],
               "Type": "string"
            }
         ]
      },
      "RetryOptions": { 
         "DurationInSeconds": number
      },
      "RoleARN": "string",
      "S3BackupMode": "string",
      "S3BackupUpdate": { 
         "BucketARN": "string",
         "BufferingHints": { 
            "IntervalInSeconds": number,
            "SizeInMBs": number
         },
         "CloudWatchLoggingOptions": { 
            "Enabled": boolean,
            "LogGroupName": "string",
            "LogStreamName": "string"
         },
         "CompressionFormat": "string",
         "EncryptionConfiguration": { 
            "KMSEncryptionConfig": { 
               "AWSKMSKeyARN": "string"
            },
            "NoEncryptionConfig": "string"
         },
         "Prefix": "string",
         "RoleARN": "string"
      },
      "S3Update": { 
         "BucketARN": "string",
         "BufferingHints": { 
            "IntervalInSeconds": number,
            "SizeInMBs": number
         },
         "CloudWatchLoggingOptions": { 
            "Enabled": boolean,
            "LogGroupName": "string",
            "LogStreamName": "string"
         },
         "CompressionFormat": "string",
         "EncryptionConfiguration": { 
            "KMSEncryptionConfig": { 
               "AWSKMSKeyARN": "string"
            },
            "NoEncryptionConfig": "string"
         },
         "Prefix": "string",
         "RoleARN": "string"
      },
      "Username": "string"
   },
   "S3DestinationUpdate": { 
      "BucketARN": "string",
      "BufferingHints": { 
         "IntervalInSeconds": number,
         "SizeInMBs": number
      },
      "CloudWatchLoggingOptions": { 
         "Enabled": boolean,
         "LogGroupName": "string",
         "LogStreamName": "string"
      },
      "CompressionFormat": "string",
      "EncryptionConfiguration": { 
         "KMSEncryptionConfig": { 
            "AWSKMSKeyARN": "string"
         },
         "NoEncryptionConfig": "string"
      },
      "Prefix": "string",
      "RoleARN": "string"
   },
   "SplunkDestinationUpdate": { 
      "CloudWatchLoggingOptions": { 
         "Enabled": boolean,
         "LogGroupName": "string",
         "LogStreamName": "string"
      },
      "HECAcknowledgmentTimeoutInSeconds": number,
      "HECEndpoint": "string",
      "HECEndpointType": "string",
      "HECToken": "string",
      "ProcessingConfiguration": { 
         "Enabled": boolean,
         "Processors": [ 
            { 
               "Parameters": [ 
                  { 
                     "ParameterName": "string",
                     "ParameterValue": "string"
                  }
               ],
               "Type": "string"
            }
         ]
      },
      "RetryOptions": { 
         "DurationInSeconds": number
      },
      "S3BackupMode": "string",
      "S3Update": { 
         "BucketARN": "string",
         "BufferingHints": { 
            "IntervalInSeconds": number,
            "SizeInMBs": number
         },
         "CloudWatchLoggingOptions": { 
            "Enabled": boolean,
            "LogGroupName": "string",
            "LogStreamName": "string"
         },
         "CompressionFormat": "string",
         "EncryptionConfiguration": { 
            "KMSEncryptionConfig": { 
               "AWSKMSKeyARN": "string"
            },
            "NoEncryptionConfig": "string"
         },
         "Prefix": "string",
         "RoleARN": "string"
      }
   }
}

Request Parameters

The request accepts the following data in JSON format.

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: [0-9]+

Required: Yes

DeliveryStreamName

The name of the delivery stream.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

DestinationId

The ID of the destination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

ElasticsearchDestinationUpdate

Describes an update for a destination in Amazon ES.

Type: ElasticsearchDestinationUpdate object

Required: No

ExtendedS3DestinationUpdate

Describes an update for a destination in Amazon S3.

Type: ExtendedS3DestinationUpdate object

Required: No

RedshiftDestinationUpdate

Describes an update for a destination in Amazon Redshift.

Type: RedshiftDestinationUpdate object

Required: No

S3DestinationUpdate

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

Type: S3DestinationUpdate object

Required: No

SplunkDestinationUpdate

Describes an update for a destination in Splunk.

Type: SplunkDestinationUpdate object

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

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

HTTP Status Code: 400

InvalidArgumentException

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

HTTP Status Code: 400

ResourceInUseException

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

HTTP Status Code: 400

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: