aws_sdk_pipes/client/

update_pipe.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdatePipe`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::set_name):<br>required: **true**<br><p>The name of the pipe.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::set_description):<br>required: **false**<br><p>A description of the pipe.</p><br>
    ///   - [`desired_state(RequestedPipeState)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::desired_state) / [`set_desired_state(Option<RequestedPipeState>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::set_desired_state):<br>required: **false**<br><p>The state the pipe should be in.</p><br>
    ///   - [`source_parameters(UpdatePipeSourceParameters)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::source_parameters) / [`set_source_parameters(Option<UpdatePipeSourceParameters>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::set_source_parameters):<br>required: **false**<br><p>The parameters required to set up a source for your pipe.</p><br>
    ///   - [`enrichment(impl Into<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::enrichment) / [`set_enrichment(Option<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::set_enrichment):<br>required: **false**<br><p>The ARN of the enrichment resource.</p><br>
    ///   - [`enrichment_parameters(PipeEnrichmentParameters)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::enrichment_parameters) / [`set_enrichment_parameters(Option<PipeEnrichmentParameters>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::set_enrichment_parameters):<br>required: **false**<br><p>The parameters required to set up enrichment on your pipe.</p><br>
    ///   - [`target(impl Into<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::target) / [`set_target(Option<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::set_target):<br>required: **false**<br><p>The ARN of the target resource.</p><br>
    ///   - [`target_parameters(PipeTargetParameters)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::target_parameters) / [`set_target_parameters(Option<PipeTargetParameters>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::set_target_parameters):<br>required: **false**<br><p>The parameters required to set up a target for your pipe.</p> <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::set_role_arn):<br>required: **true**<br><p>The ARN of the role that allows the pipe to send data to the target.</p><br>
    ///   - [`log_configuration(PipeLogConfigurationParameters)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::log_configuration) / [`set_log_configuration(Option<PipeLogConfigurationParameters>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::set_log_configuration):<br>required: **false**<br><p>The logging configuration settings for the pipe.</p><br>
    ///   - [`kms_key_identifier(impl Into<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::kms_key_identifier) / [`set_kms_key_identifier(Option<String>)`](crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::set_kms_key_identifier):<br>required: **false**<br><p>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.</p> <p>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.</p> <p>To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service Developer Guide</i>.</p><br>
    /// - On success, responds with [`UpdatePipeOutput`](crate::operation::update_pipe::UpdatePipeOutput) with field(s):
    ///   - [`arn(Option<String>)`](crate::operation::update_pipe::UpdatePipeOutput::arn): <p>The ARN of the pipe.</p>
    ///   - [`name(Option<String>)`](crate::operation::update_pipe::UpdatePipeOutput::name): <p>The name of the pipe.</p>
    ///   - [`desired_state(Option<RequestedPipeState>)`](crate::operation::update_pipe::UpdatePipeOutput::desired_state): <p>The state the pipe should be in.</p>
    ///   - [`current_state(Option<PipeState>)`](crate::operation::update_pipe::UpdatePipeOutput::current_state): <p>The state the pipe is in.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::update_pipe::UpdatePipeOutput::creation_time): <p>The time the pipe was created.</p>
    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::update_pipe::UpdatePipeOutput::last_modified_time): <p>When the pipe was last updated, in <a href="https://www.w3.org/TR/NOTE-datetime">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD).</p>
    /// - On failure, responds with [`SdkError<UpdatePipeError>`](crate::operation::update_pipe::UpdatePipeError)
    pub fn update_pipe(&self) -> crate::operation::update_pipe::builders::UpdatePipeFluentBuilder {
        crate::operation::update_pipe::builders::UpdatePipeFluentBuilder::new(self.handle.clone())
    }
}