File Coverage

blib/lib/Paws/RedShift/DescribeClusterSecurityGroups.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RedShift::DescribeClusterSecurityGroups;
3 1     1   884 use Moose;
  1     1   6  
  1         14  
  1         475  
  1         2  
  1         7  
4             has ClusterSecurityGroupName => (is => 'ro', isa => 'Str');
5             has Marker => (is => 'ro', isa => 'Str');
6             has MaxRecords => (is => 'ro', isa => 'Int');
7             has TagKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8             has TagValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9              
10 1     1   8377 use MooseX::ClassAttribute;
  1     1   5  
  1         12  
  1         6554  
  1         3  
  1         7  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeClusterSecurityGroups');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::ClusterSecurityGroupMessage');
14             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeClusterSecurityGroupsResult');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::RedShift::DescribeClusterSecurityGroups - Arguments for method DescribeClusterSecurityGroups on Paws::RedShift
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method DescribeClusterSecurityGroups on the
26             Amazon Redshift service. Use the attributes of this class
27             as arguments to method DescribeClusterSecurityGroups.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeClusterSecurityGroups.
30              
31             As an example:
32              
33             $service_obj->DescribeClusterSecurityGroups(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 ClusterSecurityGroupName => Str
41              
42             The name of a cluster security group for which you are requesting
43             details. You can specify either the B<Marker> parameter or a
44             B<ClusterSecurityGroupName> parameter, but not both.
45              
46             Example: C<securitygroup1>
47              
48              
49              
50             =head2 Marker => Str
51              
52             An optional parameter that specifies the starting point to return a set
53             of response records. When the results of a
54             DescribeClusterSecurityGroups request exceed the value specified in
55             C<MaxRecords>, AWS returns a value in the C<Marker> field of the
56             response. You can retrieve the next set of response records by
57             providing the returned marker value in the C<Marker> parameter and
58             retrying the request.
59              
60             Constraints: You can specify either the B<ClusterSecurityGroupName>
61             parameter or the B<Marker> parameter, but not both.
62              
63              
64              
65             =head2 MaxRecords => Int
66              
67             The maximum number of response records to return in each call. If the
68             number of remaining response records exceeds the specified
69             C<MaxRecords> value, a value is returned in a C<marker> field of the
70             response. You can retrieve the next set of records by retrying the
71             command with the returned marker value.
72              
73             Default: C<100>
74              
75             Constraints: minimum 20, maximum 100.
76              
77              
78              
79             =head2 TagKeys => ArrayRef[Str|Undef]
80              
81             A tag key or keys for which you want to return all matching cluster
82             security groups that are associated with the specified key or keys. For
83             example, suppose that you have security groups that are tagged with
84             keys called C<owner> and C<environment>. If you specify both of these
85             tag keys in the request, Amazon Redshift returns a response with the
86             security groups that have either or both of these tag keys associated
87             with them.
88              
89              
90              
91             =head2 TagValues => ArrayRef[Str|Undef]
92              
93             A tag value or values for which you want to return all matching cluster
94             security groups that are associated with the specified tag value or
95             values. For example, suppose that you have security groups that are
96             tagged with values called C<admin> and C<test>. If you specify both of
97             these tag values in the request, Amazon Redshift returns a response
98             with the security groups that have either or both of these tag values
99             associated with them.
100              
101              
102              
103              
104             =head1 SEE ALSO
105              
106             This class forms part of L<Paws>, documenting arguments for method DescribeClusterSecurityGroups in L<Paws::RedShift>
107              
108             =head1 BUGS and CONTRIBUTIONS
109              
110             The source code is located here: https://github.com/pplu/aws-sdk-perl
111              
112             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
113              
114             =cut
115