File Coverage

blib/lib/Paws/RedShift/GetClusterCredentials.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

line	stmt	sub	time	code
1
2				package Paws::RedShift::GetClusterCredentials;
3	1	1	279	use Moose;
	1		3
	1		6
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	1	1	5279	use MooseX::ClassAttribute;
	1		3
	1		7
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 Paws::RedShift
23
24				=head1 DESCRIPTION
25
26				This class represents the parameters used for calling the method GetClusterCredentials on the
27				Amazon 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				As an example:
33
34				$service_obj->GetClusterCredentials(Att1 => $value1, Att2 => $value2, ...);
35
36				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.
37
38				=head1 ATTRIBUTES
39
40
41				=head2 AutoCreate => Bool
42
43				Create a database user with the name specified for the user named in
44				C<DbUser> if one does not exist.
45
46
47
48				=head2 B<REQUIRED> ClusterIdentifier => Str
49
50				The unique identifier of the cluster that contains the database for
51				which your are requesting credentials. This parameter is case
52				sensitive.
53
54
55
56				=head2 DbGroups => ArrayRef[Str\|Undef]
57
58				A list of the names of existing database groups that the user named in
59				C<DbUser> will join for the current session, in addition to any group
60				memberships for an existing user. If not specified, a new user is added
61				only to PUBLIC.
62
63				Database group name constraints
64
65				=over
66
67				=item *
68
69				Must be 1 to 64 alphanumeric characters or hyphens
70
71				=item *
72
73				Must contain only lowercase letters, numbers, underscore, plus sign,
74				period (dot), at symbol (@), or hyphen.
75
76				=item *
77
78				First character must be a letter.
79
80				=item *
81
82				Must not contain a colon ( : ) or slash ( / ).
83
84				=item *
85
86				Cannot be a reserved word. A list of reserved words can be found in
87				Reserved Words in the Amazon Redshift Database Developer Guide.
88
89				=back
90
91
92
93
94				=head2 DbName => Str
95
96				The name of a database that C<DbUser> is authorized to log on to. If
97				C<DbName> is not specified, C<DbUser> can log on to any existing
98				database.
99
100				Constraints:
101
102				=over
103
104				=item *
105
106				Must be 1 to 64 alphanumeric characters or hyphens
107
108				=item *
109
110				Must contain only lowercase letters, numbers, underscore, plus sign,
111				period (dot), at symbol (@), or hyphen.
112
113				=item *
114
115				First character must be a letter.
116
117				=item *
118
119				Must not contain a colon ( : ) or slash ( / ).
120
121				=item *
122
123				Cannot be a reserved word. A list of reserved words can be found in
124				Reserved Words in the Amazon Redshift Database Developer Guide.
125
126				=back
127
128
129
130
131				=head2 B<REQUIRED> DbUser => Str
132
133				The name of a database user. If a user name matching C<DbUser> exists
134				in the database, the temporary user credentials have the same
135				permissions as the existing user. If C<DbUser> doesn't exist in the
136				database and C<Autocreate> is C<True>, a new user is created using the
137				value for C<DbUser> with PUBLIC permissions. If a database user
138				matching the value for C<DbUser> doesn't exist and C<Autocreate> is
139				C<False>, then the command succeeds but the connection attempt will
140				fail because the user doesn't exist in the database.
141
142				For more information, see CREATE USER in the Amazon Redshift Database
143				Developer Guide.
144
145				Constraints:
146
147				=over
148
149				=item *
150
151				Must be 1 to 64 alphanumeric characters or hyphens
152
153				=item *
154
155				Must contain only lowercase letters, numbers, underscore, plus sign,
156				period (dot), at symbol (@), or hyphen.
157
158				=item *
159
160				First character must be a letter.
161
162				=item *
163
164				Must not contain a colon ( : ) or slash ( / ).
165
166				=item *
167
168				Cannot be a reserved word. A list of reserved words can be found in
169				Reserved Words in the Amazon Redshift Database Developer Guide.
170
171				=back
172
173
174
175
176				=head2 DurationSeconds => Int
177
178				The number of seconds until the returned temporary password expires.
179
180				Constraint: minimum 900, maximum 3600.
181
182				Default: 900
183
184
185
186
187				=head1 SEE ALSO
188
189				This class forms part of L<Paws>, documenting arguments for method GetClusterCredentials in L<Paws::RedShift>
190
191				=head1 BUGS and CONTRIBUTIONS
192
193				The source code is located here: https://github.com/pplu/aws-sdk-perl
194
195				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
196
197				=cut
198