AWS.Backup (aws-elixir v0.8.0) View Source

AWS Backup

AWS Backup is a unified backup service designed to protect AWS services and their associated data.

AWS Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.

Link to this section Summary

Functions

Creates a backup plan using a backup plan name and backup rules.

Creates a JSON document that specifies a set of resources to assign to a backup plan.

Creates a logical container where backups are stored.

Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

Deletes the backup vault identified by its name.

Deletes the policy document that manages permissions on a backup vault.

Deletes event notifications for the specified backup vault.

Deletes the recovery point specified by a recovery point ID.

Returns backup job details for the specified BackupJobId.

Returns metadata about a backup vault specified by its name.

Returns metadata associated with creating a copy of a resource.

Describes the global settings of the AWS account, including whether it is opted in to cross-account backup.

Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

Returns the current service opt-in settings for the Region.

Returns metadata associated with a restore job that is specified by a job ID.

Deletes the specified continuous backup recovery point from AWS Backup and releases control of that continuous backup to the source service, such as Amazon RDS.

Returns the backup plan that is specified by the plan ID as a backup template.

Returns BackupPlan details for the specified BackupPlanId.

Returns a valid JSON document specifying a backup plan or an error.

Returns the template specified by its templateId as a backup plan.

Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

Returns the access policy document that is associated with the named backup vault.

Returns event notifications for the specified backup vault.

Returns a set of metadata key-value pairs that were used to create the backup.

Returns the AWS resource types supported by AWS Backup.

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

Returns a list of existing backup plans for an authenticated account.

Returns an array containing metadata of the resources associated with the target backup plan.

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

Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).

Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

Sets a resource-based policy that is used to manage access permissions on the target backup vault.

Turns on notifications on a backup vault for the specified topic and events.

Starts an on-demand backup job for the specified resource.

Starts a job to create a one-time copy of the specified resource.

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Attempts to cancel a job to create a one-time backup of a resource.

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format.

Updates the current global settings for the AWS account.

Updates the current service opt-in settings for the Region.

Link to this section Functions

Link to this function

create_backup_plan(client, input, options \\ [])

View Source

Creates a backup plan using a backup plan name and backup rules.

A backup plan is a document that contains information that AWS Backup uses to schedule tasks that create recovery points for resources.

If you call CreateBackupPlan with a plan that already exists, an AlreadyExistsException is returned.

Link to this function

create_backup_selection(client, backup_plan_id, input, options \\ [])

View Source

Creates a JSON document that specifies a set of resources to assign to a backup plan.

Resources can be included by specifying patterns for a ListOfTags and selected Resources.

For example, consider the following patterns:

  • Resources: "arn:aws:ec2:region:account-id:volume/volume-id"

  • ConditionKey:"department"

ConditionValue:"finance"

ConditionType:"StringEquals"

  • ConditionKey:"importance"

ConditionValue:"critical"

ConditionType:"StringEquals"

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume ID.

Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically put together using the OR operator. In other words, all patterns that match are selected for backup.

Link to this function

create_backup_vault(client, backup_vault_name, input, options \\ [])

View Source

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.

Sensitive data, such as passport numbers, should not be included the name of a backup vault.

Link to this function

delete_backup_plan(client, backup_plan_id, input, options \\ [])

View Source

Deletes a backup plan.

A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.

Link to this function

delete_backup_selection(client, backup_plan_id, selection_id, input, options \\ [])

View Source

Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

Link to this function

delete_backup_vault(client, backup_vault_name, input, options \\ [])

View Source

Deletes the backup vault identified by its name.

A vault can be deleted only if it is empty.

Link to this function

delete_backup_vault_access_policy(client, backup_vault_name, input, options \\ [])

View Source

Deletes the policy document that manages permissions on a backup vault.

Link to this function

delete_backup_vault_notifications(client, backup_vault_name, input, options \\ [])

View Source

Deletes event notifications for the specified backup vault.

Link to this function

delete_recovery_point(client, backup_vault_name, recovery_point_arn, input, options \\ [])

View Source

Deletes the recovery point specified by a recovery point ID.

If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.

Link to this function

describe_backup_job(client, backup_job_id, options \\ [])

View Source

Returns backup job details for the specified BackupJobId.

Link to this function

describe_backup_vault(client, backup_vault_name, options \\ [])

View Source

Returns metadata about a backup vault specified by its name.

Link to this function

describe_copy_job(client, copy_job_id, options \\ [])

View Source

Returns metadata associated with creating a copy of a resource.

Link to this function

describe_global_settings(client, options \\ [])

View Source

Describes the global settings of the AWS account, including whether it is opted in to cross-account backup.

Link to this function

describe_protected_resource(client, resource_arn, options \\ [])

View Source

Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.

Link to this function

describe_recovery_point(client, backup_vault_name, recovery_point_arn, options \\ [])

View Source

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

Link to this function

describe_region_settings(client, options \\ [])

View Source

Returns the current service opt-in settings for the Region.

If service-opt-in is enabled for a service, AWS Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, AWS Backup does not try to protect that service's resources in this Region, AWS Backup does not try to protect that service's resources in this Region.

Link to this function

describe_restore_job(client, restore_job_id, options \\ [])

View Source

Returns metadata associated with a restore job that is specified by a job ID.

Link to this function

disassociate_recovery_point(client, backup_vault_name, recovery_point_arn, input, options \\ [])

View Source

Deletes the specified continuous backup recovery point from AWS Backup and releases control of that continuous backup to the source service, such as Amazon RDS.

The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.

Does not support snapshot backup recovery points.

Link to this function

export_backup_plan_template(client, backup_plan_id, options \\ [])

View Source

Returns the backup plan that is specified by the plan ID as a backup template.

Link to this function

get_backup_plan(client, backup_plan_id, version_id \\ nil, options \\ [])

View Source

Returns BackupPlan details for the specified BackupPlanId.

The details are the body of a backup plan in JSON format, in addition to plan metadata.

Link to this function

get_backup_plan_from_json(client, input, options \\ [])

View Source

Returns a valid JSON document specifying a backup plan or an error.

Link to this function

get_backup_plan_from_template(client, backup_plan_template_id, options \\ [])

View Source

Returns the template specified by its templateId as a backup plan.

Link to this function

get_backup_selection(client, backup_plan_id, selection_id, options \\ [])

View Source

Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

Link to this function

get_backup_vault_access_policy(client, backup_vault_name, options \\ [])

View Source

Returns the access policy document that is associated with the named backup vault.

Link to this function

get_backup_vault_notifications(client, backup_vault_name, options \\ [])

View Source

Returns event notifications for the specified backup vault.

Link to this function

get_recovery_point_restore_metadata(client, backup_vault_name, recovery_point_arn, options \\ [])

View Source

Returns a set of metadata key-value pairs that were used to create the backup.

Link to this function

get_supported_resource_types(client, options \\ [])

View Source

Returns the AWS resource types supported by AWS Backup.

Link to this function

list_backup_jobs(client, by_account_id \\ nil, by_backup_vault_name \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_resource_arn \\ nil, by_resource_type \\ nil, by_state \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of existing backup jobs for an authenticated account for the last 30 days.

For a longer period of time, consider using these monitoring tools.

Link to this function

list_backup_plan_templates(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

Link to this function

list_backup_plan_versions(client, backup_plan_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

Link to this function

list_backup_plans(client, include_deleted \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of existing backup plans for an authenticated account.

The list is populated only if the advanced option is set for the backup plan. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

Link to this function

list_backup_selections(client, backup_plan_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns an array containing metadata of the resources associated with the target backup plan.

Link to this function

list_backup_vaults(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_copy_jobs(client, by_account_id \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_destination_vault_arn \\ nil, by_resource_arn \\ nil, by_resource_type \\ nil, by_state \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns metadata about your copy jobs.

Link to this function

list_protected_resources(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

Link to this function

list_recovery_points_by_backup_vault(client, backup_vault_name, by_backup_plan_id \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_resource_arn \\ nil, by_resource_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns detailed information about the recovery points stored in a backup vault.

Link to this function

list_recovery_points_by_resource(client, resource_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).

Link to this function

list_restore_jobs(client, by_account_id \\ nil, by_created_after \\ nil, by_created_before \\ nil, by_status \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.

Link to this function

list_tags(client, resource_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

ListTags are currently only supported with Amazon EFS backups.

Link to this function

put_backup_vault_access_policy(client, backup_vault_name, input, options \\ [])

View Source

Sets a resource-based policy that is used to manage access permissions on the target backup vault.

Requires a backup vault name and an access policy document in JSON format.

Link to this function

put_backup_vault_notifications(client, backup_vault_name, input, options \\ [])

View Source

Turns on notifications on a backup vault for the specified topic and events.

Link to this function

start_backup_job(client, input, options \\ [])

View Source

Starts an on-demand backup job for the specified resource.

Link to this function

start_copy_job(client, input, options \\ [])

View Source

Starts a job to create a one-time copy of the specified resource.

Does not support continuous backups.

Link to this function

start_restore_job(client, input, options \\ [])

View Source

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Link to this function

stop_backup_job(client, backup_job_id, input, options \\ [])

View Source

Attempts to cancel a job to create a one-time backup of a resource.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

Link to this function

update_backup_plan(client, backup_plan_id, input, options \\ [])

View Source

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format.

The new version is uniquely identified by a VersionId.

Link to this function

update_global_settings(client, input, options \\ [])

View Source

Updates the current global settings for the AWS account.

Use the DescribeGlobalSettings API to determine the current settings.

Link to this function

update_recovery_point_lifecycle(client, backup_vault_name, recovery_point_arn, input, options \\ [])

View Source

Sets the transition lifecycle of a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

Does not support continuous backups.

Link to this function

update_region_settings(client, input, options \\ [])

View Source

Updates the current service opt-in settings for the Region.

If service-opt-in is enabled for a service, AWS Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, AWS Backup does not try to protect that service's resources in this Region. Use the DescribeRegionSettings API to determine the resource types that are supported.