File Coverage

blib/lib/Paws/CognitoIdp/CreateUserPoolClient.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::CognitoIdp::CreateUserPoolClient;
3 1     1   428 use Moose;
  1         3  
  1         7  
4             has AllowedOAuthFlows => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has AllowedOAuthFlowsUserPoolClient => (is => 'ro', isa => 'Bool');
6             has AllowedOAuthScopes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7             has CallbackURLs => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8             has ClientName => (is => 'ro', isa => 'Str', required => 1);
9             has DefaultRedirectURI => (is => 'ro', isa => 'Str');
10             has ExplicitAuthFlows => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
11             has GenerateSecret => (is => 'ro', isa => 'Bool');
12             has LogoutURLs => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
13             has ReadAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
14             has RefreshTokenValidity => (is => 'ro', isa => 'Int');
15             has SupportedIdentityProviders => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
16             has UserPoolId => (is => 'ro', isa => 'Str', required => 1);
17             has WriteAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
18              
19 1     1   6564 use MooseX::ClassAttribute;
  1         4  
  1         10  
20              
21             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateUserPoolClient');
22             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::CreateUserPoolClientResponse');
23             class_has _result_key => (isa => 'Str', is => 'ro');
24             1;
25              
26             ### main pod documentation begin ###
27              
28             =head1 NAME
29              
30             Paws::CognitoIdp::CreateUserPoolClient - Arguments for method CreateUserPoolClient on Paws::CognitoIdp
31              
32             =head1 DESCRIPTION
33              
34             This class represents the parameters used for calling the method CreateUserPoolClient on the
35             Amazon Cognito Identity Provider service. Use the attributes of this class
36             as arguments to method CreateUserPoolClient.
37              
38             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateUserPoolClient.
39              
40             As an example:
41              
42             $service_obj->CreateUserPoolClient(Att1 => $value1, Att2 => $value2, ...);
43              
44             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.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 AllowedOAuthFlows => ArrayRef[Str|Undef]
50              
51             Set to C<code> to initiate a code grant flow, which provides an
52             authorization code as the response. This code can be exchanged for
53             access tokens with the token endpoint.
54              
55             Set to C<token> to specify that the client should get the access token
56             (and, optionally, ID token, based on scopes) directly.
57              
58              
59              
60             =head2 AllowedOAuthFlowsUserPoolClient => Bool
61              
62             Set to C<True> if the client is allowed to follow the OAuth protocol
63             when interacting with Cognito user pools.
64              
65              
66              
67             =head2 AllowedOAuthScopes => ArrayRef[Str|Undef]
68              
69             A list of allowed C<OAuth> scopes. Currently supported values are
70             C<"phone">, C<"email">, C<"openid">, and C<"Cognito">.
71              
72              
73              
74             =head2 CallbackURLs => ArrayRef[Str|Undef]
75              
76             A list of allowed callback URLs for the identity providers.
77              
78              
79              
80             =head2 B<REQUIRED> ClientName => Str
81              
82             The client name for the user pool client you would like to create.
83              
84              
85              
86             =head2 DefaultRedirectURI => Str
87              
88             The default redirect URI. Must be in the C<CallbackURLs> list.
89              
90              
91              
92             =head2 ExplicitAuthFlows => ArrayRef[Str|Undef]
93              
94             The explicit authentication flows.
95              
96              
97              
98             =head2 GenerateSecret => Bool
99              
100             Boolean to specify whether you want to generate a secret for the user
101             pool client being created.
102              
103              
104              
105             =head2 LogoutURLs => ArrayRef[Str|Undef]
106              
107             A list of allowed logout URLs for the identity providers.
108              
109              
110              
111             =head2 ReadAttributes => ArrayRef[Str|Undef]
112              
113             The read attributes.
114              
115              
116              
117             =head2 RefreshTokenValidity => Int
118              
119             The time limit, in days, after which the refresh token is no longer
120             valid and cannot be used.
121              
122              
123              
124             =head2 SupportedIdentityProviders => ArrayRef[Str|Undef]
125              
126             A list of provider names for the identity providers that are supported
127             on this client.
128              
129              
130              
131             =head2 B<REQUIRED> UserPoolId => Str
132              
133             The user pool ID for the user pool where you want to create a user pool
134             client.
135              
136              
137              
138             =head2 WriteAttributes => ArrayRef[Str|Undef]
139              
140             The write attributes.
141              
142              
143              
144              
145             =head1 SEE ALSO
146              
147             This class forms part of L<Paws>, documenting arguments for method CreateUserPoolClient in L<Paws::CognitoIdp>
148              
149             =head1 BUGS and CONTRIBUTIONS
150              
151             The source code is located here: https://github.com/pplu/aws-sdk-perl
152              
153             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
154              
155             =cut
156