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