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::Cluster

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

Overview

Contains information about an AWS CloudHSM cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_policyString

The cluster's backup policy.

Returns:

  • (String)


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_policyTypes::BackupRetentionPolicy

A policy that defines how the service retains backups.



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#certificatesTypes::Certificates

Contains one or more certificates or a certificate signing request (CSR).

Returns:



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_idString

The cluster's identifier (ID).

Returns:

  • (String)


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#create_timestampTime

The date and time when the cluster was created.

Returns:

  • (Time)


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#hsm_typeString

The type of HSM that the cluster contains.

Returns:

  • (String)


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#hsmsArray<Types::Hsm>

Contains information about the HSMs in the cluster.

Returns:



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#pre_co_passwordString

The default password for the cluster's Pre-Crypto Officer (PRECO) user.

Returns:

  • (String)


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#security_groupString

The identifier (ID) of the cluster's security group.

Returns:

  • (String)


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#source_backup_idString

The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

Returns:

  • (String)


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The cluster's state.

Returns:

  • (String)


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#state_messageString

A description of the cluster's state.

Returns:

  • (String)


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_mappingHash<String,String>

A map from availability zone to the cluster’s subnet in that availability zone.

Returns:

  • (Hash<String,String>)


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#tag_listArray<Types::Tag>

The list of tags for the cluster.

Returns:



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_idString

The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

Returns:

  • (String)


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 306

class Cluster < Struct.new(
  :backup_policy,
  :backup_retention_policy,
  :cluster_id,
  :create_timestamp,
  :hsms,
  :hsm_type,
  :pre_co_password,
  :security_group,
  :source_backup_id,
  :state,
  :state_message,
  :subnet_mapping,
  :vpc_id,
  :certificates,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end