You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Backup::Types::StartBackupJobInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::StartBackupJobInput
- Defined in:
- (unknown)
Overview
When passing StartBackupJobInput as input to an Aws::Client method, you can use a vanilla 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",
},
}
Instance Attribute Summary collapse
-
#backup_options ⇒ Hash<String,String>
Specifies the backup option for a selected resource.
-
#backup_vault_name ⇒ String
The name of a logical container where backups are stored.
-
#complete_window_minutes ⇒ Integer
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup.
-
#iam_role_arn ⇒ String
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access
. -
#idempotency_token ⇒ String
A customer chosen string that can be used to distinguish between calls to
StartBackupJob
. -
#lifecycle ⇒ Types::Lifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
-
#recovery_point_tags ⇒ Hash<String,String>
To help organize your resources, you can assign your own metadata to the resources that you create.
-
#resource_arn ⇒ String
An Amazon Resource Name (ARN) that uniquely identifies a resource.
-
#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.
Instance Attribute Details
#backup_options ⇒ Hash<String,String>
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values: Set to "WindowsVSS”:“enabled"
to enable WindowsVSS
backup option and create a VSS Windows backup. Set to
“WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS
option is not enabled by default.
#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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
#complete_window_minutes ⇒ Integer
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.
#iam_role_arn ⇒ String
Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
#idempotency_token ⇒ String
A customer chosen string that can be used to distinguish between calls
to StartBackupJob
.
#lifecycle ⇒ Types::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.
#recovery_point_tags ⇒ Hash<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.
#resource_arn ⇒ String
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
#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.