pub struct UpdatePipeFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to UpdatePipe.
Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. EventBridge updates the fields in these objects atomically as one and overrides existing values. This is by design, and means that if you don't specify an optional field in one of these Parameters objects, EventBridge sets that field to its system-default value during the update.
For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
Implementations§
Source§impl UpdatePipeFluentBuilder
impl UpdatePipeFluentBuilder
Sourcepub fn as_input(&self) -> &UpdatePipeInputBuilder
pub fn as_input(&self) -> &UpdatePipeInputBuilder
Access the UpdatePipe as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdatePipeOutput, SdkError<UpdatePipeError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdatePipeOutput, SdkError<UpdatePipeError, 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<UpdatePipeOutput, UpdatePipeError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdatePipeOutput, UpdatePipeError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the pipe.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the pipe.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the pipe.
Sourcepub fn desired_state(self, input: RequestedPipeState) -> Self
pub fn desired_state(self, input: RequestedPipeState) -> Self
The state the pipe should be in.
Sourcepub fn set_desired_state(self, input: Option<RequestedPipeState>) -> Self
pub fn set_desired_state(self, input: Option<RequestedPipeState>) -> Self
The state the pipe should be in.
Sourcepub fn get_desired_state(&self) -> &Option<RequestedPipeState>
pub fn get_desired_state(&self) -> &Option<RequestedPipeState>
The state the pipe should be in.
Sourcepub fn source_parameters(self, input: UpdatePipeSourceParameters) -> Self
pub fn source_parameters(self, input: UpdatePipeSourceParameters) -> Self
The parameters required to set up a source for your pipe.
Sourcepub fn set_source_parameters(
self,
input: Option<UpdatePipeSourceParameters>,
) -> Self
pub fn set_source_parameters( self, input: Option<UpdatePipeSourceParameters>, ) -> Self
The parameters required to set up a source for your pipe.
Sourcepub fn get_source_parameters(&self) -> &Option<UpdatePipeSourceParameters>
pub fn get_source_parameters(&self) -> &Option<UpdatePipeSourceParameters>
The parameters required to set up a source for your pipe.
Sourcepub fn enrichment(self, input: impl Into<String>) -> Self
pub fn enrichment(self, input: impl Into<String>) -> Self
The ARN of the enrichment resource.
Sourcepub fn set_enrichment(self, input: Option<String>) -> Self
pub fn set_enrichment(self, input: Option<String>) -> Self
The ARN of the enrichment resource.
Sourcepub fn get_enrichment(&self) -> &Option<String>
pub fn get_enrichment(&self) -> &Option<String>
The ARN of the enrichment resource.
Sourcepub fn enrichment_parameters(self, input: PipeEnrichmentParameters) -> Self
pub fn enrichment_parameters(self, input: PipeEnrichmentParameters) -> Self
The parameters required to set up enrichment on your pipe.
Sourcepub fn set_enrichment_parameters(
self,
input: Option<PipeEnrichmentParameters>,
) -> Self
pub fn set_enrichment_parameters( self, input: Option<PipeEnrichmentParameters>, ) -> Self
The parameters required to set up enrichment on your pipe.
Sourcepub fn get_enrichment_parameters(&self) -> &Option<PipeEnrichmentParameters>
pub fn get_enrichment_parameters(&self) -> &Option<PipeEnrichmentParameters>
The parameters required to set up enrichment on your pipe.
Sourcepub fn set_target(self, input: Option<String>) -> Self
pub fn set_target(self, input: Option<String>) -> Self
The ARN of the target resource.
Sourcepub fn get_target(&self) -> &Option<String>
pub fn get_target(&self) -> &Option<String>
The ARN of the target resource.
Sourcepub fn target_parameters(self, input: PipeTargetParameters) -> Self
pub fn target_parameters(self, input: PipeTargetParameters) -> Self
The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
Sourcepub fn set_target_parameters(self, input: Option<PipeTargetParameters>) -> Self
pub fn set_target_parameters(self, input: Option<PipeTargetParameters>) -> Self
The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
Sourcepub fn get_target_parameters(&self) -> &Option<PipeTargetParameters>
pub fn get_target_parameters(&self) -> &Option<PipeTargetParameters>
The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The ARN of the role that allows the pipe to send data to the target.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The ARN of the role that allows the pipe to send data to the target.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The ARN of the role that allows the pipe to send data to the target.
Sourcepub fn log_configuration(self, input: PipeLogConfigurationParameters) -> Self
pub fn log_configuration(self, input: PipeLogConfigurationParameters) -> Self
The logging configuration settings for the pipe.
Sourcepub fn set_log_configuration(
self,
input: Option<PipeLogConfigurationParameters>,
) -> Self
pub fn set_log_configuration( self, input: Option<PipeLogConfigurationParameters>, ) -> Self
The logging configuration settings for the pipe.
Sourcepub fn get_log_configuration(&self) -> &Option<PipeLogConfigurationParameters>
pub fn get_log_configuration(&self) -> &Option<PipeLogConfigurationParameters>
The logging configuration settings for the pipe.
Sourcepub fn kms_key_identifier(self, input: impl Into<String>) -> Self
pub fn kms_key_identifier(self, input: impl Into<String>) -> Self
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.
To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.
For more information, see Managing keys in the Key Management Service Developer Guide.
Sourcepub fn set_kms_key_identifier(self, input: Option<String>) -> Self
pub fn set_kms_key_identifier(self, input: Option<String>) -> Self
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.
To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.
For more information, see Managing keys in the Key Management Service Developer Guide.
Sourcepub fn get_kms_key_identifier(&self) -> &Option<String>
pub fn get_kms_key_identifier(&self) -> &Option<String>
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.
To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.
For more information, see Managing keys in the Key Management Service Developer Guide.
Trait Implementations§
Source§impl Clone for UpdatePipeFluentBuilder
impl Clone for UpdatePipeFluentBuilder
Source§fn clone(&self) -> UpdatePipeFluentBuilder
fn clone(&self) -> UpdatePipeFluentBuilder
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 UpdatePipeFluentBuilder
impl !RefUnwindSafe for UpdatePipeFluentBuilder
impl Send for UpdatePipeFluentBuilder
impl Sync for UpdatePipeFluentBuilder
impl Unpin for UpdatePipeFluentBuilder
impl !UnwindSafe for UpdatePipeFluentBuilder
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);