Backup class

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.

Constructors

Backup({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createBackupPlan({required BackupPlanInput backupPlan, Map<String, String>? backupPlanTags, String? creatorRequestId}) → Future<CreateBackupPlanOutput>
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.
createBackupSelection({required String backupPlanId, required BackupSelection backupSelection, String? creatorRequestId}) → Future<CreateBackupSelectionOutput>
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.
createBackupVault({required String backupVaultName, Map<String, String>? backupVaultTags, String? creatorRequestId, String? encryptionKeyArn}) → Future<CreateBackupVaultOutput>
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.
deleteBackupPlan({required String backupPlanId}) → Future<DeleteBackupPlanOutput>
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.
deleteBackupSelection({required String backupPlanId, required String selectionId}) → Future<void>
Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
deleteBackupVault({required String backupVaultName}) → Future<void>
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
deleteBackupVaultAccessPolicy({required String backupVaultName}) → Future<void>
Deletes the policy document that manages permissions on a backup vault.
deleteBackupVaultNotifications({required String backupVaultName}) → Future<void>
Deletes event notifications for the specified backup vault.
deleteRecoveryPoint({required String backupVaultName, required String recoveryPointArn}) → Future<void>
Deletes the recovery point specified by a recovery point ID.
describeBackupJob({required String backupJobId}) → Future<DescribeBackupJobOutput>
Returns backup job details for the specified BackupJobId.
describeBackupVault({required String backupVaultName}) → Future<DescribeBackupVaultOutput>
Returns metadata about a backup vault specified by its name.
describeCopyJob({required String copyJobId}) → Future<DescribeCopyJobOutput>
Returns metadata associated with creating a copy of a resource.
describeGlobalSettings() → Future<DescribeGlobalSettingsOutput>
The current feature settings for the AWS Account.
describeProtectedResource({required String resourceArn}) → Future<DescribeProtectedResourceOutput>
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.
describeRecoveryPoint({required String backupVaultName, required String recoveryPointArn}) → Future<DescribeRecoveryPointOutput>
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
describeRegionSettings() → Future<DescribeRegionSettingsOutput>
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.
describeRestoreJob({required String restoreJobId}) → Future<DescribeRestoreJobOutput>
Returns metadata associated with a restore job that is specified by a job ID.
exportBackupPlanTemplate({required String backupPlanId}) → Future<ExportBackupPlanTemplateOutput>
Returns the backup plan that is specified by the plan ID as a backup template.
getBackupPlan({required String backupPlanId, String? versionId}) → Future<GetBackupPlanOutput>
Returns BackupPlan details for the specified BackupPlanId. Returns the body of a backup plan in JSON format, in addition to plan metadata.
getBackupPlanFromJSON({required String backupPlanTemplateJson}) → Future<GetBackupPlanFromJSONOutput>
Returns a valid JSON document specifying a backup plan or an error.
getBackupPlanFromTemplate({required String backupPlanTemplateId}) → Future<GetBackupPlanFromTemplateOutput>
Returns the template specified by its templateId as a backup plan.
getBackupSelection({required String backupPlanId, required String selectionId}) → Future<GetBackupSelectionOutput>
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
getBackupVaultAccessPolicy({required String backupVaultName}) → Future<GetBackupVaultAccessPolicyOutput>
Returns the access policy document that is associated with the named backup vault.
getBackupVaultNotifications({required String backupVaultName}) → Future<GetBackupVaultNotificationsOutput>
Returns event notifications for the specified backup vault.
getRecoveryPointRestoreMetadata({required String backupVaultName, required String recoveryPointArn}) → Future<GetRecoveryPointRestoreMetadataOutput>
Returns a set of metadata key-value pairs that were used to create the backup.
getSupportedResourceTypes() → Future<GetSupportedResourceTypesOutput>
Returns the AWS resource types supported by AWS Backup.
listBackupJobs({String? byAccountId, String? byBackupVaultName, DateTime? byCreatedAfter, DateTime? byCreatedBefore, String? byResourceArn, String? byResourceType, BackupJobState? byState, int? maxResults, String? nextToken}) → Future<ListBackupJobsOutput>
Returns a list of existing backup jobs for an authenticated account.
listBackupPlans({bool? includeDeleted, int? maxResults, String? nextToken}) → Future<ListBackupPlansOutput>
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.
listBackupPlanTemplates({int? maxResults, String? nextToken}) → Future<ListBackupPlanTemplatesOutput>
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
listBackupPlanVersions({required String backupPlanId, int? maxResults, String? nextToken}) → Future<ListBackupPlanVersionsOutput>
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
listBackupSelections({required String backupPlanId, int? maxResults, String? nextToken}) → Future<ListBackupSelectionsOutput>
Returns an array containing metadata of the resources associated with the target backup plan.
listBackupVaults({int? maxResults, String? nextToken}) → Future<ListBackupVaultsOutput>
Returns a list of recovery point storage containers along with information about them.
listCopyJobs({String? byAccountId, DateTime? byCreatedAfter, DateTime? byCreatedBefore, String? byDestinationVaultArn, String? byResourceArn, String? byResourceType, CopyJobState? byState, int? maxResults, String? nextToken}) → Future<ListCopyJobsOutput>
Returns metadata about your copy jobs.
listProtectedResources({int? maxResults, String? nextToken}) → Future<ListProtectedResourcesOutput>
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.
listRecoveryPointsByBackupVault({required String backupVaultName, String? byBackupPlanId, DateTime? byCreatedAfter, DateTime? byCreatedBefore, String? byResourceArn, String? byResourceType, int? maxResults, String? nextToken}) → Future<ListRecoveryPointsByBackupVaultOutput>
Returns detailed information about the recovery points stored in a backup vault.
listRecoveryPointsByResource({required String resourceArn, int? maxResults, String? nextToken}) → Future<ListRecoveryPointsByResourceOutput>
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
listRestoreJobs({String? byAccountId, DateTime? byCreatedAfter, DateTime? byCreatedBefore, RestoreJobStatus? byStatus, int? maxResults, String? nextToken}) → Future<ListRestoreJobsOutput>
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
listTags({required String resourceArn, int? maxResults, String? nextToken}) → Future<ListTagsOutput>
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putBackupVaultAccessPolicy({required String backupVaultName, String? policy}) → Future<void>
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.
putBackupVaultNotifications({required List<BackupVaultEvent> backupVaultEvents, required String backupVaultName, required String sNSTopicArn}) → Future<void>
Turns on notifications on a backup vault for the specified topic and events.
startBackupJob({required String backupVaultName, required String iamRoleArn, required String resourceArn, Map<String, String>? backupOptions, int? completeWindowMinutes, String? idempotencyToken, Lifecycle? lifecycle, Map<String, String>? recoveryPointTags, int? startWindowMinutes}) → Future<StartBackupJobOutput>
Starts an on-demand backup job for the specified resource.
startCopyJob({required String destinationBackupVaultArn, required String iamRoleArn, required String recoveryPointArn, required String sourceBackupVaultName, String? idempotencyToken, Lifecycle? lifecycle}) → Future<StartCopyJobOutput>
Starts a job to create a one-time copy of the specified resource.
startRestoreJob({required String iamRoleArn, required Map<String, String> metadata, required String recoveryPointArn, String? idempotencyToken, String? resourceType}) → Future<StartRestoreJobOutput>
Recovers the saved resource identified by an Amazon Resource Name (ARN).
stopBackupJob({required String backupJobId}) → Future<void>
Attempts to cancel a job to create a one-time backup of a resource.
tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeyList}) → Future<void>
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
updateBackupPlan({required BackupPlanInput backupPlan, required String backupPlanId}) → Future<UpdateBackupPlanOutput>
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.
updateGlobalSettings({Map<String, String>? globalSettings}) → Future<void>
Updates the current global settings for the AWS Account. Use the DescribeGlobalSettings API to determine the current settings.
updateRecoveryPointLifecycle({required String backupVaultName, required String recoveryPointArn, Lifecycle? lifecycle}) → Future<UpdateRecoveryPointLifecycleOutput>
Sets the transition lifecycle of a recovery point.
updateRegionSettings({Map<String, bool>? resourceTypeOptInPreference}) → Future<void>
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.

Operators

operator ==(Object other) → bool
The equality operator.
inherited