You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudHSMV2::Types::DescribeClustersRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb

Overview

Note:

When making an API call, you may pass DescribeClustersRequest data as a hash:

{
  filters: {
    "Field" => ["String"],
  },
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#filtersHash<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.

Returns:

  • (Hash<String,Array<String>>)


431
432
433
434
435
436
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 431

class DescribeClustersRequest < Struct.new(
  :filters,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


431
432
433
434
435
436
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 431

class DescribeClustersRequest < Struct.new(
  :filters,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


431
432
433
434
435
436
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 431

class DescribeClustersRequest < Struct.new(
  :filters,
  :next_token,
  :max_results)
  include Aws::Structure
end