String backupJobId
Uniquely identifies a request to AWS Backup to back up a resource.
String backupVaultName
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.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String resourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
Date creationDate
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.
Date completionDate
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.
String state
The current state of a resource recovery point.
String statusMessage
A detailed message explaining the status of the job to back up a resource.
String percentDone
Contains an estimated percentage complete of a job at the time the job status was queried.
Long backupSizeInBytes
The size, in bytes, of a backup.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
RecoveryPointCreator createdBy
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.
Date expectedCompletionDate
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.
Date startBy
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.
String resourceType
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.
Long bytesTransferred
The size in bytes transferred to a backup vault at the time that the job status was queried.
String backupPlanArn
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.
String backupPlanId
Uniquely identifies a backup plan.
Date creationDate
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.
Date deletionDate
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.
String versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
String backupPlanName
The display name of a saved backup plan.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
Date lastExecutionDate
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.
String ruleName
An optional display name for a backup rule.
String targetBackupVaultName
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.
String scheduleExpression
A CRON expression specifying when AWS Backup initiates a backup job.
Long startWindowMinutes
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.
Long completionWindowMinutes
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 lifecycle
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.
Map<K,V> recoveryPointTags
An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
String ruleId
Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
String ruleName
>An optional display name for a backup rule.
String targetBackupVaultName
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.
String scheduleExpression
A CRON expression specifying when AWS Backup initiates a backup job.
Long startWindowMinutes
The amount of time in minutes before beginning a backup.
Long completionWindowMinutes
The amount of time AWS Backup attempts a backup before canceling the job and returning an error.
Lifecycle lifecycle
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.
Map<K,V> recoveryPointTags
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
String selectionName
The display name of a resource selection document.
String iamRoleArn
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.
List<E> resources
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.
List<E> listOfTags
An array of conditions used to specify a set of resources to assign to a backup plan; for example,
"StringEquals": {"ec2:ResourceTag/Department": "accounting".
String selectionId
Uniquely identifies a request to assign a set of resources to a backup plan.
String selectionName
The display name of a resource selection document.
String backupPlanId
Uniquely identifies a backup plan.
Date creationDate
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.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
String iamRoleArn
Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
String backupVaultName
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.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Date creationDate
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.
String encryptionKeyArn
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.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
Long numberOfRecoveryPoints
The number of recovery points that are stored in a backup vault.
String conditionType
An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in
a selection.
String conditionKey
The key in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting",
"ec2:ResourceTag/Department" is the key.
String conditionValue
The value in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting",
"accounting" is the value.
BackupPlanInput backupPlan
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of
Rules.
Map<K,V> backupPlanTags
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.
String creatorRequestId
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.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanArn
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.
Date creationDate
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.
String versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1024 bytes long. They cannot be edited.
String backupPlanId
Uniquely identifies the backup plan to be associated with the selection of resources.
BackupSelection backupSelection
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.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
String selectionId
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
String backupPlanId
Uniquely identifies a backup plan.
Date creationDate
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.
String backupVaultName
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.
Map<K,V> backupVaultTags
Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.
String encryptionKeyArn
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.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
String backupVaultName
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.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
Date creationDate
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.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanArn
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.
Date deletionDate
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.
String versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
String backupVaultName
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.
String backupVaultName
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.
String backupVaultName
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.
String backupVaultName
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.
String recoveryPointArn
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.
String backupJobId
Uniquely identifies a request to AWS Backup to back up a resource.
String backupJobId
Uniquely identifies a request to AWS Backup to back up a resource.
String backupVaultName
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.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String resourceArn
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
Date creationDate
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.
Date completionDate
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.
String state
The current state of a resource recovery point.
String statusMessage
A detailed message explaining the status of the job to back up a resource.
String percentDone
Contains an estimated percentage that is complete of a job at the time the job status was queried.
Long backupSizeInBytes
The size, in bytes, of a backup.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
RecoveryPointCreator createdBy
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.
String resourceType
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.
Long bytesTransferred
The size in bytes transferred to a backup vault at the time that the job status was queried.
Date expectedCompletionDate
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.
Date startBy
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.
String backupVaultName
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.
String backupVaultName
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.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String encryptionKeyArn
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.
Date creationDate
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.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
Long numberOfRecoveryPoints
The number of recovery points that are stored in a backup vault.
String resourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String resourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
String resourceType
The type of AWS resource saved as a recovery point; for example, an EBS volume or an Amazon RDS database.
Date lastBackupTime
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.
String backupVaultName
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.
String recoveryPointArn
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.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
String backupVaultName
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.
String backupVaultArn
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String resourceArn
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
String resourceType
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.
RecoveryPointCreator createdBy
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.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
String status
A status code specifying the state of the recovery point.
A partial status indicates that the recovery point was not successfully re-created and must be retried.
Date creationDate
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.
Date completionDate
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.
Long backupSizeInBytes
The size, in bytes, of a backup.
CalculatedLifecycle calculatedLifecycle
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
timestamps.
Lifecycle lifecycle
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.
String encryptionKeyArn
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.
Boolean isEncrypted
A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or
FALSE if the recovery point is not encrypted.
String storageClass
Specifies the storage class of the recovery point. Valid values are WARM or COLD.
Date lastRestoreTime
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.
String restoreJobId
Uniquely identifies the job that restores a recovery point.
String restoreJobId
Uniquely identifies the job that restores a recovery point.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Date creationDate
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.
Date completionDate
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.
String status
Status code specifying the state of the job that is initiated by AWS Backup to restore a recovery point.
String statusMessage
A detailed message explaining the status of a job to restore a recovery point.
String percentDone
Contains an estimated percentage that is complete of a job at the time the job status was queried.
Long backupSizeInBytes
The size, in bytes, of the restored resource.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
Long expectedCompletionTimeMinutes
The amount of time in minutes that a job restoring a recovery point is expected to take.
String createdResourceArn
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.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanTemplateJson
The body of a backup plan template in JSON format.
This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.
String backupPlanTemplateJson
A customer-supplied backup plan document in JSON format.
BackupPlan backupPlan
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of
Rules.
String backupPlanTemplateId
Uniquely identifies a stored backup plan template.
BackupPlan backupPlanDocument
Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.
BackupPlan backupPlan
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of
Rules.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanArn
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.
String versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
Date creationDate
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.
Date deletionDate
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.
Date lastExecutionDate
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.
BackupSelection backupSelection
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.
String selectionId
Uniquely identifies the body of a request to assign a set of resources to a backup plan.
String backupPlanId
Uniquely identifies a backup plan.
Date creationDate
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.
String creatorRequestId
A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
String backupVaultName
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.
String backupVaultName
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.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String policy
The backup vault access policy document in JSON format.
String backupVaultName
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.
String backupVaultName
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.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String sNSTopicArn
An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example,
arn:aws:sns:us-west-2:111122223333:MyTopic.
List<E> backupVaultEvents
An array of events that indicate the status of jobs to back up resources to the backup vault.
String backupVaultName
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.
String recoveryPointArn
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.
String backupVaultArn
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Map<K,V> restoreMetadata
A set of metadata key-value pairs that lists the metadata key-value pairs that are required to restore the recovery point.
Long moveToColdStorageAfterDays
Specifies the number of days after creation that a recovery point is moved to cold storage.
Long deleteAfterDays
Specifies the number of days after creation that a recovery point is deleted. Must be greater than
MoveToColdStorageAfterDays.
String nextToken
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.
Integer maxResults
The maximum number of items to be returned.
String byResourceArn
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
String byState
Returns only backup jobs that are in the specified state.
String byBackupVaultName
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.
Date byCreatedBefore
Returns only backup jobs that were created before the specified date.
Date byCreatedAfter
Returns only backup jobs that were created after the specified date.
String byResourceType
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
List<E> backupJobs
An array of structures containing metadata about your backup jobs returned in JSON format.
String nextToken
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.
String nextToken
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.
Integer maxResults
The maximum number of items to be returned.
Boolean includeDeleted
A Boolean value with a default value of FALSE that returns deleted backup plans when set to
TRUE.
String nextToken
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.
List<E> backupPlansList
An array of backup plan list items containing metadata about your saved backup plans.
String nextToken
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.
Integer maxResults
The maximum number of items to be returned.
String nextToken
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.
List<E> backupPlanTemplatesList
An array of template list items containing metadata about your saved templates.
String backupPlanId
Uniquely identifies a backup plan.
String nextToken
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.
Integer maxResults
The maximum number of items to be returned.
String nextToken
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.
List<E> backupPlanVersionsList
An array of version list items containing metadata about your backup plans.
String backupPlanId
Uniquely identifies a backup plan.
String nextToken
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.
Integer maxResults
The maximum number of items to be returned.
String nextToken
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.
List<E> backupSelectionsList
An array of backup selection list items containing metadata about each resource in the list.
String nextToken
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.
Integer maxResults
The maximum number of items to be returned.
List<E> backupVaultList
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.
String nextToken
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.
String nextToken
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.
Integer maxResults
The maximum number of items to be returned.
List<E> results
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.
String nextToken
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.
String backupVaultName
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.
String nextToken
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.
Integer maxResults
The maximum number of items to be returned.
String byResourceArn
Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
String byResourceType
Returns only recovery points that match the specified resource type.
String byBackupPlanId
Returns only recovery points that match the specified backup plan ID.
Date byCreatedBefore
Returns only recovery points that were created before the specified timestamp.
Date byCreatedAfter
Returns only recovery points that were created after the specified timestamp.
String nextToken
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.
List<E> recoveryPoints
An array of objects that contain detailed information about recovery points saved in a backup vault.
String resourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
String nextToken
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.
Integer maxResults
The maximum number of items to be returned.
String nextToken
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.
List<E> recoveryPoints
An array of objects that contain detailed information about recovery points of the specified resource type.
String nextToken
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.
Integer maxResults
The maximum number of items to be returned.
List<E> restoreJobs
An array of objects that contain detailed information about jobs to restore saved resources.
String nextToken
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.
String resourceArn
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.
String nextToken
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.
Integer maxResults
The maximum number of items to be returned.
String nextToken
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.
Map<K,V> tags
To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.
String resourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String resourceType
The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
Date lastBackupTime
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.
String backupVaultName
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.
String policy
The backup vault access policy document in JSON format.
String backupVaultName
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.
String sNSTopicArn
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.
List<E> backupVaultEvents
An array of events that indicate the status of jobs to back up resources to the backup vault.
String recoveryPointArn
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.
String backupVaultName
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.
String backupVaultArn
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String resourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
String resourceType
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.
RecoveryPointCreator createdBy
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.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
String status
A status code specifying the state of the recovery point.
Date creationDate
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.
Date completionDate
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.
Long backupSizeInBytes
The size, in bytes, of a backup.
CalculatedLifecycle calculatedLifecycle
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
timestamps.
Lifecycle lifecycle
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.
String encryptionKeyArn
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.
Boolean isEncrypted
A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or
FALSE if the recovery point is not encrypted.
Date lastRestoreTime
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.
String recoveryPointArn
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.
Date creationDate
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.
String status
A status code specifying the state of the recovery point.
String encryptionKeyArn
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.
Long backupSizeBytes
The size, in bytes, of a backup.
String backupVaultName
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.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanArn
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.
String backupPlanVersion
Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
String backupRuleId
Uniquely identifies a rule used to schedule the backup of a selection of resources.
String restoreJobId
Uniquely identifies the job that restores a recovery point.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Date creationDate
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.
Date completionDate
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.
String status
A status code specifying the state of the job initiated by AWS Backup to restore a recovery point.
String statusMessage
A detailed message explaining the status of the job to restore a recovery point.
String percentDone
Contains an estimated percentage complete of a job at the time the job status was queried.
Long backupSizeInBytes
The size, in bytes, of the restored resource.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
Long expectedCompletionTimeMinutes
The amount of time in minutes that a job restoring a recovery point is expected to take.
String createdResourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String backupVaultName
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.
String resourceArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
String idempotencyToken
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.
Long startWindowMinutes
The amount of time in minutes before beginning a backup.
Long completeWindowMinutes
The amount of time AWS Backup attempts a backup before canceling the job and returning an error.
Lifecycle lifecycle
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.
Map<K,V> recoveryPointTags
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
String backupJobId
Uniquely identifies a request to AWS Backup to back up a resource.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Date creationDate
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.
String recoveryPointArn
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Map<K,V> metadata
A set of metadata key-value pairs. Lists the metadata that the recovery point was created with.
String iamRoleArn
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.
String idempotencyToken
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.
String resourceType
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
String restoreJobId
Uniquely identifies the job that restores a recovery point.
String backupJobId
Uniquely identifies a request to AWS Backup to back up a resource.
String backupPlanId
Uniquely identifies a backup plan.
BackupPlanInput backupPlan
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of
Rules.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanArn
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.
Date creationDate
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.
String versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
String backupVaultName
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.
String recoveryPointArn
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 lifecycle
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.
String backupVaultArn
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
String recoveryPointArn
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 lifecycle
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.
CalculatedLifecycle calculatedLifecycle
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
timestamps.
Copyright © 2020. All rights reserved.