blib/lib/Paws/CloudFormation/DescribeTypeOutput.pm untested

filter: Statementstmt 0.0% 0 / 31 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 32 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CloudFormation::DescribeTypeOutput;
3 use Moose;
4 has Arn => (is => 'ro', isa => 'Str');
5 has AutoUpdate => (is => 'ro', isa => 'Bool');
6 has ConfigurationSchema => (is => 'ro', isa => 'Str');
7 has DefaultVersionId => (is => 'ro', isa => 'Str');
8 has DeprecatedStatus => (is => 'ro', isa => 'Str');
9 has Description => (is => 'ro', isa => 'Str');
10 has DocumentationUrl => (is => 'ro', isa => 'Str');
11 has ExecutionRoleArn => (is => 'ro', isa => 'Str');
12 has IsActivated => (is => 'ro', isa => 'Bool');
13 has IsDefaultVersion => (is => 'ro', isa => 'Bool');
14 has LastUpdated => (is => 'ro', isa => 'Str');
15 has LatestPublicVersion => (is => 'ro', isa => 'Str');
16 has LoggingConfig => (is => 'ro', isa => 'Paws::CloudFormation::LoggingConfig');
17 has OriginalTypeArn => (is => 'ro', isa => 'Str');
18 has OriginalTypeName => (is => 'ro', isa => 'Str');
19 has ProvisioningType => (is => 'ro', isa => 'Str');
20 has PublicVersionNumber => (is => 'ro', isa => 'Str');
21 has PublisherId => (is => 'ro', isa => 'Str');
22 has RequiredActivatedTypes => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::RequiredActivatedType]');
23 has Schema => (is => 'ro', isa => 'Str');
24 has SourceUrl => (is => 'ro', isa => 'Str');
25 has TimeCreated => (is => 'ro', isa => 'Str');
26 has Type => (is => 'ro', isa => 'Str');
27 has TypeName => (is => 'ro', isa => 'Str');
28 has TypeTestsStatus => (is => 'ro', isa => 'Str');
29 has TypeTestsStatusDescription => (is => 'ro', isa => 'Str');
30 has Visibility => (is => 'ro', isa => 'Str');
31  
32 has _request_id => (is => 'ro', isa => 'Str');
33 1;
34  
35 ### main pod documentation begin ###
36  
37 =head1 NAME
38  
39 Paws::CloudFormation::DescribeTypeOutput
40  
41 =head1 ATTRIBUTES
42  
43  
44 =head2 Arn => Str
45  
46 The Amazon Resource Name (ARN) of the extension.
47  
48  
49 =head2 AutoUpdate => Bool
50  
51 Whether CloudFormation automatically updates the extension in this
52 account and region when a new I<minor> version is published by the
53 extension publisher. Major versions released by the publisher must be
54 manually updated. For more information, see Activating public
55 extensions for use in your account in the I<AWS CloudFormation User
56 Guide>.
57  
58  
59 =head2 ConfigurationSchema => Str
60  
61 A JSON string that represent the current configuration data for the
62 extension in this account and region.
63  
64 To set the configuration data for an extension, use
65 SetTypeConfiguration
66 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html).
67 For more information, see Configuring extensions at the account level
68 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration)
69 in the I<CloudFormation User Guide>.
70  
71  
72 =head2 DefaultVersionId => Str
73  
74 The ID of the default version of the extension. The default version is
75 used when the extension version is not specified.
76  
77 This applies only to private extensions you have registered in your
78 account. For public extensions, both those provided by Amazon and
79 published by third parties, CloudFormation returns C<null>. For more
80 information, see RegisterType
81 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).
82  
83 To set the default version of an extension, use C<
84 SetTypeDefaultVersion >.
85  
86  
87 =head2 DeprecatedStatus => Str
88  
89 The deprecation status of the extension version.
90  
91 Valid values include:
92  
93 =over
94  
95 =item *
96  
97 C<LIVE>: The extension is activated or registered and can be used in
98 CloudFormation operations, dependent on its provisioning behavior and
99 visibility scope.
100  
101 =item *
102  
103 C<DEPRECATED>: The extension has been deactivated or deregistered and
104 can no longer be used in CloudFormation operations.
105  
106 =back
107  
108 For public third-party extensions, CloudFormation returns C<null>.
109  
110 Valid values are: C<"LIVE">, C<"DEPRECATED">
111 =head2 Description => Str
112  
113 The description of the extension.
114  
115  
116 =head2 DocumentationUrl => Str
117  
118 The URL of a page providing detailed documentation for this extension.
119  
120  
121 =head2 ExecutionRoleArn => Str
122  
123 The Amazon Resource Name (ARN) of the IAM execution role used to
124 register the extension. This applies only to private extensions you
125 have registered in your account. For more information, see RegisterType
126 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).
127  
128 If the registered extension calls any AWS APIs, you must create an I<
129 IAM execution role
130 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) > that
131 includes the necessary permissions to call those AWS APIs, and
132 provision that execution role in your account. CloudFormation then
133 assumes that execution role to provide your extension with the
134 appropriate credentials.
135  
136  
137 =head2 IsActivated => Bool
138  
139 Whether or not the extension is activated in the account and region.
140  
141 This only applies to public third-party extensions. For all other
142 extensions, CloudFormation returns C<null>.
143  
144  
145 =head2 IsDefaultVersion => Bool
146  
147 Whether the specified extension version is set as the default version.
148  
149 This applies only to private extensions you have registered in your
150 account, and extensions published by Amazon. For public third-party
151 extensions, whether or not they are activated in your account,
152 CloudFormation returns C<null>.
153  
154  
155 =head2 LastUpdated => Str
156  
157 When the specified extension version was registered. This applies only
158 to:
159  
160 =over
161  
162 =item *
163  
164 Private extensions you have registered in your account. For more
165 information, see RegisterType
166 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).
167  
168 =item *
169  
170 Public extensions you have activated in your account with auto-update
171 specified. For more information, see ActivateType
172 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html).
173  
174 =back
175  
176  
177  
178 =head2 LatestPublicVersion => Str
179  
180 The latest version of a public extension I<that is available> for use.
181  
182 This only applies if you specify a public extension, and you do not
183 specify a version. For all other requests, CloudFormation returns
184 C<null>.
185  
186  
187 =head2 LoggingConfig => L<Paws::CloudFormation::LoggingConfig>
188  
189 Contains logging configuration information for private extensions. This
190 applies only to private extensions you have registered in your account.
191 For public extensions, both those provided by Amazon and published by
192 third parties, CloudFormation returns C<null>. For more information,
193 see RegisterType
194 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).
195  
196  
197 =head2 OriginalTypeArn => Str
198  
199 For public extensions that have been activated for this account and
200 region, the Amazon Resource Name (ARN) of the public extension.
201  
202  
203 =head2 OriginalTypeName => Str
204  
205 For public extensions that have been activated for this account and
206 region, the type name of the public extension.
207  
208 If you specified a C<TypeNameAlias> when enabling the extension in this
209 account and region, CloudFormation treats that alias as the extension's
210 type name within the account and region, not the type name of the
211 public extension. For more information, see Specifying aliases to refer
212 to extensions
213 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias)
214 in the I<CloudFormation User Guide>.
215  
216  
217 =head2 ProvisioningType => Str
218  
219 For resource type extensions, the provisioning behavior of the resource
220 type. AWS CloudFormation determines the provisioning type during
221 registration, based on the types of handlers in the schema handler
222 package submitted.
223  
224 Valid values include:
225  
226 =over
227  
228 =item *
229  
230 C<FULLY_MUTABLE>: The resource type includes an update handler to
231 process updates to the type during stack update operations.
232  
233 =item *
234  
235 C<IMMUTABLE>: The resource type does not include an update handler, so
236 the type cannot be updated and must instead be replaced during stack
237 update operations.
238  
239 =item *
240  
241 C<NON_PROVISIONABLE>: The resource type does not include all of the
242 following handlers, and therefore cannot actually be provisioned.
243  
244 =over
245  
246 =item *
247  
248 create
249  
250 =item *
251  
252 read
253  
254 =item *
255  
256 delete
257  
258 =back
259  
260 =back
261  
262  
263 Valid values are: C<"NON_PROVISIONABLE">, C<"IMMUTABLE">, C<"FULLY_MUTABLE">
264 =head2 PublicVersionNumber => Str
265  
266 The version number of a public third-party extension.
267  
268 This applies only if you specify a public extension you have activated
269 in your account, or specify a public extension without specifying a
270 version. For all other extensions, CloudFormation returns C<null>.
271  
272  
273 =head2 PublisherId => Str
274  
275 The publisher ID of the extension publisher.
276  
277 This applies only to public third-party extensions. For private
278 registered extensions, and extensions provided by Amazon,
279 CloudFormation returns C<null>.
280  
281  
282 =head2 RequiredActivatedTypes => ArrayRef[L<Paws::CloudFormation::RequiredActivatedType>]
283  
284 For extensions that are modules, the public third-party extensions that
285 must be activated in your account in order for the module itself to be
286 activated.
287  
288  
289 =head2 Schema => Str
290  
291 The schema that defines the extension.
292  
293 For more information on extension schemas, see Resource Provider Schema
294 (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html)
295 in the I<CloudFormation CLI User Guide>.
296  
297  
298 =head2 SourceUrl => Str
299  
300 The URL of the source code for the extension.
301  
302  
303 =head2 TimeCreated => Str
304  
305 When the specified private extension version was registered or
306 activated in your account.
307  
308  
309 =head2 Type => Str
310  
311 The kind of extension.
312  
313 Valid values are: C<"RESOURCE">, C<"MODULE">
314 =head2 TypeName => Str
315  
316 The name of the extension.
317  
318 If the extension is a public third-party type you have activated with a
319 type name alias, CloudFormation returns the type name alias. For more
320 information, see ActivateType
321 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html).
322  
323  
324 =head2 TypeTestsStatus => Str
325  
326 The contract test status of the registered extension version. To return
327 the extension test status of a specifc extension version, you must
328 specify C<VersionId>.
329  
330 This applies only to registered private extension versions.
331 CloudFormation does not return this information for public extensions,
332 whether or not they are activated in your account.
333  
334 =over
335  
336 =item *
337  
338 C<PASSED>: The extension has passed all its contract tests.
339  
340 An extension must have a test status of C<PASSED> before it can be
341 published. For more information, see Publishing extensions to make them
342 available for public use
343 (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html)
344 in the I<CloudFormation Command Line Interface User Guide>.
345  
346 =item *
347  
348 C<FAILED>: The extension has failed one or more contract tests.
349  
350 =item *
351  
352 C<IN_PROGRESS>: Contract tests are currently being performed on the
353 extension.
354  
355 =item *
356  
357 C<NOT_TESTED>: Contract tests have not been performed on the extension.
358  
359 =back
360  
361  
362 Valid values are: C<"PASSED">, C<"FAILED">, C<"IN_PROGRESS">, C<"NOT_TESTED">
363 =head2 TypeTestsStatusDescription => Str
364  
365 The description of the test status. To return the extension test status
366 of a specifc extension version, you must specify C<VersionId>.
367  
368 This applies only to registered private extension versions.
369 CloudFormation does not return this information for public extensions,
370 whether or not they are activated in your account.
371  
372  
373 =head2 Visibility => Str
374  
375 The scope at which the extension is visible and usable in
376 CloudFormation operations.
377  
378 Valid values include:
379  
380 =over
381  
382 =item *
383  
384 C<PRIVATE>: The extension is only visible and usable within the account
385 in which it is registered. AWS CloudFormation marks any extensions you
386 register as C<PRIVATE>.
387  
388 =item *
389  
390 C<PUBLIC>: The extension is publically visible and usable within any
391 Amazon account.
392  
393 =back
394  
395  
396 Valid values are: C<"PUBLIC">, C<"PRIVATE">
397 =head2 _request_id => Str
398  
399  
400 =cut
401