Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/backup.ts?docs=full";

§Classes

Backup

§Interfaces

AdvancedBackupSetting

The backup options for each resource type.

BackupJob

Contains detailed information about a backup job.

BackupJobSummary

This is a summary of jobs created or running within the most recent 30 days.

BackupPlan

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of Amazon Web Services resources.

BackupPlanInput

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task.

BackupPlansListMember

Contains metadata about a backup plan.

BackupPlanTemplatesListMember

An object specifying metadata associated with a backup plan template.

BackupRule

Specifies a scheduled task used to back up a selection of resources.

BackupRuleInput

Specifies a scheduled task used to back up a selection of resources.

BackupSelection

Used to specify a set of resources to a backup plan.

BackupSelectionsListMember

Contains metadata about a BackupSelection object.

BackupVaultListMember

Contains metadata about a backup vault.

CalculatedLifecycle

Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify a lifecycle for a recovery point.

CancelLegalHoldInput
Condition

Contains an array of triplets made up of a condition type (such as StringEquals), a key, and a value. Used to filter resources using their tags and assign them to a backup plan. Case sensitive.

ConditionParameter

Includes information about tags you define to assign tagged resources to a backup plan.

Conditions

Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive.

ControlInputParameter

The parameters for a control. A control can have zero, one, or more than one parameter. An example of a control with two parameters is: "backup plan frequency is at least daily and the retention period is at least 1 year". The first parameter is daily. The second parameter is 1 year.

ControlScope

A framework consists of one or more controls. Each control has its own control scope. The control scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

CopyAction

The details of the copy operation.

CopyJob

Contains detailed information about a copy job.

CopyJobSummary

This is a summary of copy jobs created or running within the most recent 30 days.

CreateBackupPlanInput
CreateBackupPlanOutput
CreateBackupSelectionInput
CreateBackupSelectionOutput
CreateBackupVaultInput
CreateBackupVaultOutput
CreateFrameworkInput
CreateFrameworkOutput
CreateLegalHoldInput
CreateLegalHoldOutput
CreateLogicallyAirGappedBackupVaultInput
CreateLogicallyAirGappedBackupVaultOutput
CreateReportPlanInput
CreateReportPlanOutput
CreateRestoreTestingPlanInput
CreateRestoreTestingPlanOutput
CreateRestoreTestingSelectionInput
CreateRestoreTestingSelectionOutput
DateRange

This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.

DeleteBackupPlanInput
DeleteBackupPlanOutput
DeleteBackupSelectionInput
DeleteBackupVaultAccessPolicyInput
DeleteBackupVaultInput
DeleteBackupVaultLockConfigurationInput
DeleteBackupVaultNotificationsInput
DeleteFrameworkInput
DeleteRecoveryPointInput
DeleteReportPlanInput
DeleteRestoreTestingPlanInput
DeleteRestoreTestingSelectionInput
DescribeBackupJobInput
DescribeBackupJobOutput
DescribeBackupVaultInput
DescribeBackupVaultOutput
DescribeCopyJobInput
DescribeCopyJobOutput
DescribeFrameworkInput
DescribeFrameworkOutput
DescribeGlobalSettingsOutput
DescribeProtectedResourceInput
DescribeProtectedResourceOutput
DescribeRecoveryPointInput
DescribeRecoveryPointOutput
DescribeRegionSettingsOutput
DescribeReportJobInput
DescribeReportJobOutput
DescribeReportPlanInput
DescribeReportPlanOutput
DescribeRestoreJobInput
DescribeRestoreJobOutput
DisassociateRecoveryPointFromParentInput
DisassociateRecoveryPointInput
ExportBackupPlanTemplateInput
ExportBackupPlanTemplateOutput
Framework

Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.

FrameworkControl

Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.

GetBackupPlanFromJSONInput
GetBackupPlanFromJSONOutput
GetBackupPlanFromTemplateInput
GetBackupPlanFromTemplateOutput
GetBackupPlanInput
GetBackupPlanOutput
GetBackupSelectionInput
GetBackupSelectionOutput
GetBackupVaultAccessPolicyInput
GetBackupVaultAccessPolicyOutput
GetBackupVaultNotificationsInput
GetBackupVaultNotificationsOutput
GetLegalHoldInput
GetLegalHoldOutput
GetRecoveryPointRestoreMetadataInput
GetRecoveryPointRestoreMetadataOutput
GetRestoreJobMetadataInput
GetRestoreJobMetadataOutput
GetRestoreTestingInferredMetadataInput
GetRestoreTestingInferredMetadataOutput
GetRestoreTestingPlanInput
GetRestoreTestingPlanOutput
GetRestoreTestingSelectionInput
GetRestoreTestingSelectionOutput
GetSupportedResourceTypesOutput
KeyValue

Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /

LegalHold

A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.

Lifecycle

Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.

ListBackupJobsInput
ListBackupJobsOutput
ListBackupJobSummariesInput
ListBackupJobSummariesOutput
ListBackupPlansInput
ListBackupPlansOutput
ListBackupPlanTemplatesInput
ListBackupPlanTemplatesOutput
ListBackupPlanVersionsInput
ListBackupPlanVersionsOutput
ListBackupSelectionsInput
ListBackupSelectionsOutput
ListBackupVaultsInput
ListBackupVaultsOutput
ListCopyJobsInput
ListCopyJobsOutput
ListCopyJobSummariesInput
ListCopyJobSummariesOutput
ListFrameworksInput
ListFrameworksOutput
ListLegalHoldsInput
ListLegalHoldsOutput
ListProtectedResourcesByBackupVaultInput
ListProtectedResourcesByBackupVaultOutput
ListProtectedResourcesInput
ListProtectedResourcesOutput
ListRecoveryPointsByBackupVaultInput
ListRecoveryPointsByBackupVaultOutput
ListRecoveryPointsByLegalHoldInput
ListRecoveryPointsByLegalHoldOutput
ListRecoveryPointsByResourceInput
ListRecoveryPointsByResourceOutput
ListReportJobsInput
ListReportJobsOutput
ListReportPlansInput
ListReportPlansOutput
ListRestoreJobsByProtectedResourceInput
ListRestoreJobsByProtectedResourceOutput
ListRestoreJobsInput
ListRestoreJobsOutput
ListRestoreJobSummariesInput
ListRestoreJobSummariesOutput
ListRestoreTestingPlansInput
ListRestoreTestingPlansOutput
ListRestoreTestingSelectionsInput
ListRestoreTestingSelectionsOutput
ListTagsInput
ListTagsOutput
ProtectedResource

A structure that contains information about a backed-up resource.

ProtectedResourceConditions

The conditions that you define for resources in your restore testing plan using tags.

PutBackupVaultAccessPolicyInput
PutBackupVaultLockConfigurationInput
PutBackupVaultNotificationsInput
PutRestoreValidationResultInput
RecoveryPointByBackupVault

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

RecoveryPointByResource

Contains detailed information about a saved recovery point.

RecoveryPointCreator

Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

RecoveryPointMember

This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member.

RecoveryPointSelection

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

ReportDeliveryChannel

Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

ReportDestination

Contains information from your report job about your report destination.

ReportJob

Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.

ReportPlan

Contains detailed information about a report plan.

ReportSetting

Contains detailed information about a report setting.

RestoreJobCreator

Contains information about the restore testing plan that Backup used to initiate the restore job.

RestoreJobsListMember

Contains metadata about a restore job.

RestoreJobSummary

This is a summary of restore jobs created or running within the most recent 30 days.

RestoreTestingPlanForCreate

This contains metadata about a restore testing plan.

RestoreTestingPlanForGet

This contains metadata about a restore testing plan.

RestoreTestingPlanForList

This contains metadata about a restore testing plan.

RestoreTestingPlanForUpdate

This contains metadata about a restore testing plan.

RestoreTestingRecoveryPointSelection

RecoveryPointSelection has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with Algorithm if you want the latest recovery point within your SelectionWindowDays or if you want a random recovery point, and you must indicate through IncludeVaults from which vaults the recovery points can be chosen.

RestoreTestingSelectionForCreate

This contains metadata about a specific restore testing selection.

RestoreTestingSelectionForGet

This contains metadata about a restore testing selection.

RestoreTestingSelectionForList

This contains metadata about a restore testing selection.

RestoreTestingSelectionForUpdate

This contains metadata about a restore testing selection.

StartBackupJobInput
StartBackupJobOutput
StartCopyJobInput
StartCopyJobOutput
StartReportJobInput
StartReportJobOutput
StartRestoreJobInput
StartRestoreJobOutput
StopBackupJobInput
TagResourceInput
UntagResourceInput
UpdateBackupPlanInput
UpdateBackupPlanOutput
UpdateFrameworkInput
UpdateFrameworkOutput
UpdateGlobalSettingsInput
UpdateRecoveryPointLifecycleInput
UpdateRecoveryPointLifecycleOutput
UpdateRegionSettingsInput
UpdateReportPlanInput
UpdateReportPlanOutput
UpdateRestoreTestingPlanInput
UpdateRestoreTestingPlanOutput
UpdateRestoreTestingSelectionInput
UpdateRestoreTestingSelectionOutput

§Type Aliases

AggregationPeriod
BackupJobState
BackupJobStatus
BackupVaultEvent
ConditionType
CopyJobState
CopyJobStatus
LegalHoldStatus
RecoveryPointStatus
RestoreDeletionStatus
RestoreJobState
RestoreJobStatus
RestoreTestingRecoveryPointSelectionAlgorithm
RestoreTestingRecoveryPointType
RestoreValidationStatus
StorageClass
VaultState
VaultType