Menu
AWS OpsWorks CM
API Reference (API Version 2016-11-01)

Backup

Describes a single backup.

Contents

BackupArn

The ARN of the backup.

Type: String

Required: No

BackupId

The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

Type: String

Length Constraints: Maximum length of 79.

Required: No

BackupType

The backup type. Valid values are automated or manual.

Type: String

Valid Values: AUTOMATED | MANUAL

Required: No

CreatedAt

The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

Type: Timestamp

Required: No

Description

A user-provided description for a manual backup. This field is empty for automated backups.

Type: String

Required: No

Engine

The engine type that is obtained from the server when the backup is created.

Type: String

Required: No

EngineModel

The engine model that is obtained from the server when the backup is created.

Type: String

Required: No

EngineVersion

The engine version that is obtained from the server when the backup is created.

Type: String

Required: No

InstanceProfileArn

The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.

Type: String

Required: No

InstanceType

The instance type that is obtained from the server when the backup is created.

Type: String

Required: No

KeyPair

The key pair that is obtained from the server when the backup is created.

Type: String

Required: No

PreferredBackupWindow

The preferred backup period that is obtained from the server when the backup is created.

Type: String

Pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$

Required: No

PreferredMaintenanceWindow

The preferred maintenance period that is obtained from the server when the backup is created.

Type: String

Pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$

Required: No

S3DataSize

This field is deprecated and is no longer used.

Type: Integer

Required: No

S3DataUrl

This field is deprecated and is no longer used.

Type: String

Required: No

S3LogUrl

The Amazon S3 URL of the backup's log file.

Type: String

Required: No

SecurityGroupIds

The security group IDs that are obtained from the server when the backup is created.

Type: Array of strings

Required: No

ServerName

The name of the server from which the backup was made.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: No

ServiceRoleArn

The service role ARN that is obtained from the server when the backup is created.

Type: String

Required: No

Status

The status of a backup while in progress.

Type: String

Valid Values: IN_PROGRESS | OK | FAILED | DELETING

Required: No

StatusDescription

An informational message about backup status.

Type: String

Required: No

SubnetIds

The subnet IDs that are obtained from the server when the backup is created.

Type: Array of strings

Required: No

ToolsVersion

The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

Type: String

Required: No

UserArn

The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: