blib/lib/Paws/RedShift/GetClusterCredentials.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::RedShift::GetClusterCredentials;
3 use Moose;
4 has AutoCreate => (is => 'ro', isa => 'Bool');
5 has ClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
6 has DbGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7 has DbName => (is => 'ro', isa => 'Str');
8 has DbUser => (is => 'ro', isa => 'Str', required => 1);
9 has DurationSeconds => (is => 'ro', isa => 'Int');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetClusterCredentials');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::ClusterCredentials');
15 class_has _result_key => (isa => 'Str', is => 'ro', default => 'GetClusterCredentialsResult');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::RedShift::GetClusterCredentials - Arguments for method GetClusterCredentials on L<Paws::RedShift>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method GetClusterCredentials on the
27 L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class
28 as arguments to method GetClusterCredentials.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetClusterCredentials.
31  
32 =head1 SYNOPSIS
33  
34 my $redshift = Paws->service('RedShift');
35 my $ClusterCredentials = $redshift->GetClusterCredentials(
36 ClusterIdentifier => 'MyString',
37 DbUser => 'MyString',
38 AutoCreate => 1, # OPTIONAL
39 DbGroups => [
40 'MyString', ... # max: 2147483647
41 ], # OPTIONAL
42 DbName => 'MyString', # OPTIONAL
43 DurationSeconds => 1, # OPTIONAL
44 );
45  
46 # Results:
47 my $DbPassword = $ClusterCredentials->DbPassword;
48 my $DbUser = $ClusterCredentials->DbUser;
49 my $Expiration = $ClusterCredentials->Expiration;
50  
51 # Returns a L<Paws::RedShift::ClusterCredentials> 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/GetClusterCredentials>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 AutoCreate => Bool
60  
61 Create a database user with the name specified for the user named in
62 C<DbUser> if one does not exist.
63  
64  
65  
66 =head2 B<REQUIRED> ClusterIdentifier => Str
67  
68 The unique identifier of the cluster that contains the database for
69 which your are requesting credentials. This parameter is case
70 sensitive.
71  
72  
73  
74 =head2 DbGroups => ArrayRef[Str|Undef]
75  
76 A list of the names of existing database groups that the user named in
77 C<DbUser> will join for the current session, in addition to any group
78 memberships for an existing user. If not specified, a new user is added
79 only to PUBLIC.
80  
81 Database group name constraints
82  
83 =over
84  
85 =item *
86  
87 Must be 1 to 64 alphanumeric characters or hyphens
88  
89 =item *
90  
91 Must contain only lowercase letters, numbers, underscore, plus sign,
92 period (dot), at symbol (@), or hyphen.
93  
94 =item *
95  
96 First character must be a letter.
97  
98 =item *
99  
100 Must not contain a colon ( : ) or slash ( / ).
101  
102 =item *
103  
104 Cannot be a reserved word. A list of reserved words can be found in
105 Reserved Words
106 (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in
107 the Amazon Redshift Database Developer Guide.
108  
109 =back
110  
111  
112  
113  
114 =head2 DbName => Str
115  
116 The name of a database that C<DbUser> is authorized to log on to. If
117 C<DbName> is not specified, C<DbUser> can log on to any existing
118 database.
119  
120 Constraints:
121  
122 =over
123  
124 =item *
125  
126 Must be 1 to 64 alphanumeric characters or hyphens
127  
128 =item *
129  
130 Must contain only lowercase letters, numbers, underscore, plus sign,
131 period (dot), at symbol (@), or hyphen.
132  
133 =item *
134  
135 First character must be a letter.
136  
137 =item *
138  
139 Must not contain a colon ( : ) or slash ( / ).
140  
141 =item *
142  
143 Cannot be a reserved word. A list of reserved words can be found in
144 Reserved Words
145 (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in
146 the Amazon Redshift Database Developer Guide.
147  
148 =back
149  
150  
151  
152  
153 =head2 B<REQUIRED> DbUser => Str
154  
155 The name of a database user. If a user name matching C<DbUser> exists
156 in the database, the temporary user credentials have the same
157 permissions as the existing user. If C<DbUser> doesn't exist in the
158 database and C<Autocreate> is C<True>, a new user is created using the
159 value for C<DbUser> with PUBLIC permissions. If a database user
160 matching the value for C<DbUser> doesn't exist and C<Autocreate> is
161 C<False>, then the command succeeds but the connection attempt will
162 fail because the user doesn't exist in the database.
163  
164 For more information, see CREATE USER
165 (https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html) in
166 the Amazon Redshift Database Developer Guide.
167  
168 Constraints:
169  
170 =over
171  
172 =item *
173  
174 Must be 1 to 64 alphanumeric characters or hyphens. The user name can't
175 be C<PUBLIC>.
176  
177 =item *
178  
179 Must contain only lowercase letters, numbers, underscore, plus sign,
180 period (dot), at symbol (@), or hyphen.
181  
182 =item *
183  
184 First character must be a letter.
185  
186 =item *
187  
188 Must not contain a colon ( : ) or slash ( / ).
189  
190 =item *
191  
192 Cannot be a reserved word. A list of reserved words can be found in
193 Reserved Words
194 (http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in
195 the Amazon Redshift Database Developer Guide.
196  
197 =back
198  
199  
200  
201  
202 =head2 DurationSeconds => Int
203  
204 The number of seconds until the returned temporary password expires.
205  
206 Constraint: minimum 900, maximum 3600.
207  
208 Default: 900
209  
210  
211  
212  
213 =head1 SEE ALSO
214  
215 This class forms part of L<Paws>, documenting arguments for method GetClusterCredentials in L<Paws::RedShift>
216  
217 =head1 BUGS and CONTRIBUTIONS
218  
219 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
220  
221 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
222  
223 =cut
224