class Aws::Backup::Types::StartBackupJobInput
@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", }, }
@!attribute [rw] backup_vault_name
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. @return [String]
@!attribute [rw] resource_arn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type. @return [String]
@!attribute [rw] iam_role_arn
Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`. @return [String]
@!attribute [rw] idempotency_token
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. @return [String]
@!attribute [rw] start_window_minutes
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. @return [Integer]
@!attribute [rw] complete_window_minutes
A value in minutes during which a successfully started backup must complete, or else AWS 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. @return [Integer]
@!attribute [rw] 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 “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. Only Amazon EFS file system backups can be transitioned to cold storage. @return [Types::Lifecycle]
@!attribute [rw] recovery_point_tags
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. @return [Hash<String,String>]
@!attribute [rw] backup_options
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. @return [Hash<String,String>]
@see docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartBackupJobInput AWS API Documentation
Constants
- SENSITIVE