backup_vault#

State module for managing backup vault.

async idem_aws.states.aws.backup.backup_vault.present(hub, ctx, name: str, resource_id: str = None, encryption_key_arn: str = None, creator_request_id: str = None, tags: Dict[str, str] = None) → Dict[str, Any][source]#

Create/Update the backup vault.

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

Parameters:

  • name (str) – An Idem name of the resource. 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 Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

  • resource_id (str, Optional) – An Idem resource id of the resource as well as name of the backup vault.

  • encryption_key_arn (str, Optional) – The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

  • creator_request_id (str, Optional) – A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or ‘-_.’ characters.

  • tags (dict, Optional) – Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

Request Syntax:
vault_name:
  aws.backup.backup_vault.present:
  - name: "string"
  - resource_id: "string"
  - encryption_key_arn: "string"
  - creator_request_id: "string"
  - tags: "dict"
Returns:

Dict[str, Any]

Examples

resource_is_present:
  aws.backup.backup_vault.present:
    - name: idem_backup_vault
    - resource_id: idem_backup_vault
    - encryption_key_arn: arn:aws:kms:us-east-1:011922870716:key/ff4fd718-612c-4d0f-8172-8150025bb4fa
    - tags:
        name: backup_vault
async idem_aws.states.aws.backup.backup_vault.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

Deletes the backup vault.

Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

Parameters:

  • name (str) – Idem name of the backup vault.

  • resource_id (str) – Name of the backup vault to be deleted, Idem automatically considers this resource being absent if this field is not specified.

Request Syntax:
vault_name:
  aws.backup.backup_vault.absent:
    - name: "string"
    - resource_id: "string"
Returns:

Dict[str, Any]

Examples

vault_name:
  aws.backup.backup_vault.absent:
    - name: idem_backup_vault
    - resource_id: idem_backup_vault
async idem_aws.states.aws.backup.backup_vault.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Gets information about the backup vault.

Returns a list of recovery point storage containers along with information about them.

Returns:

Dict[str, Dict[str, Any]]

Examples

$ idem describe aws.backup.backup_Vault