Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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 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 Data 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 Data Firehose does not merge any parameters. In this case, all parameters must be specified.
Kinesis Data 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.
Synopsis
- updateDestination :: Text -> Text -> Text -> UpdateDestination
- data UpdateDestination
- udSplunkDestinationUpdate :: Lens' UpdateDestination (Maybe SplunkDestinationUpdate)
- udS3DestinationUpdate :: Lens' UpdateDestination (Maybe S3DestinationUpdate)
- udRedshiftDestinationUpdate :: Lens' UpdateDestination (Maybe RedshiftDestinationUpdate)
- udElasticsearchDestinationUpdate :: Lens' UpdateDestination (Maybe ElasticsearchDestinationUpdate)
- udExtendedS3DestinationUpdate :: Lens' UpdateDestination (Maybe ExtendedS3DestinationUpdate)
- udDeliveryStreamName :: Lens' UpdateDestination Text
- udCurrentDeliveryStreamVersionId :: Lens' UpdateDestination Text
- udDestinationId :: Lens' UpdateDestination Text
- updateDestinationResponse :: Int -> UpdateDestinationResponse
- data UpdateDestinationResponse
- udrsResponseStatus :: Lens' UpdateDestinationResponse Int
Creating a Request
:: Text | |
-> Text | |
-> Text | |
-> UpdateDestination |
Creates a value of UpdateDestination
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
udSplunkDestinationUpdate
- Describes an update for a destination in Splunk.udS3DestinationUpdate
- [Deprecated] Describes an update for a destination in Amazon S3.udRedshiftDestinationUpdate
- Describes an update for a destination in Amazon Redshift.udElasticsearchDestinationUpdate
- Describes an update for a destination in Amazon ES.udExtendedS3DestinationUpdate
- Describes an update for a destination in Amazon S3.udDeliveryStreamName
- The name of the delivery stream.udCurrentDeliveryStreamVersionId
- Obtain this value from the VersionId result ofDeliveryStreamDescription
. 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, theVersionId
value is updated. The service then performs a merge of the old configuration with the new configuration.udDestinationId
- The ID of the destination.
data UpdateDestination Source #
See: updateDestination
smart constructor.
Instances
Request Lenses
udSplunkDestinationUpdate :: Lens' UpdateDestination (Maybe SplunkDestinationUpdate) Source #
Describes an update for a destination in Splunk.
udS3DestinationUpdate :: Lens' UpdateDestination (Maybe S3DestinationUpdate) Source #
- Deprecated
- Describes an update for a destination in Amazon S3.
udRedshiftDestinationUpdate :: Lens' UpdateDestination (Maybe RedshiftDestinationUpdate) Source #
Describes an update for a destination in Amazon Redshift.
udElasticsearchDestinationUpdate :: Lens' UpdateDestination (Maybe ElasticsearchDestinationUpdate) Source #
Describes an update for a destination in Amazon ES.
udExtendedS3DestinationUpdate :: Lens' UpdateDestination (Maybe ExtendedS3DestinationUpdate) Source #
Describes an update for a destination in Amazon S3.
udDeliveryStreamName :: Lens' UpdateDestination Text Source #
The name of the delivery stream.
udCurrentDeliveryStreamVersionId :: Lens' UpdateDestination Text Source #
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.
udDestinationId :: Lens' UpdateDestination Text Source #
The ID of the destination.
Destructuring the Response
updateDestinationResponse Source #
Creates a value of UpdateDestinationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
udrsResponseStatus
- -- | The response status code.
data UpdateDestinationResponse Source #
See: updateDestinationResponse
smart constructor.
Instances
Response Lenses
udrsResponseStatus :: Lens' UpdateDestinationResponse Int Source #
- - | The response status code.