You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains information about an AWS CloudHSM cluster.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#backup_policyString

The cluster\'s backup policy.

Possible values:

  • DEFAULT

Returns:

  • (String)

    The cluster\'s backup policy.

#certificatesTypes::Certificates

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

Returns:

  • (Types::Certificates)

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

#cluster_idString

The cluster\'s identifier (ID).

Returns:

  • (String)

    The cluster\'s identifier (ID).

#create_timestampTime

The date and time when the cluster was created.

Returns:

  • (Time)

    The date and time when the cluster was created.

#hsm_typeString

The type of HSM that the cluster contains.

Returns:

  • (String)

    The type of HSM that the cluster contains.

#hsmsArray<Types::Hsm>

Contains information about the HSMs in the cluster.

Returns:

  • (Array<Types::Hsm>)

    Contains information about the HSMs in the cluster.

#pre_co_passwordString

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

Returns:

  • (String)

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

#security_groupString

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

Returns:

  • (String)

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

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

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

#stateString

The cluster\'s state.

Possible values:

  • CREATE_IN_PROGRESS
  • UNINITIALIZED
  • INITIALIZE_IN_PROGRESS
  • INITIALIZED
  • ACTIVE
  • UPDATE_IN_PROGRESS
  • DELETE_IN_PROGRESS
  • DELETED
  • DEGRADED

Returns:

  • (String)

    The cluster\'s state.

#state_messageString

A description of the cluster\'s state.

Returns:

  • (String)

    A description of the cluster\'s state.

#subnet_mappingHash<String,String>

A map of the cluster\'s subnets and their corresponding Availability Zones.

Returns:

  • (Hash<String,String>)

    A map of the cluster\'s subnets and their corresponding Availability Zones.

#vpc_idString

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

Returns:

  • (String)

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