Skip to content

This operation updates the settings of a recovery point index

Description

This operation updates the settings of a recovery point index.

Required: BackupVaultName, RecoveryPointArn, and IAMRoleArn

Usage

backup_update_recovery_point_index_settings(BackupVaultName,
  RecoveryPointArn, IamRoleArn, Index)

Arguments

  • BackupVaultName

    [required] 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.

    Accepted characters include lowercase letters, numbers, and hyphens.

  • RecoveryPointArn

    [required] An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

  • IamRoleArn

    This specifies the IAM role ARN used for this operation.

    For example, arn:aws:iam::123456789012:role/S3Access

  • Index

    [required] Index can have 1 of 2 possible values, either ENABLED or DISABLED.

    To create a backup index for an eligible ACTIVE recovery point that does not yet have a backup index, set value to ENABLED.

    To delete a backup index, set value to DISABLED.

Value

A list with the following syntax:

list(
  BackupVaultName = "string",
  RecoveryPointArn = "string",
  IndexStatus = "PENDING"|"ACTIVE"|"FAILED"|"DELETING",
  Index = "ENABLED"|"DISABLED"
)

Request syntax

svc$update_recovery_point_index_settings(
  BackupVaultName = "string",
  RecoveryPointArn = "string",
  IamRoleArn = "string",
  Index = "ENABLED"|"DISABLED"
)