Class: Aws::Backup::Types::StartCopyJobInput

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 StartCopyJobInput data as a hash:

{
  recovery_point_arn: "ARN", # required
  source_backup_vault_name: "BackupVaultName", # required
  destination_backup_vault_arn: "ARN", # required
  iam_role_arn: "IAMRoleArn", # required
  idempotency_token: "string",
  lifecycle: {
    move_to_cold_storage_after_days: 1,
    delete_after_days: 1,
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination_backup_vault_arnString

An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Returns:

  • (String)


5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5943

class StartCopyJobInput < Struct.new(
  :recovery_point_arn,
  :source_backup_vault_name,
  :destination_backup_vault_arn,
  :iam_role_arn,
  :idempotency_token,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arnString

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

Returns:

  • (String)


5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5943

class StartCopyJobInput < Struct.new(
  :recovery_point_arn,
  :source_backup_vault_name,
  :destination_backup_vault_arn,
  :iam_role_arn,
  :idempotency_token,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#idempotency_tokenString

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

Returns:

  • (String)


5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5943

class StartCopyJobInput < Struct.new(
  :recovery_point_arn,
  :source_backup_vault_name,
  :destination_backup_vault_arn,
  :iam_role_arn,
  :idempotency_token,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycleTypes::Lifecycle

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, 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:



5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5943

class StartCopyJobInput < Struct.new(
  :recovery_point_arn,
  :source_backup_vault_name,
  :destination_backup_vault_arn,
  :iam_role_arn,
  :idempotency_token,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_point_arnString

An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Returns:

  • (String)


5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5943

class StartCopyJobInput < Struct.new(
  :recovery_point_arn,
  :source_backup_vault_name,
  :destination_backup_vault_arn,
  :iam_role_arn,
  :idempotency_token,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#source_backup_vault_nameString

The name of a logical source 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)


5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 5943

class StartCopyJobInput < Struct.new(
  :recovery_point_arn,
  :source_backup_vault_name,
  :destination_backup_vault_arn,
  :iam_role_arn,
  :idempotency_token,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end