pub struct UpdateDestinationFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to UpdateDestination.
Updates the specified destination of the specified Firehose 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 Firehose stream remains active while the configurations are updated, so data writes to the Firehose 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.
Implementations§
Source§impl UpdateDestinationFluentBuilder
impl UpdateDestinationFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateDestinationInputBuilder
pub fn as_input(&self) -> &UpdateDestinationInputBuilder
Access the UpdateDestination as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateDestinationOutput, SdkError<UpdateDestinationError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateDestinationOutput, SdkError<UpdateDestinationError, HttpResponse>>
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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateDestinationOutput, UpdateDestinationError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateDestinationOutput, UpdateDestinationError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn delivery_stream_name(self, input: impl Into<String>) -> Self
pub fn delivery_stream_name(self, input: impl Into<String>) -> Self
The name of the Firehose stream.
Sourcepub fn set_delivery_stream_name(self, input: Option<String>) -> Self
pub fn set_delivery_stream_name(self, input: Option<String>) -> Self
The name of the Firehose stream.
Sourcepub fn get_delivery_stream_name(&self) -> &Option<String>
pub fn get_delivery_stream_name(&self) -> &Option<String>
The name of the Firehose stream.
Sourcepub fn current_delivery_stream_version_id(
self,
input: impl Into<String>,
) -> Self
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.
Sourcepub fn set_current_delivery_stream_version_id(
self,
input: Option<String>,
) -> Self
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.
Sourcepub fn get_current_delivery_stream_version_id(&self) -> &Option<String>
pub fn get_current_delivery_stream_version_id(&self) -> &Option<String>
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.
Sourcepub fn destination_id(self, input: impl Into<String>) -> Self
pub fn destination_id(self, input: impl Into<String>) -> Self
The ID of the destination.
Sourcepub fn set_destination_id(self, input: Option<String>) -> Self
pub fn set_destination_id(self, input: Option<String>) -> Self
The ID of the destination.
Sourcepub fn get_destination_id(&self) -> &Option<String>
pub fn get_destination_id(&self) -> &Option<String>
The ID of the destination.
Sourcepub fn s3_destination_update(self, input: S3DestinationUpdate) -> Self
👎Deprecated
pub fn s3_destination_update(self, input: S3DestinationUpdate) -> Self
\[Deprecated\] Describes an update for a destination in Amazon S3.
Sourcepub fn set_s3_destination_update(
self,
input: Option<S3DestinationUpdate>,
) -> Self
👎Deprecated
pub fn set_s3_destination_update( self, input: Option<S3DestinationUpdate>, ) -> Self
\[Deprecated\] Describes an update for a destination in Amazon S3.
Sourcepub fn get_s3_destination_update(&self) -> &Option<S3DestinationUpdate>
👎Deprecated
pub fn get_s3_destination_update(&self) -> &Option<S3DestinationUpdate>
\[Deprecated\] Describes an update for a destination in Amazon S3.
Sourcepub fn extended_s3_destination_update(
self,
input: ExtendedS3DestinationUpdate,
) -> Self
pub fn extended_s3_destination_update( self, input: ExtendedS3DestinationUpdate, ) -> Self
Describes an update for a destination in Amazon S3.
Sourcepub fn set_extended_s3_destination_update(
self,
input: Option<ExtendedS3DestinationUpdate>,
) -> Self
pub fn set_extended_s3_destination_update( self, input: Option<ExtendedS3DestinationUpdate>, ) -> Self
Describes an update for a destination in Amazon S3.
Sourcepub fn get_extended_s3_destination_update(
&self,
) -> &Option<ExtendedS3DestinationUpdate>
pub fn get_extended_s3_destination_update( &self, ) -> &Option<ExtendedS3DestinationUpdate>
Describes an update for a destination in Amazon S3.
Sourcepub fn redshift_destination_update(
self,
input: RedshiftDestinationUpdate,
) -> Self
pub fn redshift_destination_update( self, input: RedshiftDestinationUpdate, ) -> Self
Describes an update for a destination in Amazon Redshift.
Sourcepub fn set_redshift_destination_update(
self,
input: Option<RedshiftDestinationUpdate>,
) -> Self
pub fn set_redshift_destination_update( self, input: Option<RedshiftDestinationUpdate>, ) -> Self
Describes an update for a destination in Amazon Redshift.
Sourcepub fn get_redshift_destination_update(
&self,
) -> &Option<RedshiftDestinationUpdate>
pub fn get_redshift_destination_update( &self, ) -> &Option<RedshiftDestinationUpdate>
Describes an update for a destination in Amazon Redshift.
Sourcepub fn elasticsearch_destination_update(
self,
input: ElasticsearchDestinationUpdate,
) -> Self
pub fn elasticsearch_destination_update( self, input: ElasticsearchDestinationUpdate, ) -> Self
Describes an update for a destination in Amazon OpenSearch Service.
Sourcepub fn set_elasticsearch_destination_update(
self,
input: Option<ElasticsearchDestinationUpdate>,
) -> Self
pub fn set_elasticsearch_destination_update( self, input: Option<ElasticsearchDestinationUpdate>, ) -> Self
Describes an update for a destination in Amazon OpenSearch Service.
Sourcepub fn get_elasticsearch_destination_update(
&self,
) -> &Option<ElasticsearchDestinationUpdate>
pub fn get_elasticsearch_destination_update( &self, ) -> &Option<ElasticsearchDestinationUpdate>
Describes an update for a destination in Amazon OpenSearch Service.
Sourcepub fn amazonopensearchservice_destination_update(
self,
input: AmazonopensearchserviceDestinationUpdate,
) -> Self
pub fn amazonopensearchservice_destination_update( self, input: AmazonopensearchserviceDestinationUpdate, ) -> Self
Describes an update for a destination in Amazon OpenSearch Service.
Sourcepub fn set_amazonopensearchservice_destination_update(
self,
input: Option<AmazonopensearchserviceDestinationUpdate>,
) -> Self
pub fn set_amazonopensearchservice_destination_update( self, input: Option<AmazonopensearchserviceDestinationUpdate>, ) -> Self
Describes an update for a destination in Amazon OpenSearch Service.
Sourcepub fn get_amazonopensearchservice_destination_update(
&self,
) -> &Option<AmazonopensearchserviceDestinationUpdate>
pub fn get_amazonopensearchservice_destination_update( &self, ) -> &Option<AmazonopensearchserviceDestinationUpdate>
Describes an update for a destination in Amazon OpenSearch Service.
Sourcepub fn splunk_destination_update(self, input: SplunkDestinationUpdate) -> Self
pub fn splunk_destination_update(self, input: SplunkDestinationUpdate) -> Self
Describes an update for a destination in Splunk.
Sourcepub fn set_splunk_destination_update(
self,
input: Option<SplunkDestinationUpdate>,
) -> Self
pub fn set_splunk_destination_update( self, input: Option<SplunkDestinationUpdate>, ) -> Self
Describes an update for a destination in Splunk.
Sourcepub fn get_splunk_destination_update(&self) -> &Option<SplunkDestinationUpdate>
pub fn get_splunk_destination_update(&self) -> &Option<SplunkDestinationUpdate>
Describes an update for a destination in Splunk.
Sourcepub fn http_endpoint_destination_update(
self,
input: HttpEndpointDestinationUpdate,
) -> Self
pub fn http_endpoint_destination_update( self, input: HttpEndpointDestinationUpdate, ) -> Self
Describes an update to the specified HTTP endpoint destination.
Sourcepub fn set_http_endpoint_destination_update(
self,
input: Option<HttpEndpointDestinationUpdate>,
) -> Self
pub fn set_http_endpoint_destination_update( self, input: Option<HttpEndpointDestinationUpdate>, ) -> Self
Describes an update to the specified HTTP endpoint destination.
Sourcepub fn get_http_endpoint_destination_update(
&self,
) -> &Option<HttpEndpointDestinationUpdate>
pub fn get_http_endpoint_destination_update( &self, ) -> &Option<HttpEndpointDestinationUpdate>
Describes an update to the specified HTTP endpoint destination.
Sourcepub fn amazon_open_search_serverless_destination_update(
self,
input: AmazonOpenSearchServerlessDestinationUpdate,
) -> Self
pub fn amazon_open_search_serverless_destination_update( self, input: AmazonOpenSearchServerlessDestinationUpdate, ) -> Self
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
Sourcepub fn set_amazon_open_search_serverless_destination_update(
self,
input: Option<AmazonOpenSearchServerlessDestinationUpdate>,
) -> Self
pub fn set_amazon_open_search_serverless_destination_update( self, input: Option<AmazonOpenSearchServerlessDestinationUpdate>, ) -> Self
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
Sourcepub fn get_amazon_open_search_serverless_destination_update(
&self,
) -> &Option<AmazonOpenSearchServerlessDestinationUpdate>
pub fn get_amazon_open_search_serverless_destination_update( &self, ) -> &Option<AmazonOpenSearchServerlessDestinationUpdate>
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
Sourcepub fn snowflake_destination_update(
self,
input: SnowflakeDestinationUpdate,
) -> Self
pub fn snowflake_destination_update( self, input: SnowflakeDestinationUpdate, ) -> Self
Update to the Snowflake destination configuration settings.
Sourcepub fn set_snowflake_destination_update(
self,
input: Option<SnowflakeDestinationUpdate>,
) -> Self
pub fn set_snowflake_destination_update( self, input: Option<SnowflakeDestinationUpdate>, ) -> Self
Update to the Snowflake destination configuration settings.
Sourcepub fn get_snowflake_destination_update(
&self,
) -> &Option<SnowflakeDestinationUpdate>
pub fn get_snowflake_destination_update( &self, ) -> &Option<SnowflakeDestinationUpdate>
Update to the Snowflake destination configuration settings.
Sourcepub fn iceberg_destination_update(self, input: IcebergDestinationUpdate) -> Self
pub fn iceberg_destination_update(self, input: IcebergDestinationUpdate) -> Self
Describes an update for a destination in Apache Iceberg Tables.
Sourcepub fn set_iceberg_destination_update(
self,
input: Option<IcebergDestinationUpdate>,
) -> Self
pub fn set_iceberg_destination_update( self, input: Option<IcebergDestinationUpdate>, ) -> Self
Describes an update for a destination in Apache Iceberg Tables.
Sourcepub fn get_iceberg_destination_update(
&self,
) -> &Option<IcebergDestinationUpdate>
pub fn get_iceberg_destination_update( &self, ) -> &Option<IcebergDestinationUpdate>
Describes an update for a destination in Apache Iceberg Tables.
Trait Implementations§
Source§impl Clone for UpdateDestinationFluentBuilder
impl Clone for UpdateDestinationFluentBuilder
Source§fn clone(&self) -> UpdateDestinationFluentBuilder
fn clone(&self) -> UpdateDestinationFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for UpdateDestinationFluentBuilder
impl !RefUnwindSafe for UpdateDestinationFluentBuilder
impl Send for UpdateDestinationFluentBuilder
impl Sync for UpdateDestinationFluentBuilder
impl Unpin for UpdateDestinationFluentBuilder
impl !UnwindSafe for UpdateDestinationFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);