aws_sdk_cloudhsmv2/client/

modify_backup_attributes.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ModifyBackupAttributes`](crate::operation::modify_backup_attributes::builders::ModifyBackupAttributesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`backup_id(impl Into<String>)`](crate::operation::modify_backup_attributes::builders::ModifyBackupAttributesFluentBuilder::backup_id) / [`set_backup_id(Option<String>)`](crate::operation::modify_backup_attributes::builders::ModifyBackupAttributesFluentBuilder::set_backup_id):<br>required: **true**<br><p>The identifier (ID) of the backup to modify. To find the ID of a backup, use the <code>DescribeBackups</code> operation.</p><br>
    ///   - [`never_expires(bool)`](crate::operation::modify_backup_attributes::builders::ModifyBackupAttributesFluentBuilder::never_expires) / [`set_never_expires(Option<bool>)`](crate::operation::modify_backup_attributes::builders::ModifyBackupAttributesFluentBuilder::set_never_expires):<br>required: **true**<br><p>Specifies whether the service should exempt a backup from the retention policy for the cluster. <code>True</code> exempts a backup from the retention policy. <code>False</code> means the service applies the backup retention policy defined at the cluster.</p><br>
    /// - On success, responds with [`ModifyBackupAttributesOutput`](crate::operation::modify_backup_attributes::ModifyBackupAttributesOutput) with field(s):
    ///   - [`backup(Option<Backup>)`](crate::operation::modify_backup_attributes::ModifyBackupAttributesOutput::backup): <p>Contains information about a backup of an CloudHSM cluster. All backup objects contain the <code>BackupId</code>, <code>BackupState</code>, <code>ClusterId</code>, and <code>CreateTimestamp</code> parameters. Backups that were copied into a destination region additionally contain the <code>CopyTimestamp</code>, <code>SourceBackup</code>, <code>SourceCluster</code>, and <code>SourceRegion</code> parameters. A backup that is pending deletion will include the <code>DeleteTimestamp</code> parameter.</p>
    /// - On failure, responds with [`SdkError<ModifyBackupAttributesError>`](crate::operation::modify_backup_attributes::ModifyBackupAttributesError)
    pub fn modify_backup_attributes(&self) -> crate::operation::modify_backup_attributes::builders::ModifyBackupAttributesFluentBuilder {
        crate::operation::modify_backup_attributes::builders::ModifyBackupAttributesFluentBuilder::new(self.handle.clone())
    }
}