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",
  },
  backup_options: {
    "BackupOptionKey" => "BackupOptionValue",
  },
}

Constant Summary collapse

SENSITIVE =
[:recovery_point_tags]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_optionsHash<String,String>

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Returns:

  • (Hash<String,String>)


5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5833

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

#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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Returns:

  • (String)


5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5833

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

#complete_window_minutesInteger

A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

Returns:

  • (Integer)


5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5833

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :backup_options)
  SENSITIVE = [: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)


5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5833

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

#idempotency_tokenString

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Returns:

  • (String)


5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5833

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :backup_options)
  SENSITIVE = [: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. 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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

Returns:



5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5833

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :backup_options)
  SENSITIVE = [: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>)


5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5833

class StartBackupJobInput < Struct.new(
  :backup_vault_name,
  :resource_arn,
  :iam_role_arn,
  :idempotency_token,
  :start_window_minutes,
  :complete_window_minutes,
  :lifecycle,
  :recovery_point_tags,
  :backup_options)
  SENSITIVE = [: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)


5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5833

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

#start_window_minutesInteger

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.

Returns:

  • (Integer)


5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5833

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