aws_sdk_backup/client/

update_recovery_point_index_settings.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateRecoveryPointIndexSettings`](crate::operation::update_recovery_point_index_settings::builders::UpdateRecoveryPointIndexSettingsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`backup_vault_name(impl Into<String>)`](crate::operation::update_recovery_point_index_settings::builders::UpdateRecoveryPointIndexSettingsFluentBuilder::backup_vault_name) / [`set_backup_vault_name(Option<String>)`](crate::operation::update_recovery_point_index_settings::builders::UpdateRecoveryPointIndexSettingsFluentBuilder::set_backup_vault_name):<br>required: **true**<br><p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.</p> <p>Accepted characters include lowercase letters, numbers, and hyphens.</p><br>
    ///   - [`recovery_point_arn(impl Into<String>)`](crate::operation::update_recovery_point_index_settings::builders::UpdateRecoveryPointIndexSettingsFluentBuilder::recovery_point_arn) / [`set_recovery_point_arn(Option<String>)`](crate::operation::update_recovery_point_index_settings::builders::UpdateRecoveryPointIndexSettingsFluentBuilder::set_recovery_point_arn):<br>required: **true**<br><p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p><br>
    ///   - [`iam_role_arn(impl Into<String>)`](crate::operation::update_recovery_point_index_settings::builders::UpdateRecoveryPointIndexSettingsFluentBuilder::iam_role_arn) / [`set_iam_role_arn(Option<String>)`](crate::operation::update_recovery_point_index_settings::builders::UpdateRecoveryPointIndexSettingsFluentBuilder::set_iam_role_arn):<br>required: **false**<br><p>This specifies the IAM role ARN used for this operation.</p> <p>For example, arn:aws:iam::123456789012:role/S3Access</p><br>
    ///   - [`index(Index)`](crate::operation::update_recovery_point_index_settings::builders::UpdateRecoveryPointIndexSettingsFluentBuilder::index) / [`set_index(Option<Index>)`](crate::operation::update_recovery_point_index_settings::builders::UpdateRecoveryPointIndexSettingsFluentBuilder::set_index):<br>required: **true**<br><p>Index can have 1 of 2 possible values, either <code>ENABLED</code> or <code>DISABLED</code>.</p> <p>To create a backup index for an eligible <code>ACTIVE</code> recovery point that does not yet have a backup index, set value to <code>ENABLED</code>.</p> <p>To delete a backup index, set value to <code>DISABLED</code>.</p><br>
    /// - On success, responds with [`UpdateRecoveryPointIndexSettingsOutput`](crate::operation::update_recovery_point_index_settings::UpdateRecoveryPointIndexSettingsOutput) with field(s):
    ///   - [`backup_vault_name(Option<String>)`](crate::operation::update_recovery_point_index_settings::UpdateRecoveryPointIndexSettingsOutput::backup_vault_name): <p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.</p>
    ///   - [`recovery_point_arn(Option<String>)`](crate::operation::update_recovery_point_index_settings::UpdateRecoveryPointIndexSettingsOutput::recovery_point_arn): <p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
    ///   - [`index_status(Option<IndexStatus>)`](crate::operation::update_recovery_point_index_settings::UpdateRecoveryPointIndexSettingsOutput::index_status): <p>This is the current status for the backup index associated with the specified recovery point.</p> <p>Statuses are: <code>PENDING</code> | <code>ACTIVE</code> | <code>FAILED</code> | <code>DELETING</code></p> <p>A recovery point with an index that has the status of <code>ACTIVE</code> can be included in a search.</p>
    ///   - [`index(Option<Index>)`](crate::operation::update_recovery_point_index_settings::UpdateRecoveryPointIndexSettingsOutput::index): <p>Index can have 1 of 2 possible values, either <code>ENABLED</code> or <code>DISABLED</code>.</p> <p>A value of <code>ENABLED</code> means a backup index for an eligible <code>ACTIVE</code> recovery point has been created.</p> <p>A value of <code>DISABLED</code> means a backup index was deleted.</p>
    /// - On failure, responds with [`SdkError<UpdateRecoveryPointIndexSettingsError>`](crate::operation::update_recovery_point_index_settings::UpdateRecoveryPointIndexSettingsError)
    pub fn update_recovery_point_index_settings(
        &self,
    ) -> crate::operation::update_recovery_point_index_settings::builders::UpdateRecoveryPointIndexSettingsFluentBuilder {
        crate::operation::update_recovery_point_index_settings::builders::UpdateRecoveryPointIndexSettingsFluentBuilder::new(self.handle.clone())
    }
}