aws_sdk_eventbridge/client/
update_archive.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateArchive`](crate::operation::update_archive::builders::UpdateArchiveFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`archive_name(impl Into<String>)`](crate::operation::update_archive::builders::UpdateArchiveFluentBuilder::archive_name) / [`set_archive_name(Option<String>)`](crate::operation::update_archive::builders::UpdateArchiveFluentBuilder::set_archive_name):<br>required: **true**<br><p>The name of the archive to update.</p><br>
7    ///   - [`description(impl Into<String>)`](crate::operation::update_archive::builders::UpdateArchiveFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_archive::builders::UpdateArchiveFluentBuilder::set_description):<br>required: **false**<br><p>The description for the archive.</p><br>
8    ///   - [`event_pattern(impl Into<String>)`](crate::operation::update_archive::builders::UpdateArchiveFluentBuilder::event_pattern) / [`set_event_pattern(Option<String>)`](crate::operation::update_archive::builders::UpdateArchiveFluentBuilder::set_event_pattern):<br>required: **false**<br><p>The event pattern to use to filter events sent to the archive.</p><br>
9    ///   - [`retention_days(i32)`](crate::operation::update_archive::builders::UpdateArchiveFluentBuilder::retention_days) / [`set_retention_days(Option<i32>)`](crate::operation::update_archive::builders::UpdateArchiveFluentBuilder::set_retention_days):<br>required: **false**<br><p>The number of days to retain events in the archive.</p><br>
10    ///   - [`kms_key_identifier(impl Into<String>)`](crate::operation::update_archive::builders::UpdateArchiveFluentBuilder::kms_key_identifier) / [`set_kms_key_identifier(Option<String>)`](crate::operation::update_archive::builders::UpdateArchiveFluentBuilder::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 this archive. 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 the archive.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html">Identify and view keys</a> in the <i>Key Management Service Developer Guide</i>.</p><important>  <p>If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.</p>  <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html">Encrypting archives</a> in the <i>Amazon EventBridge User Guide</i>.</p> </important><br>
11    /// - On success, responds with [`UpdateArchiveOutput`](crate::operation::update_archive::UpdateArchiveOutput) with field(s):
12    ///   - [`archive_arn(Option<String>)`](crate::operation::update_archive::UpdateArchiveOutput::archive_arn): <p>The ARN of the archive.</p>
13    ///   - [`state(Option<ArchiveState>)`](crate::operation::update_archive::UpdateArchiveOutput::state): <p>The state of the archive.</p>
14    ///   - [`state_reason(Option<String>)`](crate::operation::update_archive::UpdateArchiveOutput::state_reason): <p>The reason that the archive is in the current state.</p>
15    ///   - [`creation_time(Option<DateTime>)`](crate::operation::update_archive::UpdateArchiveOutput::creation_time): <p>The time at which the archive was updated.</p>
16    /// - On failure, responds with [`SdkError<UpdateArchiveError>`](crate::operation::update_archive::UpdateArchiveError)
17    pub fn update_archive(&self) -> crate::operation::update_archive::builders::UpdateArchiveFluentBuilder {
18        crate::operation::update_archive::builders::UpdateArchiveFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_eventbridge/client/update_archive.rs

aws_sdk_eventbridge/client/
update_archive.rs
