Struct aws_sdk_pipes::client::fluent_builders::UpdatePipe

pub struct UpdatePipe { /* private fields */ }

Fluent builder constructing a request to UpdatePipe.

Update an existing pipe. When you call UpdatePipe, only the fields that are included in the request are changed, the rest are unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that if you don't specify an optional field in one of these Parameters objects, that field will be set to its system-default value after the update.

For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Implementations

impl UpdatePipe

pub async fn customize(
    self
) -> Result<CustomizableOperation<UpdatePipe, AwsResponseRetryClassifier>, SdkError<UpdatePipeError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(self) -> Result<UpdatePipeOutput, SdkError<UpdatePipeError>>

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 name(self, input: impl Into<String>) -> Self

The name of the pipe.

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

The name of the pipe.

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

A description of the pipe.

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

A description of the pipe.

pub fn desired_state(self, input: RequestedPipeState) -> Self

The state the pipe should be in.

pub fn set_desired_state(self, input: Option<RequestedPipeState>) -> Self

The state the pipe should be in.

pub fn source_parameters(self, input: UpdatePipeSourceParameters) -> Self

The parameters required to set up a source for your pipe.

pub fn set_source_parameters(
    self,
    input: Option<UpdatePipeSourceParameters>
) -> Self

The parameters required to set up a source for your pipe.

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

The ARN of the enrichment resource.

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

The ARN of the enrichment resource.

pub fn enrichment_parameters(self, input: PipeEnrichmentParameters) -> Self

The parameters required to set up enrichment on your pipe.

pub fn set_enrichment_parameters(
    self,
    input: Option<PipeEnrichmentParameters>
) -> Self

The parameters required to set up enrichment on your pipe.

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

The ARN of the target resource.

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

The ARN of the target resource.

pub fn target_parameters(self, input: PipeTargetParameters) -> Self

The parameters required to set up a target for your pipe.

pub fn set_target_parameters(self, input: Option<PipeTargetParameters>) -> Self

The parameters required to set up a target for your pipe.

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.

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.

Trait Implementations

impl Clone for UpdatePipe

fn clone(&self) -> UpdatePipe

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdatePipe

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

Formats the value using the given formatter.