File Coverage

blib/lib/Paws/CloudHSMv2/DescribeClusters.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CloudHSMv2::DescribeClusters;
3 1     1   309 use Moose;
  1         2  
  1         7  
4             has Filters => (is => 'ro', isa => 'Paws::CloudHSMv2::Filters');
5             has MaxResults => (is => 'ro', isa => 'Int');
6             has NextToken => (is => 'ro', isa => 'Str');
7              
8 1     1   5468 use MooseX::ClassAttribute;
  1         2  
  1         7  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeClusters');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudHSMv2::DescribeClustersResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::CloudHSMv2::DescribeClusters - Arguments for method DescribeClusters on Paws::CloudHSMv2
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method DescribeClusters on the
24             AWS CloudHSM V2 service. Use the attributes of this class
25             as arguments to method DescribeClusters.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeClusters.
28              
29             As an example:
30              
31             $service_obj->DescribeClusters(Att1 => $value1, Att2 => $value2, ...);
32              
33             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 Filters => L<Paws::CloudHSMv2::Filters>
39              
40             One or more filters to limit the items returned in the response.
41              
42             Use the C<clusterIds> filter to return only the specified clusters.
43             Specify clusters by their cluster identifier (ID).
44              
45             Use the C<vpcIds> filter to return only the clusters in the specified
46             virtual private clouds (VPCs). Specify VPCs by their VPC identifier
47             (ID).
48              
49             Use the C<states> filter to return only clusters that match the
50             specified state.
51              
52              
53              
54             =head2 MaxResults => Int
55              
56             The maximum number of clusters to return in the response. When there
57             are more clusters than the number you specify, the response contains a
58             C<NextToken> value.
59              
60              
61              
62             =head2 NextToken => Str
63              
64             The C<NextToken> value that you received in the previous response. Use
65             this value to get more clusters.
66              
67              
68              
69              
70             =head1 SEE ALSO
71              
72             This class forms part of L<Paws>, documenting arguments for method DescribeClusters in L<Paws::CloudHSMv2>
73              
74             =head1 BUGS and CONTRIBUTIONS
75              
76             The source code is located here: https://github.com/pplu/aws-sdk-perl
77              
78             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
79              
80             =cut
81