@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSBackup extends Object implements AWSBackup
AWSBackup
. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CreateBackupPlanResult |
createBackupPlan(CreateBackupPlanRequest request)
Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery
points of resources.
|
CreateBackupSelectionResult |
createBackupSelection(CreateBackupSelectionRequest request)
Creates a JSON document that specifies a set of resources to assign to a backup plan.
|
CreateBackupVaultResult |
createBackupVault(CreateBackupVaultRequest request)
Creates a logical container where backups are stored.
|
DeleteBackupPlanResult |
deleteBackupPlan(DeleteBackupPlanRequest request)
Deletes a backup plan.
|
DeleteBackupSelectionResult |
deleteBackupSelection(DeleteBackupSelectionRequest request)
Deletes the resource selection associated with a backup plan that is specified by the
SelectionId . |
DeleteBackupVaultResult |
deleteBackupVault(DeleteBackupVaultRequest request)
Deletes the backup vault identified by its name.
|
DeleteBackupVaultAccessPolicyResult |
deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest request)
Deletes the policy document that manages permissions on a backup vault.
|
DeleteBackupVaultNotificationsResult |
deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest request)
Deletes event notifications for the specified backup vault.
|
DeleteRecoveryPointResult |
deleteRecoveryPoint(DeleteRecoveryPointRequest request)
Deletes the recovery point specified by a recovery point ID.
|
DescribeBackupJobResult |
describeBackupJob(DescribeBackupJobRequest request)
Returns metadata associated with creating a backup of a resource.
|
DescribeBackupVaultResult |
describeBackupVault(DescribeBackupVaultRequest request)
Returns metadata about a backup vault specified by its name.
|
DescribeProtectedResourceResult |
describeProtectedResource(DescribeProtectedResourceRequest request)
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.
|
DescribeRecoveryPointResult |
describeRecoveryPoint(DescribeRecoveryPointRequest request)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
|
DescribeRestoreJobResult |
describeRestoreJob(DescribeRestoreJobRequest request)
Returns metadata associated with a restore job that is specified by a job ID.
|
ExportBackupPlanTemplateResult |
exportBackupPlanTemplate(ExportBackupPlanTemplateRequest request)
Returns the backup plan that is specified by the plan ID as a backup template.
|
GetBackupPlanResult |
getBackupPlan(GetBackupPlanRequest request)
Returns the body of a backup plan in JSON format, in addition to plan metadata.
|
GetBackupPlanFromJSONResult |
getBackupPlanFromJSON(GetBackupPlanFromJSONRequest request)
Returns a valid JSON document specifying a backup plan or an error.
|
GetBackupPlanFromTemplateResult |
getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest request)
Returns the template specified by its
templateId as a backup plan. |
GetBackupSelectionResult |
getBackupSelection(GetBackupSelectionRequest request)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated
with a backup plan.
|
GetBackupVaultAccessPolicyResult |
getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest request)
Returns the access policy document that is associated with the named backup vault.
|
GetBackupVaultNotificationsResult |
getBackupVaultNotifications(GetBackupVaultNotificationsRequest request)
Returns event notifications for the specified backup vault.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetRecoveryPointRestoreMetadataResult |
getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest request)
Returns two sets of metadata key-value pairs.
|
GetSupportedResourceTypesResult |
getSupportedResourceTypes(GetSupportedResourceTypesRequest request)
Returns the AWS resource types supported by AWS Backup.
|
ListBackupJobsResult |
listBackupJobs(ListBackupJobsRequest request)
Returns metadata about your backup jobs.
|
ListBackupPlansResult |
listBackupPlans(ListBackupPlansRequest request)
Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and
deletion dates, version IDs, plan names, and creator request IDs.
|
ListBackupPlanTemplatesResult |
listBackupPlanTemplates(ListBackupPlanTemplatesRequest request)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
ListBackupPlanVersionsResult |
listBackupPlanVersions(ListBackupPlanVersionsRequest request)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation
and deletion dates, plan names, and version IDs.
|
ListBackupSelectionsResult |
listBackupSelections(ListBackupSelectionsRequest request)
Returns an array containing metadata of the resources associated with the target backup plan.
|
ListBackupVaultsResult |
listBackupVaults(ListBackupVaultsRequest request)
Returns a list of recovery point storage containers along with information about them.
|
ListProtectedResourcesResult |
listProtectedResources(ListProtectedResourcesRequest request)
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.
|
ListRecoveryPointsByBackupVaultResult |
listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest request)
Returns detailed information about the recovery points stored in a backup vault.
|
ListRecoveryPointsByResourceResult |
listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest request)
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name
(ARN).
|
ListRestoreJobsResult |
listRestoreJobs(ListRestoreJobsRequest request)
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the
recovery process.
|
ListTagsResult |
listTags(ListTagsRequest request)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
PutBackupVaultAccessPolicyResult |
putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest request)
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
|
PutBackupVaultNotificationsResult |
putBackupVaultNotifications(PutBackupVaultNotificationsRequest request)
Turns on notifications on a backup vault for the specified topic and events.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartBackupJobResult |
startBackupJob(StartBackupJobRequest request)
Starts a job to create a one-time backup of the specified resource.
|
StartRestoreJobResult |
startRestoreJob(StartRestoreJobRequest request)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
|
StopBackupJobResult |
stopBackupJob(StopBackupJobRequest request)
Attempts to cancel a job to create a one-time backup of a resource.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN).
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN)
|
UpdateBackupPlanResult |
updateBackupPlan(UpdateBackupPlanRequest request)
Replaces the body of a saved backup plan identified by its
backupPlanId with the input document in
JSON format. |
UpdateRecoveryPointLifecycleResult |
updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest request)
Sets the transition lifecycle of a recovery point.
|
public CreateBackupPlanResult createBackupPlan(CreateBackupPlanRequest request)
AWSBackup
Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources.
If you call CreateBackupPlan
with a plan that already exists, the existing backupPlanId
is returned.
createBackupPlan
in interface AWSBackup
public CreateBackupSelectionResult createBackupSelection(CreateBackupSelectionRequest request)
AWSBackup
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.
createBackupSelection
in interface AWSBackup
public CreateBackupVaultResult createBackupVault(CreateBackupVaultRequest request)
AWSBackup
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.
createBackupVault
in interface AWSBackup
public DeleteBackupPlanResult deleteBackupPlan(DeleteBackupPlanRequest request)
AWSBackup
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.
deleteBackupPlan
in interface AWSBackup
public DeleteBackupSelectionResult deleteBackupSelection(DeleteBackupSelectionRequest request)
AWSBackup
Deletes the resource selection associated with a backup plan that is specified by the SelectionId
.
deleteBackupSelection
in interface AWSBackup
public DeleteBackupVaultResult deleteBackupVault(DeleteBackupVaultRequest request)
AWSBackup
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
deleteBackupVault
in interface AWSBackup
public DeleteBackupVaultAccessPolicyResult deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest request)
AWSBackup
Deletes the policy document that manages permissions on a backup vault.
deleteBackupVaultAccessPolicy
in interface AWSBackup
public DeleteBackupVaultNotificationsResult deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest request)
AWSBackup
Deletes event notifications for the specified backup vault.
deleteBackupVaultNotifications
in interface AWSBackup
public DeleteRecoveryPointResult deleteRecoveryPoint(DeleteRecoveryPointRequest request)
AWSBackup
Deletes the recovery point specified by a recovery point ID.
deleteRecoveryPoint
in interface AWSBackup
public DescribeBackupJobResult describeBackupJob(DescribeBackupJobRequest request)
AWSBackup
Returns metadata associated with creating a backup of a resource.
describeBackupJob
in interface AWSBackup
public DescribeBackupVaultResult describeBackupVault(DescribeBackupVaultRequest request)
AWSBackup
Returns metadata about a backup vault specified by its name.
describeBackupVault
in interface AWSBackup
public DescribeProtectedResourceResult describeProtectedResource(DescribeProtectedResourceRequest request)
AWSBackup
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.
describeProtectedResource
in interface AWSBackup
public DescribeRecoveryPointResult describeRecoveryPoint(DescribeRecoveryPointRequest request)
AWSBackup
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
describeRecoveryPoint
in interface AWSBackup
public DescribeRestoreJobResult describeRestoreJob(DescribeRestoreJobRequest request)
AWSBackup
Returns metadata associated with a restore job that is specified by a job ID.
describeRestoreJob
in interface AWSBackup
public ExportBackupPlanTemplateResult exportBackupPlanTemplate(ExportBackupPlanTemplateRequest request)
AWSBackup
Returns the backup plan that is specified by the plan ID as a backup template.
exportBackupPlanTemplate
in interface AWSBackup
public GetBackupPlanResult getBackupPlan(GetBackupPlanRequest request)
AWSBackup
Returns the body of a backup plan in JSON format, in addition to plan metadata.
getBackupPlan
in interface AWSBackup
public GetBackupPlanFromJSONResult getBackupPlanFromJSON(GetBackupPlanFromJSONRequest request)
AWSBackup
Returns a valid JSON document specifying a backup plan or an error.
getBackupPlanFromJSON
in interface AWSBackup
public GetBackupPlanFromTemplateResult getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest request)
AWSBackup
Returns the template specified by its templateId
as a backup plan.
getBackupPlanFromTemplate
in interface AWSBackup
public GetBackupSelectionResult getBackupSelection(GetBackupSelectionRequest request)
AWSBackup
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
getBackupSelection
in interface AWSBackup
public GetBackupVaultAccessPolicyResult getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest request)
AWSBackup
Returns the access policy document that is associated with the named backup vault.
getBackupVaultAccessPolicy
in interface AWSBackup
public GetBackupVaultNotificationsResult getBackupVaultNotifications(GetBackupVaultNotificationsRequest request)
AWSBackup
Returns event notifications for the specified backup vault.
getBackupVaultNotifications
in interface AWSBackup
public GetRecoveryPointRestoreMetadataResult getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest request)
AWSBackup
Returns two sets of metadata key-value pairs. The first set lists the metadata that the recovery point was created with. The second set lists the metadata key-value pairs that are required to restore the recovery point.
These sets can be the same, or the restore metadata set can contain different values if the target service to be restored has changed since the recovery point was created and now requires additional or different information in order to be restored.
getRecoveryPointRestoreMetadata
in interface AWSBackup
public GetSupportedResourceTypesResult getSupportedResourceTypes(GetSupportedResourceTypesRequest request)
AWSBackup
Returns the AWS resource types supported by AWS Backup.
getSupportedResourceTypes
in interface AWSBackup
public ListBackupJobsResult listBackupJobs(ListBackupJobsRequest request)
AWSBackup
Returns metadata about your backup jobs.
listBackupJobs
in interface AWSBackup
public ListBackupPlanTemplatesResult listBackupPlanTemplates(ListBackupPlanTemplatesRequest request)
AWSBackup
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
listBackupPlanTemplates
in interface AWSBackup
public ListBackupPlanVersionsResult listBackupPlanVersions(ListBackupPlanVersionsRequest request)
AWSBackup
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
listBackupPlanVersions
in interface AWSBackup
public ListBackupPlansResult listBackupPlans(ListBackupPlansRequest request)
AWSBackup
Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
listBackupPlans
in interface AWSBackup
public ListBackupSelectionsResult listBackupSelections(ListBackupSelectionsRequest request)
AWSBackup
Returns an array containing metadata of the resources associated with the target backup plan.
listBackupSelections
in interface AWSBackup
public ListBackupVaultsResult listBackupVaults(ListBackupVaultsRequest request)
AWSBackup
Returns a list of recovery point storage containers along with information about them.
listBackupVaults
in interface AWSBackup
public ListProtectedResourcesResult listProtectedResources(ListProtectedResourcesRequest request)
AWSBackup
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.
listProtectedResources
in interface AWSBackup
public ListRecoveryPointsByBackupVaultResult listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest request)
AWSBackup
Returns detailed information about the recovery points stored in a backup vault.
listRecoveryPointsByBackupVault
in interface AWSBackup
public ListRecoveryPointsByResourceResult listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest request)
AWSBackup
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
listRecoveryPointsByResource
in interface AWSBackup
public ListRestoreJobsResult listRestoreJobs(ListRestoreJobsRequest request)
AWSBackup
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
listRestoreJobs
in interface AWSBackup
public ListTagsResult listTags(ListTagsRequest request)
AWSBackup
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
listTags
in interface AWSBackup
public PutBackupVaultAccessPolicyResult putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest request)
AWSBackup
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.
putBackupVaultAccessPolicy
in interface AWSBackup
public PutBackupVaultNotificationsResult putBackupVaultNotifications(PutBackupVaultNotificationsRequest request)
AWSBackup
Turns on notifications on a backup vault for the specified topic and events.
putBackupVaultNotifications
in interface AWSBackup
public StartBackupJobResult startBackupJob(StartBackupJobRequest request)
AWSBackup
Starts a job to create a one-time backup of the specified resource.
startBackupJob
in interface AWSBackup
public StartRestoreJobResult startRestoreJob(StartRestoreJobRequest request)
AWSBackup
Recovers the saved resource identified by an Amazon Resource Name (ARN).
If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.
startRestoreJob
in interface AWSBackup
public StopBackupJobResult stopBackupJob(StopBackupJobRequest request)
AWSBackup
Attempts to cancel a job to create a one-time backup of a resource.
stopBackupJob
in interface AWSBackup
public TagResourceResult tagResource(TagResourceRequest request)
AWSBackup
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
tagResource
in interface AWSBackup
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSBackup
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
untagResource
in interface AWSBackup
public UpdateBackupPlanResult updateBackupPlan(UpdateBackupPlanRequest request)
AWSBackup
Replaces the body of a saved backup plan identified by its backupPlanId
with the input document in
JSON format. The new version is uniquely identified by a VersionId
.
updateBackupPlan
in interface AWSBackup
public UpdateRecoveryPointLifecycleResult updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest request)
AWSBackup
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.
updateRecoveryPointLifecycle
in interface AWSBackup
public void shutdown()
AWSBackup
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSBackup
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSBackup
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.