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:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#backup_policy ⇒ String

The cluster\'s backup policy.

Possible values:

  • DEFAULT

Returns:

  • (String) —

    The cluster\'s backup policy.

#backup_retention_policy ⇒ Types::BackupRetentionPolicy

A policy that defines how the service retains backups.

Returns:

#certificates ⇒ Types::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_id ⇒ String

The cluster\'s identifier (ID).

Returns:

  • (String) —

    The cluster\'s identifier (ID).

#create_timestamp ⇒ Time

The date and time when the cluster was created.

Returns:

  • (Time) —

    The date and time when the cluster was created.

#hsm_type ⇒ String

The type of HSM that the cluster contains.

Returns:

  • (String) —

    The type of HSM that the cluster contains.

#hsms ⇒ Array<Types::Hsm>

Contains information about the HSMs in the cluster.

Returns:

  • (Array<Types::Hsm>) —

    Contains information about the HSMs in the cluster.

#pre_co_password ⇒ String

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_group ⇒ String

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

Returns:

  • (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. 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.

#state ⇒ String

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_message ⇒ String

A description of the cluster\'s state.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (String) —

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