blib/lib/Paws/CloudFormation/RegisterType.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::CloudFormation::RegisterType;
3 use Moose;
4 has ClientRequestToken => (is => 'ro', isa => 'Str');
5 has ExecutionRoleArn => (is => 'ro', isa => 'Str');
6 has LoggingConfig => (is => 'ro', isa => 'Paws::CloudFormation::LoggingConfig');
7 has SchemaHandlerPackage => (is => 'ro', isa => 'Str', required => 1);
8 has Type => (is => 'ro', isa => 'Str');
9 has TypeName => (is => 'ro', isa => 'Str', required => 1);
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterType');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::RegisterTypeOutput');
15 class_has _result_key => (isa => 'Str', is => 'ro', default => 'RegisterTypeResult');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::CloudFormation::RegisterType - Arguments for method RegisterType on L<Paws::CloudFormation>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method RegisterType on the
27 L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class
28 as arguments to method RegisterType.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterType.
31  
32 =head1 SYNOPSIS
33  
34 my $cloudformation = Paws->service('CloudFormation');
35 my $RegisterTypeOutput = $cloudformation->RegisterType(
36 SchemaHandlerPackage => 'MyS3Url',
37 TypeName => 'MyTypeName',
38 ClientRequestToken => 'MyRequestToken', # OPTIONAL
39 ExecutionRoleArn => 'MyRoleArn', # OPTIONAL
40 LoggingConfig => {
41 LogGroupName => 'MyLogGroupName', # min: 1, max: 512
42 LogRoleArn => 'MyRoleArn', # min: 1, max: 256
43  
44 }, # OPTIONAL
45 Type => 'RESOURCE', # OPTIONAL
46 );
47  
48 # Results:
49 my $RegistrationToken = $RegisterTypeOutput->RegistrationToken;
50  
51 # Returns a L<Paws::CloudFormation::RegisterTypeOutput> 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/cloudformation/RegisterType>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 ClientRequestToken => Str
60  
61 A unique identifier that acts as an idempotency key for this
62 registration request. Specifying a client request token prevents
63 CloudFormation from generating more than one version of an extension
64 from the same registeration request, even if the request is submitted
65 multiple times.
66  
67  
68  
69 =head2 ExecutionRoleArn => Str
70  
71 The Amazon Resource Name (ARN) of the IAM role for CloudFormation to
72 assume when invoking the extension.
73  
74 For CloudFormation to assume the specified execution role, the role
75 must contain a trust relationship with the CloudFormation service
76 principle (C<resources.cloudformation.amazonaws.com>). For more
77 information on adding trust relationships, see Modifying a role trust
78 policy in the I<AWS Identity and Access Management User Guide>.
79  
80 If your extension calls AWS APIs in any of its handlers, you must
81 create an I< IAM execution role
82 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) > that
83 includes the necessary permissions to call those AWS APIs, and
84 provision that execution role in your account. When CloudFormation
85 needs to invoke the resource type handler, CloudFormation assumes this
86 execution role to create a temporary session token, which it then
87 passes to the resource type handler, thereby supplying your resource
88 type with the appropriate credentials.
89  
90  
91  
92 =head2 LoggingConfig => L<Paws::CloudFormation::LoggingConfig>
93  
94 Specifies logging configuration information for an extension.
95  
96  
97  
98 =head2 B<REQUIRED> SchemaHandlerPackage => Str
99  
100 A url to the S3 bucket containing the extension project package that
101 contains the neccessary files for the extension you want to register.
102  
103 For information on generating a schema handler package for the
104 extension you want to register, see submit
105 (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html)
106 in the I<CloudFormation CLI User Guide>.
107  
108 The user registering the extension must be able to access the package
109 in the S3 bucket. That is, the user needs to have GetObject
110 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
111 permissions for the schema handler package. For more information, see
112 Actions, Resources, and Condition Keys for Amazon S3
113 (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html)
114 in the I<AWS Identity and Access Management User Guide>.
115  
116  
117  
118 =head2 Type => Str
119  
120 The kind of extension.
121  
122 Valid values are: C<"RESOURCE">, C<"MODULE">
123  
124 =head2 B<REQUIRED> TypeName => Str
125  
126 The name of the extension being registered.
127  
128 We recommend that extension names adhere to the following patterns:
129  
130 =over
131  
132 =item *
133  
134 For resource types, I<company_or_organization>::I<service>::I<type>.
135  
136 =item *
137  
138 For modules, I<company_or_organization>::I<service>::I<type>::MODULE.
139  
140 =back
141  
142 The following organization namespaces are reserved and cannot be used
143 in your extension names:
144  
145 =over
146  
147 =item *
148  
149 C<Alexa>
150  
151 =item *
152  
153 C<AMZN>
154  
155 =item *
156  
157 C<Amazon>
158  
159 =item *
160  
161 C<AWS>
162  
163 =item *
164  
165 C<Custom>
166  
167 =item *
168  
169 C<Dev>
170  
171 =back
172  
173  
174  
175  
176  
177 =head1 SEE ALSO
178  
179 This class forms part of L<Paws>, documenting arguments for method RegisterType in L<Paws::CloudFormation>
180  
181 =head1 BUGS and CONTRIBUTIONS
182  
183 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
184  
185 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
186  
187 =cut
188