You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudHSMV2::Types::DescribeClustersRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudHSMV2::Types::DescribeClustersRequest
- Defined in:
- (unknown)
Overview
When passing DescribeClustersRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
filters: {
"Field" => ["String"],
},
next_token: "NextToken",
max_results: 1,
}
Instance Attribute Summary collapse
-
#filters ⇒ Hash<String,Array<String>>
One or more filters to limit the items returned in the response.
-
#max_results ⇒ Integer
The maximum number of clusters to return in the response.
-
#next_token ⇒ String
The
NextToken
value that you received in the previous response.
Instance Attribute Details
#filters ⇒ Hash<String,Array<String>>
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.
#max_results ⇒ Integer
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.
#next_token ⇒ String
The NextToken
value that you received in the previous response. Use
this value to get more clusters.