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

Class: Aws::Backup::Types::StartBackupJobInput

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

Overview

Note:

When making an API call, you may pass StartBackupJobInput data as a hash:

{
  backup_vault_name: "BackupVaultName", # required
  resource_arn: "ARN", # required
  iam_role_arn: "IAMRoleArn", # required
  idempotency_token: "string",
  start_window_minutes: 1,
  complete_window_minutes: 1,
  lifecycle: {
    move_to_cold_storage_after_days: 1,
    delete_after_days: 1,
  },
  recovery_point_tags: {
    "TagKey" => "TagValue",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#backup_vault_nameString

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.

Returns:

  • (String)


3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3310

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags)
  include Aws::Structure
end

#complete_window_minutesInteger

The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

Returns:

  • (Integer)


3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3310

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags)
  include Aws::Structure
end

#iam_role_arnString

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Returns:

  • (String)


3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3310

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags)
  include Aws::Structure
end

#idempotency_tokenString

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.

Returns:

  • (String)


3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3310

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags)
  include Aws::Structure
end

#lifecycleTypes::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.

Returns:



3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3310

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags)
  include Aws::Structure
end

#recovery_point_tagsHash<String,String>

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

Returns:

  • (Hash<String,String>)


3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3310

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags)
  include Aws::Structure
end

#resource_arnString

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Returns:

  • (String)


3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3310

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags)
  include Aws::Structure
end

#start_window_minutesInteger

The amount of time in minutes before beginning a backup.

Returns:

  • (Integer)


3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3310

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags)
  include Aws::Structure
end