blib/lib/Paws/RedShift/DescribeClusterSubnetGroups.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/DescribeClusterSnapshots.pm ↑ Summary blib/lib/Paws/RedShift/DescribeClusterVersions.pm »
1  
2 package Paws::RedShift::DescribeClusterSubnetGroups;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has ClusterSubnetGroupName => (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 => 'DescribeClusterSubnetGroups');
13 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::ClusterSubnetGroupMessage');
14 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeClusterSubnetGroupsResult');
15 1 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::RedShift::DescribeClusterSubnetGroups - Arguments for method DescribeClusterSubnetGroups on L<Paws::RedShift>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeClusterSubnetGroups on the
26 L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class
27 as arguments to method DescribeClusterSubnetGroups.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeClusterSubnetGroups.
30  
31 =head1 SYNOPSIS
32  
33 my $redshift = Paws->service('RedShift');
34 my $ClusterSubnetGroupMessage = $redshift->DescribeClusterSubnetGroups(
35 ClusterSubnetGroupName => '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 $ClusterSubnetGroups = $ClusterSubnetGroupMessage->ClusterSubnetGroups;
48 my $Marker = $ClusterSubnetGroupMessage->Marker;
49  
50 # Returns a L<Paws::RedShift::ClusterSubnetGroupMessage> object.
51  
52 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.
53 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DescribeClusterSubnetGroups>
54  
55 =head1 ATTRIBUTES
56  
57  
58 =head2 ClusterSubnetGroupName => Str
59  
60 The name of the cluster subnet group for which information is
61 requested.
62  
63  
64  
65 =head2 Marker => Str
66  
67 An optional parameter that specifies the starting point to return a set
68 of response records. When the results of a DescribeClusterSubnetGroups
69 request exceed the value specified in C<MaxRecords>, AWS returns a
70 value in the C<Marker> field of the response. You can retrieve the next
71 set of response records by providing the returned marker value in the
72 C<Marker> parameter and retrying the request.
73  
74  
75  
76 =head2 MaxRecords => Int
77  
78 The maximum number of response records to return in each call. If the
79 number of remaining response records exceeds the specified
80 C<MaxRecords> value, a value is returned in a C<marker> field of the
81 response. You can retrieve the next set of records by retrying the
82 command with the returned marker value.
83  
84 Default: C<100>
85  
86 Constraints: minimum 20, maximum 100.
87  
88  
89  
90 =head2 TagKeys => ArrayRef[Str|Undef]
91  
92 A tag key or keys for which you want to return all matching cluster
93 subnet groups that are associated with the specified key or keys. For
94 example, suppose that you have subnet groups that are tagged with keys
95 called C<owner> and C<environment>. If you specify both of these tag
96 keys in the request, Amazon Redshift returns a response with the subnet
97 groups that have either or both of these tag keys associated with them.
98  
99  
100  
101 =head2 TagValues => ArrayRef[Str|Undef]
102  
103 A tag value or values for which you want to return all matching cluster
104 subnet groups that are associated with the specified tag value or
105 values. For example, suppose that you have subnet groups that are
106 tagged with values called C<admin> and C<test>. If you specify both of
107 these tag values in the request, Amazon Redshift returns a response
108 with the subnet groups that have either or both of these tag values
109 associated with them.
110  
111  
112  
113  
114 =head1 SEE ALSO
115  
116 This class forms part of L<Paws>, documenting arguments for method DescribeClusterSubnetGroups in L<Paws::RedShift>
117  
118 =head1 BUGS and CONTRIBUTIONS
119  
120 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
121  
122 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
123  
124 =cut
125  
« blib/lib/Paws/RedShift/DescribeClusterSnapshots.pm ↑ Summary blib/lib/Paws/RedShift/DescribeClusterVersions.pm »