aws-sdk-cloudformation 1.50.0 → 1.54.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudformation.rb +2 -2
- data/lib/aws-sdk-cloudformation/client.rb +1303 -498
- data/lib/aws-sdk-cloudformation/client_api.rb +312 -1
- data/lib/aws-sdk-cloudformation/errors.rb +22 -0
- data/lib/aws-sdk-cloudformation/event.rb +2 -2
- data/lib/aws-sdk-cloudformation/resource.rb +41 -42
- data/lib/aws-sdk-cloudformation/stack.rb +102 -105
- data/lib/aws-sdk-cloudformation/stack_resource.rb +5 -5
- data/lib/aws-sdk-cloudformation/stack_resource_summary.rb +2 -2
- data/lib/aws-sdk-cloudformation/types.rb +2109 -761
- metadata +5 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 642a8c36978ebf152ba0b7df35f3c1e627e0101432269f02eee095dcc3f18f3e
|
4
|
+
data.tar.gz: 4573401978788bdecf9a7d29a0e4117bc194e86017bbc24ff29d3bb9ad7103a3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c7025f03f4433653da5cfea4f11d2ac755edee61fa291f5b4036b0c4d1af311d59f95ed0e94aa49f99c97f1bf5905c597f805731e6879329c9835886d944a96c
|
7
|
+
data.tar.gz: 3df65c06788d3e4384895b3447c29f37b34030c3ff31dc66ec626aa978bbc43ab150e249053d9f772eb18b0c91370cc3e58b70db39842a9b8faaff621aa1262b
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.54.0 (2021-07-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - SDK update to support Importing existing Stacks to new/existing Self Managed StackSet - Stack Import feature.
|
8
|
+
|
9
|
+
1.53.0 (2021-06-21)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - CloudFormation registry service now supports 3rd party public type sharing
|
13
|
+
|
14
|
+
1.52.0 (2021-04-28)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Add CallAs parameter to GetTemplateSummary to enable use with StackSets delegated administrator integration
|
18
|
+
|
19
|
+
1.51.0 (2021-04-21)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Added support for creating and updating stack sets with self-managed permissions from templates that reference macros.
|
23
|
+
|
4
24
|
1.50.0 (2021-03-31)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.54.0
|
@@ -33,7 +33,7 @@ require_relative 'aws-sdk-cloudformation/customizations'
|
|
33
33
|
# structure.
|
34
34
|
#
|
35
35
|
# cloud_formation = Aws::CloudFormation::Client.new
|
36
|
-
# resp = cloud_formation.
|
36
|
+
# resp = cloud_formation.activate_type(params)
|
37
37
|
#
|
38
38
|
# See {Client} for more information.
|
39
39
|
#
|
@@ -53,6 +53,6 @@ require_relative 'aws-sdk-cloudformation/customizations'
|
|
53
53
|
# @!group service
|
54
54
|
module Aws::CloudFormation
|
55
55
|
|
56
|
-
GEM_VERSION = '1.
|
56
|
+
GEM_VERSION = '1.54.0'
|
57
57
|
|
58
58
|
end
|
@@ -327,6 +327,193 @@ module Aws::CloudFormation
|
|
327
327
|
|
328
328
|
# @!group API Operations
|
329
329
|
|
330
|
+
# Activates a public third-party extension, making it available for use
|
331
|
+
# in stack templates. For more information, see [Using public
|
332
|
+
# extensions][1] in the *CloudFormation User Guide*.
|
333
|
+
#
|
334
|
+
# Once you have activated a public third-party extension in your account
|
335
|
+
# and region, use
|
336
|
+
# [SetTypeConfiguration](AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)
|
337
|
+
# to specify configuration properties for the extension. For more
|
338
|
+
# information, see [Configuring extensions at the account level][2] in
|
339
|
+
# the *CloudFormation User Guide*.
|
340
|
+
#
|
341
|
+
#
|
342
|
+
#
|
343
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html
|
344
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
|
345
|
+
#
|
346
|
+
# @option params [String] :type
|
347
|
+
# The extension type.
|
348
|
+
#
|
349
|
+
# Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`,
|
350
|
+
# and `PublisherId`.
|
351
|
+
#
|
352
|
+
# @option params [String] :public_type_arn
|
353
|
+
# The Amazon Resource Number (ARN) of the public extension.
|
354
|
+
#
|
355
|
+
# Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`,
|
356
|
+
# and `PublisherId`.
|
357
|
+
#
|
358
|
+
# @option params [String] :publisher_id
|
359
|
+
# The ID of the extension publisher.
|
360
|
+
#
|
361
|
+
# Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`,
|
362
|
+
# and `PublisherId`.
|
363
|
+
#
|
364
|
+
# @option params [String] :type_name
|
365
|
+
# The name of the extension.
|
366
|
+
#
|
367
|
+
# Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`,
|
368
|
+
# and `PublisherId`.
|
369
|
+
#
|
370
|
+
# @option params [String] :type_name_alias
|
371
|
+
# An alias to assign to the public extension, in this account and
|
372
|
+
# region. If you specify an alias for the extension, CloudFormation
|
373
|
+
# treats the alias as the extension type name within this account and
|
374
|
+
# region. You must use the alias to refer to the extension in your
|
375
|
+
# templates, API calls, and CloudFormation console.
|
376
|
+
#
|
377
|
+
# An extension alias must be unique within a given account and region.
|
378
|
+
# You can activate the same public resource multiple times in the same
|
379
|
+
# account and region, using different type name aliases.
|
380
|
+
#
|
381
|
+
# @option params [Boolean] :auto_update
|
382
|
+
# Whether to automatically update the extension in this account and
|
383
|
+
# region when a new *minor* version is published by the extension
|
384
|
+
# publisher. Major versions released by the publisher must be manually
|
385
|
+
# updated.
|
386
|
+
#
|
387
|
+
# The default is `true`.
|
388
|
+
#
|
389
|
+
# @option params [Types::LoggingConfig] :logging_config
|
390
|
+
# Contains logging configuration information for an extension.
|
391
|
+
#
|
392
|
+
# @option params [String] :execution_role_arn
|
393
|
+
# The name of the IAM execution role to use to activate the extension.
|
394
|
+
#
|
395
|
+
# @option params [String] :version_bump
|
396
|
+
# Manually updates a previously-activated type to a new major or minor
|
397
|
+
# version, if available. You can also use this parameter to update the
|
398
|
+
# value of `AutoUpdate`.
|
399
|
+
#
|
400
|
+
# * `MAJOR`\: CloudFormation updates the extension to the newest major
|
401
|
+
# version, if one is available.
|
402
|
+
#
|
403
|
+
# * `MINOR`\: CloudFormation updates the extension to the newest minor
|
404
|
+
# version, if one is available.
|
405
|
+
#
|
406
|
+
# @option params [Integer] :major_version
|
407
|
+
# The major version of this extension you want to activate, if multiple
|
408
|
+
# major versions are available. The default is the latest major version.
|
409
|
+
# CloudFormation uses the latest available *minor* version of the major
|
410
|
+
# version selected.
|
411
|
+
#
|
412
|
+
# You can specify `MajorVersion` or `VersionBump`, but not both.
|
413
|
+
#
|
414
|
+
# @return [Types::ActivateTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
415
|
+
#
|
416
|
+
# * {Types::ActivateTypeOutput#arn #arn} => String
|
417
|
+
#
|
418
|
+
# @example Request syntax with placeholder values
|
419
|
+
#
|
420
|
+
# resp = client.activate_type({
|
421
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
422
|
+
# public_type_arn: "ThirdPartyTypeArn",
|
423
|
+
# publisher_id: "PublisherId",
|
424
|
+
# type_name: "TypeName",
|
425
|
+
# type_name_alias: "TypeName",
|
426
|
+
# auto_update: false,
|
427
|
+
# logging_config: {
|
428
|
+
# log_role_arn: "RoleArn", # required
|
429
|
+
# log_group_name: "LogGroupName", # required
|
430
|
+
# },
|
431
|
+
# execution_role_arn: "RoleArn",
|
432
|
+
# version_bump: "MAJOR", # accepts MAJOR, MINOR
|
433
|
+
# major_version: 1,
|
434
|
+
# })
|
435
|
+
#
|
436
|
+
# @example Response structure
|
437
|
+
#
|
438
|
+
# resp.arn #=> String
|
439
|
+
#
|
440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateType AWS API Documentation
|
441
|
+
#
|
442
|
+
# @overload activate_type(params = {})
|
443
|
+
# @param [Hash] params ({})
|
444
|
+
def activate_type(params = {}, options = {})
|
445
|
+
req = build_request(:activate_type, params)
|
446
|
+
req.send_request(options)
|
447
|
+
end
|
448
|
+
|
449
|
+
# Returns configuration data for the specified CloudFormation
|
450
|
+
# extensions, from the CloudFormation registry for the account and
|
451
|
+
# region.
|
452
|
+
#
|
453
|
+
# For more information, see [Configuring extensions at the account
|
454
|
+
# level][1] in the *CloudFormation User Guide*.
|
455
|
+
#
|
456
|
+
#
|
457
|
+
#
|
458
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
|
459
|
+
#
|
460
|
+
# @option params [required, Array<Types::TypeConfigurationIdentifier>] :type_configuration_identifiers
|
461
|
+
# The list of identifiers for the desired extension configurations.
|
462
|
+
#
|
463
|
+
# @return [Types::BatchDescribeTypeConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
464
|
+
#
|
465
|
+
# * {Types::BatchDescribeTypeConfigurationsOutput#errors #errors} => Array<Types::BatchDescribeTypeConfigurationsError>
|
466
|
+
# * {Types::BatchDescribeTypeConfigurationsOutput#unprocessed_type_configurations #unprocessed_type_configurations} => Array<Types::TypeConfigurationIdentifier>
|
467
|
+
# * {Types::BatchDescribeTypeConfigurationsOutput#type_configurations #type_configurations} => Array<Types::TypeConfigurationDetails>
|
468
|
+
#
|
469
|
+
# @example Request syntax with placeholder values
|
470
|
+
#
|
471
|
+
# resp = client.batch_describe_type_configurations({
|
472
|
+
# type_configuration_identifiers: [ # required
|
473
|
+
# {
|
474
|
+
# type_arn: "TypeArn",
|
475
|
+
# type_configuration_alias: "TypeConfigurationAlias",
|
476
|
+
# type_configuration_arn: "TypeConfigurationArn",
|
477
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
478
|
+
# type_name: "TypeName",
|
479
|
+
# },
|
480
|
+
# ],
|
481
|
+
# })
|
482
|
+
#
|
483
|
+
# @example Response structure
|
484
|
+
#
|
485
|
+
# resp.errors #=> Array
|
486
|
+
# resp.errors[0].error_code #=> String
|
487
|
+
# resp.errors[0].error_message #=> String
|
488
|
+
# resp.errors[0].type_configuration_identifier.type_arn #=> String
|
489
|
+
# resp.errors[0].type_configuration_identifier.type_configuration_alias #=> String
|
490
|
+
# resp.errors[0].type_configuration_identifier.type_configuration_arn #=> String
|
491
|
+
# resp.errors[0].type_configuration_identifier.type #=> String, one of "RESOURCE", "MODULE"
|
492
|
+
# resp.errors[0].type_configuration_identifier.type_name #=> String
|
493
|
+
# resp.unprocessed_type_configurations #=> Array
|
494
|
+
# resp.unprocessed_type_configurations[0].type_arn #=> String
|
495
|
+
# resp.unprocessed_type_configurations[0].type_configuration_alias #=> String
|
496
|
+
# resp.unprocessed_type_configurations[0].type_configuration_arn #=> String
|
497
|
+
# resp.unprocessed_type_configurations[0].type #=> String, one of "RESOURCE", "MODULE"
|
498
|
+
# resp.unprocessed_type_configurations[0].type_name #=> String
|
499
|
+
# resp.type_configurations #=> Array
|
500
|
+
# resp.type_configurations[0].arn #=> String
|
501
|
+
# resp.type_configurations[0].alias #=> String
|
502
|
+
# resp.type_configurations[0].configuration #=> String
|
503
|
+
# resp.type_configurations[0].last_updated #=> Time
|
504
|
+
# resp.type_configurations[0].type_arn #=> String
|
505
|
+
# resp.type_configurations[0].type_name #=> String
|
506
|
+
# resp.type_configurations[0].is_default_configuration #=> Boolean
|
507
|
+
#
|
508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurations AWS API Documentation
|
509
|
+
#
|
510
|
+
# @overload batch_describe_type_configurations(params = {})
|
511
|
+
# @param [Hash] params ({})
|
512
|
+
def batch_describe_type_configurations(params = {}, options = {})
|
513
|
+
req = build_request(:batch_describe_type_configurations, params)
|
514
|
+
req.send_request(options)
|
515
|
+
end
|
516
|
+
|
330
517
|
# Cancels an update on the specified stack. If the call completes
|
331
518
|
# successfully, the stack rolls back the update and reverts to the
|
332
519
|
# previous stack configuration.
|
@@ -340,10 +527,10 @@ module Aws::CloudFormation
|
|
340
527
|
#
|
341
528
|
# @option params [String] :client_request_token
|
342
529
|
# A unique identifier for this `CancelUpdateStack` request. Specify this
|
343
|
-
# token if you plan to retry requests so that
|
344
|
-
#
|
345
|
-
#
|
346
|
-
#
|
530
|
+
# token if you plan to retry requests so that CloudFormation knows that
|
531
|
+
# you're not attempting to cancel an update on a stack with the same
|
532
|
+
# name. You might retry `CancelUpdateStack` requests to ensure that
|
533
|
+
# CloudFormation successfully received them.
|
347
534
|
#
|
348
535
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
349
536
|
#
|
@@ -371,11 +558,11 @@ module Aws::CloudFormation
|
|
371
558
|
# `UPDATE_ROLLBACK_COMPLETE` state), and then try to update the stack
|
372
559
|
# again.
|
373
560
|
#
|
374
|
-
# A stack goes into the `UPDATE_ROLLBACK_FAILED` state when
|
561
|
+
# A stack goes into the `UPDATE_ROLLBACK_FAILED` state when
|
375
562
|
# CloudFormation cannot roll back all changes after a failed stack
|
376
563
|
# update. For example, you might have a stack that is rolling back to an
|
377
|
-
# old database instance that was deleted outside of
|
378
|
-
# Because
|
564
|
+
# old database instance that was deleted outside of CloudFormation.
|
565
|
+
# Because CloudFormation doesn't know the database was deleted, it
|
379
566
|
# assumes that the database instance still exists and attempts to roll
|
380
567
|
# back to it, causing the update rollback to fail.
|
381
568
|
#
|
@@ -395,33 +582,32 @@ module Aws::CloudFormation
|
|
395
582
|
# </note>
|
396
583
|
#
|
397
584
|
# @option params [String] :role_arn
|
398
|
-
# The Amazon Resource Name (ARN) of an
|
399
|
-
#
|
400
|
-
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
#
|
404
|
-
#
|
405
|
-
#
|
406
|
-
#
|
407
|
-
#
|
408
|
-
# was previously associated with the stack. If no role is available, AWS
|
585
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
586
|
+
# (IAM) role that CloudFormation assumes to roll back the stack.
|
587
|
+
# CloudFormation uses the role's credentials to make calls on your
|
588
|
+
# behalf. CloudFormation always uses this role for all future operations
|
589
|
+
# on the stack. As long as users have permission to operate on the
|
590
|
+
# stack, CloudFormation uses this role even if the users don't have
|
591
|
+
# permission to pass it. Ensure that the role grants least privilege.
|
592
|
+
#
|
593
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
594
|
+
# previously associated with the stack. If no role is available,
|
409
595
|
# CloudFormation uses a temporary session that is generated from your
|
410
596
|
# user credentials.
|
411
597
|
#
|
412
598
|
# @option params [Array<String>] :resources_to_skip
|
413
|
-
# A list of the logical IDs of the resources that
|
414
|
-
#
|
415
|
-
#
|
416
|
-
#
|
417
|
-
#
|
418
|
-
#
|
419
|
-
#
|
420
|
-
#
|
421
|
-
# Specify this property to skip rolling back resources that
|
599
|
+
# A list of the logical IDs of the resources that CloudFormation skips
|
600
|
+
# during the continue update rollback operation. You can specify only
|
601
|
+
# resources that are in the `UPDATE_FAILED` state because a rollback
|
602
|
+
# failed. You can't specify resources that are in the `UPDATE_FAILED`
|
603
|
+
# state for other reasons, for example, because an update was cancelled.
|
604
|
+
# To check why a resource update failed, use the DescribeStackResources
|
605
|
+
# action, and view the resource status reason.
|
606
|
+
#
|
607
|
+
# Specify this property to skip rolling back resources that
|
422
608
|
# CloudFormation can't successfully roll back. We recommend that you [
|
423
|
-
# troubleshoot][1] resources before skipping them.
|
424
|
-
#
|
609
|
+
# troubleshoot][1] resources before skipping them. CloudFormation sets
|
610
|
+
# the status of the specified resources to `UPDATE_COMPLETE` and
|
425
611
|
# continues to roll back the stack. After the rollback is complete, the
|
426
612
|
# state of the skipped resources will be inconsistent with the state of
|
427
613
|
# the resources in the stack template. Before performing another stack
|
@@ -455,10 +641,10 @@ module Aws::CloudFormation
|
|
455
641
|
#
|
456
642
|
# @option params [String] :client_request_token
|
457
643
|
# A unique identifier for this `ContinueUpdateRollback` request. Specify
|
458
|
-
# this token if you plan to retry requests so that
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
644
|
+
# this token if you plan to retry requests so that CloudFormationknows
|
645
|
+
# that you're not attempting to continue the rollback to a stack with
|
646
|
+
# the same name. You might retry `ContinueUpdateRollback` requests to
|
647
|
+
# ensure that CloudFormation successfully received them.
|
462
648
|
#
|
463
649
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
464
650
|
#
|
@@ -484,25 +670,25 @@ module Aws::CloudFormation
|
|
484
670
|
# can review the changes before executing them. You can create a change
|
485
671
|
# set for a stack that doesn't exist or an existing stack. If you
|
486
672
|
# create a change set for a stack that doesn't exist, the change set
|
487
|
-
# shows all of the resources that
|
488
|
-
# create a change set for an existing stack,
|
489
|
-
#
|
673
|
+
# shows all of the resources that CloudFormation will create. If you
|
674
|
+
# create a change set for an existing stack, CloudFormation compares the
|
675
|
+
# stack's information with the information that you submit in the
|
490
676
|
# change set and lists the differences. Use change sets to understand
|
491
|
-
# which resources
|
492
|
-
#
|
493
|
-
#
|
677
|
+
# which resources CloudFormation will create or change, and how it will
|
678
|
+
# change resources in an existing stack, before you create or update a
|
679
|
+
# stack.
|
494
680
|
#
|
495
681
|
# To create a change set for a stack that doesn't exist, for the
|
496
682
|
# `ChangeSetType` parameter, specify `CREATE`. To create a change set
|
497
683
|
# for an existing stack, specify `UPDATE` for the `ChangeSetType`
|
498
684
|
# parameter. To create a change set for an import operation, specify
|
499
685
|
# `IMPORT` for the `ChangeSetType` parameter. After the
|
500
|
-
# `CreateChangeSet` call successfully completes,
|
501
|
-
#
|
502
|
-
#
|
686
|
+
# `CreateChangeSet` call successfully completes, CloudFormation starts
|
687
|
+
# creating the change set. To check the status of the change set or to
|
688
|
+
# review it, use the DescribeChangeSet action.
|
503
689
|
#
|
504
690
|
# When you are satisfied with the changes the change set will make,
|
505
|
-
# execute the change set by using the ExecuteChangeSet action.
|
691
|
+
# execute the change set by using the ExecuteChangeSet action.
|
506
692
|
# CloudFormation doesn't make changes until you execute the change set.
|
507
693
|
#
|
508
694
|
# To create a change set for the entire stack hierachy, set
|
@@ -510,13 +696,13 @@ module Aws::CloudFormation
|
|
510
696
|
#
|
511
697
|
# @option params [required, String] :stack_name
|
512
698
|
# The name or the unique ID of the stack for which you are creating a
|
513
|
-
# change set.
|
514
|
-
#
|
515
|
-
#
|
699
|
+
# change set. CloudFormation generates the change set by comparing this
|
700
|
+
# stack's information with the information that you submit, such as a
|
701
|
+
# modified template or different parameter input values.
|
516
702
|
#
|
517
703
|
# @option params [String] :template_body
|
518
704
|
# A structure that contains the body of the revised template, with a
|
519
|
-
# minimum length of 1 byte and a maximum length of 51,200 bytes.
|
705
|
+
# minimum length of 1 byte and a maximum length of 51,200 bytes.
|
520
706
|
# CloudFormation generates the change set by comparing this template
|
521
707
|
# with the template of the stack that you specified.
|
522
708
|
#
|
@@ -525,9 +711,9 @@ module Aws::CloudFormation
|
|
525
711
|
# @option params [String] :template_url
|
526
712
|
# The location of the file that contains the revised template. The URL
|
527
713
|
# must point to a template (max size: 460,800 bytes) that is located in
|
528
|
-
# an S3 bucket or a Systems Manager document.
|
529
|
-
#
|
530
|
-
#
|
714
|
+
# an S3 bucket or a Systems Manager document. CloudFormation generates
|
715
|
+
# the change set by comparing this template with the stack that you
|
716
|
+
# specified.
|
531
717
|
#
|
532
718
|
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
|
533
719
|
#
|
@@ -541,16 +727,15 @@ module Aws::CloudFormation
|
|
541
727
|
#
|
542
728
|
# @option params [Array<String>] :capabilities
|
543
729
|
# In some cases, you must explicitly acknowledge that your stack
|
544
|
-
# template contains certain capabilities in order for
|
545
|
-
#
|
730
|
+
# template contains certain capabilities in order for CloudFormation to
|
731
|
+
# create the stack.
|
546
732
|
#
|
547
733
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
548
734
|
#
|
549
735
|
# Some stack templates might include resources that can affect
|
550
|
-
# permissions in your
|
551
|
-
#
|
552
|
-
#
|
553
|
-
# capabilities.
|
736
|
+
# permissions in your account; for example, by creating new Identity
|
737
|
+
# and Access Management (IAM) users. For those stacks, you must
|
738
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
554
739
|
#
|
555
740
|
# The following IAM resources require you to specify either the
|
556
741
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
@@ -560,8 +745,8 @@ module Aws::CloudFormation
|
|
560
745
|
# * If you have IAM resources with custom names, you *must* specify
|
561
746
|
# `CAPABILITY_NAMED_IAM`.
|
562
747
|
#
|
563
|
-
# * If you don't specify either of these capabilities,
|
564
|
-
#
|
748
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
749
|
+
# returns an `InsufficientCapabilities` error.
|
565
750
|
#
|
566
751
|
# If your stack template contains these resources, we recommend that
|
567
752
|
# you review all permissions associated with them and edit their
|
@@ -581,7 +766,7 @@ module Aws::CloudFormation
|
|
581
766
|
#
|
582
767
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
583
768
|
#
|
584
|
-
# For more information, see [Acknowledging IAM Resources in
|
769
|
+
# For more information, see [Acknowledging IAM Resources in
|
585
770
|
# CloudFormation Templates][8].
|
586
771
|
#
|
587
772
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -596,7 +781,7 @@ module Aws::CloudFormation
|
|
596
781
|
# create a stack directly from the processed template, without first
|
597
782
|
# reviewing the resulting changes in a change set, you must
|
598
783
|
# acknowledge this capability. This includes the [AWS::Include][9] and
|
599
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
784
|
+
# [AWS::Serverless][10] transforms, which are macros hosted by
|
600
785
|
# CloudFormation.
|
601
786
|
#
|
602
787
|
# <note markdown="1"> This capacity does not apply to creating change sets, and specifying
|
@@ -609,8 +794,8 @@ module Aws::CloudFormation
|
|
609
794
|
#
|
610
795
|
# </note>
|
611
796
|
#
|
612
|
-
# For more information on macros, see [Using
|
613
|
-
#
|
797
|
+
# For more information on macros, see [Using CloudFormation Macros to
|
798
|
+
# Perform Custom Processing on Templates][11].
|
614
799
|
#
|
615
800
|
#
|
616
801
|
#
|
@@ -632,44 +817,43 @@ module Aws::CloudFormation
|
|
632
817
|
# `AWS::EC2::*`, or `Custom::MyCustomInstance`.
|
633
818
|
#
|
634
819
|
# If the list of resource types doesn't include a resource type that
|
635
|
-
# you're updating, the stack update fails. By default,
|
636
|
-
#
|
637
|
-
#
|
638
|
-
#
|
639
|
-
#
|
640
|
-
#
|
820
|
+
# you're updating, the stack update fails. By default, CloudFormation
|
821
|
+
# grants permissions to all resource types. Identity and Access
|
822
|
+
# Management (IAM) uses this parameter for condition keys in IAM
|
823
|
+
# policies for CloudFormation. For more information, see [Controlling
|
824
|
+
# Access with Identity and Access Management][1] in the CloudFormation
|
825
|
+
# User Guide.
|
641
826
|
#
|
642
827
|
#
|
643
828
|
#
|
644
829
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
645
830
|
#
|
646
831
|
# @option params [String] :role_arn
|
647
|
-
# The Amazon Resource Name (ARN) of an
|
648
|
-
#
|
649
|
-
#
|
650
|
-
#
|
651
|
-
#
|
652
|
-
#
|
653
|
-
#
|
654
|
-
#
|
655
|
-
#
|
656
|
-
#
|
657
|
-
# was previously associated with the stack. If no role is available, AWS
|
832
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
833
|
+
# (IAM) role that CloudFormation assumes when executing the change set.
|
834
|
+
# CloudFormation uses the role's credentials to make calls on your
|
835
|
+
# behalf. CloudFormation uses this role for all future operations on the
|
836
|
+
# stack. As long as users have permission to operate on the stack,
|
837
|
+
# CloudFormation uses this role even if the users don't have permission
|
838
|
+
# to pass it. Ensure that the role grants least privilege.
|
839
|
+
#
|
840
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
841
|
+
# previously associated with the stack. If no role is available,
|
658
842
|
# CloudFormation uses a temporary session that is generated from your
|
659
843
|
# user credentials.
|
660
844
|
#
|
661
845
|
# @option params [Types::RollbackConfiguration] :rollback_configuration
|
662
|
-
# The rollback triggers for
|
846
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
663
847
|
# creation and updating operations, and for the specified monitoring
|
664
848
|
# period afterwards.
|
665
849
|
#
|
666
850
|
# @option params [Array<String>] :notification_arns
|
667
851
|
# The Amazon Resource Names (ARNs) of Amazon Simple Notification Service
|
668
|
-
# (Amazon SNS) topics that
|
669
|
-
#
|
852
|
+
# (Amazon SNS) topics that CloudFormation associates with the stack. To
|
853
|
+
# remove all associated notification topics, specify an empty list.
|
670
854
|
#
|
671
855
|
# @option params [Array<Types::Tag>] :tags
|
672
|
-
# Key-value pairs to associate with this stack.
|
856
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
673
857
|
# propagates these tags to resources in the stack. You can specify a
|
674
858
|
# maximum of 50 tags.
|
675
859
|
#
|
@@ -683,9 +867,9 @@ module Aws::CloudFormation
|
|
683
867
|
#
|
684
868
|
# @option params [String] :client_token
|
685
869
|
# A unique identifier for this `CreateChangeSet` request. Specify this
|
686
|
-
# token if you plan to retry requests so that
|
687
|
-
#
|
688
|
-
# name. You might retry `CreateChangeSet` requests to ensure that
|
870
|
+
# token if you plan to retry requests so that CloudFormation knows that
|
871
|
+
# you're not attempting to create another change set with the same
|
872
|
+
# name. You might retry `CreateChangeSet` requests to ensure that
|
689
873
|
# CloudFormation successfully received them.
|
690
874
|
#
|
691
875
|
# @option params [String] :description
|
@@ -697,12 +881,12 @@ module Aws::CloudFormation
|
|
697
881
|
# specify `UPDATE`. To create a change set for an import operation,
|
698
882
|
# specify `IMPORT`.
|
699
883
|
#
|
700
|
-
# If you create a change set for a new stack,
|
701
|
-
#
|
702
|
-
#
|
703
|
-
#
|
884
|
+
# If you create a change set for a new stack, CloudFormation creates a
|
885
|
+
# stack with a unique stack ID, but no template or resources. The stack
|
886
|
+
# will be in the [ `REVIEW_IN_PROGRESS` ][1] state until you execute the
|
887
|
+
# change set.
|
704
888
|
#
|
705
|
-
# By default,
|
889
|
+
# By default, CloudFormation specifies `UPDATE`. You can't use the
|
706
890
|
# `UPDATE` type to create a change set for a new stack or the `CREATE`
|
707
891
|
# type to create a change set for an existing stack.
|
708
892
|
#
|
@@ -804,7 +988,7 @@ module Aws::CloudFormation
|
|
804
988
|
# @option params [String] :template_body
|
805
989
|
# Structure containing the template body with a minimum length of 1 byte
|
806
990
|
# and a maximum length of 51,200 bytes. For more information, go to
|
807
|
-
# [Template Anatomy][1] in the
|
991
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
808
992
|
#
|
809
993
|
# Conditional: You must specify either the `TemplateBody` or the
|
810
994
|
# `TemplateURL` parameter, but not both.
|
@@ -817,7 +1001,7 @@ module Aws::CloudFormation
|
|
817
1001
|
# Location of file containing the template body. The URL must point to a
|
818
1002
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
819
1003
|
# bucket or a Systems Manager document. For more information, go to the
|
820
|
-
# [Template Anatomy][1] in the
|
1004
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
821
1005
|
#
|
822
1006
|
# Conditional: You must specify either the `TemplateBody` or the
|
823
1007
|
# `TemplateURL` parameter, but not both.
|
@@ -842,7 +1026,7 @@ module Aws::CloudFormation
|
|
842
1026
|
# Default: `false`
|
843
1027
|
#
|
844
1028
|
# @option params [Types::RollbackConfiguration] :rollback_configuration
|
845
|
-
# The rollback triggers for
|
1029
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
846
1030
|
# creation and updating operations, and for the specified monitoring
|
847
1031
|
# period afterwards.
|
848
1032
|
#
|
@@ -858,16 +1042,15 @@ module Aws::CloudFormation
|
|
858
1042
|
#
|
859
1043
|
# @option params [Array<String>] :capabilities
|
860
1044
|
# In some cases, you must explicitly acknowledge that your stack
|
861
|
-
# template contains certain capabilities in order for
|
862
|
-
#
|
1045
|
+
# template contains certain capabilities in order for CloudFormation to
|
1046
|
+
# create the stack.
|
863
1047
|
#
|
864
1048
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
865
1049
|
#
|
866
1050
|
# Some stack templates might include resources that can affect
|
867
|
-
# permissions in your
|
868
|
-
#
|
869
|
-
#
|
870
|
-
# capabilities.
|
1051
|
+
# permissions in your account; for example, by creating new Identity
|
1052
|
+
# and Access Management (IAM) users. For those stacks, you must
|
1053
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
871
1054
|
#
|
872
1055
|
# The following IAM resources require you to specify either the
|
873
1056
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
@@ -877,8 +1060,8 @@ module Aws::CloudFormation
|
|
877
1060
|
# * If you have IAM resources with custom names, you *must* specify
|
878
1061
|
# `CAPABILITY_NAMED_IAM`.
|
879
1062
|
#
|
880
|
-
# * If you don't specify either of these capabilities,
|
881
|
-
#
|
1063
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
1064
|
+
# returns an `InsufficientCapabilities` error.
|
882
1065
|
#
|
883
1066
|
# If your stack template contains these resources, we recommend that
|
884
1067
|
# you review all permissions associated with them and edit their
|
@@ -898,7 +1081,7 @@ module Aws::CloudFormation
|
|
898
1081
|
#
|
899
1082
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
900
1083
|
#
|
901
|
-
# For more information, see [Acknowledging IAM Resources in
|
1084
|
+
# For more information, see [Acknowledging IAM Resources in
|
902
1085
|
# CloudFormation Templates][8].
|
903
1086
|
#
|
904
1087
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -913,7 +1096,7 @@ module Aws::CloudFormation
|
|
913
1096
|
# create a stack directly from the processed template, without first
|
914
1097
|
# reviewing the resulting changes in a change set, you must
|
915
1098
|
# acknowledge this capability. This includes the [AWS::Include][9] and
|
916
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
1099
|
+
# [AWS::Serverless][10] transforms, which are macros hosted by
|
917
1100
|
# CloudFormation.
|
918
1101
|
#
|
919
1102
|
# If you want to create a stack from a stack template that contains
|
@@ -925,11 +1108,11 @@ module Aws::CloudFormation
|
|
925
1108
|
#
|
926
1109
|
# Each macro relies on an underlying Lambda service function for
|
927
1110
|
# processing stack templates. Be aware that the Lambda function owner
|
928
|
-
# can update the function operation without
|
1111
|
+
# can update the function operation without CloudFormation being
|
929
1112
|
# notified.
|
930
1113
|
#
|
931
|
-
# For more information, see [Using
|
932
|
-
#
|
1114
|
+
# For more information, see [Using CloudFormation Macros to Perform
|
1115
|
+
# Custom Processing on Templates][11].
|
933
1116
|
#
|
934
1117
|
#
|
935
1118
|
#
|
@@ -949,35 +1132,35 @@ module Aws::CloudFormation
|
|
949
1132
|
# The template resource types that you have permissions to work with for
|
950
1133
|
# this create stack action, such as `AWS::EC2::Instance`, `AWS::EC2::*`,
|
951
1134
|
# or `Custom::MyCustomInstance`. Use the following syntax to describe
|
952
|
-
# template resource types: `AWS::*` (for all
|
953
|
-
#
|
954
|
-
#
|
955
|
-
#
|
956
|
-
#
|
1135
|
+
# template resource types: `AWS::*` (for all Amazon Web Services
|
1136
|
+
# resources), `Custom::*` (for all custom resources),
|
1137
|
+
# `Custom::logical_ID ` (for a specific custom resource),
|
1138
|
+
# `AWS::service_name::*` (for all resources of a particular Amazon Web
|
1139
|
+
# Services service), and `AWS::service_name::resource_logical_ID ` (for
|
1140
|
+
# a specific Amazon Web Services resource).
|
957
1141
|
#
|
958
1142
|
# If the list of resource types doesn't include a resource that you're
|
959
|
-
# creating, the stack creation fails. By default,
|
960
|
-
#
|
961
|
-
#
|
962
|
-
#
|
963
|
-
#
|
1143
|
+
# creating, the stack creation fails. By default, CloudFormation grants
|
1144
|
+
# permissions to all resource types. Identity and Access Management
|
1145
|
+
# (IAM) uses this parameter for CloudFormation-specific condition keys
|
1146
|
+
# in IAM policies. For more information, see [Controlling Access with
|
1147
|
+
# Identity and Access Management][1].
|
964
1148
|
#
|
965
1149
|
#
|
966
1150
|
#
|
967
1151
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
968
1152
|
#
|
969
1153
|
# @option params [String] :role_arn
|
970
|
-
# The Amazon Resource Name (ARN) of an
|
971
|
-
#
|
972
|
-
#
|
973
|
-
#
|
974
|
-
#
|
975
|
-
#
|
976
|
-
#
|
977
|
-
#
|
978
|
-
#
|
979
|
-
#
|
980
|
-
# was previously associated with the stack. If no role is available, AWS
|
1154
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
1155
|
+
# (IAM) role that CloudFormation assumes to create the stack.
|
1156
|
+
# CloudFormation uses the role's credentials to make calls on your
|
1157
|
+
# behalf. CloudFormation always uses this role for all future operations
|
1158
|
+
# on the stack. As long as users have permission to operate on the
|
1159
|
+
# stack, CloudFormation uses this role even if the users don't have
|
1160
|
+
# permission to pass it. Ensure that the role grants least privilege.
|
1161
|
+
#
|
1162
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
1163
|
+
# previously associated with the stack. If no role is available,
|
981
1164
|
# CloudFormation uses a temporary session that is generated from your
|
982
1165
|
# user credentials.
|
983
1166
|
#
|
@@ -990,7 +1173,7 @@ module Aws::CloudFormation
|
|
990
1173
|
#
|
991
1174
|
# @option params [String] :stack_policy_body
|
992
1175
|
# Structure containing the stack policy body. For more information, go
|
993
|
-
# to [ Prevent Updates to Stack Resources][1] in the *
|
1176
|
+
# to [ Prevent Updates to Stack Resources][1] in the *CloudFormation
|
994
1177
|
# User Guide*. You can specify either the `StackPolicyBody` or the
|
995
1178
|
# `StackPolicyURL` parameter, but not both.
|
996
1179
|
#
|
@@ -1005,15 +1188,15 @@ module Aws::CloudFormation
|
|
1005
1188
|
# the `StackPolicyURL` parameter, but not both.
|
1006
1189
|
#
|
1007
1190
|
# @option params [Array<Types::Tag>] :tags
|
1008
|
-
# Key-value pairs to associate with this stack.
|
1191
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
1009
1192
|
# propagates these tags to the resources created in the stack. A maximum
|
1010
1193
|
# number of 50 tags can be specified.
|
1011
1194
|
#
|
1012
1195
|
# @option params [String] :client_request_token
|
1013
1196
|
# A unique identifier for this `CreateStack` request. Specify this token
|
1014
|
-
# if you plan to retry requests so that
|
1197
|
+
# if you plan to retry requests so that CloudFormation knows that
|
1015
1198
|
# you're not attempting to create a stack with the same name. You might
|
1016
|
-
# retry `CreateStack` requests to ensure that
|
1199
|
+
# retry `CreateStack` requests to ensure that CloudFormation
|
1017
1200
|
# successfully received them.
|
1018
1201
|
#
|
1019
1202
|
# All events triggered by a given stack operation are assigned the same
|
@@ -1035,7 +1218,7 @@ module Aws::CloudFormation
|
|
1035
1218
|
# user attempts to delete a stack with termination protection enabled,
|
1036
1219
|
# the operation fails and the stack remains unchanged. For more
|
1037
1220
|
# information, see [Protecting a Stack From Being Deleted][1] in the
|
1038
|
-
# *
|
1221
|
+
# *CloudFormation User Guide*. Termination protection is disabled on
|
1039
1222
|
# stacks by default.
|
1040
1223
|
#
|
1041
1224
|
# For [nested stacks][2], termination protection is set on the root
|
@@ -1116,21 +1299,20 @@ module Aws::CloudFormation
|
|
1116
1299
|
# instances from.
|
1117
1300
|
#
|
1118
1301
|
# @option params [Array<String>] :accounts
|
1119
|
-
# \[Self-managed permissions\] The names of one or more
|
1120
|
-
#
|
1121
|
-
# for.
|
1302
|
+
# \[Self-managed permissions\] The names of one or more accounts that
|
1303
|
+
# you want to create stack instances in the specified Region(s) for.
|
1122
1304
|
#
|
1123
1305
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1124
1306
|
#
|
1125
1307
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
1126
|
-
# \[Service-managed permissions\] The
|
1127
|
-
#
|
1308
|
+
# \[Service-managed permissions\] The Organizations accounts for which
|
1309
|
+
# to create stack instances in the specified Regions.
|
1128
1310
|
#
|
1129
1311
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1130
1312
|
#
|
1131
1313
|
# @option params [required, Array<String>] :regions
|
1132
1314
|
# The names of one or more Regions where you want to create stack
|
1133
|
-
# instances using the specified
|
1315
|
+
# instances using the specified accounts.
|
1134
1316
|
#
|
1135
1317
|
# @option params [Array<Types::Parameter>] :parameter_overrides
|
1136
1318
|
# A list of stack set parameters whose values you want to override in
|
@@ -1138,24 +1320,19 @@ module Aws::CloudFormation
|
|
1138
1320
|
#
|
1139
1321
|
# Any overridden parameter values will be applied to all stack instances
|
1140
1322
|
# in the specified accounts and Regions. When specifying parameters and
|
1141
|
-
# their values, be aware of how
|
1323
|
+
# their values, be aware of how CloudFormation sets parameter values
|
1142
1324
|
# during stack instance operations:
|
1143
1325
|
#
|
1144
1326
|
# * To override the current value for a parameter, include the parameter
|
1145
1327
|
# and specify its value.
|
1146
1328
|
#
|
1147
|
-
# * To leave
|
1148
|
-
#
|
1149
|
-
#
|
1150
|
-
# * Do not include the parameter in the list.
|
1151
|
-
#
|
1152
|
-
# * Include the parameter and specify `UsePreviousValue` as `true`.
|
1153
|
-
# (You cannot specify both a value and set `UsePreviousValue` to
|
1154
|
-
# `true`.)
|
1329
|
+
# * To leave an overridden parameter set to its present value, include
|
1330
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You cannot
|
1331
|
+
# specify both a value and set `UsePreviousValue` to `true`.)
|
1155
1332
|
#
|
1156
|
-
# * To set
|
1157
|
-
# stack set, specify a parameter list but do not include
|
1158
|
-
#
|
1333
|
+
# * To set an overridden parameter back to the value specified in the
|
1334
|
+
# stack set, specify a parameter list but do not include the parameter
|
1335
|
+
# in the list.
|
1159
1336
|
#
|
1160
1337
|
# * To leave all parameters set to their present values, do not specify
|
1161
1338
|
# this property at all.
|
@@ -1172,17 +1349,16 @@ module Aws::CloudFormation
|
|
1172
1349
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
|
1173
1350
|
#
|
1174
1351
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
1175
|
-
# Preferences for how
|
1176
|
-
# operation.
|
1352
|
+
# Preferences for how CloudFormation performs this stack set operation.
|
1177
1353
|
#
|
1178
1354
|
# @option params [String] :operation_id
|
1179
1355
|
# The unique identifier for this stack set operation.
|
1180
1356
|
#
|
1181
1357
|
# The operation ID also functions as an idempotency token, to ensure
|
1182
|
-
# that
|
1183
|
-
#
|
1184
|
-
#
|
1185
|
-
#
|
1358
|
+
# that CloudFormation performs the stack set operation only once, even
|
1359
|
+
# if you retry the request multiple times. You might retry stack set
|
1360
|
+
# operation requests to ensure that CloudFormation successfully received
|
1361
|
+
# them.
|
1186
1362
|
#
|
1187
1363
|
# If you don't specify an operation ID, the SDK generates one
|
1188
1364
|
# automatically.
|
@@ -1206,9 +1382,9 @@ module Aws::CloudFormation
|
|
1206
1382
|
# * If you are signed in to a delegated administrator account, specify
|
1207
1383
|
# `DELEGATED_ADMIN`.
|
1208
1384
|
#
|
1209
|
-
# Your
|
1210
|
-
#
|
1211
|
-
#
|
1385
|
+
# Your account must be registered as a delegated administrator in the
|
1386
|
+
# management account. For more information, see [Register a delegated
|
1387
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
1212
1388
|
#
|
1213
1389
|
#
|
1214
1390
|
#
|
@@ -1281,7 +1457,7 @@ module Aws::CloudFormation
|
|
1281
1457
|
# @option params [String] :template_body
|
1282
1458
|
# The structure that contains the template body, with a minimum length
|
1283
1459
|
# of 1 byte and a maximum length of 51,200 bytes. For more information,
|
1284
|
-
# see [Template Anatomy][1] in the
|
1460
|
+
# see [Template Anatomy][1] in the CloudFormation User Guide.
|
1285
1461
|
#
|
1286
1462
|
# Conditional: You must specify either the TemplateBody or the
|
1287
1463
|
# TemplateURL parameter, but not both.
|
@@ -1294,7 +1470,7 @@ module Aws::CloudFormation
|
|
1294
1470
|
# The location of the file that contains the template body. The URL must
|
1295
1471
|
# point to a template (maximum size: 460,800 bytes) that's located in
|
1296
1472
|
# an Amazon S3 bucket or a Systems Manager document. For more
|
1297
|
-
# information, see [Template Anatomy][1] in the
|
1473
|
+
# information, see [Template Anatomy][1] in the CloudFormation User
|
1298
1474
|
# Guide.
|
1299
1475
|
#
|
1300
1476
|
# Conditional: You must specify either the TemplateBody or the
|
@@ -1304,21 +1480,24 @@ module Aws::CloudFormation
|
|
1304
1480
|
#
|
1305
1481
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
|
1306
1482
|
#
|
1483
|
+
# @option params [String] :stack_id
|
1484
|
+
# The stack ID you are importing into a new stack set. Specify the
|
1485
|
+
# Amazon Resource Number (ARN) of the stack.
|
1486
|
+
#
|
1307
1487
|
# @option params [Array<Types::Parameter>] :parameters
|
1308
1488
|
# The input parameters for the stack set template.
|
1309
1489
|
#
|
1310
1490
|
# @option params [Array<String>] :capabilities
|
1311
1491
|
# In some cases, you must explicitly acknowledge that your stack set
|
1312
|
-
# template contains certain capabilities in order for
|
1313
|
-
#
|
1492
|
+
# template contains certain capabilities in order for CloudFormation to
|
1493
|
+
# create the stack set and related stack instances.
|
1314
1494
|
#
|
1315
1495
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
1316
1496
|
#
|
1317
1497
|
# Some stack templates might include resources that can affect
|
1318
|
-
# permissions in your
|
1319
|
-
#
|
1320
|
-
#
|
1321
|
-
# capabilities.
|
1498
|
+
# permissions in your account; for example, by creating new Identity
|
1499
|
+
# and Access Management (IAM) users. For those stack sets, you must
|
1500
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
1322
1501
|
#
|
1323
1502
|
# The following IAM resources require you to specify either the
|
1324
1503
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
@@ -1328,8 +1507,8 @@ module Aws::CloudFormation
|
|
1328
1507
|
# * If you have IAM resources with custom names, you *must* specify
|
1329
1508
|
# `CAPABILITY_NAMED_IAM`.
|
1330
1509
|
#
|
1331
|
-
# * If you don't specify either of these capabilities,
|
1332
|
-
#
|
1510
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
1511
|
+
# returns an `InsufficientCapabilities` error.
|
1333
1512
|
#
|
1334
1513
|
# If your stack template contains these resources, we recommend that
|
1335
1514
|
# you review all permissions associated with them and edit their
|
@@ -1349,25 +1528,26 @@ module Aws::CloudFormation
|
|
1349
1528
|
#
|
1350
1529
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
1351
1530
|
#
|
1352
|
-
# For more information, see [Acknowledging IAM Resources in
|
1531
|
+
# For more information, see [Acknowledging IAM Resources in
|
1353
1532
|
# CloudFormation Templates][8].
|
1354
1533
|
#
|
1355
1534
|
# * `CAPABILITY_AUTO_EXPAND`
|
1356
1535
|
#
|
1357
|
-
# Some templates
|
1358
|
-
# or more macros,
|
1359
|
-
# processed template, without first reviewing the
|
1360
|
-
# a change set
|
1361
|
-
#
|
1362
|
-
# Processing on
|
1536
|
+
# Some templates reference macros. If your stack set template
|
1537
|
+
# references one or more macros, you must create the stack set
|
1538
|
+
# directly from the processed template, without first reviewing the
|
1539
|
+
# resulting changes in a change set. To create the stack set directly,
|
1540
|
+
# you must acknowledge this capability. For more information, see
|
1541
|
+
# [Using CloudFormation Macros to Perform Custom Processing on
|
1542
|
+
# Templates][9].
|
1363
1543
|
#
|
1364
|
-
#
|
1365
|
-
#
|
1366
|
-
# transforms, which are
|
1367
|
-
#
|
1368
|
-
#
|
1369
|
-
#
|
1370
|
-
#
|
1544
|
+
# Stack sets with service-managed permissions do not currently support
|
1545
|
+
# the use of macros in templates. (This includes the
|
1546
|
+
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
1547
|
+
# macros hosted by CloudFormation.) Even if you specify this
|
1548
|
+
# capability for a stack set with service-managed permissions, if you
|
1549
|
+
# reference a macro in your template the stack set operation will
|
1550
|
+
# fail.
|
1371
1551
|
#
|
1372
1552
|
#
|
1373
1553
|
#
|
@@ -1385,11 +1565,11 @@ module Aws::CloudFormation
|
|
1385
1565
|
#
|
1386
1566
|
# @option params [Array<Types::Tag>] :tags
|
1387
1567
|
# The key-value pairs to associate with this stack set and the stacks
|
1388
|
-
# created from it.
|
1568
|
+
# created from it. CloudFormation also propagates these tags to
|
1389
1569
|
# supported resources that are created in the stacks. A maximum number
|
1390
1570
|
# of 50 tags can be specified.
|
1391
1571
|
#
|
1392
|
-
# If you specify tags as part of a `CreateStackSet` action,
|
1572
|
+
# If you specify tags as part of a `CreateStackSet` action,
|
1393
1573
|
# CloudFormation checks to see if you have the required IAM permission
|
1394
1574
|
# to tag resources. If you don't, the entire `CreateStackSet` action
|
1395
1575
|
# fails with an `access denied` error, and the stack set is not created.
|
@@ -1402,7 +1582,7 @@ module Aws::CloudFormation
|
|
1402
1582
|
# roles to control which users or groups can manage specific stack sets
|
1403
1583
|
# within the same administrator account. For more information, see
|
1404
1584
|
# [Prerequisites: Granting Permissions for Stack Set Operations][1] in
|
1405
|
-
# the *
|
1585
|
+
# the *CloudFormation User Guide*.
|
1406
1586
|
#
|
1407
1587
|
#
|
1408
1588
|
#
|
@@ -1410,7 +1590,7 @@ module Aws::CloudFormation
|
|
1410
1590
|
#
|
1411
1591
|
# @option params [String] :execution_role_name
|
1412
1592
|
# The name of the IAM execution role to use to create the stack set. If
|
1413
|
-
# you do not specify an execution role,
|
1593
|
+
# you do not specify an execution role, CloudFormation uses the
|
1414
1594
|
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
|
1415
1595
|
# operation.
|
1416
1596
|
#
|
@@ -1427,7 +1607,7 @@ module Aws::CloudFormation
|
|
1427
1607
|
# information, see [Grant Self-Managed Stack Set Permissions][1].
|
1428
1608
|
#
|
1429
1609
|
# * With `service-managed` permissions, StackSets automatically creates
|
1430
|
-
# the IAM roles required to deploy to accounts managed by
|
1610
|
+
# the IAM roles required to deploy to accounts managed by
|
1431
1611
|
# Organizations. For more information, see [Grant Service-Managed
|
1432
1612
|
# Stack Set Permissions][2].
|
1433
1613
|
#
|
@@ -1437,7 +1617,7 @@ module Aws::CloudFormation
|
|
1437
1617
|
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
|
1438
1618
|
#
|
1439
1619
|
# @option params [Types::AutoDeployment] :auto_deployment
|
1440
|
-
# Describes whether StackSets automatically deploys to
|
1620
|
+
# Describes whether StackSets automatically deploys to Organizations
|
1441
1621
|
# accounts that are added to the target organization or organizational
|
1442
1622
|
# unit (OU). Specify only if `PermissionModel` is `SERVICE_MANAGED`.
|
1443
1623
|
#
|
@@ -1455,9 +1635,9 @@ module Aws::CloudFormation
|
|
1455
1635
|
# * To create a stack set with service-managed permissions while signed
|
1456
1636
|
# in to a delegated administrator account, specify `DELEGATED_ADMIN`.
|
1457
1637
|
#
|
1458
|
-
# Your
|
1638
|
+
# Your account must be registered as a delegated admin in the
|
1459
1639
|
# management account. For more information, see [Register a delegated
|
1460
|
-
# administrator][1] in the *
|
1640
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
1461
1641
|
#
|
1462
1642
|
# Stack sets with service-managed permissions are created in the
|
1463
1643
|
# management account, including stack sets that are created by delegated
|
@@ -1469,9 +1649,9 @@ module Aws::CloudFormation
|
|
1469
1649
|
#
|
1470
1650
|
# @option params [String] :client_request_token
|
1471
1651
|
# A unique identifier for this `CreateStackSet` request. Specify this
|
1472
|
-
# token if you plan to retry requests so that
|
1473
|
-
#
|
1474
|
-
#
|
1652
|
+
# token if you plan to retry requests so that CloudFormation knows that
|
1653
|
+
# you're not attempting to create another stack set with the same name.
|
1654
|
+
# You might retry `CreateStackSet` requests to ensure that
|
1475
1655
|
# CloudFormation successfully received them.
|
1476
1656
|
#
|
1477
1657
|
# If you don't specify an operation ID, the SDK generates one
|
@@ -1491,6 +1671,7 @@ module Aws::CloudFormation
|
|
1491
1671
|
# description: "Description",
|
1492
1672
|
# template_body: "TemplateBody",
|
1493
1673
|
# template_url: "TemplateURL",
|
1674
|
+
# stack_id: "StackId",
|
1494
1675
|
# parameters: [
|
1495
1676
|
# {
|
1496
1677
|
# parameter_key: "ParameterKey",
|
@@ -1530,10 +1711,56 @@ module Aws::CloudFormation
|
|
1530
1711
|
req.send_request(options)
|
1531
1712
|
end
|
1532
1713
|
|
1714
|
+
# Deactivates a public extension that was previously activated in this
|
1715
|
+
# account and region.
|
1716
|
+
#
|
1717
|
+
# Once deactivated, an extension cannot be used in any CloudFormation
|
1718
|
+
# operation. This includes stack update operations where the stack
|
1719
|
+
# template includes the extension, even if no updates are being made to
|
1720
|
+
# the extension. In addition, deactivated extensions are not
|
1721
|
+
# automatically updated if a new version of the extension is released.
|
1722
|
+
#
|
1723
|
+
# @option params [String] :type_name
|
1724
|
+
# The type name of the extension, in this account and region. If you
|
1725
|
+
# specified a type name alias when enabling the extension, use the type
|
1726
|
+
# name alias.
|
1727
|
+
#
|
1728
|
+
# Conditional: You must specify either `Arn`, or `TypeName` and `Type`.
|
1729
|
+
#
|
1730
|
+
# @option params [String] :type
|
1731
|
+
# The extension type.
|
1732
|
+
#
|
1733
|
+
# Conditional: You must specify either `Arn`, or `TypeName` and `Type`.
|
1734
|
+
#
|
1735
|
+
# @option params [String] :arn
|
1736
|
+
# The Amazon Resource Name (ARN) for the extension, in this account and
|
1737
|
+
# region.
|
1738
|
+
#
|
1739
|
+
# Conditional: You must specify either `Arn`, or `TypeName` and `Type`.
|
1740
|
+
#
|
1741
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1742
|
+
#
|
1743
|
+
# @example Request syntax with placeholder values
|
1744
|
+
#
|
1745
|
+
# resp = client.deactivate_type({
|
1746
|
+
# type_name: "TypeName",
|
1747
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
1748
|
+
# arn: "PrivateTypeArn",
|
1749
|
+
# })
|
1750
|
+
#
|
1751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateType AWS API Documentation
|
1752
|
+
#
|
1753
|
+
# @overload deactivate_type(params = {})
|
1754
|
+
# @param [Hash] params ({})
|
1755
|
+
def deactivate_type(params = {}, options = {})
|
1756
|
+
req = build_request(:deactivate_type, params)
|
1757
|
+
req.send_request(options)
|
1758
|
+
end
|
1759
|
+
|
1533
1760
|
# Deletes the specified change set. Deleting change sets ensures that no
|
1534
1761
|
# one executes the wrong change set.
|
1535
1762
|
#
|
1536
|
-
# If the call successfully completes,
|
1763
|
+
# If the call successfully completes, CloudFormation successfully
|
1537
1764
|
# deleted the change set.
|
1538
1765
|
#
|
1539
1766
|
# If `IncludeNestedStacks` specifies `True` during the creation of the
|
@@ -1577,28 +1804,28 @@ module Aws::CloudFormation
|
|
1577
1804
|
# @option params [Array<String>] :retain_resources
|
1578
1805
|
# For stacks in the `DELETE_FAILED` state, a list of resource logical
|
1579
1806
|
# IDs that are associated with the resources you want to retain. During
|
1580
|
-
# deletion,
|
1807
|
+
# deletion, CloudFormation deletes the stack but does not delete the
|
1581
1808
|
# retained resources.
|
1582
1809
|
#
|
1583
1810
|
# Retaining resources is useful when you cannot delete a resource, such
|
1584
1811
|
# as a non-empty S3 bucket, but you want to delete the stack.
|
1585
1812
|
#
|
1586
1813
|
# @option params [String] :role_arn
|
1587
|
-
# The Amazon Resource Name (ARN) of an
|
1588
|
-
#
|
1589
|
-
#
|
1590
|
-
#
|
1814
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
1815
|
+
# (IAM) role that CloudFormation assumes to delete the stack.
|
1816
|
+
# CloudFormation uses the role's credentials to make calls on your
|
1817
|
+
# behalf.
|
1591
1818
|
#
|
1592
|
-
# If you don't specify a value,
|
1593
|
-
#
|
1819
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
1820
|
+
# previously associated with the stack. If no role is available,
|
1594
1821
|
# CloudFormation uses a temporary session that is generated from your
|
1595
1822
|
# user credentials.
|
1596
1823
|
#
|
1597
1824
|
# @option params [String] :client_request_token
|
1598
1825
|
# A unique identifier for this `DeleteStack` request. Specify this token
|
1599
|
-
# if you plan to retry requests so that
|
1826
|
+
# if you plan to retry requests so that CloudFormation knows that
|
1600
1827
|
# you're not attempting to delete a stack with the same name. You might
|
1601
|
-
# retry `DeleteStack` requests to ensure that
|
1828
|
+
# retry `DeleteStack` requests to ensure that CloudFormation
|
1602
1829
|
# successfully received them.
|
1603
1830
|
#
|
1604
1831
|
# All events triggered by a given stack operation are assigned the same
|
@@ -1643,14 +1870,14 @@ module Aws::CloudFormation
|
|
1643
1870
|
# instances for.
|
1644
1871
|
#
|
1645
1872
|
# @option params [Array<String>] :accounts
|
1646
|
-
# \[Self-managed permissions\] The names of the
|
1647
|
-
#
|
1873
|
+
# \[Self-managed permissions\] The names of the accounts that you want
|
1874
|
+
# to delete stack instances for.
|
1648
1875
|
#
|
1649
1876
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1650
1877
|
#
|
1651
1878
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
1652
|
-
# \[Service-managed permissions\] The
|
1653
|
-
#
|
1879
|
+
# \[Service-managed permissions\] The Organizations accounts from which
|
1880
|
+
# to delete stack instances.
|
1654
1881
|
#
|
1655
1882
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
1656
1883
|
#
|
@@ -1658,8 +1885,7 @@ module Aws::CloudFormation
|
|
1658
1885
|
# The Regions where you want to delete stack set instances.
|
1659
1886
|
#
|
1660
1887
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
1661
|
-
# Preferences for how
|
1662
|
-
# operation.
|
1888
|
+
# Preferences for how CloudFormation performs this stack set operation.
|
1663
1889
|
#
|
1664
1890
|
# @option params [required, Boolean] :retain_stacks
|
1665
1891
|
# Removes the stack instances from the specified stack set, but doesn't
|
@@ -1679,10 +1905,10 @@ module Aws::CloudFormation
|
|
1679
1905
|
# automatically.
|
1680
1906
|
#
|
1681
1907
|
# The operation ID also functions as an idempotency token, to ensure
|
1682
|
-
# that
|
1683
|
-
#
|
1684
|
-
# operation requests to ensure that
|
1685
|
-
#
|
1908
|
+
# that CloudFormation performs the stack set operation only once, even
|
1909
|
+
# if you retry the request multiple times. You can retry stack set
|
1910
|
+
# operation requests to ensure that CloudFormation successfully received
|
1911
|
+
# them.
|
1686
1912
|
#
|
1687
1913
|
# Repeating this stack set operation with a new operation ID retries all
|
1688
1914
|
# stack instances whose status is `OUTDATED`.
|
@@ -1703,9 +1929,9 @@ module Aws::CloudFormation
|
|
1703
1929
|
# * If you are signed in to a delegated administrator account, specify
|
1704
1930
|
# `DELEGATED_ADMIN`.
|
1705
1931
|
#
|
1706
|
-
# Your
|
1707
|
-
#
|
1708
|
-
#
|
1932
|
+
# Your account must be registered as a delegated administrator in the
|
1933
|
+
# management account. For more information, see [Register a delegated
|
1934
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
1709
1935
|
#
|
1710
1936
|
#
|
1711
1937
|
#
|
@@ -1773,9 +1999,9 @@ module Aws::CloudFormation
|
|
1773
1999
|
# * If you are signed in to a delegated administrator account, specify
|
1774
2000
|
# `DELEGATED_ADMIN`.
|
1775
2001
|
#
|
1776
|
-
# Your
|
1777
|
-
#
|
1778
|
-
#
|
2002
|
+
# Your account must be registered as a delegated administrator in the
|
2003
|
+
# management account. For more information, see [Register a delegated
|
2004
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
1779
2005
|
#
|
1780
2006
|
#
|
1781
2007
|
#
|
@@ -1862,10 +2088,10 @@ module Aws::CloudFormation
|
|
1862
2088
|
req.send_request(options)
|
1863
2089
|
end
|
1864
2090
|
|
1865
|
-
# Retrieves your account's
|
1866
|
-
#
|
1867
|
-
# information about account limits, see [
|
1868
|
-
#
|
2091
|
+
# Retrieves your account's CloudFormation limits, such as the maximum
|
2092
|
+
# number of stacks that you can create in your account. For more
|
2093
|
+
# information about account limits, see [CloudFormation Limits][1] in
|
2094
|
+
# the *CloudFormation User Guide*.
|
1869
2095
|
#
|
1870
2096
|
#
|
1871
2097
|
#
|
@@ -1904,9 +2130,9 @@ module Aws::CloudFormation
|
|
1904
2130
|
req.send_request(options)
|
1905
2131
|
end
|
1906
2132
|
|
1907
|
-
# Returns the inputs for the change set and a list of changes that
|
2133
|
+
# Returns the inputs for the change set and a list of changes that
|
1908
2134
|
# CloudFormation will make if you execute the change set. For more
|
1909
|
-
# information, see [Updating Stacks Using Change Sets][1] in the
|
2135
|
+
# information, see [Updating Stacks Using Change Sets][1] in the
|
1910
2136
|
# CloudFormation User Guide.
|
1911
2137
|
#
|
1912
2138
|
#
|
@@ -2020,6 +2246,60 @@ module Aws::CloudFormation
|
|
2020
2246
|
req.send_request(options)
|
2021
2247
|
end
|
2022
2248
|
|
2249
|
+
# Returns information about a CloudFormation extension publisher.
|
2250
|
+
#
|
2251
|
+
# If you do not supply a `PublisherId`, and you have registered as an
|
2252
|
+
# extension publisher, `DescribePublisher` returns information about
|
2253
|
+
# your own publisher account.
|
2254
|
+
#
|
2255
|
+
# For more information on registering as a publisher, see:
|
2256
|
+
#
|
2257
|
+
# * [RegisterPublisher][1]
|
2258
|
+
#
|
2259
|
+
# * [Publishing extensions to make them available for public use][2] in
|
2260
|
+
# the *CloudFormation CLI User Guide*
|
2261
|
+
#
|
2262
|
+
#
|
2263
|
+
#
|
2264
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html
|
2265
|
+
# [2]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html
|
2266
|
+
#
|
2267
|
+
# @option params [String] :publisher_id
|
2268
|
+
# The ID of the extension publisher.
|
2269
|
+
#
|
2270
|
+
# If you do not supply a `PublisherId`, and you have registered as an
|
2271
|
+
# extension publisher, `DescribePublisher` returns information about
|
2272
|
+
# your own publisher account.
|
2273
|
+
#
|
2274
|
+
# @return [Types::DescribePublisherOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2275
|
+
#
|
2276
|
+
# * {Types::DescribePublisherOutput#publisher_id #publisher_id} => String
|
2277
|
+
# * {Types::DescribePublisherOutput#publisher_status #publisher_status} => String
|
2278
|
+
# * {Types::DescribePublisherOutput#identity_provider #identity_provider} => String
|
2279
|
+
# * {Types::DescribePublisherOutput#publisher_profile #publisher_profile} => String
|
2280
|
+
#
|
2281
|
+
# @example Request syntax with placeholder values
|
2282
|
+
#
|
2283
|
+
# resp = client.describe_publisher({
|
2284
|
+
# publisher_id: "PublisherId",
|
2285
|
+
# })
|
2286
|
+
#
|
2287
|
+
# @example Response structure
|
2288
|
+
#
|
2289
|
+
# resp.publisher_id #=> String
|
2290
|
+
# resp.publisher_status #=> String, one of "VERIFIED", "UNVERIFIED"
|
2291
|
+
# resp.identity_provider #=> String, one of "AWS_Marketplace", "GitHub", "Bitbucket"
|
2292
|
+
# resp.publisher_profile #=> String
|
2293
|
+
#
|
2294
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribePublisher AWS API Documentation
|
2295
|
+
#
|
2296
|
+
# @overload describe_publisher(params = {})
|
2297
|
+
# @param [Hash] params ({})
|
2298
|
+
def describe_publisher(params = {}, options = {})
|
2299
|
+
req = build_request(:describe_publisher, params)
|
2300
|
+
req.send_request(options)
|
2301
|
+
end
|
2302
|
+
|
2023
2303
|
# Returns information about a stack drift detection operation. A stack
|
2024
2304
|
# drift detection operation detects whether a stack's actual
|
2025
2305
|
# configuration differs, or has *drifted*, from it's expected
|
@@ -2043,10 +2323,10 @@ module Aws::CloudFormation
|
|
2043
2323
|
# @option params [required, String] :stack_drift_detection_id
|
2044
2324
|
# The ID of the drift detection results of this operation.
|
2045
2325
|
#
|
2046
|
-
#
|
2047
|
-
#
|
2048
|
-
#
|
2049
|
-
#
|
2326
|
+
# CloudFormation generates new results, with a new drift detection ID,
|
2327
|
+
# each time this operation is run. However, the number of drift results
|
2328
|
+
# CloudFormation retains for any given stack, and for how long, may
|
2329
|
+
# vary.
|
2050
2330
|
#
|
2051
2331
|
# @return [Types::DescribeStackDriftDetectionStatusOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2052
2332
|
#
|
@@ -2085,7 +2365,7 @@ module Aws::CloudFormation
|
|
2085
2365
|
|
2086
2366
|
# Returns all stack related events for a specified stack in reverse
|
2087
2367
|
# chronological order. For more information about a stack's event
|
2088
|
-
# history, go to [Stacks][1] in the
|
2368
|
+
# history, go to [Stacks][1] in the CloudFormation User Guide.
|
2089
2369
|
#
|
2090
2370
|
# <note markdown="1"> You can list events for stacks that have failed to create or have been
|
2091
2371
|
# deleted by specifying the unique stack identifier (stack ID).
|
@@ -2151,7 +2431,7 @@ module Aws::CloudFormation
|
|
2151
2431
|
end
|
2152
2432
|
|
2153
2433
|
# Returns the stack instance that's associated with the specified stack
|
2154
|
-
# set,
|
2434
|
+
# set, account, and Region.
|
2155
2435
|
#
|
2156
2436
|
# For a list of stack instances that are associated with a specific
|
2157
2437
|
# stack set, use ListStackInstances.
|
@@ -2161,7 +2441,7 @@ module Aws::CloudFormation
|
|
2161
2441
|
# stack instance information for.
|
2162
2442
|
#
|
2163
2443
|
# @option params [required, String] :stack_instance_account
|
2164
|
-
# The ID of an
|
2444
|
+
# The ID of an account that's associated with this stack instance.
|
2165
2445
|
#
|
2166
2446
|
# @option params [required, String] :stack_instance_region
|
2167
2447
|
# The name of a Region that's associated with this stack instance.
|
@@ -2179,9 +2459,9 @@ module Aws::CloudFormation
|
|
2179
2459
|
# * If you are signed in to a delegated administrator account, specify
|
2180
2460
|
# `DELEGATED_ADMIN`.
|
2181
2461
|
#
|
2182
|
-
# Your
|
2183
|
-
#
|
2184
|
-
#
|
2462
|
+
# Your account must be registered as a delegated administrator in the
|
2463
|
+
# management account. For more information, see [Register a delegated
|
2464
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
2185
2465
|
#
|
2186
2466
|
#
|
2187
2467
|
#
|
@@ -2288,7 +2568,7 @@ module Aws::CloudFormation
|
|
2288
2568
|
|
2289
2569
|
# Returns drift information for the resources that have been checked for
|
2290
2570
|
# drift in the specified stack. This includes actual and expected
|
2291
|
-
# configuration values for resources where
|
2571
|
+
# configuration values for resources where CloudFormation detects
|
2292
2572
|
# configuration drift.
|
2293
2573
|
#
|
2294
2574
|
# For a given stack, there will be one `StackResourceDrift` for each
|
@@ -2322,8 +2602,7 @@ module Aws::CloudFormation
|
|
2322
2602
|
# * `IN_SYNC`\: The resources's actual configuration matches its
|
2323
2603
|
# expected template configuration.
|
2324
2604
|
#
|
2325
|
-
# * `NOT_CHECKED`\:
|
2326
|
-
# value.
|
2605
|
+
# * `NOT_CHECKED`\: CloudFormation does not currently return this value.
|
2327
2606
|
#
|
2328
2607
|
# @option params [String] :next_token
|
2329
2608
|
# A string that identifies the next page of stack resource drift
|
@@ -2383,11 +2662,11 @@ module Aws::CloudFormation
|
|
2383
2662
|
req.send_request(options)
|
2384
2663
|
end
|
2385
2664
|
|
2386
|
-
# Returns
|
2387
|
-
# `StackName` is specified, all the associated
|
2388
|
-
# of the stack are returned. If
|
2389
|
-
#
|
2390
|
-
# returned.
|
2665
|
+
# Returns Amazon Web Services resource descriptions for running and
|
2666
|
+
# deleted stacks. If `StackName` is specified, all the associated
|
2667
|
+
# resources that are part of the stack are returned. If
|
2668
|
+
# `PhysicalResourceId` is specified, the associated resources of the
|
2669
|
+
# stack that the resource belongs to are returned.
|
2391
2670
|
#
|
2392
2671
|
# <note markdown="1"> Only the first 100 resources will be returned. If your stack has more
|
2393
2672
|
# resources than this, you should use `ListStackResources` instead.
|
@@ -2400,8 +2679,8 @@ module Aws::CloudFormation
|
|
2400
2679
|
# You must specify either `StackName` or `PhysicalResourceId`, but not
|
2401
2680
|
# both. In addition, you can specify `LogicalResourceId` to filter the
|
2402
2681
|
# returned result. For more information about resources, the
|
2403
|
-
# `LogicalResourceId` and `PhysicalResourceId`, go to the
|
2404
|
-
# CloudFormation User Guide][1].
|
2682
|
+
# `LogicalResourceId` and `PhysicalResourceId`, go to the
|
2683
|
+
# [CloudFormation User Guide][1].
|
2405
2684
|
#
|
2406
2685
|
# <note markdown="1"> A `ValidationError` is returned if you specify both `StackName` and
|
2407
2686
|
# `PhysicalResourceId` in the same request.
|
@@ -2433,7 +2712,7 @@ module Aws::CloudFormation
|
|
2433
2712
|
#
|
2434
2713
|
# @option params [String] :physical_resource_id
|
2435
2714
|
# The name or unique identifier that corresponds to a physical instance
|
2436
|
-
# ID of a resource supported by
|
2715
|
+
# ID of a resource supported by CloudFormation.
|
2437
2716
|
#
|
2438
2717
|
# For example, for an Amazon Elastic Compute Cloud (EC2) instance,
|
2439
2718
|
# `PhysicalResourceId` corresponds to the `InstanceId`. You can pass the
|
@@ -2501,9 +2780,9 @@ module Aws::CloudFormation
|
|
2501
2780
|
# * If you are signed in to a delegated administrator account, specify
|
2502
2781
|
# `DELEGATED_ADMIN`.
|
2503
2782
|
#
|
2504
|
-
# Your
|
2505
|
-
#
|
2506
|
-
#
|
2783
|
+
# Your account must be registered as a delegated administrator in the
|
2784
|
+
# management account. For more information, see [Register a delegated
|
2785
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
2507
2786
|
#
|
2508
2787
|
#
|
2509
2788
|
#
|
@@ -2585,9 +2864,9 @@ module Aws::CloudFormation
|
|
2585
2864
|
# * If you are signed in to a delegated administrator account, specify
|
2586
2865
|
# `DELEGATED_ADMIN`.
|
2587
2866
|
#
|
2588
|
-
# Your
|
2589
|
-
#
|
2590
|
-
#
|
2867
|
+
# Your account must be registered as a delegated administrator in the
|
2868
|
+
# management account. For more information, see [Register a delegated
|
2869
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
2591
2870
|
#
|
2592
2871
|
#
|
2593
2872
|
#
|
@@ -2776,6 +3055,14 @@ module Aws::CloudFormation
|
|
2776
3055
|
# that specific extension version. Otherwise, it returns information
|
2777
3056
|
# about the default extension version.
|
2778
3057
|
#
|
3058
|
+
# @option params [String] :publisher_id
|
3059
|
+
# The publisher ID of the extension publisher.
|
3060
|
+
#
|
3061
|
+
# Extensions provided by Amazon are not assigned a publisher ID.
|
3062
|
+
#
|
3063
|
+
# @option params [String] :public_version_number
|
3064
|
+
# The version number of a public third-party extension.
|
3065
|
+
#
|
2779
3066
|
# @return [Types::DescribeTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2780
3067
|
#
|
2781
3068
|
# * {Types::DescribeTypeOutput#arn #arn} => String
|
@@ -2783,17 +3070,28 @@ module Aws::CloudFormation
|
|
2783
3070
|
# * {Types::DescribeTypeOutput#type_name #type_name} => String
|
2784
3071
|
# * {Types::DescribeTypeOutput#default_version_id #default_version_id} => String
|
2785
3072
|
# * {Types::DescribeTypeOutput#is_default_version #is_default_version} => Boolean
|
3073
|
+
# * {Types::DescribeTypeOutput#type_tests_status #type_tests_status} => String
|
3074
|
+
# * {Types::DescribeTypeOutput#type_tests_status_description #type_tests_status_description} => String
|
2786
3075
|
# * {Types::DescribeTypeOutput#description #description} => String
|
2787
3076
|
# * {Types::DescribeTypeOutput#schema #schema} => String
|
2788
3077
|
# * {Types::DescribeTypeOutput#provisioning_type #provisioning_type} => String
|
2789
3078
|
# * {Types::DescribeTypeOutput#deprecated_status #deprecated_status} => String
|
2790
3079
|
# * {Types::DescribeTypeOutput#logging_config #logging_config} => Types::LoggingConfig
|
3080
|
+
# * {Types::DescribeTypeOutput#required_activated_types #required_activated_types} => Array<Types::RequiredActivatedType>
|
2791
3081
|
# * {Types::DescribeTypeOutput#execution_role_arn #execution_role_arn} => String
|
2792
3082
|
# * {Types::DescribeTypeOutput#visibility #visibility} => String
|
2793
3083
|
# * {Types::DescribeTypeOutput#source_url #source_url} => String
|
2794
3084
|
# * {Types::DescribeTypeOutput#documentation_url #documentation_url} => String
|
2795
3085
|
# * {Types::DescribeTypeOutput#last_updated #last_updated} => Time
|
2796
3086
|
# * {Types::DescribeTypeOutput#time_created #time_created} => Time
|
3087
|
+
# * {Types::DescribeTypeOutput#configuration_schema #configuration_schema} => String
|
3088
|
+
# * {Types::DescribeTypeOutput#publisher_id #publisher_id} => String
|
3089
|
+
# * {Types::DescribeTypeOutput#original_type_name #original_type_name} => String
|
3090
|
+
# * {Types::DescribeTypeOutput#original_type_arn #original_type_arn} => String
|
3091
|
+
# * {Types::DescribeTypeOutput#public_version_number #public_version_number} => String
|
3092
|
+
# * {Types::DescribeTypeOutput#latest_public_version #latest_public_version} => String
|
3093
|
+
# * {Types::DescribeTypeOutput#is_activated #is_activated} => Boolean
|
3094
|
+
# * {Types::DescribeTypeOutput#auto_update #auto_update} => Boolean
|
2797
3095
|
#
|
2798
3096
|
# @example Request syntax with placeholder values
|
2799
3097
|
#
|
@@ -2802,6 +3100,8 @@ module Aws::CloudFormation
|
|
2802
3100
|
# type_name: "TypeName",
|
2803
3101
|
# arn: "TypeArn",
|
2804
3102
|
# version_id: "TypeVersionId",
|
3103
|
+
# publisher_id: "PublisherId",
|
3104
|
+
# public_version_number: "PublicVersionNumber",
|
2805
3105
|
# })
|
2806
3106
|
#
|
2807
3107
|
# @example Response structure
|
@@ -2811,18 +3111,34 @@ module Aws::CloudFormation
|
|
2811
3111
|
# resp.type_name #=> String
|
2812
3112
|
# resp.default_version_id #=> String
|
2813
3113
|
# resp.is_default_version #=> Boolean
|
3114
|
+
# resp.type_tests_status #=> String, one of "PASSED", "FAILED", "IN_PROGRESS", "NOT_TESTED"
|
3115
|
+
# resp.type_tests_status_description #=> String
|
2814
3116
|
# resp.description #=> String
|
2815
3117
|
# resp.schema #=> String
|
2816
3118
|
# resp.provisioning_type #=> String, one of "NON_PROVISIONABLE", "IMMUTABLE", "FULLY_MUTABLE"
|
2817
3119
|
# resp.deprecated_status #=> String, one of "LIVE", "DEPRECATED"
|
2818
3120
|
# resp.logging_config.log_role_arn #=> String
|
2819
3121
|
# resp.logging_config.log_group_name #=> String
|
3122
|
+
# resp.required_activated_types #=> Array
|
3123
|
+
# resp.required_activated_types[0].type_name_alias #=> String
|
3124
|
+
# resp.required_activated_types[0].original_type_name #=> String
|
3125
|
+
# resp.required_activated_types[0].publisher_id #=> String
|
3126
|
+
# resp.required_activated_types[0].supported_major_versions #=> Array
|
3127
|
+
# resp.required_activated_types[0].supported_major_versions[0] #=> Integer
|
2820
3128
|
# resp.execution_role_arn #=> String
|
2821
3129
|
# resp.visibility #=> String, one of "PUBLIC", "PRIVATE"
|
2822
3130
|
# resp.source_url #=> String
|
2823
3131
|
# resp.documentation_url #=> String
|
2824
3132
|
# resp.last_updated #=> Time
|
2825
3133
|
# resp.time_created #=> Time
|
3134
|
+
# resp.configuration_schema #=> String
|
3135
|
+
# resp.publisher_id #=> String
|
3136
|
+
# resp.original_type_name #=> String
|
3137
|
+
# resp.original_type_arn #=> String
|
3138
|
+
# resp.public_version_number #=> String
|
3139
|
+
# resp.latest_public_version #=> String
|
3140
|
+
# resp.is_activated #=> Boolean
|
3141
|
+
# resp.auto_update #=> Boolean
|
2826
3142
|
#
|
2827
3143
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeType AWS API Documentation
|
2828
3144
|
#
|
@@ -2886,14 +3202,13 @@ module Aws::CloudFormation
|
|
2886
3202
|
# Detects whether a stack's actual configuration differs, or has
|
2887
3203
|
# *drifted*, from it's expected configuration, as defined in the stack
|
2888
3204
|
# template and any values specified as template parameters. For each
|
2889
|
-
# resource in the stack that supports drift detection,
|
2890
|
-
#
|
2891
|
-
#
|
2892
|
-
#
|
2893
|
-
#
|
2894
|
-
#
|
2895
|
-
#
|
2896
|
-
# Stacks and Resources][1].
|
3205
|
+
# resource in the stack that supports drift detection, CloudFormation
|
3206
|
+
# compares the actual configuration of the resource with its expected
|
3207
|
+
# template configuration. Only resource properties explicitly defined in
|
3208
|
+
# the stack template are checked for drift. A stack is considered to
|
3209
|
+
# have drifted if one or more of its resources differ from their
|
3210
|
+
# expected template configurations. For more information, see [Detecting
|
3211
|
+
# Unregulated Configuration Changes to Stacks and Resources][1].
|
2897
3212
|
#
|
2898
3213
|
# Use `DetectStackDrift` to detect drift on all supported resources for
|
2899
3214
|
# a given stack, or DetectStackResourceDrift to detect drift on
|
@@ -2909,8 +3224,8 @@ module Aws::CloudFormation
|
|
2909
3224
|
# completed, use DescribeStackResourceDrifts to return drift information
|
2910
3225
|
# about the stack and its resources.
|
2911
3226
|
#
|
2912
|
-
# When detecting drift on a stack,
|
2913
|
-
#
|
3227
|
+
# When detecting drift on a stack, CloudFormation does not detect drift
|
3228
|
+
# on any nested stacks belonging to that stack. Perform
|
2914
3229
|
# `DetectStackDrift` directly on the nested stack itself.
|
2915
3230
|
#
|
2916
3231
|
#
|
@@ -2952,7 +3267,7 @@ module Aws::CloudFormation
|
|
2952
3267
|
# differs, or has *drifted*, from it's expected configuration, as
|
2953
3268
|
# defined in the stack template and any values specified as template
|
2954
3269
|
# parameters. This information includes actual and expected property
|
2955
|
-
# values for resources in which
|
3270
|
+
# values for resources in which CloudFormation detects drift. Only
|
2956
3271
|
# resource properties explicitly defined in the stack template are
|
2957
3272
|
# checked for drift. For more information about stack and resource
|
2958
3273
|
# drift, see [Detecting Unregulated Configuration Changes to Stacks and
|
@@ -3066,8 +3381,8 @@ module Aws::CloudFormation
|
|
3066
3381
|
# operation.
|
3067
3382
|
#
|
3068
3383
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
3069
|
-
# The user-specified preferences for how
|
3070
|
-
#
|
3384
|
+
# The user-specified preferences for how CloudFormation performs a stack
|
3385
|
+
# set operation.
|
3071
3386
|
#
|
3072
3387
|
# For more information on maximum concurrent accounts and failure
|
3073
3388
|
# tolerance, see [Stack set operation options][1].
|
@@ -3095,9 +3410,9 @@ module Aws::CloudFormation
|
|
3095
3410
|
# * If you are signed in to a delegated administrator account, specify
|
3096
3411
|
# `DELEGATED_ADMIN`.
|
3097
3412
|
#
|
3098
|
-
# Your
|
3099
|
-
#
|
3100
|
-
#
|
3413
|
+
# Your account must be registered as a delegated administrator in the
|
3414
|
+
# management account. For more information, see [Register a delegated
|
3415
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
3101
3416
|
#
|
3102
3417
|
#
|
3103
3418
|
#
|
@@ -3137,13 +3452,13 @@ module Aws::CloudFormation
|
|
3137
3452
|
end
|
3138
3453
|
|
3139
3454
|
# Returns the estimated monthly cost of a template. The return value is
|
3140
|
-
# an
|
3141
|
-
# describes the resources required to run the template.
|
3455
|
+
# an Amazon Web Services Simple Monthly Calculator URL with a query
|
3456
|
+
# string that describes the resources required to run the template.
|
3142
3457
|
#
|
3143
3458
|
# @option params [String] :template_body
|
3144
3459
|
# Structure containing the template body with a minimum length of 1 byte
|
3145
3460
|
# and a maximum length of 51,200 bytes. (For more information, go to
|
3146
|
-
# [Template Anatomy][1] in the
|
3461
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.)
|
3147
3462
|
#
|
3148
3463
|
# Conditional: You must pass `TemplateBody` or `TemplateURL`. If both
|
3149
3464
|
# are passed, only `TemplateBody` is used.
|
@@ -3155,7 +3470,7 @@ module Aws::CloudFormation
|
|
3155
3470
|
# @option params [String] :template_url
|
3156
3471
|
# Location of file containing the template body. The URL must point to a
|
3157
3472
|
# template that is located in an Amazon S3 bucket or a Systems Manager
|
3158
|
-
# document. For more information, go to [Template Anatomy][1] in the
|
3473
|
+
# document. For more information, go to [Template Anatomy][1] in the
|
3159
3474
|
# CloudFormation User Guide.
|
3160
3475
|
#
|
3161
3476
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
@@ -3202,14 +3517,14 @@ module Aws::CloudFormation
|
|
3202
3517
|
|
3203
3518
|
# Updates a stack using the input information that was provided when the
|
3204
3519
|
# specified change set was created. After the call successfully
|
3205
|
-
# completes,
|
3520
|
+
# completes, CloudFormation starts updating the stack. Use the
|
3206
3521
|
# DescribeStacks action to view the status of the update.
|
3207
3522
|
#
|
3208
|
-
# When you execute a change set,
|
3209
|
-
#
|
3210
|
-
#
|
3523
|
+
# When you execute a change set, CloudFormation deletes all other change
|
3524
|
+
# sets associated with the stack because they aren't valid for the
|
3525
|
+
# updated stack.
|
3211
3526
|
#
|
3212
|
-
# If a stack policy is associated with the stack,
|
3527
|
+
# If a stack policy is associated with the stack, CloudFormation
|
3213
3528
|
# enforces the policy during the update. You can't specify a temporary
|
3214
3529
|
# stack policy that overrides the current policy.
|
3215
3530
|
#
|
@@ -3226,10 +3541,10 @@ module Aws::CloudFormation
|
|
3226
3541
|
#
|
3227
3542
|
# @option params [String] :client_request_token
|
3228
3543
|
# A unique identifier for this `ExecuteChangeSet` request. Specify this
|
3229
|
-
# token if you plan to retry requests so that
|
3230
|
-
#
|
3231
|
-
#
|
3232
|
-
#
|
3544
|
+
# token if you plan to retry requests so that CloudFormation knows that
|
3545
|
+
# you're not attempting to execute a change set to update a stack with
|
3546
|
+
# the same name. You might retry `ExecuteChangeSet` requests to ensure
|
3547
|
+
# that CloudFormation successfully received them.
|
3233
3548
|
#
|
3234
3549
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3235
3550
|
#
|
@@ -3302,19 +3617,19 @@ module Aws::CloudFormation
|
|
3302
3617
|
# Default: There is no default value.
|
3303
3618
|
#
|
3304
3619
|
# @option params [String] :change_set_name
|
3305
|
-
# The name or Amazon Resource Name (ARN) of a change set for which
|
3620
|
+
# The name or Amazon Resource Name (ARN) of a change set for which
|
3306
3621
|
# CloudFormation returns the associated template. If you specify a name,
|
3307
3622
|
# you must also specify the `StackName`.
|
3308
3623
|
#
|
3309
3624
|
# @option params [String] :template_stage
|
3310
3625
|
# For templates that include transforms, the stage of the template that
|
3311
|
-
#
|
3312
|
-
#
|
3313
|
-
#
|
3626
|
+
# CloudFormation returns. To get the user-submitted template, specify
|
3627
|
+
# `Original`. To get the template after CloudFormation has processed all
|
3628
|
+
# transforms, specify `Processed`.
|
3314
3629
|
#
|
3315
3630
|
# If the template doesn't include transforms, `Original` and
|
3316
|
-
# `Processed` return the same template. By default,
|
3317
|
-
# specifies `
|
3631
|
+
# `Processed` return the same template. By default, CloudFormation
|
3632
|
+
# specifies `Processed`.
|
3318
3633
|
#
|
3319
3634
|
# @return [Types::GetTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3320
3635
|
#
|
@@ -3360,8 +3675,7 @@ module Aws::CloudFormation
|
|
3360
3675
|
# @option params [String] :template_body
|
3361
3676
|
# Structure containing the template body with a minimum length of 1 byte
|
3362
3677
|
# and a maximum length of 51,200 bytes. For more information about
|
3363
|
-
# templates, see [Template Anatomy][1] in the
|
3364
|
-
# Guide.
|
3678
|
+
# templates, see [Template Anatomy][1] in the CloudFormation User Guide.
|
3365
3679
|
#
|
3366
3680
|
# Conditional: You must specify only one of the following parameters:
|
3367
3681
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3374,8 +3688,7 @@ module Aws::CloudFormation
|
|
3374
3688
|
# Location of file containing the template body. The URL must point to a
|
3375
3689
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
3376
3690
|
# bucket or a Systems Manager document. For more information about
|
3377
|
-
# templates, see [Template Anatomy][1] in the
|
3378
|
-
# Guide.
|
3691
|
+
# templates, see [Template Anatomy][1] in the CloudFormation User Guide.
|
3379
3692
|
#
|
3380
3693
|
# Conditional: You must specify only one of the following parameters:
|
3381
3694
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
@@ -3400,6 +3713,27 @@ module Aws::CloudFormation
|
|
3400
3713
|
# Conditional: You must specify only one of the following parameters:
|
3401
3714
|
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
|
3402
3715
|
#
|
3716
|
+
# @option params [String] :call_as
|
3717
|
+
# \[Service-managed permissions\] Specifies whether you are acting as an
|
3718
|
+
# account administrator in the organization's management account or as
|
3719
|
+
# a delegated administrator in a member account.
|
3720
|
+
#
|
3721
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
3722
|
+
# self-managed permissions.
|
3723
|
+
#
|
3724
|
+
# * If you are signed in to the management account, specify `SELF`.
|
3725
|
+
#
|
3726
|
+
# * If you are signed in to a delegated administrator account, specify
|
3727
|
+
# `DELEGATED_ADMIN`.
|
3728
|
+
#
|
3729
|
+
# Your account must be registered as a delegated administrator in the
|
3730
|
+
# management account. For more information, see [Register a delegated
|
3731
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
3732
|
+
#
|
3733
|
+
#
|
3734
|
+
#
|
3735
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
|
3736
|
+
#
|
3403
3737
|
# @return [Types::GetTemplateSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3404
3738
|
#
|
3405
3739
|
# * {Types::GetTemplateSummaryOutput#parameters #parameters} => Array<Types::ParameterDeclaration>
|
@@ -3419,6 +3753,7 @@ module Aws::CloudFormation
|
|
3419
3753
|
# template_url: "TemplateURL",
|
3420
3754
|
# stack_name: "StackNameOrId",
|
3421
3755
|
# stack_set_name: "StackSetNameOrId",
|
3756
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
3422
3757
|
# })
|
3423
3758
|
#
|
3424
3759
|
# @example Response structure
|
@@ -3457,8 +3792,86 @@ module Aws::CloudFormation
|
|
3457
3792
|
req.send_request(options)
|
3458
3793
|
end
|
3459
3794
|
|
3795
|
+
# Import existing stacks into a new stack sets. Use the stack import
|
3796
|
+
# operation to import up to 10 stacks into a new stack set in the same
|
3797
|
+
# account as the source stack or in a different administrator account
|
3798
|
+
# and Region, by specifying the stack ID of the stack you intend to
|
3799
|
+
# import.
|
3800
|
+
#
|
3801
|
+
# <note markdown="1"> `ImportStacksToStackSet` is only supported by self-managed
|
3802
|
+
# permissions.
|
3803
|
+
#
|
3804
|
+
# </note>
|
3805
|
+
#
|
3806
|
+
# @option params [required, String] :stack_set_name
|
3807
|
+
# The name of the stack set. The name must be unique in the Region where
|
3808
|
+
# you create your stack set.
|
3809
|
+
#
|
3810
|
+
# @option params [required, Array<String>] :stack_ids
|
3811
|
+
# The IDs of the stacks you are importing into a stack set. You import
|
3812
|
+
# up to 10 stacks per stack set at a time.
|
3813
|
+
#
|
3814
|
+
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
3815
|
+
# The user-specified preferences for how CloudFormation performs a stack
|
3816
|
+
# set operation.
|
3817
|
+
#
|
3818
|
+
# For more information on maximum concurrent accounts and failure
|
3819
|
+
# tolerance, see [Stack set operation options][1].
|
3820
|
+
#
|
3821
|
+
#
|
3822
|
+
#
|
3823
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
|
3824
|
+
#
|
3825
|
+
# @option params [String] :operation_id
|
3826
|
+
# A unique, user defined, identifier for the stack set operation.
|
3827
|
+
#
|
3828
|
+
# **A suitable default value is auto-generated.** You should normally
|
3829
|
+
# not need to pass this option.**
|
3830
|
+
#
|
3831
|
+
# @option params [String] :call_as
|
3832
|
+
# By default, `SELF` is specified. Use `SELF` for stack sets with
|
3833
|
+
# self-managed permissions.
|
3834
|
+
#
|
3835
|
+
# * If you are signed in to the management account, specify `SELF`.
|
3836
|
+
#
|
3837
|
+
# * For service managed stack sets, specify `DELEGATED_ADMIN`.
|
3838
|
+
#
|
3839
|
+
# @return [Types::ImportStacksToStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3840
|
+
#
|
3841
|
+
# * {Types::ImportStacksToStackSetOutput#operation_id #operation_id} => String
|
3842
|
+
#
|
3843
|
+
# @example Request syntax with placeholder values
|
3844
|
+
#
|
3845
|
+
# resp = client.import_stacks_to_stack_set({
|
3846
|
+
# stack_set_name: "StackSetNameOrId", # required
|
3847
|
+
# stack_ids: ["StackId"], # required
|
3848
|
+
# operation_preferences: {
|
3849
|
+
# region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
|
3850
|
+
# region_order: ["Region"],
|
3851
|
+
# failure_tolerance_count: 1,
|
3852
|
+
# failure_tolerance_percentage: 1,
|
3853
|
+
# max_concurrent_count: 1,
|
3854
|
+
# max_concurrent_percentage: 1,
|
3855
|
+
# },
|
3856
|
+
# operation_id: "ClientRequestToken",
|
3857
|
+
# call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
|
3858
|
+
# })
|
3859
|
+
#
|
3860
|
+
# @example Response structure
|
3861
|
+
#
|
3862
|
+
# resp.operation_id #=> String
|
3863
|
+
#
|
3864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSet AWS API Documentation
|
3865
|
+
#
|
3866
|
+
# @overload import_stacks_to_stack_set(params = {})
|
3867
|
+
# @param [Hash] params ({})
|
3868
|
+
def import_stacks_to_stack_set(params = {}, options = {})
|
3869
|
+
req = build_request(:import_stacks_to_stack_set, params)
|
3870
|
+
req.send_request(options)
|
3871
|
+
end
|
3872
|
+
|
3460
3873
|
# Returns the ID and status of each active change set for a stack. For
|
3461
|
-
# example,
|
3874
|
+
# example, CloudFormation lists change sets that are in the
|
3462
3875
|
# `CREATE_IN_PROGRESS` or `CREATE_PENDING` state.
|
3463
3876
|
#
|
3464
3877
|
# @option params [required, String] :stack_name
|
@@ -3514,7 +3927,7 @@ module Aws::CloudFormation
|
|
3514
3927
|
# values that you can import into other stacks. To import values, use
|
3515
3928
|
# the [ `Fn::ImportValue` ][1] function.
|
3516
3929
|
#
|
3517
|
-
# For more information, see [
|
3930
|
+
# For more information, see [ CloudFormation Export Stack Output
|
3518
3931
|
# Values][2].
|
3519
3932
|
#
|
3520
3933
|
#
|
@@ -3569,7 +3982,7 @@ module Aws::CloudFormation
|
|
3569
3982
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html
|
3570
3983
|
#
|
3571
3984
|
# @option params [required, String] :export_name
|
3572
|
-
# The name of the exported output value.
|
3985
|
+
# The name of the exported output value. CloudFormation returns the
|
3573
3986
|
# stack names that are importing this value.
|
3574
3987
|
#
|
3575
3988
|
# @option params [String] :next_token
|
@@ -3608,8 +4021,8 @@ module Aws::CloudFormation
|
|
3608
4021
|
|
3609
4022
|
# Returns summary information about stack instances that are associated
|
3610
4023
|
# with the specified stack set. You can filter for stack instances that
|
3611
|
-
# are associated with a specific
|
3612
|
-
#
|
4024
|
+
# are associated with a specific account name or Region, or that have a
|
4025
|
+
# specific status.
|
3613
4026
|
#
|
3614
4027
|
# @option params [required, String] :stack_set_name
|
3615
4028
|
# The name or unique ID of the stack set that you want to list stack
|
@@ -3633,7 +4046,7 @@ module Aws::CloudFormation
|
|
3633
4046
|
# The status that stack instances are filtered by.
|
3634
4047
|
#
|
3635
4048
|
# @option params [String] :stack_instance_account
|
3636
|
-
# The name of the
|
4049
|
+
# The name of the account that you want to list stack instances for.
|
3637
4050
|
#
|
3638
4051
|
# @option params [String] :stack_instance_region
|
3639
4052
|
# The name of the Region where you want to list stack instances.
|
@@ -3651,9 +4064,9 @@ module Aws::CloudFormation
|
|
3651
4064
|
# * If you are signed in to a delegated administrator account, specify
|
3652
4065
|
# `DELEGATED_ADMIN`.
|
3653
4066
|
#
|
3654
|
-
# Your
|
3655
|
-
#
|
3656
|
-
#
|
4067
|
+
# Your account must be registered as a delegated administrator in the
|
4068
|
+
# management account. For more information, see [Register a delegated
|
4069
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
3657
4070
|
#
|
3658
4071
|
#
|
3659
4072
|
#
|
@@ -3803,9 +4216,9 @@ module Aws::CloudFormation
|
|
3803
4216
|
# * If you are signed in to a delegated administrator account, specify
|
3804
4217
|
# `DELEGATED_ADMIN`.
|
3805
4218
|
#
|
3806
|
-
# Your
|
3807
|
-
#
|
3808
|
-
#
|
4219
|
+
# Your account must be registered as a delegated administrator in the
|
4220
|
+
# management account. For more information, see [Register a delegated
|
4221
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
3809
4222
|
#
|
3810
4223
|
#
|
3811
4224
|
#
|
@@ -3883,9 +4296,9 @@ module Aws::CloudFormation
|
|
3883
4296
|
# * If you are signed in to a delegated administrator account, specify
|
3884
4297
|
# `DELEGATED_ADMIN`.
|
3885
4298
|
#
|
3886
|
-
# Your
|
3887
|
-
#
|
3888
|
-
#
|
4299
|
+
# Your account must be registered as a delegated administrator in the
|
4300
|
+
# management account. For more information, see [Register a delegated
|
4301
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
3889
4302
|
#
|
3890
4303
|
#
|
3891
4304
|
#
|
@@ -3930,8 +4343,8 @@ module Aws::CloudFormation
|
|
3930
4343
|
# the user.
|
3931
4344
|
#
|
3932
4345
|
# * \[Self-managed permissions\] If you set the `CallAs` parameter to
|
3933
|
-
# `SELF` while signed in to your
|
3934
|
-
#
|
4346
|
+
# `SELF` while signed in to your account, `ListStackSets` returns all
|
4347
|
+
# self-managed stack sets in your account.
|
3935
4348
|
#
|
3936
4349
|
# * \[Service-managed permissions\] If you set the `CallAs` parameter to
|
3937
4350
|
# `SELF` while signed in to the organization's management account,
|
@@ -3973,9 +4386,9 @@ module Aws::CloudFormation
|
|
3973
4386
|
# * If you are signed in to a delegated administrator account, specify
|
3974
4387
|
# `DELEGATED_ADMIN`.
|
3975
4388
|
#
|
3976
|
-
# Your
|
3977
|
-
#
|
3978
|
-
#
|
4389
|
+
# Your account must be registered as a delegated administrator in the
|
4390
|
+
# management account. For more information, see [Register a delegated
|
4391
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
3979
4392
|
#
|
3980
4393
|
#
|
3981
4394
|
#
|
@@ -4194,6 +4607,11 @@ module Aws::CloudFormation
|
|
4194
4607
|
#
|
4195
4608
|
# The default is `LIVE`.
|
4196
4609
|
#
|
4610
|
+
# @option params [String] :publisher_id
|
4611
|
+
# The publisher ID of the extension publisher.
|
4612
|
+
#
|
4613
|
+
# Extensions published by Amazon are not assigned a publisher ID.
|
4614
|
+
#
|
4197
4615
|
# @return [Types::ListTypeVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4198
4616
|
#
|
4199
4617
|
# * {Types::ListTypeVersionsOutput#type_version_summaries #type_version_summaries} => Array<Types::TypeVersionSummary>
|
@@ -4206,10 +4624,11 @@ module Aws::CloudFormation
|
|
4206
4624
|
# resp = client.list_type_versions({
|
4207
4625
|
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4208
4626
|
# type_name: "TypeName",
|
4209
|
-
# arn: "
|
4627
|
+
# arn: "TypeArn",
|
4210
4628
|
# max_results: 1,
|
4211
4629
|
# next_token: "NextToken",
|
4212
4630
|
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
|
4631
|
+
# publisher_id: "PublisherId",
|
4213
4632
|
# })
|
4214
4633
|
#
|
4215
4634
|
# @example Response structure
|
@@ -4222,6 +4641,7 @@ module Aws::CloudFormation
|
|
4222
4641
|
# resp.type_version_summaries[0].arn #=> String
|
4223
4642
|
# resp.type_version_summaries[0].time_created #=> Time
|
4224
4643
|
# resp.type_version_summaries[0].description #=> String
|
4644
|
+
# resp.type_version_summaries[0].public_version_number #=> String
|
4225
4645
|
# resp.next_token #=> String
|
4226
4646
|
#
|
4227
4647
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeVersions AWS API Documentation
|
@@ -4237,36 +4657,45 @@ module Aws::CloudFormation
|
|
4237
4657
|
# with CloudFormation.
|
4238
4658
|
#
|
4239
4659
|
# @option params [String] :visibility
|
4240
|
-
# The scope at which the
|
4660
|
+
# The scope at which the extensions are visible and usable in
|
4241
4661
|
# CloudFormation operations.
|
4242
4662
|
#
|
4243
4663
|
# Valid values include:
|
4244
4664
|
#
|
4245
|
-
# * `PRIVATE`\:
|
4246
|
-
# account
|
4247
|
-
#
|
4665
|
+
# * `PRIVATE`\: Extensions that are visible and usable within this
|
4666
|
+
# account and region. This includes:
|
4667
|
+
#
|
4668
|
+
# * Private extensions you have registered in this account and region.
|
4248
4669
|
#
|
4249
|
-
#
|
4250
|
-
#
|
4670
|
+
# * Public extensions that you have activated in this account and
|
4671
|
+
# region.
|
4672
|
+
#
|
4673
|
+
# * `PUBLIC`\: Extensions that are publicly visible and available to be
|
4674
|
+
# activated within any Amazon account. This includes extensions from
|
4675
|
+
# Amazon, as well as third-party publishers.
|
4251
4676
|
#
|
4252
4677
|
# The default is `PRIVATE`.
|
4253
4678
|
#
|
4254
4679
|
# @option params [String] :provisioning_type
|
4255
|
-
#
|
4256
|
-
# the provisioning type during registration,
|
4257
|
-
# handlers in the schema handler package
|
4680
|
+
# For resource types, the provisioning behavior of the resource type.
|
4681
|
+
# CloudFormation determines the provisioning type during registration,
|
4682
|
+
# based on the types of handlers in the schema handler package
|
4683
|
+
# submitted.
|
4258
4684
|
#
|
4259
4685
|
# Valid values include:
|
4260
4686
|
#
|
4261
|
-
# * `FULLY_MUTABLE`\: The
|
4262
|
-
# process updates to the
|
4687
|
+
# * `FULLY_MUTABLE`\: The resource type includes an update handler to
|
4688
|
+
# process updates to the type during stack update operations.
|
4263
4689
|
#
|
4264
|
-
# * `IMMUTABLE`\: The
|
4265
|
-
# the
|
4690
|
+
# * `IMMUTABLE`\: The resource type does not include an update handler,
|
4691
|
+
# so the type cannot be updated and must instead be replaced during
|
4266
4692
|
# stack update operations.
|
4267
4693
|
#
|
4268
|
-
# * `NON_PROVISIONABLE`\: The
|
4269
|
-
# and delete handlers, and therefore cannot actually be
|
4694
|
+
# * `NON_PROVISIONABLE`\: The resource type does not include create,
|
4695
|
+
# read, and delete handlers, and therefore cannot actually be
|
4696
|
+
# provisioned.
|
4697
|
+
#
|
4698
|
+
# The default is `FULLY_MUTABLE`.
|
4270
4699
|
#
|
4271
4700
|
# @option params [String] :deprecated_status
|
4272
4701
|
# The deprecation status of the extension that you want to get summary
|
@@ -4283,6 +4712,12 @@ module Aws::CloudFormation
|
|
4283
4712
|
# @option params [String] :type
|
4284
4713
|
# The type of extension.
|
4285
4714
|
#
|
4715
|
+
# @option params [Types::TypeFilters] :filters
|
4716
|
+
# Filter criteria to use in determining which extensions to return.
|
4717
|
+
#
|
4718
|
+
# If you specify a filter, CloudFormation ignores any specified
|
4719
|
+
# `Visibility` value when returning the list of types.
|
4720
|
+
#
|
4286
4721
|
# @option params [Integer] :max_results
|
4287
4722
|
# The maximum number of results to be returned with a single call. If
|
4288
4723
|
# the number of available results exceeds this maximum, the response
|
@@ -4311,6 +4746,11 @@ module Aws::CloudFormation
|
|
4311
4746
|
# provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
|
4312
4747
|
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
|
4313
4748
|
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4749
|
+
# filters: {
|
4750
|
+
# category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
|
4751
|
+
# publisher_id: "PublisherId",
|
4752
|
+
# type_name_prefix: "TypeNamePrefix",
|
4753
|
+
# },
|
4314
4754
|
# max_results: 1,
|
4315
4755
|
# next_token: "NextToken",
|
4316
4756
|
# })
|
@@ -4324,6 +4764,13 @@ module Aws::CloudFormation
|
|
4324
4764
|
# resp.type_summaries[0].type_arn #=> String
|
4325
4765
|
# resp.type_summaries[0].last_updated #=> Time
|
4326
4766
|
# resp.type_summaries[0].description #=> String
|
4767
|
+
# resp.type_summaries[0].publisher_id #=> String
|
4768
|
+
# resp.type_summaries[0].original_type_name #=> String
|
4769
|
+
# resp.type_summaries[0].public_version_number #=> String
|
4770
|
+
# resp.type_summaries[0].latest_public_version #=> String
|
4771
|
+
# resp.type_summaries[0].publisher_identity #=> String, one of "AWS_Marketplace", "GitHub", "Bitbucket"
|
4772
|
+
# resp.type_summaries[0].publisher_name #=> String
|
4773
|
+
# resp.type_summaries[0].is_activated #=> Boolean
|
4327
4774
|
# resp.next_token #=> String
|
4328
4775
|
#
|
4329
4776
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypes AWS API Documentation
|
@@ -4335,6 +4782,81 @@ module Aws::CloudFormation
|
|
4335
4782
|
req.send_request(options)
|
4336
4783
|
end
|
4337
4784
|
|
4785
|
+
# Publishes the specified extension to the CloudFormation registry as a
|
4786
|
+
# public extension in this region. Public extensions are available for
|
4787
|
+
# use by all CloudFormation users. For more information on publishing
|
4788
|
+
# extensions, see [Publishing extensions to make them available for
|
4789
|
+
# public use][1] in the *CloudFormation CLI User Guide*.
|
4790
|
+
#
|
4791
|
+
# To publish an extension, you must be registered as a publisher with
|
4792
|
+
# CloudFormation. For more information, see [RegisterPublisher][2].
|
4793
|
+
#
|
4794
|
+
#
|
4795
|
+
#
|
4796
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html
|
4797
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html
|
4798
|
+
#
|
4799
|
+
# @option params [String] :type
|
4800
|
+
# The type of the extension.
|
4801
|
+
#
|
4802
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
4803
|
+
#
|
4804
|
+
# @option params [String] :arn
|
4805
|
+
# The Amazon Resource Number (ARN) of the extension.
|
4806
|
+
#
|
4807
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
4808
|
+
#
|
4809
|
+
# @option params [String] :type_name
|
4810
|
+
# The name of the extension.
|
4811
|
+
#
|
4812
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
4813
|
+
#
|
4814
|
+
# @option params [String] :public_version_number
|
4815
|
+
# The version number to assign to this version of the extension.
|
4816
|
+
#
|
4817
|
+
# Use the following format, and adhere to semantic versioning when
|
4818
|
+
# assigning a version number to your extension:
|
4819
|
+
#
|
4820
|
+
# `MAJOR.MINOR.PATCH`
|
4821
|
+
#
|
4822
|
+
# For more information, see [Semantic Versioning 2.0.0][1].
|
4823
|
+
#
|
4824
|
+
# If you do not specify a version number, CloudFormation increments the
|
4825
|
+
# version number by one minor version release.
|
4826
|
+
#
|
4827
|
+
# The first time you publish a type, CloudFormation sets the version
|
4828
|
+
# number to `1.0.0`, regardless of the value you specify.
|
4829
|
+
#
|
4830
|
+
#
|
4831
|
+
#
|
4832
|
+
# [1]: https://semver.org/
|
4833
|
+
#
|
4834
|
+
# @return [Types::PublishTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4835
|
+
#
|
4836
|
+
# * {Types::PublishTypeOutput#public_type_arn #public_type_arn} => String
|
4837
|
+
#
|
4838
|
+
# @example Request syntax with placeholder values
|
4839
|
+
#
|
4840
|
+
# resp = client.publish_type({
|
4841
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
4842
|
+
# arn: "PrivateTypeArn",
|
4843
|
+
# type_name: "TypeName",
|
4844
|
+
# public_version_number: "PublicVersionNumber",
|
4845
|
+
# })
|
4846
|
+
#
|
4847
|
+
# @example Response structure
|
4848
|
+
#
|
4849
|
+
# resp.public_type_arn #=> String
|
4850
|
+
#
|
4851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/PublishType AWS API Documentation
|
4852
|
+
#
|
4853
|
+
# @overload publish_type(params = {})
|
4854
|
+
# @param [Hash] params ({})
|
4855
|
+
def publish_type(params = {}, options = {})
|
4856
|
+
req = build_request(:publish_type, params)
|
4857
|
+
req.send_request(options)
|
4858
|
+
end
|
4859
|
+
|
4338
4860
|
# Reports progress of a resource handler to CloudFormation.
|
4339
4861
|
#
|
4340
4862
|
# Reserved for use by the [CloudFormation CLI][1]. Do not use this API
|
@@ -4402,7 +4924,7 @@ module Aws::CloudFormation
|
|
4402
4924
|
# operation_status: "PENDING", # required, accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
|
4403
4925
|
# current_operation_status: "PENDING", # accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
|
4404
4926
|
# status_message: "StatusMessage",
|
4405
|
-
# error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure
|
4927
|
+
# error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure, InvalidTypeConfiguration
|
4406
4928
|
# resource_model: "ResourceModel",
|
4407
4929
|
# client_request_token: "ClientRequestToken",
|
4408
4930
|
# })
|
@@ -4416,9 +4938,72 @@ module Aws::CloudFormation
|
|
4416
4938
|
req.send_request(options)
|
4417
4939
|
end
|
4418
4940
|
|
4941
|
+
# Registers your account as a publisher of public extensions in the
|
4942
|
+
# CloudFormation registry. Public extensions are available for use by
|
4943
|
+
# all CloudFormation users. This publisher ID applies to your account in
|
4944
|
+
# all Regions.
|
4945
|
+
#
|
4946
|
+
# For information on requirements for registering as a public extension
|
4947
|
+
# publisher, see [Registering your account to publish CloudFormation
|
4948
|
+
# extensions][1] in the *CloudFormation CLI User Guide*.
|
4949
|
+
#
|
4950
|
+
#
|
4951
|
+
#
|
4952
|
+
#
|
4953
|
+
#
|
4954
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs
|
4955
|
+
#
|
4956
|
+
# @option params [Boolean] :accept_terms_and_conditions
|
4957
|
+
# Whether you accept the [Terms and Conditions][1] for publishing
|
4958
|
+
# extensions in the CloudFormation registry. You must accept the terms
|
4959
|
+
# and conditions in order to register to publish public extensions to
|
4960
|
+
# the CloudFormation registry.
|
4961
|
+
#
|
4962
|
+
# The default is `false`.
|
4963
|
+
#
|
4964
|
+
#
|
4965
|
+
#
|
4966
|
+
# [1]: https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf
|
4967
|
+
#
|
4968
|
+
# @option params [String] :connection_arn
|
4969
|
+
# If you are using a Bitbucket or GitHub account for identity
|
4970
|
+
# verification, the Amazon Resource Name (ARN) for your connection to
|
4971
|
+
# that account.
|
4972
|
+
#
|
4973
|
+
# For more information, see [Registering your account to publish
|
4974
|
+
# CloudFormation extensions][1] in the *CloudFormation CLI User Guide*.
|
4975
|
+
#
|
4976
|
+
#
|
4977
|
+
#
|
4978
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs
|
4979
|
+
#
|
4980
|
+
# @return [Types::RegisterPublisherOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4981
|
+
#
|
4982
|
+
# * {Types::RegisterPublisherOutput#publisher_id #publisher_id} => String
|
4983
|
+
#
|
4984
|
+
# @example Request syntax with placeholder values
|
4985
|
+
#
|
4986
|
+
# resp = client.register_publisher({
|
4987
|
+
# accept_terms_and_conditions: false,
|
4988
|
+
# connection_arn: "ConnectionArn",
|
4989
|
+
# })
|
4990
|
+
#
|
4991
|
+
# @example Response structure
|
4992
|
+
#
|
4993
|
+
# resp.publisher_id #=> String
|
4994
|
+
#
|
4995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterPublisher AWS API Documentation
|
4996
|
+
#
|
4997
|
+
# @overload register_publisher(params = {})
|
4998
|
+
# @param [Hash] params ({})
|
4999
|
+
def register_publisher(params = {}, options = {})
|
5000
|
+
req = build_request(:register_publisher, params)
|
5001
|
+
req.send_request(options)
|
5002
|
+
end
|
5003
|
+
|
4419
5004
|
# Registers an extension with the CloudFormation service. Registering an
|
4420
5005
|
# extension makes it available for use in CloudFormation templates in
|
4421
|
-
# your
|
5006
|
+
# your account, and includes:
|
4422
5007
|
#
|
4423
5008
|
# * Validating the extension schema
|
4424
5009
|
#
|
@@ -4440,9 +5025,17 @@ module Aws::CloudFormation
|
|
4440
5025
|
# you can use ` DescribeTypeRegistration ` to monitor the progress of
|
4441
5026
|
# the registration request.
|
4442
5027
|
#
|
5028
|
+
# Once you have registered a private extension in your account and
|
5029
|
+
# region, use
|
5030
|
+
# [SetTypeConfiguration](AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html)
|
5031
|
+
# to specify configuration properties for the extension. For more
|
5032
|
+
# information, see [Configuring extensions at the account level][2] in
|
5033
|
+
# the *CloudFormation User Guide*.
|
5034
|
+
#
|
4443
5035
|
#
|
4444
5036
|
#
|
4445
5037
|
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html
|
5038
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
|
4446
5039
|
#
|
4447
5040
|
# @option params [String] :type
|
4448
5041
|
# The kind of extension.
|
@@ -4450,8 +5043,13 @@ module Aws::CloudFormation
|
|
4450
5043
|
# @option params [required, String] :type_name
|
4451
5044
|
# The name of the extension being registered.
|
4452
5045
|
#
|
4453
|
-
# We recommend that extension names adhere to the following
|
4454
|
-
#
|
5046
|
+
# We recommend that extension names adhere to the following patterns:
|
5047
|
+
#
|
5048
|
+
# * For resource types,
|
5049
|
+
# *company\_or\_organization*\::*service*\::*type*.
|
5050
|
+
#
|
5051
|
+
# * For modules,
|
5052
|
+
# *company\_or\_organization*\::*service*\::*type*\::MODULE.
|
4455
5053
|
#
|
4456
5054
|
# <note markdown="1"> The following organization namespaces are reserved and cannot be used
|
4457
5055
|
# in your extension names:
|
@@ -4481,8 +5079,8 @@ module Aws::CloudFormation
|
|
4481
5079
|
# <note markdown="1"> The user registering the extension must be able to access the package
|
4482
5080
|
# in the S3 bucket. That is, the user needs to have [GetObject][2]
|
4483
5081
|
# permissions for the schema handler package. For more information, see
|
4484
|
-
# [Actions, Resources, and Condition Keys for Amazon S3][3] in the
|
4485
|
-
# Identity and Access Management User Guide*.
|
5082
|
+
# [Actions, Resources, and Condition Keys for Amazon S3][3] in the
|
5083
|
+
# *Identity and Access Management User Guide*.
|
4486
5084
|
#
|
4487
5085
|
# </note>
|
4488
5086
|
#
|
@@ -4497,15 +5095,25 @@ module Aws::CloudFormation
|
|
4497
5095
|
#
|
4498
5096
|
# @option params [String] :execution_role_arn
|
4499
5097
|
# The Amazon Resource Name (ARN) of the IAM role for CloudFormation to
|
4500
|
-
# assume when invoking the extension.
|
4501
|
-
#
|
5098
|
+
# assume when invoking the extension.
|
5099
|
+
#
|
5100
|
+
# For CloudFormation to assume the specified execution role, the role
|
5101
|
+
# must contain a trust relationship with the CloudFormation service
|
5102
|
+
# principle (`resources.cloudformation.amazonaws.com`). For more
|
5103
|
+
# information on adding trust relationships, see [Modifying a role trust
|
5104
|
+
# policy](IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy)
|
5105
|
+
# in the *Identity and Access Management User Guide*.
|
5106
|
+
#
|
5107
|
+
# If your extension calls Amazon Web Services APIs in any of its
|
5108
|
+
# handlers, you must create an <i> <a
|
4502
5109
|
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
|
4503
5110
|
# execution role</a> </i> that includes the necessary permissions to
|
4504
|
-
# call those
|
4505
|
-
# account. When CloudFormation needs to invoke the
|
4506
|
-
# CloudFormation assumes this execution role to create a
|
4507
|
-
# session token, which it then passes to the
|
4508
|
-
# supplying your
|
5111
|
+
# call those Amazon Web Services APIs, and provision that execution role
|
5112
|
+
# in your account. When CloudFormation needs to invoke the resource type
|
5113
|
+
# handler, CloudFormation assumes this execution role to create a
|
5114
|
+
# temporary session token, which it then passes to the resource type
|
5115
|
+
# handler, thereby supplying your resource type with the appropriate
|
5116
|
+
# credentials.
|
4509
5117
|
#
|
4510
5118
|
# @option params [String] :client_request_token
|
4511
5119
|
# A unique identifier that acts as an idempotency key for this
|
@@ -4552,8 +5160,8 @@ module Aws::CloudFormation
|
|
4552
5160
|
#
|
4553
5161
|
# @option params [String] :stack_policy_body
|
4554
5162
|
# Structure containing the stack policy body. For more information, go
|
4555
|
-
# to [ Prevent Updates to Stack Resources][1] in the
|
4556
|
-
#
|
5163
|
+
# to [ Prevent Updates to Stack Resources][1] in the CloudFormation User
|
5164
|
+
# Guide. You can specify either the `StackPolicyBody` or the
|
4557
5165
|
# `StackPolicyURL` parameter, but not both.
|
4558
5166
|
#
|
4559
5167
|
#
|
@@ -4585,6 +5193,101 @@ module Aws::CloudFormation
|
|
4585
5193
|
req.send_request(options)
|
4586
5194
|
end
|
4587
5195
|
|
5196
|
+
# Specifies the configuration data for a registered CloudFormation
|
5197
|
+
# extension, in the given account and region.
|
5198
|
+
#
|
5199
|
+
# To view the current configuration data for an extension, refer to the
|
5200
|
+
# `ConfigurationSchema` element of
|
5201
|
+
# [DescribeType](AWSCloudFormation/latest/APIReference/API_DescribeType.html).
|
5202
|
+
# For more information, see [Configuring extensions at the account
|
5203
|
+
# level][1] in the *CloudFormation User Guide*.
|
5204
|
+
#
|
5205
|
+
# It is strongly recommended that you use dynamic references to restrict
|
5206
|
+
# sensitive configuration definitions, such as third-party credentials.
|
5207
|
+
# For more details on dynamic references, see [Using dynamic references
|
5208
|
+
# to specify template values][2] in the *CloudFormation User Guide*.
|
5209
|
+
#
|
5210
|
+
#
|
5211
|
+
#
|
5212
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
|
5213
|
+
# [2]: https://docs.aws.amazon.com/
|
5214
|
+
#
|
5215
|
+
# @option params [String] :type_arn
|
5216
|
+
# The Amazon Resource Name (ARN) for the extension, in this account and
|
5217
|
+
# region.
|
5218
|
+
#
|
5219
|
+
# For public extensions, this will be the ARN assigned when you
|
5220
|
+
# [activate the type][1] in this account and region. For private
|
5221
|
+
# extensions, this will be the ARN assigned when you [register the
|
5222
|
+
# type][2] in this account and region.
|
5223
|
+
#
|
5224
|
+
# Do not include the extension versions suffix at the end of the ARN.
|
5225
|
+
# You can set the configuration for an extension, but not for a specific
|
5226
|
+
# extension version.
|
5227
|
+
#
|
5228
|
+
#
|
5229
|
+
#
|
5230
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
|
5231
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
|
5232
|
+
#
|
5233
|
+
# @option params [required, String] :configuration
|
5234
|
+
# The configuration data for the extension, in this account and region.
|
5235
|
+
#
|
5236
|
+
# The configuration data must be formatted as JSON, and validate against
|
5237
|
+
# the schema returned in the `ConfigurationSchema` response element of
|
5238
|
+
# [API\_DescribeType](AWSCloudFormation/latest/APIReference/API_DescribeType.html).
|
5239
|
+
# For more information, see [Defining account-level configuration data
|
5240
|
+
# for an extension][1] in the *CloudFormation CLI User Guide*.
|
5241
|
+
#
|
5242
|
+
#
|
5243
|
+
#
|
5244
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
|
5245
|
+
#
|
5246
|
+
# @option params [String] :configuration_alias
|
5247
|
+
# An alias by which to refer to this extension configuration data.
|
5248
|
+
#
|
5249
|
+
# Conditional: Specifying a configuration alias is required when setting
|
5250
|
+
# a configuration for a resource type extension.
|
5251
|
+
#
|
5252
|
+
# @option params [String] :type_name
|
5253
|
+
# The name of the extension.
|
5254
|
+
#
|
5255
|
+
# Conditional: You must specify `ConfigurationArn`, or `Type` and
|
5256
|
+
# `TypeName`.
|
5257
|
+
#
|
5258
|
+
# @option params [String] :type
|
5259
|
+
# The type of extension.
|
5260
|
+
#
|
5261
|
+
# Conditional: You must specify `ConfigurationArn`, or `Type` and
|
5262
|
+
# `TypeName`.
|
5263
|
+
#
|
5264
|
+
# @return [Types::SetTypeConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5265
|
+
#
|
5266
|
+
# * {Types::SetTypeConfigurationOutput#configuration_arn #configuration_arn} => String
|
5267
|
+
#
|
5268
|
+
# @example Request syntax with placeholder values
|
5269
|
+
#
|
5270
|
+
# resp = client.set_type_configuration({
|
5271
|
+
# type_arn: "TypeArn",
|
5272
|
+
# configuration: "TypeConfiguration", # required
|
5273
|
+
# configuration_alias: "TypeConfigurationAlias",
|
5274
|
+
# type_name: "TypeName",
|
5275
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5276
|
+
# })
|
5277
|
+
#
|
5278
|
+
# @example Response structure
|
5279
|
+
#
|
5280
|
+
# resp.configuration_arn #=> String
|
5281
|
+
#
|
5282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeConfiguration AWS API Documentation
|
5283
|
+
#
|
5284
|
+
# @overload set_type_configuration(params = {})
|
5285
|
+
# @param [Hash] params ({})
|
5286
|
+
def set_type_configuration(params = {}, options = {})
|
5287
|
+
req = build_request(:set_type_configuration, params)
|
5288
|
+
req.send_request(options)
|
5289
|
+
end
|
5290
|
+
|
4588
5291
|
# Specify the default version of an extension. The default version of an
|
4589
5292
|
# extension will be used in CloudFormation operations.
|
4590
5293
|
#
|
@@ -4631,11 +5334,11 @@ module Aws::CloudFormation
|
|
4631
5334
|
|
4632
5335
|
# Sends a signal to the specified resource with a success or failure
|
4633
5336
|
# status. You can use the SignalResource API in conjunction with a
|
4634
|
-
# creation policy or update policy.
|
4635
|
-
#
|
4636
|
-
#
|
4637
|
-
#
|
4638
|
-
#
|
5337
|
+
# creation policy or update policy. CloudFormation doesn't proceed with
|
5338
|
+
# a stack creation or update until resources receive the required number
|
5339
|
+
# of signals or the timeout period is exceeded. The SignalResource API
|
5340
|
+
# is useful in cases where you want to send signals from anywhere other
|
5341
|
+
# than an Amazon EC2 instance.
|
4639
5342
|
#
|
4640
5343
|
# @option params [required, String] :stack_name
|
4641
5344
|
# The stack name or unique stack ID that includes the resource that you
|
@@ -4654,7 +5357,7 @@ module Aws::CloudFormation
|
|
4654
5357
|
#
|
4655
5358
|
# @option params [required, String] :status
|
4656
5359
|
# The status of the signal, which is either success or failure. A
|
4657
|
-
# failure signal causes
|
5360
|
+
# failure signal causes CloudFormation to immediately fail the stack
|
4658
5361
|
# creation or update.
|
4659
5362
|
#
|
4660
5363
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -4700,9 +5403,9 @@ module Aws::CloudFormation
|
|
4700
5403
|
# * If you are signed in to a delegated administrator account, specify
|
4701
5404
|
# `DELEGATED_ADMIN`.
|
4702
5405
|
#
|
4703
|
-
# Your
|
4704
|
-
#
|
4705
|
-
#
|
5406
|
+
# Your account must be registered as a delegated administrator in the
|
5407
|
+
# management account. For more information, see [Register a delegated
|
5408
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
4706
5409
|
#
|
4707
5410
|
#
|
4708
5411
|
#
|
@@ -4727,6 +5430,115 @@ module Aws::CloudFormation
|
|
4727
5430
|
req.send_request(options)
|
4728
5431
|
end
|
4729
5432
|
|
5433
|
+
# Tests a registered extension to make sure it meets all necessary
|
5434
|
+
# requirements for being published in the CloudFormation registry.
|
5435
|
+
#
|
5436
|
+
# * For resource types, this includes passing all contracts tests
|
5437
|
+
# defined for the type.
|
5438
|
+
#
|
5439
|
+
# * For modules, this includes determining if the module's model meets
|
5440
|
+
# all necessary requirements.
|
5441
|
+
#
|
5442
|
+
# For more information, see [Testing your public extension prior to
|
5443
|
+
# publishing][1] in the *CloudFormation CLI User Guide*.
|
5444
|
+
#
|
5445
|
+
# If you do not specify a version, CloudFormation uses the default
|
5446
|
+
# version of the extension in your account and region for testing.
|
5447
|
+
#
|
5448
|
+
# To perform testing, CloudFormation assumes the execution role
|
5449
|
+
# specified when the type was registered. For more information, see
|
5450
|
+
# [RegisterType](AWSCloudFormation/latest/APIReference/API_RegisterType.html).
|
5451
|
+
#
|
5452
|
+
# Once you've initiated testing on an extension using `TestType`, you
|
5453
|
+
# can use [DescribeType][2] to monitor the current test status and test
|
5454
|
+
# status description for the extension.
|
5455
|
+
#
|
5456
|
+
# An extension must have a test status of `PASSED` before it can be
|
5457
|
+
# published. For more information, see [Publishing extensions to make
|
5458
|
+
# them available for public use][3] in the *CloudFormation CLI User
|
5459
|
+
# Guide*.
|
5460
|
+
#
|
5461
|
+
#
|
5462
|
+
#
|
5463
|
+
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing
|
5464
|
+
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
|
5465
|
+
# [3]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
|
5466
|
+
#
|
5467
|
+
# @option params [String] :arn
|
5468
|
+
# The Amazon Resource Number (ARN) of the extension.
|
5469
|
+
#
|
5470
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
5471
|
+
#
|
5472
|
+
# @option params [String] :type
|
5473
|
+
# The type of the extension to test.
|
5474
|
+
#
|
5475
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
5476
|
+
#
|
5477
|
+
# @option params [String] :type_name
|
5478
|
+
# The name of the extension to test.
|
5479
|
+
#
|
5480
|
+
# Conditional: You must specify `Arn`, or `TypeName` and `Type`.
|
5481
|
+
#
|
5482
|
+
# @option params [String] :version_id
|
5483
|
+
# The version of the extension to test.
|
5484
|
+
#
|
5485
|
+
# You can specify the version id with either `Arn`, or with `TypeName`
|
5486
|
+
# and `Type`.
|
5487
|
+
#
|
5488
|
+
# If you do not specify a version, CloudFormation uses the default
|
5489
|
+
# version of the extension in this account and region for testing.
|
5490
|
+
#
|
5491
|
+
# @option params [String] :log_delivery_bucket
|
5492
|
+
# The S3 bucket to which CloudFormation delivers the contract test
|
5493
|
+
# execution logs.
|
5494
|
+
#
|
5495
|
+
# CloudFormation delivers the logs by the time contract testing has
|
5496
|
+
# completed and the extension has been assigned a test type status of
|
5497
|
+
# `PASSED` or `FAILED`.
|
5498
|
+
#
|
5499
|
+
# The user calling `TestType` must be able to access items in the
|
5500
|
+
# specified S3 bucket. Specifically, the user needs the following
|
5501
|
+
# permissions:
|
5502
|
+
#
|
5503
|
+
# * GetObject
|
5504
|
+
#
|
5505
|
+
# * PutObject
|
5506
|
+
#
|
5507
|
+
# For more information, see [Actions, Resources, and Condition Keys for
|
5508
|
+
# Amazon S3][1] in the *Amazon Web Services Identity and Access
|
5509
|
+
# Management User Guide*.
|
5510
|
+
#
|
5511
|
+
#
|
5512
|
+
#
|
5513
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html
|
5514
|
+
#
|
5515
|
+
# @return [Types::TestTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5516
|
+
#
|
5517
|
+
# * {Types::TestTypeOutput#type_version_arn #type_version_arn} => String
|
5518
|
+
#
|
5519
|
+
# @example Request syntax with placeholder values
|
5520
|
+
#
|
5521
|
+
# resp = client.test_type({
|
5522
|
+
# arn: "TypeArn",
|
5523
|
+
# type: "RESOURCE", # accepts RESOURCE, MODULE
|
5524
|
+
# type_name: "TypeName",
|
5525
|
+
# version_id: "TypeVersionId",
|
5526
|
+
# log_delivery_bucket: "S3Bucket",
|
5527
|
+
# })
|
5528
|
+
#
|
5529
|
+
# @example Response structure
|
5530
|
+
#
|
5531
|
+
# resp.type_version_arn #=> String
|
5532
|
+
#
|
5533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TestType AWS API Documentation
|
5534
|
+
#
|
5535
|
+
# @overload test_type(params = {})
|
5536
|
+
# @param [Hash] params ({})
|
5537
|
+
def test_type(params = {}, options = {})
|
5538
|
+
req = build_request(:test_type, params)
|
5539
|
+
req.send_request(options)
|
5540
|
+
end
|
5541
|
+
|
4730
5542
|
# Updates a stack as specified in the template. After the call completes
|
4731
5543
|
# successfully, the stack update starts. You can check the status of the
|
4732
5544
|
# stack via the DescribeStacks action.
|
@@ -4748,7 +5560,7 @@ module Aws::CloudFormation
|
|
4748
5560
|
# @option params [String] :template_body
|
4749
5561
|
# Structure containing the template body with a minimum length of 1 byte
|
4750
5562
|
# and a maximum length of 51,200 bytes. (For more information, go to
|
4751
|
-
# [Template Anatomy][1] in the
|
5563
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.)
|
4752
5564
|
#
|
4753
5565
|
# Conditional: You must specify only one of the following parameters:
|
4754
5566
|
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
|
@@ -4761,7 +5573,7 @@ module Aws::CloudFormation
|
|
4761
5573
|
# @option params [String] :template_url
|
4762
5574
|
# Location of file containing the template body. The URL must point to a
|
4763
5575
|
# template that is located in an Amazon S3 bucket or a Systems Manager
|
4764
|
-
# document. For more information, go to [Template Anatomy][1] in the
|
5576
|
+
# document. For more information, go to [Template Anatomy][1] in the
|
4765
5577
|
# CloudFormation User Guide.
|
4766
5578
|
#
|
4767
5579
|
# Conditional: You must specify only one of the following parameters:
|
@@ -4812,16 +5624,15 @@ module Aws::CloudFormation
|
|
4812
5624
|
#
|
4813
5625
|
# @option params [Array<String>] :capabilities
|
4814
5626
|
# In some cases, you must explicitly acknowledge that your stack
|
4815
|
-
# template contains certain capabilities in order for
|
4816
|
-
#
|
5627
|
+
# template contains certain capabilities in order for CloudFormation to
|
5628
|
+
# update the stack.
|
4817
5629
|
#
|
4818
5630
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
4819
5631
|
#
|
4820
5632
|
# Some stack templates might include resources that can affect
|
4821
|
-
# permissions in your
|
4822
|
-
#
|
4823
|
-
#
|
4824
|
-
# capabilities.
|
5633
|
+
# permissions in your account; for example, by creating new Identity
|
5634
|
+
# and Access Management (IAM) users. For those stacks, you must
|
5635
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
4825
5636
|
#
|
4826
5637
|
# The following IAM resources require you to specify either the
|
4827
5638
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
@@ -4831,8 +5642,8 @@ module Aws::CloudFormation
|
|
4831
5642
|
# * If you have IAM resources with custom names, you *must* specify
|
4832
5643
|
# `CAPABILITY_NAMED_IAM`.
|
4833
5644
|
#
|
4834
|
-
# * If you don't specify either of these capabilities,
|
4835
|
-
#
|
5645
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
5646
|
+
# returns an `InsufficientCapabilities` error.
|
4836
5647
|
#
|
4837
5648
|
# If your stack template contains these resources, we recommend that
|
4838
5649
|
# you review all permissions associated with them and edit their
|
@@ -4852,7 +5663,7 @@ module Aws::CloudFormation
|
|
4852
5663
|
#
|
4853
5664
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
4854
5665
|
#
|
4855
|
-
# For more information, see [Acknowledging IAM Resources in
|
5666
|
+
# For more information, see [Acknowledging IAM Resources in
|
4856
5667
|
# CloudFormation Templates][8].
|
4857
5668
|
#
|
4858
5669
|
# * `CAPABILITY_AUTO_EXPAND`
|
@@ -4867,7 +5678,7 @@ module Aws::CloudFormation
|
|
4867
5678
|
# update a stack directly from the processed template, without first
|
4868
5679
|
# reviewing the resulting changes in a change set, you must
|
4869
5680
|
# acknowledge this capability. This includes the [AWS::Include][9] and
|
4870
|
-
# [AWS::Serverless][10] transforms, which are macros hosted by
|
5681
|
+
# [AWS::Serverless][10] transforms, which are macros hosted by
|
4871
5682
|
# CloudFormation.
|
4872
5683
|
#
|
4873
5684
|
# If you want to update a stack from a stack template that contains
|
@@ -4879,11 +5690,11 @@ module Aws::CloudFormation
|
|
4879
5690
|
#
|
4880
5691
|
# Each macro relies on an underlying Lambda service function for
|
4881
5692
|
# processing stack templates. Be aware that the Lambda function owner
|
4882
|
-
# can update the function operation without
|
5693
|
+
# can update the function operation without CloudFormation being
|
4883
5694
|
# notified.
|
4884
5695
|
#
|
4885
|
-
# For more information, see [Using
|
4886
|
-
#
|
5696
|
+
# For more information, see [Using CloudFormation Macros to Perform
|
5697
|
+
# Custom Processing on Templates][11].
|
4887
5698
|
#
|
4888
5699
|
#
|
4889
5700
|
#
|
@@ -4905,33 +5716,32 @@ module Aws::CloudFormation
|
|
4905
5716
|
# or `Custom::MyCustomInstance`.
|
4906
5717
|
#
|
4907
5718
|
# If the list of resource types doesn't include a resource that you're
|
4908
|
-
# updating, the stack update fails. By default,
|
4909
|
-
#
|
4910
|
-
#
|
4911
|
-
#
|
4912
|
-
#
|
5719
|
+
# updating, the stack update fails. By default, CloudFormation grants
|
5720
|
+
# permissions to all resource types. Identity and Access Management
|
5721
|
+
# (IAM) uses this parameter for CloudFormation-specific condition keys
|
5722
|
+
# in IAM policies. For more information, see [Controlling Access with
|
5723
|
+
# Identity and Access Management][1].
|
4913
5724
|
#
|
4914
5725
|
#
|
4915
5726
|
#
|
4916
5727
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
|
4917
5728
|
#
|
4918
5729
|
# @option params [String] :role_arn
|
4919
|
-
# The Amazon Resource Name (ARN) of an
|
4920
|
-
#
|
4921
|
-
#
|
4922
|
-
#
|
4923
|
-
#
|
4924
|
-
#
|
4925
|
-
#
|
4926
|
-
#
|
4927
|
-
#
|
4928
|
-
#
|
4929
|
-
# was previously associated with the stack. If no role is available, AWS
|
5730
|
+
# The Amazon Resource Name (ARN) of an Identity and Access Management
|
5731
|
+
# (IAM) role that CloudFormation assumes to update the stack.
|
5732
|
+
# CloudFormation uses the role's credentials to make calls on your
|
5733
|
+
# behalf. CloudFormation always uses this role for all future operations
|
5734
|
+
# on the stack. As long as users have permission to operate on the
|
5735
|
+
# stack, CloudFormation uses this role even if the users don't have
|
5736
|
+
# permission to pass it. Ensure that the role grants least privilege.
|
5737
|
+
#
|
5738
|
+
# If you don't specify a value, CloudFormation uses the role that was
|
5739
|
+
# previously associated with the stack. If no role is available,
|
4930
5740
|
# CloudFormation uses a temporary session that is generated from your
|
4931
5741
|
# user credentials.
|
4932
5742
|
#
|
4933
5743
|
# @option params [Types::RollbackConfiguration] :rollback_configuration
|
4934
|
-
# The rollback triggers for
|
5744
|
+
# The rollback triggers for CloudFormation to monitor during stack
|
4935
5745
|
# creation and updating operations, and for the specified monitoring
|
4936
5746
|
# period afterwards.
|
4937
5747
|
#
|
@@ -4957,23 +5767,23 @@ module Aws::CloudFormation
|
|
4957
5767
|
#
|
4958
5768
|
# @option params [Array<String>] :notification_arns
|
4959
5769
|
# Amazon Simple Notification Service topic Amazon Resource Names (ARNs)
|
4960
|
-
# that
|
4961
|
-
#
|
5770
|
+
# that CloudFormation associates with the stack. Specify an empty list
|
5771
|
+
# to remove all notification topics.
|
4962
5772
|
#
|
4963
5773
|
# @option params [Array<Types::Tag>] :tags
|
4964
|
-
# Key-value pairs to associate with this stack.
|
5774
|
+
# Key-value pairs to associate with this stack. CloudFormation also
|
4965
5775
|
# propagates these tags to supported resources in the stack. You can
|
4966
5776
|
# specify a maximum number of 50 tags.
|
4967
5777
|
#
|
4968
|
-
# If you don't specify this parameter,
|
4969
|
-
#
|
4970
|
-
#
|
5778
|
+
# If you don't specify this parameter, CloudFormation doesn't modify
|
5779
|
+
# the stack's tags. If you specify an empty value, CloudFormation
|
5780
|
+
# removes all associated tags.
|
4971
5781
|
#
|
4972
5782
|
# @option params [String] :client_request_token
|
4973
5783
|
# A unique identifier for this `UpdateStack` request. Specify this token
|
4974
|
-
# if you plan to retry requests so that
|
5784
|
+
# if you plan to retry requests so that CloudFormation knows that
|
4975
5785
|
# you're not attempting to update a stack with the same name. You might
|
4976
|
-
# retry `UpdateStack` requests to ensure that
|
5786
|
+
# retry `UpdateStack` requests to ensure that CloudFormation
|
4977
5787
|
# successfully received them.
|
4978
5788
|
#
|
4979
5789
|
# All events triggered by a given stack operation are assigned the same
|
@@ -5079,7 +5889,7 @@ module Aws::CloudFormation
|
|
5079
5889
|
# instances.
|
5080
5890
|
#
|
5081
5891
|
# @option params [Array<String>] :accounts
|
5082
|
-
# \[Self-managed permissions\] The names of one or more
|
5892
|
+
# \[Self-managed permissions\] The names of one or more accounts for
|
5083
5893
|
# which you want to update parameter values for stack instances. The
|
5084
5894
|
# overridden parameter values will be applied to all stack instances in
|
5085
5895
|
# the specified accounts and Regions.
|
@@ -5087,8 +5897,8 @@ module Aws::CloudFormation
|
|
5087
5897
|
# You can specify `Accounts` or `DeploymentTargets`, but not both.
|
5088
5898
|
#
|
5089
5899
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
5090
|
-
# \[Service-managed permissions\] The
|
5091
|
-
#
|
5900
|
+
# \[Service-managed permissions\] The Organizations accounts for which
|
5901
|
+
# you want to update parameter values for stack instances. If your
|
5092
5902
|
# update targets OUs, the overridden parameter values only apply to the
|
5093
5903
|
# accounts that are currently in the target OUs and their child OUs.
|
5094
5904
|
# Accounts added to the target OUs and their child OUs in the future
|
@@ -5107,24 +5917,19 @@ module Aws::CloudFormation
|
|
5107
5917
|
#
|
5108
5918
|
# Any overridden parameter values will be applied to all stack instances
|
5109
5919
|
# in the specified accounts and Regions. When specifying parameters and
|
5110
|
-
# their values, be aware of how
|
5920
|
+
# their values, be aware of how CloudFormation sets parameter values
|
5111
5921
|
# during stack instance update operations:
|
5112
5922
|
#
|
5113
5923
|
# * To override the current value for a parameter, include the parameter
|
5114
5924
|
# and specify its value.
|
5115
5925
|
#
|
5116
|
-
# * To leave
|
5117
|
-
#
|
5118
|
-
#
|
5119
|
-
# * Do not include the parameter in the list.
|
5926
|
+
# * To leave an overridden parameter set to its present value, include
|
5927
|
+
# the parameter and specify `UsePreviousValue` as `true`. (You cannot
|
5928
|
+
# specify both a value and set `UsePreviousValue` to `true`.)
|
5120
5929
|
#
|
5121
|
-
#
|
5122
|
-
#
|
5123
|
-
#
|
5124
|
-
#
|
5125
|
-
# * To set all overridden parameter back to the values specified in the
|
5126
|
-
# stack set, specify a parameter list but do not include any
|
5127
|
-
# parameters.
|
5930
|
+
# * To set an overridden parameter back to the value specified in the
|
5931
|
+
# stack set, specify a parameter list but do not include the parameter
|
5932
|
+
# in the list.
|
5128
5933
|
#
|
5129
5934
|
# * To leave all parameters set to their present values, do not specify
|
5130
5935
|
# this property at all.
|
@@ -5147,17 +5952,16 @@ module Aws::CloudFormation
|
|
5147
5952
|
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
|
5148
5953
|
#
|
5149
5954
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
5150
|
-
# Preferences for how
|
5151
|
-
# operation.
|
5955
|
+
# Preferences for how CloudFormation performs this stack set operation.
|
5152
5956
|
#
|
5153
5957
|
# @option params [String] :operation_id
|
5154
5958
|
# The unique identifier for this stack set operation.
|
5155
5959
|
#
|
5156
5960
|
# The operation ID also functions as an idempotency token, to ensure
|
5157
|
-
# that
|
5158
|
-
#
|
5159
|
-
#
|
5160
|
-
#
|
5961
|
+
# that CloudFormation performs the stack set operation only once, even
|
5962
|
+
# if you retry the request multiple times. You might retry stack set
|
5963
|
+
# operation requests to ensure that CloudFormation successfully received
|
5964
|
+
# them.
|
5161
5965
|
#
|
5162
5966
|
# If you don't specify an operation ID, the SDK generates one
|
5163
5967
|
# automatically.
|
@@ -5178,9 +5982,9 @@ module Aws::CloudFormation
|
|
5178
5982
|
# * If you are signed in to a delegated administrator account, specify
|
5179
5983
|
# `DELEGATED_ADMIN`.
|
5180
5984
|
#
|
5181
|
-
# Your
|
5182
|
-
#
|
5183
|
-
#
|
5985
|
+
# Your account must be registered as a delegated administrator in the
|
5986
|
+
# management account. For more information, see [Register a delegated
|
5987
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
5184
5988
|
#
|
5185
5989
|
#
|
5186
5990
|
#
|
@@ -5252,7 +6056,7 @@ module Aws::CloudFormation
|
|
5252
6056
|
# @option params [String] :template_body
|
5253
6057
|
# The structure that contains the template body, with a minimum length
|
5254
6058
|
# of 1 byte and a maximum length of 51,200 bytes. For more information,
|
5255
|
-
# see [Template Anatomy][1] in the
|
6059
|
+
# see [Template Anatomy][1] in the CloudFormation User Guide.
|
5256
6060
|
#
|
5257
6061
|
# Conditional: You must specify only one of the following parameters:
|
5258
6062
|
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
|
@@ -5265,7 +6069,7 @@ module Aws::CloudFormation
|
|
5265
6069
|
# The location of the file that contains the template body. The URL must
|
5266
6070
|
# point to a template (maximum size: 460,800 bytes) that is located in
|
5267
6071
|
# an Amazon S3 bucket or a Systems Manager document. For more
|
5268
|
-
# information, see [Template Anatomy][1] in the
|
6072
|
+
# information, see [Template Anatomy][1] in the CloudFormation User
|
5269
6073
|
# Guide.
|
5270
6074
|
#
|
5271
6075
|
# Conditional: You must specify only one of the following parameters:
|
@@ -5287,16 +6091,15 @@ module Aws::CloudFormation
|
|
5287
6091
|
#
|
5288
6092
|
# @option params [Array<String>] :capabilities
|
5289
6093
|
# In some cases, you must explicitly acknowledge that your stack
|
5290
|
-
# template contains certain capabilities in order for
|
5291
|
-
#
|
6094
|
+
# template contains certain capabilities in order for CloudFormation to
|
6095
|
+
# update the stack set and its associated stack instances.
|
5292
6096
|
#
|
5293
6097
|
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
|
5294
6098
|
#
|
5295
6099
|
# Some stack templates might include resources that can affect
|
5296
|
-
# permissions in your
|
5297
|
-
#
|
5298
|
-
#
|
5299
|
-
# capabilities.
|
6100
|
+
# permissions in your account; for example, by creating new Identity
|
6101
|
+
# and Access Management (IAM) users. For those stacks sets, you must
|
6102
|
+
# explicitly acknowledge this by specifying one of these capabilities.
|
5300
6103
|
#
|
5301
6104
|
# The following IAM resources require you to specify either the
|
5302
6105
|
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
|
@@ -5306,8 +6109,8 @@ module Aws::CloudFormation
|
|
5306
6109
|
# * If you have IAM resources with custom names, you *must* specify
|
5307
6110
|
# `CAPABILITY_NAMED_IAM`.
|
5308
6111
|
#
|
5309
|
-
# * If you don't specify either of these capabilities,
|
5310
|
-
#
|
6112
|
+
# * If you don't specify either of these capabilities, CloudFormation
|
6113
|
+
# returns an `InsufficientCapabilities` error.
|
5311
6114
|
#
|
5312
6115
|
# If your stack template contains these resources, we recommend that
|
5313
6116
|
# you review all permissions associated with them and edit their
|
@@ -5327,23 +6130,26 @@ module Aws::CloudFormation
|
|
5327
6130
|
#
|
5328
6131
|
# * [ AWS::IAM::UserToGroupAddition][7]
|
5329
6132
|
#
|
5330
|
-
# For more information, see [Acknowledging IAM Resources in
|
6133
|
+
# For more information, see [Acknowledging IAM Resources in
|
5331
6134
|
# CloudFormation Templates][8].
|
5332
6135
|
#
|
5333
6136
|
# * `CAPABILITY_AUTO_EXPAND`
|
5334
6137
|
#
|
5335
|
-
# Some templates
|
5336
|
-
# or more macros,
|
5337
|
-
# processed template, without first reviewing the
|
5338
|
-
# a change set
|
5339
|
-
#
|
5340
|
-
# Processing on
|
6138
|
+
# Some templates reference macros. If your stack set template
|
6139
|
+
# references one or more macros, you must update the stack set
|
6140
|
+
# directly from the processed template, without first reviewing the
|
6141
|
+
# resulting changes in a change set. To update the stack set directly,
|
6142
|
+
# you must acknowledge this capability. For more information, see
|
6143
|
+
# [Using CloudFormation Macros to Perform Custom Processing on
|
6144
|
+
# Templates][9].
|
5341
6145
|
#
|
5342
|
-
# Stack sets do not currently support
|
5343
|
-
#
|
5344
|
-
# transforms, which are
|
5345
|
-
#
|
5346
|
-
#
|
6146
|
+
# Stack sets with service-managed permissions do not currently support
|
6147
|
+
# the use of macros in templates. (This includes the
|
6148
|
+
# [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
|
6149
|
+
# macros hosted by CloudFormation.) Even if you specify this
|
6150
|
+
# capability for a stack set with service-managed permissions, if you
|
6151
|
+
# reference a macro in your template the stack set operation will
|
6152
|
+
# fail.
|
5347
6153
|
#
|
5348
6154
|
#
|
5349
6155
|
#
|
@@ -5361,15 +6167,15 @@ module Aws::CloudFormation
|
|
5361
6167
|
#
|
5362
6168
|
# @option params [Array<Types::Tag>] :tags
|
5363
6169
|
# The key-value pairs to associate with this stack set and the stacks
|
5364
|
-
# created from it.
|
6170
|
+
# created from it. CloudFormation also propagates these tags to
|
5365
6171
|
# supported resources that are created in the stacks. You can specify a
|
5366
6172
|
# maximum number of 50 tags.
|
5367
6173
|
#
|
5368
6174
|
# If you specify tags for this parameter, those tags replace any list of
|
5369
6175
|
# tags that are currently associated with this stack set. This means:
|
5370
6176
|
#
|
5371
|
-
# * If you don't specify this parameter,
|
5372
|
-
#
|
6177
|
+
# * If you don't specify this parameter, CloudFormation doesn't modify
|
6178
|
+
# the stack's tags.
|
5373
6179
|
#
|
5374
6180
|
# * If you specify *any* tags using this parameter, you must specify
|
5375
6181
|
# *all* the tags that you want associated with this stack set, even
|
@@ -5378,21 +6184,20 @@ module Aws::CloudFormation
|
|
5378
6184
|
# you don't include in the updated list of tags are removed from the
|
5379
6185
|
# stack set, and therefore from the stacks and resources as well.
|
5380
6186
|
#
|
5381
|
-
# * If you specify an empty value,
|
5382
|
-
#
|
6187
|
+
# * If you specify an empty value, CloudFormation removes all currently
|
6188
|
+
# associated tags.
|
5383
6189
|
#
|
5384
|
-
# If you specify new tags as part of an `UpdateStackSet` action,
|
6190
|
+
# If you specify new tags as part of an `UpdateStackSet` action,
|
5385
6191
|
# CloudFormation checks to see if you have the required IAM permission
|
5386
6192
|
# to tag resources. If you omit tags that are currently associated with
|
5387
|
-
# the stack set from the list of tags you specify,
|
6193
|
+
# the stack set from the list of tags you specify, CloudFormation
|
5388
6194
|
# assumes that you want to remove those tags from the stack set, and
|
5389
6195
|
# checks to see if you have permission to untag resources. If you don't
|
5390
6196
|
# have the necessary permission(s), the entire `UpdateStackSet` action
|
5391
6197
|
# fails with an `access denied` error, and the stack set is not updated.
|
5392
6198
|
#
|
5393
6199
|
# @option params [Types::StackSetOperationPreferences] :operation_preferences
|
5394
|
-
# Preferences for how
|
5395
|
-
# operation.
|
6200
|
+
# Preferences for how CloudFormation performs this stack set operation.
|
5396
6201
|
#
|
5397
6202
|
# @option params [String] :administration_role_arn
|
5398
6203
|
# The Amazon Resource Number (ARN) of the IAM role to use to update this
|
@@ -5401,8 +6206,8 @@ module Aws::CloudFormation
|
|
5401
6206
|
# Specify an IAM role only if you are using customized administrator
|
5402
6207
|
# roles to control which users or groups can manage specific stack sets
|
5403
6208
|
# within the same administrator account. For more information, see
|
5404
|
-
# [Granting Permissions for Stack Set Operations][1] in the
|
5405
|
-
# CloudFormation User Guide*.
|
6209
|
+
# [Granting Permissions for Stack Set Operations][1] in the
|
6210
|
+
# *CloudFormation User Guide*.
|
5406
6211
|
#
|
5407
6212
|
# If you specified a customized administrator role when you created the
|
5408
6213
|
# stack set, you must specify a customized administrator role, even if
|
@@ -5415,7 +6220,7 @@ module Aws::CloudFormation
|
|
5415
6220
|
#
|
5416
6221
|
# @option params [String] :execution_role_name
|
5417
6222
|
# The name of the IAM execution role to use to update the stack set. If
|
5418
|
-
# you do not specify an execution role,
|
6223
|
+
# you do not specify an execution role, CloudFormation uses the
|
5419
6224
|
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
|
5420
6225
|
# operation.
|
5421
6226
|
#
|
@@ -5423,27 +6228,27 @@ module Aws::CloudFormation
|
|
5423
6228
|
# to control which stack resources users and groups can include in their
|
5424
6229
|
# stack sets.
|
5425
6230
|
#
|
5426
|
-
# If you specify a customized execution role,
|
5427
|
-
#
|
5428
|
-
#
|
5429
|
-
#
|
5430
|
-
#
|
6231
|
+
# If you specify a customized execution role, CloudFormation uses that
|
6232
|
+
# role to update the stack. If you do not specify a customized execution
|
6233
|
+
# role, CloudFormation performs the update using the role previously
|
6234
|
+
# associated with the stack set, so long as you have permissions to
|
6235
|
+
# perform operations on the stack set.
|
5431
6236
|
#
|
5432
6237
|
# @option params [Types::DeploymentTargets] :deployment_targets
|
5433
|
-
# \[Service-managed permissions\] The
|
5434
|
-
#
|
6238
|
+
# \[Service-managed permissions\] The Organizations accounts in which to
|
6239
|
+
# update associated stack instances.
|
5435
6240
|
#
|
5436
6241
|
# To update all the stack instances associated with this stack set, do
|
5437
6242
|
# not specify `DeploymentTargets` or `Regions`.
|
5438
6243
|
#
|
5439
6244
|
# If the stack set update includes changes to the template (that is, if
|
5440
6245
|
# `TemplateBody` or `TemplateURL` is specified), or the `Parameters`,
|
5441
|
-
#
|
5442
|
-
#
|
5443
|
-
#
|
5444
|
-
#
|
5445
|
-
#
|
5446
|
-
#
|
6246
|
+
# CloudFormation marks all stack instances with a status of `OUTDATED`
|
6247
|
+
# prior to updating the stack instances in the specified accounts and
|
6248
|
+
# Regions. If the stack set update does not include changes to the
|
6249
|
+
# template or parameters, CloudFormation updates the stack instances in
|
6250
|
+
# the specified accounts and Regions, while leaving all other stack
|
6251
|
+
# instances with their existing stack instance status.
|
5447
6252
|
#
|
5448
6253
|
# @option params [String] :permission_model
|
5449
6254
|
# Describes how the IAM roles required for stack set operations are
|
@@ -5455,7 +6260,7 @@ module Aws::CloudFormation
|
|
5455
6260
|
# information, see [Grant Self-Managed Stack Set Permissions][1].
|
5456
6261
|
#
|
5457
6262
|
# * With `service-managed` permissions, StackSets automatically creates
|
5458
|
-
# the IAM roles required to deploy to accounts managed by
|
6263
|
+
# the IAM roles required to deploy to accounts managed by
|
5459
6264
|
# Organizations. For more information, see [Grant Service-Managed
|
5460
6265
|
# Stack Set Permissions][2].
|
5461
6266
|
#
|
@@ -5466,8 +6271,8 @@ module Aws::CloudFormation
|
|
5466
6271
|
#
|
5467
6272
|
# @option params [Types::AutoDeployment] :auto_deployment
|
5468
6273
|
# \[Service-managed permissions\] Describes whether StackSets
|
5469
|
-
# automatically deploys to
|
5470
|
-
#
|
6274
|
+
# automatically deploys to Organizations accounts that are added to a
|
6275
|
+
# target organization or organizational unit (OU).
|
5471
6276
|
#
|
5472
6277
|
# If you specify `AutoDeployment`, do not specify `DeploymentTargets` or
|
5473
6278
|
# `Regions`.
|
@@ -5476,13 +6281,13 @@ module Aws::CloudFormation
|
|
5476
6281
|
# The unique ID for this stack set operation.
|
5477
6282
|
#
|
5478
6283
|
# The operation ID also functions as an idempotency token, to ensure
|
5479
|
-
# that
|
5480
|
-
#
|
5481
|
-
#
|
5482
|
-
#
|
6284
|
+
# that CloudFormation performs the stack set operation only once, even
|
6285
|
+
# if you retry the request multiple times. You might retry stack set
|
6286
|
+
# operation requests to ensure that CloudFormation successfully received
|
6287
|
+
# them.
|
5483
6288
|
#
|
5484
|
-
# If you don't specify an operation ID,
|
5485
|
-
#
|
6289
|
+
# If you don't specify an operation ID, CloudFormation generates one
|
6290
|
+
# automatically.
|
5486
6291
|
#
|
5487
6292
|
# Repeating this stack set operation with a new operation ID retries all
|
5488
6293
|
# stack instances whose status is `OUTDATED`.
|
@@ -5500,13 +6305,13 @@ module Aws::CloudFormation
|
|
5500
6305
|
#
|
5501
6306
|
# If the stack set update includes changes to the template (that is, if
|
5502
6307
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
5503
|
-
# `Parameters` property,
|
5504
|
-
#
|
5505
|
-
#
|
5506
|
-
# include changes to the template or parameters,
|
5507
|
-
#
|
5508
|
-
#
|
5509
|
-
#
|
6308
|
+
# `Parameters` property, CloudFormation marks all stack instances with a
|
6309
|
+
# status of `OUTDATED` prior to updating the stack instances in the
|
6310
|
+
# specified accounts and Regions. If the stack set update does not
|
6311
|
+
# include changes to the template or parameters, CloudFormation updates
|
6312
|
+
# the stack instances in the specified accounts and Regions, while
|
6313
|
+
# leaving all other stack instances with their existing stack instance
|
6314
|
+
# status.
|
5510
6315
|
#
|
5511
6316
|
# @option params [Array<String>] :regions
|
5512
6317
|
# The Regions in which to update associated stack instances. If you
|
@@ -5518,13 +6323,13 @@ module Aws::CloudFormation
|
|
5518
6323
|
#
|
5519
6324
|
# If the stack set update includes changes to the template (that is, if
|
5520
6325
|
# the `TemplateBody` or `TemplateURL` properties are specified), or the
|
5521
|
-
# `Parameters` property,
|
5522
|
-
#
|
5523
|
-
#
|
5524
|
-
# include changes to the template or parameters,
|
5525
|
-
#
|
5526
|
-
#
|
5527
|
-
#
|
6326
|
+
# `Parameters` property, CloudFormation marks all stack instances with a
|
6327
|
+
# status of `OUTDATED` prior to updating the stack instances in the
|
6328
|
+
# specified accounts and Regions. If the stack set update does not
|
6329
|
+
# include changes to the template or parameters, CloudFormation updates
|
6330
|
+
# the stack instances in the specified accounts and Regions, while
|
6331
|
+
# leaving all other stack instances with their existing stack instance
|
6332
|
+
# status.
|
5528
6333
|
#
|
5529
6334
|
# @option params [String] :call_as
|
5530
6335
|
# \[Service-managed permissions\] Specifies whether you are acting as an
|
@@ -5539,9 +6344,9 @@ module Aws::CloudFormation
|
|
5539
6344
|
# * If you are signed in to a delegated administrator account, specify
|
5540
6345
|
# `DELEGATED_ADMIN`.
|
5541
6346
|
#
|
5542
|
-
# Your
|
5543
|
-
#
|
5544
|
-
#
|
6347
|
+
# Your account must be registered as a delegated administrator in the
|
6348
|
+
# management account. For more information, see [Register a delegated
|
6349
|
+
# administrator][1] in the *CloudFormation User Guide*.
|
5545
6350
|
#
|
5546
6351
|
#
|
5547
6352
|
#
|
@@ -5616,8 +6421,8 @@ module Aws::CloudFormation
|
|
5616
6421
|
# Updates termination protection for the specified stack. If a user
|
5617
6422
|
# attempts to delete a stack with termination protection enabled, the
|
5618
6423
|
# operation fails and the stack remains unchanged. For more information,
|
5619
|
-
# see [Protecting a Stack From Being Deleted][1] in the *
|
5620
|
-
#
|
6424
|
+
# see [Protecting a Stack From Being Deleted][1] in the *CloudFormation
|
6425
|
+
# User Guide*.
|
5621
6426
|
#
|
5622
6427
|
# For [nested stacks][2], termination protection is set on the root
|
5623
6428
|
# stack and cannot be changed directly on the nested stack.
|
@@ -5658,15 +6463,15 @@ module Aws::CloudFormation
|
|
5658
6463
|
req.send_request(options)
|
5659
6464
|
end
|
5660
6465
|
|
5661
|
-
# Validates a specified template.
|
5662
|
-
# template is valid JSON. If it isn't,
|
5663
|
-
# template is valid YAML. If both these checks fail,
|
6466
|
+
# Validates a specified template. CloudFormation first checks if the
|
6467
|
+
# template is valid JSON. If it isn't, CloudFormation checks if the
|
6468
|
+
# template is valid YAML. If both these checks fail, CloudFormation
|
5664
6469
|
# returns a template validation error.
|
5665
6470
|
#
|
5666
6471
|
# @option params [String] :template_body
|
5667
6472
|
# Structure containing the template body with a minimum length of 1 byte
|
5668
6473
|
# and a maximum length of 51,200 bytes. For more information, go to
|
5669
|
-
# [Template Anatomy][1] in the
|
6474
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
5670
6475
|
#
|
5671
6476
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
5672
6477
|
# are passed, only `TemplateBody` is used.
|
@@ -5679,7 +6484,7 @@ module Aws::CloudFormation
|
|
5679
6484
|
# Location of file containing the template body. The URL must point to a
|
5680
6485
|
# template (max size: 460,800 bytes) that is located in an Amazon S3
|
5681
6486
|
# bucket or a Systems Manager document. For more information, go to
|
5682
|
-
# [Template Anatomy][1] in the
|
6487
|
+
# [Template Anatomy][1] in the CloudFormation User Guide.
|
5683
6488
|
#
|
5684
6489
|
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
|
5685
6490
|
# are passed, only `TemplateBody` is used.
|
@@ -5739,7 +6544,7 @@ module Aws::CloudFormation
|
|
5739
6544
|
params: params,
|
5740
6545
|
config: config)
|
5741
6546
|
context[:gem_name] = 'aws-sdk-cloudformation'
|
5742
|
-
context[:gem_version] = '1.
|
6547
|
+
context[:gem_version] = '1.54.0'
|
5743
6548
|
Seahorse::Client::Request.new(handlers, context)
|
5744
6549
|
end
|
5745
6550
|
|