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 bran cond sub pod time code
1              
2             package Paws::RedShift::GetClusterCredentials;
3 1     1   495 use Moose;
  1         3  
  1         8  
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   6356 use MooseX::ClassAttribute;
  1         3  
  1         10  
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 C<DbUser> if one
44             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 C<DbUser> will
59             join for the current session. If not specified, the new user is added
60             only to PUBLIC.
61              
62              
63              
64             =head2 DbName => Str
65              
66             The name of a database that C<DbUser> is authorized to log on to. If
67             C<DbName> is not specified, C<DbUser> can log in to any existing
68             database.
69              
70             Constraints:
71              
72             =over
73              
74             =item *
75              
76             Must be 1 to 64 alphanumeric characters or hyphens
77              
78             =item *
79              
80             Must contain only lowercase letters.
81              
82             =item *
83              
84             Cannot be a reserved word. A list of reserved words can be found in
85             Reserved Words in the Amazon Redshift Database Developer Guide.
86              
87             =back
88              
89              
90              
91              
92             =head2 B<REQUIRED> DbUser => Str
93              
94             The name of a database user. If a user name matching C<DbUser> exists
95             in the database, the temporary user credentials have the same
96             permissions as the existing user. If C<DbUser> doesn't exist in the
97             database and C<Autocreate> is C<True>, a new user is created using the
98             value for C<DbUser> with PUBLIC permissions. If a database user
99             matching the value for C<DbUser> doesn't exist and C<Autocreate> is
100             C<False>, then the command succeeds but the connection attempt will
101             fail because the user doesn't exist in the database.
102              
103             For more information, see CREATE USER in the Amazon Redshift Database
104             Developer Guide.
105              
106             Constraints:
107              
108             =over
109              
110             =item *
111              
112             Must be 1 to 128 alphanumeric characters or hyphens
113              
114             =item *
115              
116             Must contain only lowercase letters.
117              
118             =item *
119              
120             First character must be a letter.
121              
122             =item *
123              
124             Must not contain a colon ( : ) or slash ( / ).
125              
126             =item *
127              
128             Cannot be a reserved word. A list of reserved words can be found in
129             Reserved Words in the Amazon Redshift Database Developer Guide.
130              
131             =back
132              
133              
134              
135              
136             =head2 DurationSeconds => Int
137              
138             The number of seconds until the returned temporary password expires.
139              
140             Constraint: minimum 900, maximum 3600.
141              
142             Default: 900
143              
144              
145              
146              
147             =head1 SEE ALSO
148              
149             This class forms part of L<Paws>, documenting arguments for method GetClusterCredentials in L<Paws::RedShift>
150              
151             =head1 BUGS and CONTRIBUTIONS
152              
153             The source code is located here: https://github.com/pplu/aws-sdk-perl
154              
155             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
156              
157             =cut
158