Skip to content

Describe Clusters

cloudhsmv2_describe_clusters R Documentation

Gets information about CloudHSM clusters

Description

Gets information about CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent describe_clusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.

Usage

cloudhsmv2_describe_clusters(Filters, NextToken, MaxResults)

Arguments

Filters

One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

NextToken

The NextToken value that you received in the previous response. Use this value to get more clusters.

MaxResults

The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

Value

A list with the following syntax: 

list(
  Clusters = list(
    list(
      BackupPolicy = "DEFAULT",
      BackupRetentionPolicy = list(
        Type = "DAYS",
        Value = "string"
      ),
      ClusterId = "string",
      CreateTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      Hsms = list(
        list(
          AvailabilityZone = "string",
          ClusterId = "string",
          SubnetId = "string",
          EniId = "string",
          EniIp = "string",
          HsmId = "string",
          State = "CREATE_IN_PROGRESS"|"ACTIVE"|"DEGRADED"|"DELETE_IN_PROGRESS"|"DELETED",
          StateMessage = "string"
        )
      ),
      HsmType = "string",
      PreCoPassword = "string",
      SecurityGroup = "string",
      SourceBackupId = "string",
      State = "CREATE_IN_PROGRESS"|"UNINITIALIZED"|"INITIALIZE_IN_PROGRESS"|"INITIALIZED"|"ACTIVE"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DEGRADED",
      StateMessage = "string",
      SubnetMapping = list(
        "string"
      ),
      VpcId = "string",
      Certificates = list(
        ClusterCsr = "string",
        HsmCertificate = "string",
        AwsHardwareCertificate = "string",
        ManufacturerHardwareCertificate = "string",
        ClusterCertificate = "string"
      ),
      TagList = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      Mode = "FIPS"|"NON_FIPS"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_clusters(
  Filters = list(
    list(
      "string"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)