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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb

Overview

Describes a single backup.

Instance Attribute Summary collapse

Instance Attribute Details

#backup_arnString

The ARN of the backup.

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#backup_idString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#backup_typeString

The backup type. Valid values are automated or manual.

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#created_atTime

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

Returns:

  • (Time)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#engineString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#engine_modelString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#engine_versionString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#instance_profile_arnString

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)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#instance_typeString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#key_pairString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#preferred_backup_windowString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#preferred_maintenance_windowString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#s3_data_sizeInteger

This field is deprecated and is no longer used.

Returns:

  • (Integer)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#s3_data_urlString

This field is deprecated and is no longer used.

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#s3_log_urlString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#security_group_idsArray<String>

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

Returns:

  • (Array<String>)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#server_nameString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#service_role_arnString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#statusString

The status of a backup while in progress.

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#status_descriptionString

An informational message about backup status.

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#subnet_idsArray<String>

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

Returns:

  • (Array<String>)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#tools_versionString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end

#user_arnString

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

Returns:

  • (String)


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 217

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)
  include Aws::Structure
end