blib/lib/Paws/IAM/CreateOpenIDConnectProvider.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::IAM::CreateOpenIDConnectProvider;
3 use Moose;
4 has ClientIDList => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IAM::Tag]');
6 has ThumbprintList => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
7 has Url => (is => 'ro', isa => 'Str', required => 1);
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateOpenIDConnectProvider');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IAM::CreateOpenIDConnectProviderResponse');
13 class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateOpenIDConnectProviderResult');
14 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::IAM::CreateOpenIDConnectProvider - Arguments for method CreateOpenIDConnectProvider on L<Paws::IAM>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method CreateOpenIDConnectProvider on the
25 L<AWS Identity and Access Management|Paws::IAM> service. Use the attributes of this class
26 as arguments to method CreateOpenIDConnectProvider.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateOpenIDConnectProvider.
29  
30 =head1 SYNOPSIS
31  
32 my $iam = Paws->service('IAM');
33 # To create an instance profile
34 # The following example defines a new OIDC provider in IAM with a client ID of
35 # my-application-id and pointing at the server with a URL of
36 # https://server.example.com.
37 my $CreateOpenIDConnectProviderResponse = $iam->CreateOpenIDConnectProvider(
38 'ClientIDList' => ['my-application-id'],
39 'ThumbprintList' => ['3768084dfb3d2b68b7897bf5f565da8efEXAMPLE'],
40 'Url' => 'https://server.example.com'
41 );
42  
43 # Results:
44 my $OpenIDConnectProviderArn =
45 $CreateOpenIDConnectProviderResponse->OpenIDConnectProviderArn;
46  
47 # Returns a L<Paws::IAM::CreateOpenIDConnectProviderResponse> object.
48  
49 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.
50 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iam/CreateOpenIDConnectProvider>
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 ClientIDList => ArrayRef[Str|Undef]
56  
57 A list of client IDs (also known as audiences). When a mobile or web
58 app registers with an OpenID Connect provider, they establish a value
59 that identifies the application. (This is the value that's sent as the
60 C<client_id> parameter on OAuth requests.)
61  
62 You can register multiple client IDs with the same provider. For
63 example, you might have multiple applications that use the same OIDC
64 provider. You cannot register more than 100 client IDs with a single
65 IAM OIDC provider.
66  
67 There is no defined format for a client ID. The
68 C<CreateOpenIDConnectProviderRequest> operation accepts client IDs up
69 to 255 characters long.
70  
71  
72  
73 =head2 Tags => ArrayRef[L<Paws::IAM::Tag>]
74  
75 A list of tags that you want to attach to the new IAM OpenID Connect
76 (OIDC) provider. Each tag consists of a key name and an associated
77 value. For more information about tagging, see Tagging IAM resources
78 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the
79 I<IAM User Guide>.
80  
81 If any one of the tags is invalid or if you exceed the allowed maximum
82 number of tags, then the entire request fails and the resource is not
83 created.
84  
85  
86  
87 =head2 B<REQUIRED> ThumbprintList => ArrayRef[Str|Undef]
88  
89 A list of server certificate thumbprints for the OpenID Connect (OIDC)
90 identity provider's server certificates. Typically this list includes
91 only one entry. However, IAM lets you have up to five thumbprints for
92 an OIDC provider. This lets you maintain multiple thumbprints if the
93 identity provider is rotating certificates.
94  
95 The server certificate thumbprint is the hex-encoded SHA-1 hash value
96 of the X.509 certificate used by the domain where the OpenID Connect
97 provider makes its keys available. It is always a 40-character string.
98  
99 You must provide at least one thumbprint when creating an IAM OIDC
100 provider. For example, assume that the OIDC provider is
101 C<server.example.com> and the provider stores its keys at
102 https://keys.server.example.com/openid-connect. In that case, the
103 thumbprint string would be the hex-encoded SHA-1 hash value of the
104 certificate used by https://keys.server.example.com.
105  
106 For more information about obtaining the OIDC provider's thumbprint,
107 see Obtaining the thumbprint for an OpenID Connect provider
108 (https://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html)
109 in the I<IAM User Guide>.
110  
111  
112  
113 =head2 B<REQUIRED> Url => Str
114  
115 The URL of the identity provider. The URL must begin with C<https://>
116 and should correspond to the C<iss> claim in the provider's OpenID
117 Connect ID tokens. Per the OIDC standard, path components are allowed
118 but query parameters are not. Typically the URL consists of only a
119 hostname, like C<https://server.example.org> or C<https://example.com>.
120  
121 You cannot register the same provider multiple times in a single AWS
122 account. If you try to submit a URL that has already been used for an
123 OpenID Connect provider in the AWS account, you will get an error.
124  
125  
126  
127  
128 =head1 SEE ALSO
129  
130 This class forms part of L<Paws>, documenting arguments for method CreateOpenIDConnectProvider in L<Paws::IAM>
131  
132 =head1 BUGS and CONTRIBUTIONS
133  
134 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
135  
136 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
137  
138 =cut
139