Class: AWS.Backup

Inherits:
AWS.Service show all
Identifier:
backup
API Version:
2018-11-15
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using Backup

var backup = new AWS.Backup();
backup.createBackupPlan(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Backup object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var backup = new AWS.Backup({apiVersion: '2018-11-15'});

You can also set the API version globally in AWS.config.apiVersions using the backup service identifier:

AWS.config.apiVersions = {
  backup: '2018-11-15',
  // other service API versions
};

var backup = new AWS.Backup();

Version:

  • 2018-11-15

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Backup(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Backup object

var backup = new AWS.Backup({apiVersion: '2018-11-15'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Backup.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Backup.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Backup.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createBackupPlan(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createBackupPlan operation

var params = {
  BackupPlan: { /* required */
    BackupPlanName: 'STRING_VALUE', /* required */
    Rules: [ /* required */
      {
        RuleName: 'STRING_VALUE', /* required */
        TargetBackupVaultName: 'STRING_VALUE', /* required */
        CompletionWindowMinutes: 'NUMBER_VALUE',
        Lifecycle: {
          DeleteAfterDays: 'NUMBER_VALUE',
          MoveToColdStorageAfterDays: 'NUMBER_VALUE'
        },
        RecoveryPointTags: {
          '<TagKey>': 'STRING_VALUE',
          /* '<TagKey>': ... */
        },
        ScheduleExpression: 'STRING_VALUE',
        StartWindowMinutes: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  BackupPlanTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  CreatorRequestId: 'STRING_VALUE'
};
backup.createBackupPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlan — (map)

      Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

      • BackupPlanName — required — (String)

        The display name of a backup plan.

      • Rules — required — (Array<map>)

        An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

        • RuleName — required — (String)

          >An optional display name for a backup rule.

        • TargetBackupVaultName — required — (String)

          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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

        • ScheduleExpression — (String)

          A CRON expression specifying when AWS Backup initiates a backup job.

        • StartWindowMinutes — (Integer)

          The amount of time in minutes before beginning a backup.

        • CompletionWindowMinutes — (Integer)

          The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

        • Lifecycle — (map)

          The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire 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”. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

          • MoveToColdStorageAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is moved to cold storage.

          • DeleteAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays.

        • RecoveryPointTags — (map<String>)

          To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

    • BackupPlanTags — (map<String>)

      To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

    • CreatorRequestId — (String)

      Identifies the request and allows failed requests to be retried without the risk of executing the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • BackupPlanArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • CreationDate — (Date)

        The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • VersionId — (String)

        Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1024 bytes long. They cannot be edited.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createBackupSelection(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createBackupSelection operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  BackupSelection: { /* required */
    IamRoleArn: 'STRING_VALUE', /* required */
    SelectionName: 'STRING_VALUE', /* required */
    ListOfTags: [
      {
        ConditionKey: 'STRING_VALUE', /* required */
        ConditionType: STRINGEQUALS, /* required */
        ConditionValue: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    Resources: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  CreatorRequestId: 'STRING_VALUE'
};
backup.createBackupSelection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlanId — (String)

      Uniquely identifies the backup plan to be associated with the selection of resources.

    • BackupSelection — (map)

      Specifies the body of a request to assign a set of resources to a backup plan.

      It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service the resource belongs to, and an optional array of tags used to identify a set of resources.

      • SelectionName — required — (String)

        The display name of a resource selection document.

      • IamRoleArn — required — (String)

        The ARN of the IAM role that AWS Backup uses to authenticate when restoring the target resource; for example, arn:aws:iam::123456789012:role/S3Access.

      • Resources — (Array<String>)

        An array of strings that either contain Amazon Resource Names (ARNs) or match patterns such as "arn:aws:ec2:us-east-1:123456789012:volume/*" of resources to assign to a backup plan.

      • ListOfTags — (Array<map>)

        An array of conditions used to specify a set of resources to assign to a backup plan; for example, "StringEquals": {"ec2:ResourceTag/Department": "accounting".

        • ConditionType — required — (String)

          An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in a selection.

          Possible values include:
          • "STRINGEQUALS"
        • ConditionKey — required — (String)

          The key in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "ec2:ResourceTag/Department" is the key.

        • ConditionValue — required — (String)

          The value in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "accounting" is the value.

    • CreatorRequestId — (String)

      A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SelectionId — (String)

        Uniquely identifies the body of a request to assign a set of resources to a backup plan.

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • CreationDate — (Date)

        The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createBackupVault(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the createBackupVault operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  BackupVaultTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  CreatorRequestId: 'STRING_VALUE',
  EncryptionKeyArn: 'STRING_VALUE'
};
backup.createBackupVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • BackupVaultTags — (map<String>)

      Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

    • EncryptionKeyArn — (String)

      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.

    • CreatorRequestId — (String)

      A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultName — (String)

        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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • CreationDate — (Date)

        The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBackupPlan(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteBackupPlan operation

var params = {
  BackupPlanId: 'STRING_VALUE' /* required */
};
backup.deleteBackupPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • BackupPlanArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • DeletionDate — (Date)

        The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • VersionId — (String)

        Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBackupSelection(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteBackupSelection operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  SelectionId: 'STRING_VALUE' /* required */
};
backup.deleteBackupSelection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • SelectionId — (String)

      Uniquely identifies the body of a request to assign a set of resources to a backup plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBackupVault(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteBackupVault operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.deleteBackupVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 theAWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBackupVaultAccessPolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteBackupVaultAccessPolicy operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.deleteBackupVaultAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBackupVaultNotifications(params = {}, callback) ⇒ AWS.Request

Deletes event notifications for the specified backup vault.

Service Reference:

Examples:

Calling the deleteBackupVaultNotifications operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.deleteBackupVaultNotifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteRecoveryPoint(params = {}, callback) ⇒ AWS.Request

Deletes the recovery point specified by a recovery point ID.

Service Reference:

Examples:

Calling the deleteRecoveryPoint operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE' /* required */
};
backup.deleteRecoveryPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • RecoveryPointArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeBackupJob(params = {}, callback) ⇒ AWS.Request

Returns metadata associated with creating a backup of a resource.

Service Reference:

Examples:

Calling the describeBackupJob operation

var params = {
  BackupJobId: 'STRING_VALUE' /* required */
};
backup.describeBackupJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupJobId — (String)

      Uniquely identifies a request to AWS Backup to back up a resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupJobId — (String)

        Uniquely identifies a request to AWS Backup to back up a resource.

      • BackupVaultName — (String)

        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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • RecoveryPointArn — (String)

        An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • ResourceArn — (String)

        An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

      • CreationDate — (Date)

        The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • CompletionDate — (Date)

        The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • State — (String)

        The current state of a resource recovery point.

        Possible values include:
        • "CREATED"
        • "PENDING"
        • "RUNNING"
        • "ABORTING"
        • "ABORTED"
        • "COMPLETED"
        • "FAILED"
        • "EXPIRED"
      • StatusMessage — (String)

        A detailed message explaining the status of the job to back up a resource.

      • PercentDone — (String)

        Contains an estimated percentage that is complete of a job at the time the job status was queried.

      • BackupSizeInBytes — (Integer)

        The size, in bytes, of a backup.

      • IamRoleArn — (String)

        Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

      • CreatedBy — (map)

        Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

        • BackupPlanId — (String)

          Uniquely identifies a backup plan.

        • BackupPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

        • BackupPlanVersion — (String)

          Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

        • BackupRuleId — (String)

          Uniquely identifies a rule used to schedule the backup of a selection of resources.

      • ResourceType — (String)

        The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

      • BytesTransferred — (Integer)

        The size in bytes transferred to a backup vault at the time that the job status was queried.

      • ExpectedCompletionDate — (Date)

        The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • StartBy — (Date)

        Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeBackupVault(params = {}, callback) ⇒ AWS.Request

Returns metadata about a backup vault specified by its name.

Service Reference:

Examples:

Calling the describeBackupVault operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.describeBackupVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultName — (String)

        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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • EncryptionKeyArn — (String)

        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.

      • CreationDate — (Date)

        The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • CreatorRequestId — (String)

        A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

      • NumberOfRecoveryPoints — (Integer)

        The number of recovery points that are stored in a backup vault.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeProtectedResource(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the describeProtectedResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
backup.describeProtectedResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceArn — (String)

        An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

      • ResourceType — (String)

        The type of AWS resource saved as a recovery point; for example, an EBS volume or an Amazon RDS database.

      • LastBackupTime — (Date)

        The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeRecoveryPoint(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeRecoveryPoint operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE' /* required */
};
backup.describeRecoveryPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • RecoveryPointArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RecoveryPointArn — (String)

        An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • BackupVaultName — (String)

        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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • ResourceArn — (String)

        An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

      • ResourceType — (String)

        The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

      • CreatedBy — (map)

        Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

        • BackupPlanId — (String)

          Uniquely identifies a backup plan.

        • BackupPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

        • BackupPlanVersion — (String)

          Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

        • BackupRuleId — (String)

          Uniquely identifies a rule used to schedule the backup of a selection of resources.

      • IamRoleArn — (String)

        Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

      • Status — (String)

        A status code specifying the state of the recovery point.

        Note: A partial status indicates that the recovery point was not successfully re-created and must be retried.
        Possible values include:
        • "COMPLETED"
        • "PARTIAL"
        • "DELETING"
        • "EXPIRED"
      • CreationDate — (Date)

        The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • CompletionDate — (Date)

        The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • BackupSizeInBytes — (Integer)

        The size, in bytes, of a backup.

      • CalculatedLifecycle — (map)

        A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

        • MoveToColdStorageAt — (Date)

          A timestamp that specifies when to transition a recovery point to cold storage.

        • DeleteAt — (Date)

          A timestamp that specifies when to delete a recovery point.

      • Lifecycle — (map)

        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 that are 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.

        • MoveToColdStorageAfterDays — (Integer)

          Specifies the number of days after creation that a recovery point is moved to cold storage.

        • DeleteAfterDays — (Integer)

          Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays.

      • EncryptionKeyArn — (String)

        The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      • IsEncrypted — (Boolean)

        A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

      • StorageClass — (String)

        Specifies the storage class of the recovery point. Valid values are WARM or COLD.

        Possible values include:
        • "WARM"
        • "COLD"
        • "DELETED"
      • LastRestoreTime — (Date)

        The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeRestoreJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeRestoreJob operation

var params = {
  RestoreJobId: 'STRING_VALUE' /* required */
};
backup.describeRestoreJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RestoreJobId — (String)

      Uniquely identifies the job that restores a recovery point.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RestoreJobId — (String)

        Uniquely identifies the job that restores a recovery point.

      • RecoveryPointArn — (String)

        An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • CreationDate — (Date)

        The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • CompletionDate — (Date)

        The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • Status — (String)

        Status code specifying the state of the job that is initiated by AWS Backup to restore a recovery point.

        Possible values include:
        • "PENDING"
        • "RUNNING"
        • "COMPLETED"
        • "ABORTED"
        • "FAILED"
      • StatusMessage — (String)

        A detailed message explaining the status of a job to restore a recovery point.

      • PercentDone — (String)

        Contains an estimated percentage that is complete of a job at the time the job status was queried.

      • BackupSizeInBytes — (Integer)

        The size, in bytes, of the restored resource.

      • IamRoleArn — (String)

        Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

      • ExpectedCompletionTimeMinutes — (Integer)

        The amount of time in minutes that a job restoring a recovery point is expected to take.

      • CreatedResourceArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

exportBackupPlanTemplate(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the exportBackupPlanTemplate operation

var params = {
  BackupPlanId: 'STRING_VALUE' /* required */
};
backup.exportBackupPlanTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlanTemplateJson — (String)

        The body of a backup plan template in JSON format.

        Note: This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBackupPlan(params = {}, callback) ⇒ AWS.Request

Returns the body of a backup plan in JSON format, in addition to plan metadata.

Service Reference:

Examples:

Calling the getBackupPlan operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  VersionId: 'STRING_VALUE'
};
backup.getBackupPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • VersionId — (String)

      Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlan — (map)

        Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

        • BackupPlanName — required — (String)

          The display name of a backup plan.

        • Rules — required — (Array<map>)

          An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

          • RuleName — required — (String)

            An optional display name for a backup rule.

          • TargetBackupVaultName — required — (String)

            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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

          • ScheduleExpression — (String)

            A CRON expression specifying when AWS Backup initiates a backup job.

          • StartWindowMinutes — (Integer)

            An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.

          • CompletionWindowMinutes — (Integer)

            A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. This value is optional.

          • Lifecycle — (map)

            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.

            • MoveToColdStorageAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is moved to cold storage.

            • DeleteAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays.

          • RecoveryPointTags — (map<String>)

            An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

          • RuleId — (String)

            Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • BackupPlanArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • VersionId — (String)

        Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

      • CreatorRequestId — (String)

        A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

      • CreationDate — (Date)

        The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • DeletionDate — (Date)

        The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • LastExecutionDate — (Date)

        The last time a job to back up resources was executed with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBackupPlanFromJSON(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getBackupPlanFromJSON operation

var params = {
  BackupPlanTemplateJson: 'STRING_VALUE' /* required */
};
backup.getBackupPlanFromJSON(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlanTemplateJson — (String)

      A customer-supplied backup plan document in JSON format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlan — (map)

        Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

        • BackupPlanName — required — (String)

          The display name of a backup plan.

        • Rules — required — (Array<map>)

          An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

          • RuleName — required — (String)

            An optional display name for a backup rule.

          • TargetBackupVaultName — required — (String)

            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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

          • ScheduleExpression — (String)

            A CRON expression specifying when AWS Backup initiates a backup job.

          • StartWindowMinutes — (Integer)

            An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.

          • CompletionWindowMinutes — (Integer)

            A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. This value is optional.

          • Lifecycle — (map)

            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.

            • MoveToColdStorageAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is moved to cold storage.

            • DeleteAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays.

          • RecoveryPointTags — (map<String>)

            An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

          • RuleId — (String)

            Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBackupPlanFromTemplate(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getBackupPlanFromTemplate operation

var params = {
  BackupPlanTemplateId: 'STRING_VALUE' /* required */
};
backup.getBackupPlanFromTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlanTemplateId — (String)

      Uniquely identifies a stored backup plan template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlanDocument — (map)

        Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.

        • BackupPlanName — required — (String)

          The display name of a backup plan.

        • Rules — required — (Array<map>)

          An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

          • RuleName — required — (String)

            An optional display name for a backup rule.

          • TargetBackupVaultName — required — (String)

            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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

          • ScheduleExpression — (String)

            A CRON expression specifying when AWS Backup initiates a backup job.

          • StartWindowMinutes — (Integer)

            An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.

          • CompletionWindowMinutes — (Integer)

            A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. This value is optional.

          • Lifecycle — (map)

            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.

            • MoveToColdStorageAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is moved to cold storage.

            • DeleteAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays.

          • RecoveryPointTags — (map<String>)

            An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

          • RuleId — (String)

            Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBackupSelection(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getBackupSelection operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  SelectionId: 'STRING_VALUE' /* required */
};
backup.getBackupSelection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • SelectionId — (String)

      Uniquely identifies the body of a request to assign a set of resources to a backup plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupSelection — (map)

        Specifies the body of a request to assign a set of resources to a backup plan.

        It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service that the resource belongs to, and an optional array of tags used to identify a set of resources.

        • SelectionName — required — (String)

          The display name of a resource selection document.

        • IamRoleArn — required — (String)

          The ARN of the IAM role that AWS Backup uses to authenticate when restoring the target resource; for example, arn:aws:iam::123456789012:role/S3Access.

        • Resources — (Array<String>)

          An array of strings that either contain Amazon Resource Names (ARNs) or match patterns such as "arn:aws:ec2:us-east-1:123456789012:volume/*" of resources to assign to a backup plan.

        • ListOfTags — (Array<map>)

          An array of conditions used to specify a set of resources to assign to a backup plan; for example, "StringEquals": {"ec2:ResourceTag/Department": "accounting".

          • ConditionType — required — (String)

            An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in a selection.

            Possible values include:
            • "STRINGEQUALS"
          • ConditionKey — required — (String)

            The key in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "ec2:ResourceTag/Department" is the key.

          • ConditionValue — required — (String)

            The value in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "accounting" is the value.

      • SelectionId — (String)

        Uniquely identifies the body of a request to assign a set of resources to a backup plan.

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • CreationDate — (Date)

        The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • CreatorRequestId — (String)

        A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBackupVaultAccessPolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getBackupVaultAccessPolicy operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.getBackupVaultAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultName — (String)

        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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • Policy — (String)

        The backup vault access policy document in JSON format.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBackupVaultNotifications(params = {}, callback) ⇒ AWS.Request

Returns event notifications for the specified backup vault.

Service Reference:

Examples:

Calling the getBackupVaultNotifications operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.getBackupVaultNotifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultName — (String)

        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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • SNSTopicArn — (String)

        An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

      • BackupVaultEvents — (Array<String>)

        An array of events that indicate the status of jobs to back up resources to the backup vault.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRecoveryPointRestoreMetadata(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getRecoveryPointRestoreMetadata operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE' /* required */
};
backup.getRecoveryPointRestoreMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • RecoveryPointArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultArn — (String)

        An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • RecoveryPointArn — (String)

        An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • RestoreMetadata — (map<String>)

        A set of metadata key-value pairs that lists the metadata key-value pairs that are required to restore the recovery point.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSupportedResourceTypes(params = {}, callback) ⇒ AWS.Request

Returns the AWS resource types supported by AWS Backup.

Service Reference:

Examples:

Calling the getSupportedResourceTypes operation

backup.getSupportedResourceTypes(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceTypes — (Array<String>)

        Contains a string with the supported AWS resource types:

        • EBS for Amazon Elastic Block Store

        • SGW for AWS Storage Gateway

        • RDS for Amazon Relational Database Service

        • DDB for Amazon DynamoDB

        • EFS for Amazon Elastic File System

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBackupJobs(params = {}, callback) ⇒ AWS.Request

Returns metadata about your backup jobs.

Service Reference:

Examples:

Calling the listBackupJobs operation

var params = {
  ByBackupVaultName: 'STRING_VALUE',
  ByCreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByCreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByResourceArn: 'STRING_VALUE',
  ByResourceType: 'STRING_VALUE',
  ByState: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

    • ByResourceArn — (String)

      Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

    • ByState — (String)

      Returns only backup jobs that are in the specified state.

      Possible values include:
      • "CREATED"
      • "PENDING"
      • "RUNNING"
      • "ABORTING"
      • "ABORTED"
      • "COMPLETED"
      • "FAILED"
      • "EXPIRED"
    • ByBackupVaultName — (String)

      Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • ByCreatedBefore — (Date)

      Returns only backup jobs that were created before the specified date.

    • ByCreatedAfter — (Date)

      Returns only backup jobs that were created after the specified date.

    • ByResourceType — (String)

      Returns only backup jobs for the specified resources:

      • EBS for Amazon Elastic Block Store

      • SGW for AWS Storage Gateway

      • RDS for Amazon Relational Database Service

      • DDB for Amazon DynamoDB

      • EFS for Amazon Elastic File System

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupJobs — (Array<map>)

        An array of structures containing metadata about your backup jobs returned in JSON format.

        • BackupJobId — (String)

          Uniquely identifies a request to AWS Backup to back up a resource.

        • BackupVaultName — (String)

          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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

        • BackupVaultArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • RecoveryPointArn — (String)

          An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • ResourceArn — (String)

          An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • CreationDate — (Date)

          The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CompletionDate — (Date)

          The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • State — (String)

          The current state of a resource recovery point.

          Possible values include:
          • "CREATED"
          • "PENDING"
          • "RUNNING"
          • "ABORTING"
          • "ABORTED"
          • "COMPLETED"
          • "FAILED"
          • "EXPIRED"
        • StatusMessage — (String)

          A detailed message explaining the status of the job to back up a resource.

        • PercentDone — (String)

          Contains an estimated percentage complete of a job at the time the job status was queried.

        • BackupSizeInBytes — (Integer)

          The size, in bytes, of a backup.

        • IamRoleArn — (String)

          Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

        • CreatedBy — (map)

          Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

          • BackupPlanId — (String)

            Uniquely identifies a backup plan.

          • BackupPlanArn — (String)

            An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

          • BackupPlanVersion — (String)

            Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

          • BackupRuleId — (String)

            Uniquely identifies a rule used to schedule the backup of a selection of resources.

        • ExpectedCompletionDate — (Date)

          The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • StartBy — (Date)

          Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • ResourceType — (String)

          The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

        • BytesTransferred — (Integer)

          The size in bytes transferred to a backup vault at the time that the job status was queried.

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBackupPlans(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the listBackupPlans operation

var params = {
  IncludeDeleted: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupPlans(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

    • IncludeDeleted — (Boolean)

      A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • BackupPlansList — (Array<map>)

        An array of backup plan list items containing metadata about your saved backup plans.

        • BackupPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

        • BackupPlanId — (String)

          Uniquely identifies a backup plan.

        • CreationDate — (Date)

          The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • DeletionDate — (Date)

          The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • VersionId — (String)

          Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

        • BackupPlanName — (String)

          The display name of a saved backup plan.

        • CreatorRequestId — (String)

          A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

        • LastExecutionDate — (Date)

          The last time a job to back up resources was executed with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBackupPlanTemplates(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listBackupPlanTemplates operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupPlanTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • BackupPlanTemplatesList — (Array<map>)

        An array of template list items containing metadata about your saved templates.

        • BackupPlanTemplateId — (String)

          Uniquely identifies a stored backup plan template.

        • BackupPlanTemplateName — (String)

          The optional display name of a backup plan template.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBackupPlanVersions(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the listBackupPlanVersions operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupPlanVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • BackupPlanVersionsList — (Array<map>)

        An array of version list items containing metadata about your backup plans.

        • BackupPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

        • BackupPlanId — (String)

          Uniquely identifies a backup plan.

        • CreationDate — (Date)

          The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • DeletionDate — (Date)

          The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • VersionId — (String)

          Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

        • BackupPlanName — (String)

          The display name of a saved backup plan.

        • CreatorRequestId — (String)

          A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

        • LastExecutionDate — (Date)

          The last time a job to back up resources was executed with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBackupSelections(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listBackupSelections operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupSelections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • BackupSelectionsList — (Array<map>)

        An array of backup selection list items containing metadata about each resource in the list.

        • SelectionId — (String)

          Uniquely identifies a request to assign a set of resources to a backup plan.

        • SelectionName — (String)

          The display name of a resource selection document.

        • BackupPlanId — (String)

          Uniquely identifies a backup plan.

        • CreationDate — (Date)

          The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CreatorRequestId — (String)

          A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

        • IamRoleArn — (String)

          Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listBackupVaults(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listBackupVaults operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupVaults(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultList — (Array<map>)

        An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.

        • BackupVaultName — (String)

          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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

        • BackupVaultArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • CreationDate — (Date)

          The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • EncryptionKeyArn — (String)

          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.

        • CreatorRequestId — (String)

          A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

        • NumberOfRecoveryPoints — (Integer)

          The number of recovery points that are stored in a backup vault.

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listProtectedResources(params = {}, callback) ⇒ AWS.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.

Service Reference:

Examples:

Calling the listProtectedResources operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listProtectedResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Results — (Array<map>)

        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.

        • ResourceArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • ResourceType — (String)

          The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

        • LastBackupTime — (Date)

          The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listRecoveryPointsByBackupVault(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listRecoveryPointsByBackupVault operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  ByBackupPlanId: 'STRING_VALUE',
  ByCreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByCreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByResourceArn: 'STRING_VALUE',
  ByResourceType: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listRecoveryPointsByBackupVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

    • ByResourceArn — (String)

      Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

    • ByResourceType — (String)

      Returns only recovery points that match the specified resource type.

    • ByBackupPlanId — (String)

      Returns only recovery points that match the specified backup plan ID.

    • ByCreatedBefore — (Date)

      Returns only recovery points that were created before the specified timestamp.

    • ByCreatedAfter — (Date)

      Returns only recovery points that were created after the specified timestamp.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • RecoveryPoints — (Array<map>)

        An array of objects that contain detailed information about recovery points saved in a backup vault.

        • RecoveryPointArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • BackupVaultName — (String)

          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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

        • BackupVaultArn — (String)

          An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • ResourceArn — (String)

          An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • ResourceType — (String)

          The type of AWS resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

        • CreatedBy — (map)

          Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

          • BackupPlanId — (String)

            Uniquely identifies a backup plan.

          • BackupPlanArn — (String)

            An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

          • BackupPlanVersion — (String)

            Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

          • BackupRuleId — (String)

            Uniquely identifies a rule used to schedule the backup of a selection of resources.

        • IamRoleArn — (String)

          Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

        • Status — (String)

          A status code specifying the state of the recovery point.

          Possible values include:
          • "COMPLETED"
          • "PARTIAL"
          • "DELETING"
          • "EXPIRED"
        • CreationDate — (Date)

          The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CompletionDate — (Date)

          The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • BackupSizeInBytes — (Integer)

          The size, in bytes, of a backup.

        • CalculatedLifecycle — (map)

          A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

          • MoveToColdStorageAt — (Date)

            A timestamp that specifies when to transition a recovery point to cold storage.

          • DeleteAt — (Date)

            A timestamp that specifies when to delete a recovery point.

        • Lifecycle — (map)

          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.

          • MoveToColdStorageAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is moved to cold storage.

          • DeleteAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays.

        • EncryptionKeyArn — (String)

          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.

        • IsEncrypted — (Boolean)

          A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

        • LastRestoreTime — (Date)

          The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listRecoveryPointsByResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listRecoveryPointsByResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listRecoveryPointsByResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • RecoveryPoints — (Array<map>)

        An array of objects that contain detailed information about recovery points of the specified resource type.

        • RecoveryPointArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • CreationDate — (Date)

          The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • Status — (String)

          A status code specifying the state of the recovery point.

          Possible values include:
          • "COMPLETED"
          • "PARTIAL"
          • "DELETING"
          • "EXPIRED"
        • EncryptionKeyArn — (String)

          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.

        • BackupSizeBytes — (Integer)

          The size, in bytes, of a backup.

        • BackupVaultName — (String)

          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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listRestoreJobs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listRestoreJobs operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listRestoreJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RestoreJobs — (Array<map>)

        An array of objects that contain detailed information about jobs to restore saved resources.

        • RestoreJobId — (String)

          Uniquely identifies the job that restores a recovery point.

        • RecoveryPointArn — (String)

          An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • CreationDate — (Date)

          The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CompletionDate — (Date)

          The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • Status — (String)

          A status code specifying the state of the job initiated by AWS Backup to restore a recovery point.

          Possible values include:
          • "PENDING"
          • "RUNNING"
          • "COMPLETED"
          • "ABORTED"
          • "FAILED"
        • StatusMessage — (String)

          A detailed message explaining the status of the job to restore a recovery point.

        • PercentDone — (String)

          Contains an estimated percentage complete of a job at the time the job status was queried.

        • BackupSizeInBytes — (Integer)

          The size, in bytes, of the restored resource.

        • IamRoleArn — (String)

          Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

        • ExpectedCompletionTimeMinutes — (Integer)

          The amount of time in minutes that a job restoring a recovery point is expected to take.

        • CreatedResourceArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTags(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTags operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.

    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • Tags — (map<String>)

        To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBackupVaultAccessPolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putBackupVaultAccessPolicy operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE'
};
backup.putBackupVaultAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • Policy — (String)

      The backup vault access policy document in JSON format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putBackupVaultNotifications(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putBackupVaultNotifications operation

var params = {
  BackupVaultEvents: [ /* required */
    BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED | RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED | BACKUP_PLAN_CREATED | BACKUP_PLAN_MODIFIED,
    /* more items */
  ],
  BackupVaultName: 'STRING_VALUE', /* required */
  SNSTopicArn: 'STRING_VALUE' /* required */
};
backup.putBackupVaultNotifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • SNSTopicArn — (String)

      The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

    • BackupVaultEvents — (Array<String>)

      An array of events that indicate the status of jobs to back up resources to the backup vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startBackupJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startBackupJob operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  IamRoleArn: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE', /* required */
  CompleteWindowMinutes: 'NUMBER_VALUE',
  IdempotencyToken: 'STRING_VALUE',
  Lifecycle: {
    DeleteAfterDays: 'NUMBER_VALUE',
    MoveToColdStorageAfterDays: 'NUMBER_VALUE'
  },
  RecoveryPointTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  StartWindowMinutes: 'NUMBER_VALUE'
};
backup.startBackupJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • ResourceArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

    • IamRoleArn — (String)

      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

    • IdempotencyToken — (String)

      A customer chosen string that can be used to distinguish between calls to StartBackupJob. Idempotency tokens time out after one hour. Therefore, if you call StartBackupJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups.

    • StartWindowMinutes — (Integer)

      The amount of time in minutes before beginning a backup.

    • CompleteWindowMinutes — (Integer)

      The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

    • Lifecycle — (map)

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire 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.

      • MoveToColdStorageAfterDays — (Integer)

        Specifies the number of days after creation that a recovery point is moved to cold storage.

      • DeleteAfterDays — (Integer)

        Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays.

    • RecoveryPointTags — (map<String>)

      To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupJobId — (String)

        Uniquely identifies a request to AWS Backup to back up a resource.

      • RecoveryPointArn — (String)

        An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • CreationDate — (Date)

        The date and time that a backup job is started, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startRestoreJob(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the startRestoreJob operation

var params = {
  IamRoleArn: 'STRING_VALUE', /* required */
  Metadata: { /* required */
    '<MetadataKey>': 'STRING_VALUE',
    /* '<MetadataKey>': ... */
  },
  RecoveryPointArn: 'STRING_VALUE', /* required */
  IdempotencyToken: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE'
};
backup.startRestoreJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RecoveryPointArn — (String)

      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • Metadata — (map<String>)

      A set of metadata key-value pairs. Lists the metadata that the recovery point was created with.

    • IamRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

    • IdempotencyToken — (String)

      A customer chosen string that can be used to distinguish between calls to StartRestoreJob. Idempotency tokens time out after one hour. Therefore, if you call StartRestoreJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one restore job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple restores.

    • ResourceType — (String)

      Starts a job to restore a recovery point for one of the following resources:

      • EBS for Amazon Elastic Block Store

      • SGW for AWS Storage Gateway

      • RDS for Amazon Relational Database Service

      • DDB for Amazon DynamoDB

      • EFS for Amazon Elastic File System

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RestoreJobId — (String)

        Uniquely identifies the job that restores a recovery point.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopBackupJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the stopBackupJob operation

var params = {
  BackupJobId: 'STRING_VALUE' /* required */
};
backup.stopBackupJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupJobId — (String)

      Uniquely identifies a request to AWS Backup to back up a resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
backup.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

    • Tags — (map<String>)

      Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeyList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
backup.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

    • TagKeyList — (Array<String>)

      A list of keys to identify which key-value tags to remove from a resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateBackupPlan(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateBackupPlan operation

var params = {
  BackupPlan: { /* required */
    BackupPlanName: 'STRING_VALUE', /* required */
    Rules: [ /* required */
      {
        RuleName: 'STRING_VALUE', /* required */
        TargetBackupVaultName: 'STRING_VALUE', /* required */
        CompletionWindowMinutes: 'NUMBER_VALUE',
        Lifecycle: {
          DeleteAfterDays: 'NUMBER_VALUE',
          MoveToColdStorageAfterDays: 'NUMBER_VALUE'
        },
        RecoveryPointTags: {
          '<TagKey>': 'STRING_VALUE',
          /* '<TagKey>': ... */
        },
        ScheduleExpression: 'STRING_VALUE',
        StartWindowMinutes: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  BackupPlanId: 'STRING_VALUE' /* required */
};
backup.updateBackupPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • BackupPlan — (map)

      Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

      • BackupPlanName — required — (String)

        The display name of a backup plan.

      • Rules — required — (Array<map>)

        An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

        • RuleName — required — (String)

          >An optional display name for a backup rule.

        • TargetBackupVaultName — required — (String)

          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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

        • ScheduleExpression — (String)

          A CRON expression specifying when AWS Backup initiates a backup job.

        • StartWindowMinutes — (Integer)

          The amount of time in minutes before beginning a backup.

        • CompletionWindowMinutes — (Integer)

          The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

        • Lifecycle — (map)

          The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire 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”. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

          • MoveToColdStorageAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is moved to cold storage.

          • DeleteAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays.

        • RecoveryPointTags — (map<String>)

          To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • BackupPlanArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • CreationDate — (Date)

        The date and time a backup plan is updated, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • VersionId — (String)

        Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateRecoveryPointLifecycle(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateRecoveryPointLifecycle operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE', /* required */
  Lifecycle: {
    DeleteAfterDays: 'NUMBER_VALUE',
    MoveToColdStorageAfterDays: 'NUMBER_VALUE'
  }
};
backup.updateRecoveryPointLifecycle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • BackupVaultName — (String)

      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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • RecoveryPointArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • Lifecycle — (map)

      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.

      • MoveToColdStorageAfterDays — (Integer)

        Specifies the number of days after creation that a recovery point is moved to cold storage.

      • DeleteAfterDays — (Integer)

        Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultArn — (String)

        An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • RecoveryPointArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • Lifecycle — (map)

        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.

        • MoveToColdStorageAfterDays — (Integer)

          Specifies the number of days after creation that a recovery point is moved to cold storage.

        • DeleteAfterDays — (Integer)

          Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays.

      • CalculatedLifecycle — (map)

        A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

        • MoveToColdStorageAt — (Date)

          A timestamp that specifies when to transition a recovery point to cold storage.

        • DeleteAt — (Date)

          A timestamp that specifies when to delete a recovery point.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.