Builder

class Builder

Properties

Link copied to clipboard

Returns the account ID that owns the backup job.

Link copied to clipboard

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

Link copied to clipboard

Represents the options specified as part of backup plan or on-demand backup job.

Link copied to clipboard

The size, in bytes, of a backup.

Link copied to clipboard

Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

This returns the statistics of the included child (nested) backup jobs.

Link copied to clipboard

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 CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

This is the date a backup job was initiated.

Link copied to clipboard

This returns the boolean value that a backup job is a parent (composite) job.

Link copied to clipboard

This is the job count for the specified message category.

Link copied to clipboard

This returns the number of child (nested) backup jobs.

Link copied to clipboard

This returns the parent (composite) resource backup job ID.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

This is the non-unique name of the resource that belongs to the specified backup.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The current state of a backup job.

Link copied to clipboard

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

Functions

Link copied to clipboard