You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::OpsWorksCM::Types::Backup

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a single backup.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#backup_arn ⇒ String

The ARN of the backup.

Returns:

  • (String) —

    The ARN of the backup.

#backup_id ⇒ String

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

Returns:

  • (String) —

    The generated ID of the backup.

#backup_type ⇒ String

The backup type. Valid values are automated or manual.

Possible values:

  • AUTOMATED
  • MANUAL

Returns:

  • (String) —

    The backup type.

#created_at ⇒ Time

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

Returns:

  • (Time) —

    The time stamp when the backup was created in the database.

#description ⇒ String

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

Returns:

  • (String) —

    A user-provided description for a manual backup.

#engine ⇒ String

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

Returns:

  • (String) —

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

#engine_model ⇒ String

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

Returns:

  • (String) —

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

#engine_version ⇒ String

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

Returns:

  • (String) —

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

#instance_profile_arn ⇒ String

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.

Returns:

  • (String) —

    The EC2 instance profile ARN that is obtained from the server when the backup is created.

#instance_type ⇒ String

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

Returns:

  • (String) —

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

#key_pair ⇒ String

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

Returns:

  • (String) —

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

#preferred_backup_window ⇒ String

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

Returns:

  • (String) —

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

#preferred_maintenance_window ⇒ String

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

Returns:

  • (String) —

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

#s3_data_size ⇒ Integer

This field is deprecated and is no longer used.

Returns:

  • (Integer) —

    This field is deprecated and is no longer used.

#s3_data_url ⇒ String

This field is deprecated and is no longer used.

Returns:

  • (String) —

    This field is deprecated and is no longer used.

#s3_log_url ⇒ String

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

Returns:

  • (String) —

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

#security_group_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#server_name ⇒ String

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

Returns:

  • (String) —

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

#service_role_arn ⇒ String

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

Returns:

  • (String) —

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

#status ⇒ String

The status of a backup while in progress.

Possible values:

  • IN_PROGRESS
  • OK
  • FAILED
  • DELETING

Returns:

  • (String) —

    The status of a backup while in progress.

#status_description ⇒ String

An informational message about backup status.

Returns:

  • (String) —

    An informational message about backup status.

#subnet_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#tools_version ⇒ String

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

Returns:

  • (String) —

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

#user_arn ⇒ String

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

Returns:

  • (String) —

    The IAM user ARN of the requester for manual backups.