aws_sdk_eventbridge/client/

update_event_bus.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateEventBus`](crate::operation::update_event_bus::builders::UpdateEventBusFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::update_event_bus::builders::UpdateEventBusFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_event_bus::builders::UpdateEventBusFluentBuilder::set_name):<br>required: **false**<br><p>The name of the event bus.</p><br>
    ///   - [`kms_key_identifier(impl Into<String>)`](crate::operation::update_event_bus::builders::UpdateEventBusFluentBuilder::kms_key_identifier) / [`set_kms_key_identifier(Option<String>)`](crate::operation::update_event_bus::builders::UpdateEventBusFluentBuilder::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 events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p> <p>If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus.</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><note>  <p>Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:</p>  <ul>   <li>    <p>You call <code> <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateArchive.html">CreateArchive</a> </code> on an event bus set to use a customer managed key for encryption.</p></li>   <li>    <p>You call <code> <a href="https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer">CreateDiscoverer</a> </code> on an event bus set to use a customer managed key for encryption.</p></li>   <li>    <p>You call <code> <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html">UpdatedEventBus</a> </code> to set a customer managed key on an event bus with an archives or schema discovery enabled.</p></li>  </ul>  <p>To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html">Data encryption in EventBridge</a> in the <i>Amazon EventBridge User Guide</i>.</p> </note><br>
    ///   - [`description(impl Into<String>)`](crate::operation::update_event_bus::builders::UpdateEventBusFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_event_bus::builders::UpdateEventBusFluentBuilder::set_description):<br>required: **false**<br><p>The event bus description.</p><br>
    ///   - [`dead_letter_config(DeadLetterConfig)`](crate::operation::update_event_bus::builders::UpdateEventBusFluentBuilder::dead_letter_config) / [`set_dead_letter_config(Option<DeadLetterConfig>)`](crate::operation::update_event_bus::builders::UpdateEventBusFluentBuilder::set_dead_letter_config):<br>required: **false**<br><p>Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).</p> <p>For more information, see <a href="eventbridge/latest/userguide/eb-rule-dlq.html">Event retry policy and using dead-letter queues</a> in the <i>EventBridge User Guide</i>.</p><br>
    /// - On success, responds with [`UpdateEventBusOutput`](crate::operation::update_event_bus::UpdateEventBusOutput) with field(s):
    ///   - [`arn(Option<String>)`](crate::operation::update_event_bus::UpdateEventBusOutput::arn): <p>The event bus Amazon Resource Name (ARN).</p>
    ///   - [`name(Option<String>)`](crate::operation::update_event_bus::UpdateEventBusOutput::name): <p>The event bus name.</p>
    ///   - [`kms_key_identifier(Option<String>)`](crate::operation::update_event_bus::UpdateEventBusOutput::kms_key_identifier): <p>The identifier of the KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html">Data encryption in EventBridge</a> in the <i>Amazon EventBridge User Guide</i>.</p>
    ///   - [`description(Option<String>)`](crate::operation::update_event_bus::UpdateEventBusOutput::description): <p>The event bus description.</p>
    ///   - [`dead_letter_config(Option<DeadLetterConfig>)`](crate::operation::update_event_bus::UpdateEventBusOutput::dead_letter_config): <p>Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).</p> <p>For more information, see <a href="eventbridge/latest/userguide/eb-rule-dlq.html">Event retry policy and using dead-letter queues</a> in the <i>EventBridge User Guide</i>.</p>
    /// - On failure, responds with [`SdkError<UpdateEventBusError>`](crate::operation::update_event_bus::UpdateEventBusError)
    pub fn update_event_bus(&self) -> crate::operation::update_event_bus::builders::UpdateEventBusFluentBuilder {
        crate::operation::update_event_bus::builders::UpdateEventBusFluentBuilder::new(self.handle.clone())
    }
}