AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idString

The identifier (ID) of the backup.

Returns:

  • (String)


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 73

class Backup < Struct.new(
  :backup_id,
  :backup_state,
  :cluster_id,
  :create_timestamp,
  :copy_timestamp,
  :never_expires,
  :source_region,
  :source_backup,
  :source_cluster,
  :delete_timestamp,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#backup_stateString

The state of the backup.

Returns:

  • (String)


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 73

class Backup < Struct.new(
  :backup_id,
  :backup_state,
  :cluster_id,
  :create_timestamp,
  :copy_timestamp,
  :never_expires,
  :source_region,
  :source_backup,
  :source_cluster,
  :delete_timestamp,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_idString

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

Returns:

  • (String)


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 73

class Backup < Struct.new(
  :backup_id,
  :backup_state,
  :cluster_id,
  :create_timestamp,
  :copy_timestamp,
  :never_expires,
  :source_region,
  :source_backup,
  :source_cluster,
  :delete_timestamp,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#copy_timestampTime

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

Returns:

  • (Time)


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 73

class Backup < Struct.new(
  :backup_id,
  :backup_state,
  :cluster_id,
  :create_timestamp,
  :copy_timestamp,
  :never_expires,
  :source_region,
  :source_backup,
  :source_cluster,
  :delete_timestamp,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#create_timestampTime

The date and time when the backup was created.

Returns:

  • (Time)


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 73

class Backup < Struct.new(
  :backup_id,
  :backup_state,
  :cluster_id,
  :create_timestamp,
  :copy_timestamp,
  :never_expires,
  :source_region,
  :source_backup,
  :source_cluster,
  :delete_timestamp,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#delete_timestampTime

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

Returns:

  • (Time)


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 73

class Backup < Struct.new(
  :backup_id,
  :backup_state,
  :cluster_id,
  :create_timestamp,
  :copy_timestamp,
  :never_expires,
  :source_region,
  :source_backup,
  :source_cluster,
  :delete_timestamp,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#never_expiresBoolean

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)


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 73

class Backup < Struct.new(
  :backup_id,
  :backup_state,
  :cluster_id,
  :create_timestamp,
  :copy_timestamp,
  :never_expires,
  :source_region,
  :source_backup,
  :source_cluster,
  :delete_timestamp,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#source_backupString

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

Returns:

  • (String)


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 73

class Backup < Struct.new(
  :backup_id,
  :backup_state,
  :cluster_id,
  :create_timestamp,
  :copy_timestamp,
  :never_expires,
  :source_region,
  :source_backup,
  :source_cluster,
  :delete_timestamp,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#source_clusterString

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

Returns:

  • (String)


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 73

class Backup < Struct.new(
  :backup_id,
  :backup_state,
  :cluster_id,
  :create_timestamp,
  :copy_timestamp,
  :never_expires,
  :source_region,
  :source_backup,
  :source_cluster,
  :delete_timestamp,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#source_regionString

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

Returns:

  • (String)


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 73

class Backup < Struct.new(
  :backup_id,
  :backup_state,
  :cluster_id,
  :create_timestamp,
  :copy_timestamp,
  :never_expires,
  :source_region,
  :source_backup,
  :source_cluster,
  :delete_timestamp,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#tag_listArray<Types::Tag>

The list of tags for the backup.

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 73

class Backup < Struct.new(
  :backup_id,
  :backup_state,
  :cluster_id,
  :create_timestamp,
  :copy_timestamp,
  :never_expires,
  :source_region,
  :source_backup,
  :source_cluster,
  :delete_timestamp,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end