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

Inherits:

Struct

• Object
• Struct
• Aws::Backup::Types::StartCopyJobInput

Includes:

Structure

Defined in:

lib/aws-sdk-backup/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #destination_backup_vault_arn ⇒ String

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

• #iam_role_arn ⇒ String

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

• #idempotency_token ⇒ String

  A customer-chosen string that you can use to distinguish between otherwise identical calls to ‘StartCopyJob`.

• #lifecycle ⇒ Types::Lifecycle

  Specifies the time period, in days, before a recovery point transitions to cold storage or is deleted.

• #recovery_point_arn ⇒ String

  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.

• #source_backup_vault_name ⇒ String

  The name of a logical source container where backups are stored.

Instance Attribute Details

#destination_backup_vault_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 8152

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

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

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 8152

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

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)

# File 'lib/aws-sdk-backup/types.rb', line 8152

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

#lifecycle ⇒ Types::Lifecycle

Specifies the time period, 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 can’t 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.

To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for ‘MoveToColdStorageAfterDays` and `DeleteAfterDays`.

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

Returns:

• (Types::Lifecycle)

# File 'lib/aws-sdk-backup/types.rb', line 8152

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

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)

# File 'lib/aws-sdk-backup/types.rb', line 8152

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

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.

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 8152

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