AWS.Tools.CloudControlApi.XML

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.CloudControlApi</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceCmdlet">
            <summary>
            Returns information about the current state of the specified resource. For details,
            see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-read.html">Reading
            a resource's current state</a>.
             
              
            <para>
            You can use this action to return information about an existing resource in your account
            and Amazon Web Services Region, whether or not those resources were provisioned using
            Cloud Control API.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceCmdlet.Identifier">
            <summary>
            <para>
            <para>The identifier for the resource.</para><para>You can specify the primary identifier, or any secondary identifier defined for the
            resource type in its resource schema. You can only specify one identifier. Primary
            identifiers can be specified as a string or JSON; secondary identifiers must be specified
            as JSON.</para><para>For compound primary identifiers (that is, one that consists of multiple resource
            properties strung together), to specify the primary identifier as a string, list the
            property values <i>in the order they are specified</i> in the primary identifier definition,
            separated by <code>|</code>. </para><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html">Identifying
            resources</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceCmdlet.RoleArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud
            Control API to use when performing this resource operation. The role specified must
            have the permissions required for this operation. The necessary permissions for each
            event handler are defined in the <code><a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers">handlers</a></code> section of the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">resource
            type definition schema</a>.</para><para>If you do not specify a role, Cloud Control API uses a temporary session created using
            your Amazon Web Services user credentials.</para><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions">Specifying
            credentials</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceCmdlet.TypeName">
            <summary>
            <para>
            <para>The name of the resource type.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceCmdlet.TypeVersionId">
            <summary>
            <para>
            <para>For private resource types, the type version to use in this resource operation. If
            you do not specify a resource version, CloudFormation uses the default version.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudControlApi.Model.GetResourceResponse).
            Specifying the name of a property of type Amazon.CloudControlApi.Model.GetResourceResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the Identifier parameter.
            The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceListCmdlet">
            <summary>
            Returns information about the specified resources. For more information, see <a href="cloudcontrolapi/latest/userguide/resource-operations-list.html">Discovering
            resources</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.
             
              
            <para>
            You can use this action to return information about existing resources in your account
            and Amazon Web Services Region, whether or not those resources were provisioned using
            Cloud Control API.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceListCmdlet.ResourceModel">
            <summary>
            <para>
            <para>The resource model to use to select the resources to return.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceListCmdlet.RoleArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud
            Control API to use when performing this resource operation. The role specified must
            have the permissions required for this operation. The necessary permissions for each
            event handler are defined in the <code><a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers">handlers</a></code> section of the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">resource
            type definition schema</a>.</para><para>If you do not specify a role, Cloud Control API uses a temporary session created using
            your Amazon Web Services user credentials.</para><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions">Specifying
            credentials</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceListCmdlet.TypeName">
            <summary>
            <para>
            <para>The name of the resource type.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceListCmdlet.TypeVersionId">
            <summary>
            <para>
            <para>For private resource types, the type version to use in this resource operation. If
            you do not specify a resource version, CloudFormation uses the default version.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of results to be returned with a single call. If the number of
            available results exceeds this maximum, the response includes a <code>NextToken</code>
            value that you can assign to the <code>NextToken</code> request parameter to get the
            next set of results.</para><para>The default is <code>20</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceListCmdlet.NextToken">
            <summary>
            <para>
            <para>If the previous paginated request didn't return all of the remaining results, the
            response object's <code>NextToken</code> parameter value is set to a token. To retrieve
            the next set of results, call this action again and assign that token to the request
            object's <code>NextToken</code> parameter. If there are no remaining results, the
            previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudControlApi.Model.ListResourcesResponse).
            Specifying the name of a property of type Amazon.CloudControlApi.Model.ListResourcesResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceListCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the TypeName parameter.
            The -PassThru parameter is deprecated, use -Select '^TypeName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceRequestListCmdlet">
            <summary>
            Returns existing resource operation requests. This includes requests of all status
            types. For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-list">Listing
            active resource operation requests</a> in the <i>Amazon Web Services Cloud Control
            API User Guide</i>.
             
             <note><para>
            Resource operation requests expire after seven days.
            </para></note>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceRequestListCmdlet.ResourceRequestStatusFilter_Operation">
            <summary>
            <para>
            <para>The operation types to include in the filter.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceRequestListCmdlet.ResourceRequestStatusFilter_OperationStatus">
            <summary>
            <para>
            <para>The operation statuses to include in the filter.</para><ul><li><para><code>PENDING</code>: The operation has been requested, but not yet initiated.</para></li><li><para><code>IN_PROGRESS</code>: The operation is currently in progress.</para></li><li><para><code>SUCCESS</code>: The operation has successfully completed.</para></li><li><para><code>FAILED</code>: The operation has failed.</para></li><li><para><code>CANCEL_IN_PROGRESS</code>: The operation is currently in the process of being
            canceled.</para></li><li><para><code>CANCEL_COMPLETE</code>: The operation has been canceled.</para></li></ul>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceRequestListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of results to be returned with a single call. If the number of
            available results exceeds this maximum, the response includes a <code>NextToken</code>
            value that you can assign to the <code>NextToken</code> request parameter to get the
            next set of results.</para><para>The default is <code>20</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceRequestListCmdlet.NextToken">
            <summary>
            <para>
            <para>If the previous paginated request didn't return all of the remaining results, the
            response object's <code>NextToken</code> parameter value is set to a token. To retrieve
            the next set of results, call this action again and assign that token to the request
            object's <code>NextToken</code> parameter. If there are no remaining results, the
            previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceRequestListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'ResourceRequestStatusSummaries'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudControlApi.Model.ListResourceRequestsResponse).
            Specifying the name of a property of type Amazon.CloudControlApi.Model.ListResourceRequestsResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceRequestStatusCmdlet">
            <summary>
            Returns the current status of a resource operation request. For more information,
            see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-track">Tracking
            the progress of resource operation requests</a> in the <i>Amazon Web Services Cloud
            Control API User Guide</i>.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceRequestStatusCmdlet.RequestToken">
            <summary>
            <para>
            <para>A unique token used to track the progress of the resource operation request.</para><para>Request tokens are included in the <code>ProgressEvent</code> type returned by a resource
            operation request.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceRequestStatusCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'ProgressEvent'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudControlApi.Model.GetResourceRequestStatusResponse).
            Specifying the name of a property of type Amazon.CloudControlApi.Model.GetResourceRequestStatusResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.GetCCAResourceRequestStatusCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the RequestToken parameter.
            The -PassThru parameter is deprecated, use -Select '^RequestToken' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CCA.NewCCAResourceCmdlet">
            <summary>
            Creates the specified resource. For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html">Creating
            a resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.
             
              
            <para>
            After you have initiated a resource creation request, you can monitor the progress
            of your request by calling <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a>
            using the <code>RequestToken</code> of the <code>ProgressEvent</code> type returned
            by <code>CreateResource</code>.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.NewCCAResourceCmdlet.DesiredState">
            <summary>
            <para>
            <para>Structured data format representing the desired state of the resource, consisting
            of that resource's properties and their desired values. </para><note><para>Cloud Control API currently supports JSON as a structured data format.</para></note><para>Specify the desired state as one of the following:</para><ul><li><para>A JSON blob</para></li><li><para>A local path containing the desired state in JSON data format</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing
            the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control
            API User Guide</i>.</para><para>For more information about the properties of a specific resource, refer to the related
            topic for the resource in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource
            and property types reference</a> in the <i>Amazon Web Services CloudFormation Users
            Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.NewCCAResourceCmdlet.RoleArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud
            Control API to use when performing this resource operation. The role specified must
            have the permissions required for this operation. The necessary permissions for each
            event handler are defined in the <code><a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers">handlers</a></code> section of the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">resource
            type definition schema</a>.</para><para>If you do not specify a role, Cloud Control API uses a temporary session created using
            your Amazon Web Services user credentials.</para><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions">Specifying
            credentials</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.NewCCAResourceCmdlet.TypeName">
            <summary>
            <para>
            <para>The name of the resource type.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.NewCCAResourceCmdlet.TypeVersionId">
            <summary>
            <para>
            <para>For private resource types, the type version to use in this resource operation. If
            you do not specify a resource version, CloudFormation uses the default version.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.NewCCAResourceCmdlet.ClientToken">
            <summary>
            <para>
            <para>A unique identifier to ensure the idempotency of the resource request. As a best practice,
            specify this token to ensure idempotency, so that Amazon Web Services Cloud Control
            API can accurately distinguish between request retries and new resource requests.
            You might retry a resource request to ensure that it was successfully received.</para><para>A client token is valid for 36 hours once used. After that, a resource request with
            the same client token is treated as a new request.</para><para>If you do not specify a client token, one is generated for inclusion in the request.</para><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency">Ensuring
            resource operation requests are unique</a> in the <i>Amazon Web Services Cloud Control
            API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.NewCCAResourceCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'ProgressEvent'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudControlApi.Model.CreateResourceResponse).
            Specifying the name of a property of type Amazon.CloudControlApi.Model.CreateResourceResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.NewCCAResourceCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the TypeName parameter.
            The -PassThru parameter is deprecated, use -Select '^TypeName' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.NewCCAResourceCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CCA.RemoveCCAResourceCmdlet">
            <summary>
            Deletes the specified resource. For details, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-delete.html">Deleting
            a resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.
             
              
            <para>
            After you have initiated a resource deletion request, you can monitor the progress
            of your request by calling <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a>
            using the <code>RequestToken</code> of the <code>ProgressEvent</code> returned by
            <code>DeleteResource</code>.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.RemoveCCAResourceCmdlet.Identifier">
            <summary>
            <para>
            <para>The identifier for the resource.</para><para>You can specify the primary identifier, or any secondary identifier defined for the
            resource type in its resource schema. You can only specify one identifier. Primary
            identifiers can be specified as a string or JSON; secondary identifiers must be specified
            as JSON.</para><para>For compound primary identifiers (that is, one that consists of multiple resource
            properties strung together), to specify the primary identifier as a string, list the
            property values <i>in the order they are specified</i> in the primary identifier definition,
            separated by <code>|</code>. </para><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html">Identifying
            resources</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.RemoveCCAResourceCmdlet.RoleArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud
            Control API to use when performing this resource operation. The role specified must
            have the permissions required for this operation. The necessary permissions for each
            event handler are defined in the <code><a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers">handlers</a></code> section of the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">resource
            type definition schema</a>.</para><para>If you do not specify a role, Cloud Control API uses a temporary session created using
            your Amazon Web Services user credentials.</para><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions">Specifying
            credentials</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.RemoveCCAResourceCmdlet.TypeName">
            <summary>
            <para>
            <para>The name of the resource type.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.RemoveCCAResourceCmdlet.TypeVersionId">
            <summary>
            <para>
            <para>For private resource types, the type version to use in this resource operation. If
            you do not specify a resource version, CloudFormation uses the default version.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.RemoveCCAResourceCmdlet.ClientToken">
            <summary>
            <para>
            <para>A unique identifier to ensure the idempotency of the resource request. As a best practice,
            specify this token to ensure idempotency, so that Amazon Web Services Cloud Control
            API can accurately distinguish between request retries and new resource requests.
            You might retry a resource request to ensure that it was successfully received.</para><para>A client token is valid for 36 hours once used. After that, a resource request with
            the same client token is treated as a new request.</para><para>If you do not specify a client token, one is generated for inclusion in the request.</para><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency">Ensuring
            resource operation requests are unique</a> in the <i>Amazon Web Services Cloud Control
            API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.RemoveCCAResourceCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'ProgressEvent'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudControlApi.Model.DeleteResourceResponse).
            Specifying the name of a property of type Amazon.CloudControlApi.Model.DeleteResourceResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.RemoveCCAResourceCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the Identifier parameter.
            The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.RemoveCCAResourceCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CCA.StopCCAResourceRequestCmdlet">
            <summary>
            Cancels the specified resource operation request. For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-cancel">Canceling
            resource operation requests</a> in the <i>Amazon Web Services Cloud Control API User
            Guide</i>.
             
              
            <para>
            Only resource operations requests with a status of <code>PENDING</code> or <code>IN_PROGRESS</code>
            can be cancelled.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.StopCCAResourceRequestCmdlet.RequestToken">
            <summary>
            <para>
            <para>The <code>RequestToken</code> of the <code>ProgressEvent</code> object returned by
            the resource operation request.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.StopCCAResourceRequestCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'ProgressEvent'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudControlApi.Model.CancelResourceRequestResponse).
            Specifying the name of a property of type Amazon.CloudControlApi.Model.CancelResourceRequestResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.StopCCAResourceRequestCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the RequestToken parameter.
            The -PassThru parameter is deprecated, use -Select '^RequestToken' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.StopCCAResourceRequestCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.CCA.UpdateCCAResourceCmdlet">
            <summary>
            Updates the specified property values in the resource.
             
              
            <para>
            You specify your resource property updates as a list of patch operations contained
            in a JSON patch document that adheres to the <a href="https://datatracker.ietf.org/doc/html/rfc6902"><i>RFC 6902 - JavaScript Object Notation (JSON) Patch</i></a> standard.
            </para><para>
            For details on how Cloud Control API performs resource update operations, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html">Updating
            a resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.
            </para><para>
            After you have initiated a resource update request, you can monitor the progress of
            your request by calling <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a>
            using the <code>RequestToken</code> of the <code>ProgressEvent</code> returned by
            <code>UpdateResource</code>.
            </para><para>
            For more information about the properties of a specific resource, refer to the related
            topic for the resource in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource
            and property types reference</a> in the <i>Amazon Web Services CloudFormation Users
            Guide</i>.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.UpdateCCAResourceCmdlet.Identifier">
            <summary>
            <para>
            <para>The identifier for the resource.</para><para>You can specify the primary identifier, or any secondary identifier defined for the
            resource type in its resource schema. You can only specify one identifier. Primary
            identifiers can be specified as a string or JSON; secondary identifiers must be specified
            as JSON.</para><para>For compound primary identifiers (that is, one that consists of multiple resource
            properties strung together), to specify the primary identifier as a string, list the
            property values <i>in the order they are specified</i> in the primary identifier definition,
            separated by <code>|</code>. </para><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html">Identifying
            resources</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.UpdateCCAResourceCmdlet.PatchDocument">
            <summary>
            <para>
            <para>A JavaScript Object Notation (JSON) document listing the patch operations that represent
            the updates to apply to the current resource properties. For details, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html#resource-operations-update-patch">Composing
            the patch document</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.UpdateCCAResourceCmdlet.RoleArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud
            Control API to use when performing this resource operation. The role specified must
            have the permissions required for this operation. The necessary permissions for each
            event handler are defined in the <code><a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers">handlers</a></code> section of the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">resource
            type definition schema</a>.</para><para>If you do not specify a role, Cloud Control API uses a temporary session created using
            your Amazon Web Services user credentials.</para><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions">Specifying
            credentials</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.UpdateCCAResourceCmdlet.TypeName">
            <summary>
            <para>
            <para>The name of the resource type.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.UpdateCCAResourceCmdlet.TypeVersionId">
            <summary>
            <para>
            <para>For private resource types, the type version to use in this resource operation. If
            you do not specify a resource version, CloudFormation uses the default version.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.UpdateCCAResourceCmdlet.ClientToken">
            <summary>
            <para>
            <para>A unique identifier to ensure the idempotency of the resource request. As a best practice,
            specify this token to ensure idempotency, so that Amazon Web Services Cloud Control
            API can accurately distinguish between request retries and new resource requests.
            You might retry a resource request to ensure that it was successfully received.</para><para>A client token is valid for 36 hours once used. After that, a resource request with
            the same client token is treated as a new request.</para><para>If you do not specify a client token, one is generated for inclusion in the request.</para><para>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency">Ensuring
            resource operation requests are unique</a> in the <i>Amazon Web Services Cloud Control
            API User Guide</i>.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.UpdateCCAResourceCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'ProgressEvent'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudControlApi.Model.UpdateResourceResponse).
            Specifying the name of a property of type Amazon.CloudControlApi.Model.UpdateResourceResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.UpdateCCAResourceCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the Identifier parameter.
            The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCA.UpdateCCAResourceCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
    </members>
</doc>