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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:recovery_point_tags]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_options ⇒ Hash<String,String>

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


8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
 
# File 'lib/aws-sdk-backup/types.rb', line 8046

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_name ⇒ String

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.

Returns:

  • (String) 


8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
 
# File 'lib/aws-sdk-backup/types.rb', line 8046

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_minutes ⇒ Integer

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.

Like ‘StartWindowMinutes`, this parameter has a maximum value of 100 years (52,560,000 minutes).

Returns:

  • (Integer) 


8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
 
# File 'lib/aws-sdk-backup/types.rb', line 8046

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_arn ⇒ String

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

Returns:

  • (String) 


8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
 
# File 'lib/aws-sdk-backup/types.rb', line 8046

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_token ⇒ String

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) 


8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
 
# File 'lib/aws-sdk-backup/types.rb', line 8046

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

#lifecycle ⇒ Types::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 can transition to cold storage are listed in the

Feature availability by resource][1

table. Backup ignores this

expression for other resource types.

This parameter has a maximum value of 100 years (36,500 days).

[1]: docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource

Returns:



8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
 
# File 'lib/aws-sdk-backup/types.rb', line 8046

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_tags ⇒ Hash<String,String>

The tags to assign to the resources.

Returns:

  • (Hash<String,String>) 


8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
 
# File 'lib/aws-sdk-backup/types.rb', line 8046

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_arn ⇒ String

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

Returns:

  • (String) 


8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
 
# File 'lib/aws-sdk-backup/types.rb', line 8046

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_minutes ⇒ Integer

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. If this value is included, it must be at least 60 minutes to avoid errors.

This parameter has a maximum value of 100 years (52,560,000 minutes).

During the start window, the backup job status remains in ‘CREATED` status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to `RUNNING`) or until the job status changes to `EXPIRED` (which is expected to occur when the start window time is over).

Returns:

  • (Integer) 


8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
 
# File 'lib/aws-sdk-backup/types.rb', line 8046

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