Skip to content

DescribeClusters

Source: src/AWS/CloudHSMV2/DescribeClusters.ts

Runtime binding for the DescribeClusters operation (IAM action cloudhsm:DescribeClusters).

Lists the account’s CloudHSM clusters (optionally filtered by cluster id, VPC or state) with each cluster’s HSMs embedded — the building block of cluster-health monitoring and automatic-HSM-replacement automation. Provide the implementation with Effect.provide(AWS.CloudHSMV2.DescribeClustersHttp).

const describeClusters = yield* AWS.CloudHSMV2.DescribeClusters();
const page = yield* describeClusters({
Filters: { clusterIds: [clusterId] },
});
const active = page.Clusters?.[0]?.Hsms?.filter(
(hsm) => hsm.State === "ACTIVE",
);