Struct aws_sdk_firehose::client::fluent_builders::UpdateDestination

pub struct UpdateDestination { /* private fields */ }

Fluent builder constructing a request to 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 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.

Implementations

impl UpdateDestination

pub async fn send(
    self
) -> Result<UpdateDestinationOutput, SdkError<UpdateDestinationError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn delivery_stream_name(self, input: impl Into<String>) -> Self

The name of the delivery stream.

pub fn set_delivery_stream_name(self, input: Option<String>) -> Self

The name of the delivery stream.

pub fn current_delivery_stream_version_id(
    self,
    input: impl Into<String>
) -> Self

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.

pub fn set_current_delivery_stream_version_id(
    self,
    input: Option<String>
) -> Self

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.

pub fn destination_id(self, input: impl Into<String>) -> Self

The ID of the destination.

pub fn set_destination_id(self, input: Option<String>) -> Self

The ID of the destination.

pub fn s3_destination_update(self, input: S3DestinationUpdate) -> Self

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

pub fn set_s3_destination_update(
    self,
    input: Option<S3DestinationUpdate>
) -> Self

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

pub fn extended_s3_destination_update(
    self,
    input: ExtendedS3DestinationUpdate
) -> Self

Describes an update for a destination in Amazon S3.

pub fn set_extended_s3_destination_update(
    self,
    input: Option<ExtendedS3DestinationUpdate>
) -> Self

Describes an update for a destination in Amazon S3.

pub fn redshift_destination_update(
    self,
    input: RedshiftDestinationUpdate
) -> Self

Describes an update for a destination in Amazon Redshift.

pub fn set_redshift_destination_update(
    self,
    input: Option<RedshiftDestinationUpdate>
) -> Self

Describes an update for a destination in Amazon Redshift.

pub fn elasticsearch_destination_update(
    self,
    input: ElasticsearchDestinationUpdate
) -> Self

Describes an update for a destination in Amazon ES.

pub fn set_elasticsearch_destination_update(
    self,
    input: Option<ElasticsearchDestinationUpdate>
) -> Self

Describes an update for a destination in Amazon ES.

pub fn amazonopensearchservice_destination_update(
    self,
    input: AmazonopensearchserviceDestinationUpdate
) -> Self

pub fn set_amazonopensearchservice_destination_update(
    self,
    input: Option<AmazonopensearchserviceDestinationUpdate>
) -> Self

pub fn splunk_destination_update(self, input: SplunkDestinationUpdate) -> Self

Describes an update for a destination in Splunk.

pub fn set_splunk_destination_update(
    self,
    input: Option<SplunkDestinationUpdate>
) -> Self

Describes an update for a destination in Splunk.

pub fn http_endpoint_destination_update(
    self,
    input: HttpEndpointDestinationUpdate
) -> Self

Describes an update to the specified HTTP endpoint destination.

pub fn set_http_endpoint_destination_update(
    self,
    input: Option<HttpEndpointDestinationUpdate>
) -> Self

Describes an update to the specified HTTP endpoint destination.

Trait Implementations

impl Clone for UpdateDestination

fn clone(&self) -> UpdateDestination

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateDestination

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.