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

Inherits:

Struct

• Object
• Struct
• Aws::OpsWorksCM::Types::Backup

Defined in:

gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb

Overview

Describes a single backup.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #backup_arn ⇒ String

  The ARN of the backup.

• #backup_id ⇒ String

  The generated ID of the backup.

• #backup_type ⇒ String

  The backup type.

• #created_at ⇒ Time

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

• #description ⇒ 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.

• #engine_model ⇒ 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.

• #instance_profile_arn ⇒ 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.

• #key_pair ⇒ 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.

• #preferred_maintenance_window ⇒ 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.

• #s3_data_url ⇒ String

  This field is deprecated and is no longer used.

• #s3_log_url ⇒ 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.

• #server_name ⇒ 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.

• #status ⇒ String

  The status of a backup while in progress.

• #status_description ⇒ 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.

• #tools_version ⇒ 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.

Instance Attribute Details

#backup_arn ⇒ String

The ARN of the backup.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#backup_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#backup_type ⇒ String

The backup type. Valid values are automated or manual.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine_model ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#key_pair ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_backup_window ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#s3_data_size ⇒ Integer

This field is deprecated and is no longer used.

Returns:

• (Integer)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#s3_data_url ⇒ String

This field is deprecated and is no longer used.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#s3_log_url ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#server_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#service_role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of a backup while in progress.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status_description ⇒ String

An informational message about backup status.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tools_version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#user_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 215

class Backup < Struct.new(
  :backup_arn,
  :backup_id,
  :backup_type,
  :created_at,
  :description,
  :engine,
  :engine_model,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :s3_data_size,
  :s3_data_url,
  :s3_log_url,
  :security_group_ids,
  :server_name,
  :service_role_arn,
  :status,
  :status_description,
  :subnet_ids,
  :tools_version,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end