Class: Aws::CloudHSMV2::Types::Cluster

Inherits:

Struct

• Object
• Struct
• Aws::CloudHSMV2::Types::Cluster

Includes:

Structure

Defined in:

lib/aws-sdk-cloudhsmv2/types.rb

Overview

Contains information about an CloudHSM cluster.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #backup_policy ⇒ String

  The cluster’s backup policy.

• #backup_retention_policy ⇒ Types::BackupRetentionPolicy

  A policy that defines how the service retains backups.

• #certificates ⇒ Types::Certificates

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

• #cluster_id ⇒ String

  The cluster’s identifier (ID).

• #create_timestamp ⇒ Time

  The date and time when the cluster was created.

• #hsm_type ⇒ String

  The type of HSM that the cluster contains.

• #hsm_type_rollback_expiration ⇒ Time

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

• #hsms ⇒ Array<Types::Hsm>

  Contains information about the HSMs in the cluster.

• #mode ⇒ String

  The mode of the cluster.

• #network_type ⇒ String

  The cluster’s NetworkType can be IPv4 (the default) or DUALSTACK.

• #pre_co_password ⇒ String

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

• #security_group ⇒ String

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

• #source_backup_id ⇒ String

  The identifier (ID) of the backup used to create the cluster.

• #state ⇒ String

  The cluster’s state.

• #state_message ⇒ String

  A description of the cluster’s state.

• #subnet_mapping ⇒ Hash<String,String>

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

• #tag_list ⇒ Array<Types::Tag>

  The list of tags for the cluster.

• #vpc_id ⇒ String

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

Instance Attribute Details

#backup_policy ⇒ String

The cluster’s backup policy.

Returns:

• (String)

# File '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:

• (Types::BackupRetentionPolicy)

# File '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:

• (Types::Certificates)

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

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

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

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

# File '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:

• (Array<Types::Hsm>)

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

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

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

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

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

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

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

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

# File '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:

• (Array<Types::Tag>)

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

# File '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