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

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

Overview

Contains information about a backup of an 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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_arn ⇒ String

The Amazon Resource Name (ARN) of the backup.

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#backup_id ⇒ String

The identifier (ID) of the backup.

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#backup_state ⇒ String

The state of the backup.

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#cluster_id ⇒ String

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

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#copy_timestamp ⇒ Time

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

Returns:

  • (Time) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#create_timestamp ⇒ Time

The date and time when the backup was created.

Returns:

  • (Time) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#delete_timestamp ⇒ Time

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

Returns:

  • (Time) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#hsm_type ⇒ String

The HSM type used to create the backup.

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#mode ⇒ String

The mode of the cluster that was backed up.

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#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) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#source_backup ⇒ String

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

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#source_cluster ⇒ String

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

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#source_region ⇒ String

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

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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

#tag_list ⇒ Array<Types::Tag>

The list of tags for the backup.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 85

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