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

Inherits:

Struct

• Object
• Struct
• Aws::CloudHSMV2::Types::DescribeClustersRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cloudhsmv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

Returns:

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

# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 723

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

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

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 723

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

#next_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudhsmv2/types.rb', line 723

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