DescribeClustersRequest Class | AWS SDK for .NET V3

Container for the parameters to the DescribeClusters operation. Gets information about AWS 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 DescribeClusters 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudHSMV2.AmazonCloudHSMV2Request
      Amazon.CloudHSMV2.Model.DescribeClustersRequest

Namespace: Amazon.CloudHSMV2.Model
Assembly: AWSSDK.CloudHSMV2.dll
Version: 3.x.y.z

Syntax

public class DescribeClustersRequest : AmazonCloudHSMV2Request
         IAmazonWebServiceRequest

The DescribeClustersRequest type exposes the following members

Constructors

	Name	Description
	DescribeClustersRequest()

Properties

Name Type Description

Name	Type	Description
Filters	System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>	Gets and sets the property 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.
MaxResults	System.Int32	Gets and sets the property 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.
NextToken	System.String	Gets and sets the property NextToken. The `NextToken` value that you received in the previous response. Use this value to get more clusters.

Filters

System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Gets and sets the property 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.

MaxResults

System.Int32

Gets and sets the property 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.

NextToken

System.String

Gets and sets the property NextToken.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5