You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudHSMV2::Types::Backup

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#backup_id ⇒ String

The identifier (ID) of the backup.

Returns:

  • (String) —

    The identifier (ID) of the backup.

#backup_state ⇒ String

The state of the backup.

Possible values:

  • CREATE_IN_PROGRESS
  • READY
  • DELETED
  • PENDING_DELETION

Returns:

  • (String) —

    The state of the backup.

#cluster_id ⇒ String

The identifier (ID) of the cluster that was backed up.

Returns:

  • (String) —

    The identifier (ID) of the cluster that was backed up.

#copy_timestamp ⇒ Time

The date and time when the backup was copied from a source backup.

Returns:

  • (Time) —

    The date and time when the backup was copied from a source backup.

#create_timestamp ⇒ Time

The date and time when the backup was created.

Returns:

  • (Time) —

    The date and time when the backup was created.

#delete_timestamp ⇒ Time

The date and time when the backup will be permanently deleted.

Returns:

  • (Time) —

    The date and time when the backup will be permanently deleted.

#never_expires ⇒ Boolean

Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

Returns:

  • (Boolean) —

    Specifies whether the service should exempt a backup from the retention policy for the cluster.

#source_backup ⇒ String

The identifier (ID) of the source backup from which the new backup was copied.

Returns:

  • (String) —

    The identifier (ID) of the source backup from which the new backup was copied.

#source_cluster ⇒ String

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

Returns:

  • (String) —

    The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

#source_region ⇒ String

The AWS Region that contains the source backup from which the new backup was copied.

Returns:

  • (String) —

    The AWS Region that contains the source backup from which the new backup was copied.

#tag_list ⇒ Array<Types::Tag>

The list of tags for the backup.

Returns:

  • (Array<Types::Tag>) —

    The list of tags for the backup.