blib/lib/Paws/RedShift/DescribeClusterSecurityGroups.pm

filter: Statementstmt 100% 15 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 17 / 17 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/RedShift/DescribeClusterParameters.pm ↑ Summary blib/lib/Paws/RedShift/DescribeClusterSnapshots.pm »
1  
2 package Paws::RedShift::DescribeClusterSecurityGroups;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has ClusterSecurityGroupName => (is => 'ro', isa => 'Str');
5 1 has Marker => (is => 'ro', isa => 'Str');
6 1 has MaxRecords => (is => 'ro', isa => 'Int');
7 1 has TagKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8 1 has TagValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9  
10 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeClusterSecurityGroups');
13 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::ClusterSecurityGroupMessage');
14 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeClusterSecurityGroupsResult');
15 1 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::RedShift::DescribeClusterSecurityGroups - Arguments for method DescribeClusterSecurityGroups on L<Paws::RedShift>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeClusterSecurityGroups on the
26 L<Amazon Redshift|Paws::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 =head1 SYNOPSIS
32  
33 my $redshift = Paws->service('RedShift');
34 my $ClusterSecurityGroupMessage = $redshift->DescribeClusterSecurityGroups(
35 ClusterSecurityGroupName => 'MyString', # OPTIONAL
36 Marker => 'MyString', # OPTIONAL
37 MaxRecords => 1, # OPTIONAL
38 TagKeys => [
39 'MyString', ... # max: 2147483647
40 ], # OPTIONAL
41 TagValues => [
42 'MyString', ... # max: 2147483647
43 ], # OPTIONAL
44 );
45  
46 # Results:
47 my $ClusterSecurityGroups =
48 $ClusterSecurityGroupMessage->ClusterSecurityGroups;
49 my $Marker = $ClusterSecurityGroupMessage->Marker;
50  
51 # Returns a L<Paws::RedShift::ClusterSecurityGroupMessage> object.
52  
53 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.
54 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DescribeClusterSecurityGroups>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 ClusterSecurityGroupName => Str
60  
61 The name of a cluster security group for which you are requesting
62 details. You can specify either the B<Marker> parameter or a
63 B<ClusterSecurityGroupName> parameter, but not both.
64  
65 Example: C<securitygroup1>
66  
67  
68  
69 =head2 Marker => Str
70  
71 An optional parameter that specifies the starting point to return a set
72 of response records. When the results of a
73 DescribeClusterSecurityGroups request exceed the value specified in
74 C<MaxRecords>, AWS returns a value in the C<Marker> field of the
75 response. You can retrieve the next set of response records by
76 providing the returned marker value in the C<Marker> parameter and
77 retrying the request.
78  
79 Constraints: You can specify either the B<ClusterSecurityGroupName>
80 parameter or the B<Marker> parameter, but not both.
81  
82  
83  
84 =head2 MaxRecords => Int
85  
86 The maximum number of response records to return in each call. If the
87 number of remaining response records exceeds the specified
88 C<MaxRecords> value, a value is returned in a C<marker> field of the
89 response. You can retrieve the next set of records by retrying the
90 command with the returned marker value.
91  
92 Default: C<100>
93  
94 Constraints: minimum 20, maximum 100.
95  
96  
97  
98 =head2 TagKeys => ArrayRef[Str|Undef]
99  
100 A tag key or keys for which you want to return all matching cluster
101 security groups that are associated with the specified key or keys. For
102 example, suppose that you have security groups that are tagged with
103 keys called C<owner> and C<environment>. If you specify both of these
104 tag keys in the request, Amazon Redshift returns a response with the
105 security groups that have either or both of these tag keys associated
106 with them.
107  
108  
109  
110 =head2 TagValues => ArrayRef[Str|Undef]
111  
112 A tag value or values for which you want to return all matching cluster
113 security groups that are associated with the specified tag value or
114 values. For example, suppose that you have security groups that are
115 tagged with values called C<admin> and C<test>. If you specify both of
116 these tag values in the request, Amazon Redshift returns a response
117 with the security groups that have either or both of these tag values
118 associated with them.
119  
120  
121  
122  
123 =head1 SEE ALSO
124  
125 This class forms part of L<Paws>, documenting arguments for method DescribeClusterSecurityGroups in L<Paws::RedShift>
126  
127 =head1 BUGS and CONTRIBUTIONS
128  
129 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
130  
131 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
132  
133 =cut
134  
« blib/lib/Paws/RedShift/DescribeClusterParameters.pm ↑ Summary blib/lib/Paws/RedShift/DescribeClusterSnapshots.pm »