Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudhsmv2 ]

delete-cluster

Description

Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters . To delete an HSM, use DeleteHsm .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-cluster
--cluster-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--cluster-id (string)

The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Cluster -> (structure)

Information about the cluster that was deleted.

BackupPolicy -> (string)

The cluster's backup policy.

BackupRetentionPolicy -> (structure)

A policy that defines how the service retains backups.

Type -> (string)

The type of backup retention policy. For the DAYS type, the value is the number of days to retain backups.

Value -> (string)

Use a value between 7 - 379.

ClusterId -> (string)

The cluster's identifier (ID).

CreateTimestamp -> (timestamp)

The date and time when the cluster was created.

Hsms -> (list)

Contains information about the HSMs in the cluster.

(structure)

Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.

AvailabilityZone -> (string)

The Availability Zone that contains the HSM.

ClusterId -> (string)

The identifier (ID) of the cluster that contains the HSM.

SubnetId -> (string)

The subnet that contains the HSM's elastic network interface (ENI).

EniId -> (string)

The identifier (ID) of the HSM's elastic network interface (ENI).

EniIp -> (string)

The IP address of the HSM's elastic network interface (ENI).

HsmId -> (string)

The HSM's identifier (ID).

State -> (string)

The HSM's state.

StateMessage -> (string)

A description of the HSM's state.

HsmType -> (string)

The type of HSM that the cluster contains.

PreCoPassword -> (string)

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

SecurityGroup -> (string)

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

SourceBackupId -> (string)

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

State -> (string)

The cluster's state.

StateMessage -> (string)

A description of the cluster's state.

SubnetMapping -> (map)

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

key -> (string)

value -> (string)

VpcId -> (string)

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

Certificates -> (structure)

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

ClusterCsr -> (string)

The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED .

HsmCertificate -> (string)

The HSM certificate issued (signed) by the HSM hardware.

AwsHardwareCertificate -> (string)

The HSM hardware certificate issued (signed) by AWS CloudHSM.

ManufacturerHardwareCertificate -> (string)

The HSM hardware certificate issued (signed) by the hardware manufacturer.

ClusterCertificate -> (string)

The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.

TagList -> (list)

The list of tags for the cluster.

(structure)

Contains a tag. A tag is a key-value pair.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.