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 CloudHSM cluster.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_policy ⇒ String

The cluster's backup policy.

Returns:

  • (String) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#backup_retention_policy ⇒ Types::BackupRetentionPolicy

A policy that defines how the service retains backups.

Returns:



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#certificates ⇒ Types::Certificates

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

Returns:



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#cluster_id ⇒ String

The cluster's identifier (ID).

Returns:

  • (String) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#create_timestamp ⇒ Time

The date and time when the cluster was created.

Returns:

  • (Time) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#hsm_type ⇒ String

The type of HSM that the cluster contains.

Returns:

  • (String) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#hsm_type_rollback_expiration ⇒ Time

The timestamp until when the cluster can be rolled back to its original HSM type.

Returns:

  • (Time) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#hsms ⇒ Array<Types::Hsm>

Contains information about the HSMs in the cluster.

Returns:



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#mode ⇒ String

The mode of the cluster.

Returns:

  • (String) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#network_type ⇒ String

The cluster's NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.

Returns:

  • (String) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#pre_co_password ⇒ String

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

Returns:

  • (String) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#security_group ⇒ String

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

Returns:

  • (String) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#source_backup_id ⇒ String

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) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#state ⇒ String

The cluster's state.

Returns:

  • (String) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#state_message ⇒ String

A description of the cluster's state.

Returns:

  • (String) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#subnet_mapping ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#tag_list ⇒ Array<Types::Tag>

The list of tags for the cluster.

Returns:



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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

#vpc_id ⇒ String

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

Returns:

  • (String) 


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 349

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