New Upstream Release - ruby-aws-sdk-cloudformation
Ready changes
Summary
Merged new upstream version: 1.82.0 (was: 1.73.0).
Diff
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..de1fb83
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,497 @@
+Unreleased Changes
+------------------
+
+1.82.0 (2023-06-19)
+------------------
+
+* Feature - Specify desired CloudFormation behavior in the event of ChangeSet execution failure using the CreateChangeSet OnStackFailure parameter
+
+1.81.0 (2023-06-15)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.80.0 (2023-06-07)
+------------------
+
+* Feature - AWS CloudFormation StackSets is updating the deployment experience for all stackset operations to skip suspended AWS accounts during deployments. StackSets will skip target AWS accounts that are suspended and set the Detailed Status of the corresponding stack instances as SKIPPED_SUSPENDED_ACCOUNT
+
+1.79.0 (2023-06-05)
+------------------
+
+* Feature - AWS CloudFormation StackSets provides customers with three new APIs to activate, deactivate, and describe AWS Organizations trusted access which is needed to get started with service-managed StackSets.
+
+1.78.0 (2023-05-31)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.77.0 (2023-04-06)
+------------------
+
+* Feature - Including UPDATE_COMPLETE as a failed status for DeleteStack waiter.
+
+1.76.0 (2023-01-30)
+------------------
+
+* Feature - This feature provides a method of obtaining which regions a stackset has stack instances deployed in.
+
+1.75.0 (2023-01-25)
+------------------
+
+* Feature - Enabled FIPS aws-us-gov endpoints in SDK.
+
+1.74.0 (2023-01-18)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+* Issue - Replace runtime endpoint resolution approach with generated ruby code.
+
+1.73.0 (2022-11-16)
+------------------
+
+* Feature - Added UnsupportedTarget HandlerErrorCode for use with CFN Resource Hooks
+
+1.72.0 (2022-10-28)
+------------------
+
+* Feature - This release adds more fields to improves visibility of AWS CloudFormation StackSets information in following APIs: ListStackInstances, DescribeStackInstance, ListStackSetOperationResults, ListStackSetOperations, DescribeStackSetOperation.
+
+1.71.0 (2022-10-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.70.0 (2022-07-06)
+------------------
+
+* Feature - My AWS Service (placeholder) - Add a new feature Account-level Targeting for StackSet operation
+
+1.69.0 (2022-05-25)
+------------------
+
+* Feature - Add a new parameter statusReason to DescribeStackSetOperation output for additional details
+
+1.68.0 (2022-02-24)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.67.0 (2022-02-10)
+------------------
+
+* Feature - This SDK release adds AWS CloudFormation Hooks HandlerErrorCodes
+
+1.66.0 (2022-02-09)
+------------------
+
+* Feature - This SDK release is for the feature launch of AWS CloudFormation Hooks.
+
+1.65.0 (2022-02-03)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.64.0 (2021-12-21)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.63.0 (2021-11-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.62.0 (2021-11-22)
+------------------
+
+* Feature - This release include SDK changes for the feature launch of Stack Import to Service Managed StackSet.
+
+1.61.0 (2021-11-19)
+------------------
+
+* Feature - The StackSets ManagedExecution feature will allow concurrency for non-conflicting StackSet operations and queuing the StackSet operations that conflict at a given time for later execution.
+
+1.60.0 (2021-11-04)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.59.0 (2021-10-18)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.58.0 (2021-09-10)
+------------------
+
+* Feature - Doc only update for CloudFormation that fixes several customer-reported issues.
+
+1.57.0 (2021-09-01)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.56.0 (2021-08-30)
+------------------
+
+* Feature - AWS CloudFormation allows you to iteratively develop your applications when failures are encountered without rolling back successfully provisioned resources. By specifying stack failure options, you can troubleshoot resources in a CREATE_FAILED or UPDATE_FAILED status.
+
+1.55.0 (2021-07-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.54.0 (2021-07-28)
+------------------
+
+* Feature - SDK update to support Importing existing Stacks to new/existing Self Managed StackSet - Stack Import feature.
+
+1.53.0 (2021-06-21)
+------------------
+
+* Feature - CloudFormation registry service now supports 3rd party public type sharing
+
+1.52.0 (2021-04-28)
+------------------
+
+* Feature - Add CallAs parameter to GetTemplateSummary to enable use with StackSets delegated administrator integration
+
+1.51.0 (2021-04-21)
+------------------
+
+* Feature - Added support for creating and updating stack sets with self-managed permissions from templates that reference macros.
+
+1.50.0 (2021-03-31)
+------------------
+
+* Feature - 1. Added a new parameter "RegionConcurrencyType" in OperationPreferences. 2. Changed the name of "AccountUrl" to "AccountsUrl" in "DeploymentTargets" parameter.
+
+1.49.0 (2021-03-10)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.48.0 (2021-02-18)
+------------------
+
+* Feature - Adding the 'callAs' parameter to all CloudFormation StackSets APIs except getTemplateSummary to support creating and managing service-managed StackSets with AWS Organizations Delegated Administrators
+
+1.47.0 (2021-02-02)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.46.0 (2020-11-24)
+------------------
+
+* Feature - Adds support for the new Modules feature for CloudFormation. A module encapsulates one or more resources and their respective configurations for reuse across your organization.
+
+1.45.0 (2020-11-18)
+------------------
+
+* Feature - This release adds ChangeSets support for Nested Stacks. ChangeSets offer a preview of how proposed changes to a stack might impact existing resources or create new ones.
+
+1.44.0 (2020-09-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.43.0 (2020-09-15)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.42.0 (2020-08-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.41.0 (2020-07-02)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.40.0 (2020-06-26)
+------------------
+
+* Feature - ListStackInstances and DescribeStackInstance now return a new `StackInstanceStatus` object that contains `DetailedStatus` values: a disambiguation of the more generic `Status` value. ListStackInstances output can now be filtered on `DetailedStatus` using the new `Filters` parameter.
+
+1.39.0 (2020-06-23)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.38.0 (2020-06-12)
+------------------
+
+* Feature - The following parameters now return the organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets: the OrganizationalUnitIds parameter on StackSet and the OrganizationalUnitId parameter on StackInstance, StackInstanceSummary, and StackSetOperationResultSummary
+
+1.37.1 (2020-06-11)
+------------------
+
+* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
+
+1.37.0 (2020-06-10)
+------------------
+
+* Issue - This version has been yanked. (#2327).
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.36.0 (2020-05-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.35.0 (2020-05-15)
+------------------
+
+* Feature - This release adds support for the following features: 1. DescribeType and ListTypeVersions APIs now output a field IsDefaultVersion, indicating if a version is the default version for its type; 2. Add StackRollbackComplete waiter feature to wait until stack status is UPDATE_ROLLBACK_COMPLETE; 3. Add paginators in DescribeAccountLimits, ListChangeSets, ListStackInstances, ListStackSetOperationResults, ListStackSetOperations, ListStackSets APIs.
+
+1.34.0 (2020-05-07)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.33.0 (2020-04-20)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.32.0 (2020-04-08)
+------------------
+
+* Feature - The OrganizationalUnitIds parameter on StackSet and the OrganizationalUnitId parameter on StackInstance, StackInstanceSummary, and StackSetOperationResultSummary are now reserved for internal use. No data is returned for this parameter.
+
+1.31.0 (2020-03-09)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.30.0 (2020-02-11)
+------------------
+
+* Feature - This release of AWS CloudFormation StackSets allows you to centrally manage deployments to all the accounts in your organization or specific organizational units (OUs) in AWS Organizations. You will also be able to enable automatic deployments to any new accounts added to your organization or OUs. The permissions needed to deploy across accounts will automatically be taken care of by the StackSets service.
+
+1.29.0 (2019-11-19)
+------------------
+
+* Feature - This release of AWS CloudFormation StackSets enables users to detect drift on a stack set and the stack instances that belong to that stack set.
+
+1.28.0 (2019-11-18)
+------------------
+
+* Feature - This release introduces APIs for the CloudFormation Registry, a new service to submit and discover resource providers with which you can manage third-party resources natively in CloudFormation.
+
+1.27.0 (2019-11-11)
+------------------
+
+* Feature - The Resource Import feature enables customers to import existing AWS resources into new or existing CloudFormation Stacks.
+
+1.26.0 (2019-10-23)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.25.0 (2019-07-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.24.0 (2019-07-01)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.23.0 (2019-06-17)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.22.0 (2019-05-21)
+------------------
+
+* Feature - API update.
+
+1.21.0 (2019-05-15)
+------------------
+
+* Feature - API update.
+
+1.20.0 (2019-05-14)
+------------------
+
+* Feature - API update.
+
+1.19.0 (2019-04-24)
+------------------
+
+* Feature - API update.
+
+1.18.0 (2019-03-22)
+------------------
+
+* Feature - API update.
+
+1.17.0 (2019-03-21)
+------------------
+
+* Feature - API update.
+
+1.16.0 (2019-03-18)
+------------------
+
+* Feature - API update.
+
+1.15.0 (2019-03-14)
+------------------
+
+* Feature - API update.
+
+1.14.0 (2018-12-14)
+------------------
+
+* Feature - API update.
+
+1.13.0 (2018-11-20)
+------------------
+
+* Feature - API update.
+
+1.12.0 (2018-11-19)
+------------------
+
+* Feature - API update.
+
+1.11.1 (2018-11-16)
+------------------
+
+* Issue - Update version dependency on `aws-sdk-core` to support endpoint discovery.
+
+1.11.0 (2018-11-12)
+------------------
+
+* Feature - API update.
+
+1.10.0 (2018-10-24)
+------------------
+
+* Feature - API update.
+
+1.9.0 (2018-10-23)
+------------------
+
+* Feature - API update.
+
+1.8.0 (2018-09-06)
+------------------
+
+* Feature - Adds code paths and plugins for future SDK instrumentation and telemetry.
+
+1.7.0 (2018-09-05)
+------------------
+
+* Feature - API update.
+
+1.6.0 (2018-06-26)
+------------------
+
+* Feature - API update.
+
+1.5.0 (2018-05-21)
+------------------
+
+* Feature - API update.
+
+1.4.0 (2018-03-29)
+------------------
+
+* Feature - API update.
+
+1.3.0 (2017-11-22)
+------------------
+
+* Feature - API update.
+
+1.2.0 (2017-09-26)
+------------------
+
+* Feature - API update.
+
+1.1.0 (2017-09-14)
+------------------
+
+* Feature - API update.
+
+* Issue - Update `aws-sdk-cloudformation` gemspec metadata.
+
+1.0.0 (2017-08-29)
+------------------
+
+1.0.0.rc13 (2017-08-25)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc12 (2017-08-15)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc11 (2017-08-01)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc10 (2017-07-25)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc9 (2017-07-13)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc8 (2017-07-06)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc7 (2017-06-29)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc6 (2017-05-23)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc5 (2017-05-09)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc4 (2017-05-09)
+------------------
+
+* Feature - API update.
+
+* Issue - Fix resource model load path
+
+1.0.0.rc3 (2017-05-05)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc2 (2017-04-21)
+------------------
+
+* Feature - API update.
+
+1.0.0.rc1 (2016-12-05)
+------------------
+
+* Feature - Initial preview release of the `aws-sdk-cloudformation` gem.
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/VERSION b/VERSION
new file mode 100644
index 0000000..71fae54
--- /dev/null
+++ b/VERSION
@@ -0,0 +1 @@
+1.82.0
diff --git a/aws-sdk-cloudformation.gemspec b/aws-sdk-cloudformation.gemspec
index c4fb34d..e5c240f 100644
--- a/aws-sdk-cloudformation.gemspec
+++ b/aws-sdk-cloudformation.gemspec
@@ -2,23 +2,24 @@
# This file has been automatically generated by gem2tgz #
#########################################################
# -*- encoding: utf-8 -*-
-# stub: aws-sdk-cloudformation 1.41.0 ruby lib
+# stub: aws-sdk-cloudformation 1.82.0 ruby lib
Gem::Specification.new do |s|
s.name = "aws-sdk-cloudformation".freeze
- s.version = "1.41.0"
+ s.version = "1.82.0"
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
- s.metadata = { "changelog_uri" => "https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-cloudformation/CHANGELOG.md", "source_code_uri" => "https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-cloudformation" } if s.respond_to? :metadata=
+ s.metadata = { "changelog_uri" => "https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-cloudformation/CHANGELOG.md", "source_code_uri" => "https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-cloudformation" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Amazon Web Services".freeze]
- s.date = "2020-07-02"
+ s.date = "2023-06-19"
s.description = "Official AWS Ruby gem for AWS CloudFormation. This gem is part of the AWS SDK for Ruby.".freeze
- s.email = ["trevrowe@amazon.com".freeze]
- s.files = ["lib/aws-sdk-cloudformation.rb".freeze, "lib/aws-sdk-cloudformation/client.rb".freeze, "lib/aws-sdk-cloudformation/client_api.rb".freeze, "lib/aws-sdk-cloudformation/customizations.rb".freeze, "lib/aws-sdk-cloudformation/errors.rb".freeze, "lib/aws-sdk-cloudformation/event.rb".freeze, "lib/aws-sdk-cloudformation/resource.rb".freeze, "lib/aws-sdk-cloudformation/stack.rb".freeze, "lib/aws-sdk-cloudformation/stack_resource.rb".freeze, "lib/aws-sdk-cloudformation/stack_resource_summary.rb".freeze, "lib/aws-sdk-cloudformation/types.rb".freeze, "lib/aws-sdk-cloudformation/waiters.rb".freeze]
+ s.email = ["aws-dr-rubygems@amazon.com".freeze]
+ s.files = ["CHANGELOG.md".freeze, "LICENSE.txt".freeze, "VERSION".freeze, "lib/aws-sdk-cloudformation.rb".freeze, "lib/aws-sdk-cloudformation/client.rb".freeze, "lib/aws-sdk-cloudformation/client_api.rb".freeze, "lib/aws-sdk-cloudformation/customizations.rb".freeze, "lib/aws-sdk-cloudformation/endpoint_parameters.rb".freeze, "lib/aws-sdk-cloudformation/endpoint_provider.rb".freeze, "lib/aws-sdk-cloudformation/endpoints.rb".freeze, "lib/aws-sdk-cloudformation/errors.rb".freeze, "lib/aws-sdk-cloudformation/event.rb".freeze, "lib/aws-sdk-cloudformation/plugins/endpoints.rb".freeze, "lib/aws-sdk-cloudformation/resource.rb".freeze, "lib/aws-sdk-cloudformation/stack.rb".freeze, "lib/aws-sdk-cloudformation/stack_resource.rb".freeze, "lib/aws-sdk-cloudformation/stack_resource_summary.rb".freeze, "lib/aws-sdk-cloudformation/types.rb".freeze, "lib/aws-sdk-cloudformation/waiters.rb".freeze]
s.homepage = "https://github.com/aws/aws-sdk-ruby".freeze
s.licenses = ["Apache-2.0".freeze]
- s.rubygems_version = "3.1.2".freeze
+ s.required_ruby_version = Gem::Requirement.new(">= 2.3".freeze)
+ s.rubygems_version = "3.2.5".freeze
s.summary = "AWS SDK for Ruby - AWS CloudFormation".freeze
if s.respond_to? :specification_version then
@@ -26,10 +27,10 @@ Gem::Specification.new do |s|
end
if s.respond_to? :add_runtime_dependency then
- s.add_runtime_dependency(%q<aws-sdk-core>.freeze, ["~> 3", ">= 3.99.0"])
+ s.add_runtime_dependency(%q<aws-sdk-core>.freeze, ["~> 3", ">= 3.174.0"])
s.add_runtime_dependency(%q<aws-sigv4>.freeze, ["~> 1.1"])
else
- s.add_dependency(%q<aws-sdk-core>.freeze, ["~> 3", ">= 3.99.0"])
+ s.add_dependency(%q<aws-sdk-core>.freeze, ["~> 3", ">= 3.174.0"])
s.add_dependency(%q<aws-sigv4>.freeze, ["~> 1.1"])
end
end
diff --git a/debian/changelog b/debian/changelog
index f409cf7..f0d8d02 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+ruby-aws-sdk-cloudformation (1.82.0-1) UNRELEASED; urgency=low
+
+ * New upstream release.
+ * New upstream release.
+
+ -- Debian Janitor <janitor@jelmer.uk> Tue, 20 Jun 2023 05:48:11 -0000
+
ruby-aws-sdk-cloudformation (1.41.0-2) unstable; urgency=medium
* Source only upload for testing migration
diff --git a/lib/aws-sdk-cloudformation.rb b/lib/aws-sdk-cloudformation.rb
index b71c6b6..2dbd997 100644
--- a/lib/aws-sdk-cloudformation.rb
+++ b/lib/aws-sdk-cloudformation.rb
@@ -3,19 +3,24 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
+
require 'aws-sdk-core'
require 'aws-sigv4'
require_relative 'aws-sdk-cloudformation/types'
require_relative 'aws-sdk-cloudformation/client_api'
+require_relative 'aws-sdk-cloudformation/plugins/endpoints.rb'
require_relative 'aws-sdk-cloudformation/client'
require_relative 'aws-sdk-cloudformation/errors'
require_relative 'aws-sdk-cloudformation/waiters'
require_relative 'aws-sdk-cloudformation/resource'
+require_relative 'aws-sdk-cloudformation/endpoint_parameters'
+require_relative 'aws-sdk-cloudformation/endpoint_provider'
+require_relative 'aws-sdk-cloudformation/endpoints'
require_relative 'aws-sdk-cloudformation/event'
require_relative 'aws-sdk-cloudformation/stack'
require_relative 'aws-sdk-cloudformation/stack_resource'
@@ -32,7 +37,7 @@ require_relative 'aws-sdk-cloudformation/customizations'
# structure.
#
# cloud_formation = Aws::CloudFormation::Client.new
-# resp = cloud_formation.cancel_update_stack(params)
+# resp = cloud_formation.activate_organizations_access(params)
#
# See {Client} for more information.
#
@@ -49,9 +54,9 @@ require_relative 'aws-sdk-cloudformation/customizations'
#
# See {Errors} for more information.
#
-# @service
+# @!group service
module Aws::CloudFormation
- GEM_VERSION = '1.41.0'
+ GEM_VERSION = '1.82.0'
end
diff --git a/lib/aws-sdk-cloudformation/client.rb b/lib/aws-sdk-cloudformation/client.rb
index 63c33b3..058f4ad 100644
--- a/lib/aws-sdk-cloudformation/client.rb
+++ b/lib/aws-sdk-cloudformation/client.rb
@@ -3,7 +3,7 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -27,7 +27,10 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
require 'aws-sdk-core/plugins/transfer_encoding.rb'
require 'aws-sdk-core/plugins/http_checksum.rb'
-require 'aws-sdk-core/plugins/signature_v4.rb'
+require 'aws-sdk-core/plugins/checksum_algorithm.rb'
+require 'aws-sdk-core/plugins/defaults_mode.rb'
+require 'aws-sdk-core/plugins/recursion_detection.rb'
+require 'aws-sdk-core/plugins/sign.rb'
require 'aws-sdk-core/plugins/protocols/query.rb'
Aws::Plugins::GlobalConfiguration.add_identifier(:cloudformation)
@@ -73,8 +76,12 @@ module Aws::CloudFormation
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
add_plugin(Aws::Plugins::TransferEncoding)
add_plugin(Aws::Plugins::HttpChecksum)
- add_plugin(Aws::Plugins::SignatureV4)
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
+ add_plugin(Aws::Plugins::DefaultsMode)
+ add_plugin(Aws::Plugins::RecursionDetection)
+ add_plugin(Aws::Plugins::Sign)
add_plugin(Aws::Plugins::Protocols::Query)
+ add_plugin(Aws::CloudFormation::Plugins::Endpoints)
# @overload initialize(options)
# @param [Hash] options
@@ -85,13 +92,28 @@ module Aws::CloudFormation
# * `Aws::Credentials` - Used for configuring static, non-refreshing
# credentials.
#
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
+ # shared file, such as `~/.aws/config`.
+ #
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+ #
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+ # assume a role after providing credentials via the web.
+ #
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+ # access token generated from `aws login`.
+ #
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
+ # process that outputs to stdout.
+ #
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
# from an EC2 IMDS on an EC2 instance.
#
- # * `Aws::SharedCredentials` - Used for loading credentials from a
- # shared file, such as `~/.aws/config`.
+ # * `Aws::ECSCredentials` - Used for loading credentials from
+ # instances running in ECS.
#
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+ # from the Cognito Identity service.
#
# When `:credentials` are not configured directly, the following
# locations will be searched for credentials:
@@ -101,10 +123,12 @@ module Aws::CloudFormation
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
# * `~/.aws/credentials`
# * `~/.aws/config`
- # * EC2 IMDS instance profile - When used by default, the timeouts are
- # very aggressive. Construct and pass an instance of
- # `Aws::InstanceProfileCredentails` to enable retries and extended
- # timeouts.
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
+ # are very aggressive. Construct and pass an instance of
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+ # enable retries and extended timeouts. Instance profile credential
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
+ # to true.
#
# @option options [required, String] :region
# The AWS region to connect to. The configured `:region` is
@@ -158,6 +182,10 @@ module Aws::CloudFormation
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
# a clock skew correction and retry requests with skewed client clocks.
#
+ # @option options [String] :defaults_mode ("legacy")
+ # See {Aws::DefaultsModeConfiguration} for a list of the
+ # accepted modes and the configuration defaults that are included.
+ #
# @option options [Boolean] :disable_host_prefix_injection (false)
# Set to true to disable SDK automatically adding host prefix
# to default service endpoint when available.
@@ -247,6 +275,11 @@ module Aws::CloudFormation
# in the future.
#
#
+ # @option options [String] :sdk_ua_app_id
+ # A unique and opaque application ID that is appended to the
+ # User-Agent header as app/<sdk_ua_app_id>. It should have a
+ # maximum length of 50.
+ #
# @option options [String] :secret_access_key
#
# @option options [String] :session_token
@@ -260,10 +293,35 @@ module Aws::CloudFormation
# ** Please note ** When response stubbing is enabled, no HTTP
# requests are made, and retries are disabled.
#
+ # @option options [Aws::TokenProvider] :token_provider
+ # A Bearer Token Provider. This can be an instance of any one of the
+ # following classes:
+ #
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
+ # tokens.
+ #
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
+ # access token generated from `aws login`.
+ #
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
+ # will be used to search for tokens configured for your profile in shared configuration files.
+ #
+ # @option options [Boolean] :use_dualstack_endpoint
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
+ # will be used if available.
+ #
+ # @option options [Boolean] :use_fips_endpoint
+ # When set to `true`, fips compatible endpoints will be used if available.
+ # When a `fips` region is used, the region is normalized and this config
+ # is set to `true`.
+ #
# @option options [Boolean] :validate_params (true)
# When `true`, request parameters are validated before
# sending the request.
#
+ # @option options [Aws::CloudFormation::EndpointProvider] :endpoint_provider
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::CloudFormation::EndpointParameters`
+ #
# @option options [URI::HTTP,String] :http_proxy A proxy to send
# requests through. Formatted like 'http://proxy.com:123'.
#
@@ -271,7 +329,7 @@ module Aws::CloudFormation
# seconds to wait when opening a HTTP session before raising a
# `Timeout::Error`.
#
- # @option options [Integer] :http_read_timeout (60) The default
+ # @option options [Float] :http_read_timeout (60) The default
# number of seconds to wait for response data. This value can
# safely be set per-request on the session.
#
@@ -287,6 +345,9 @@ module Aws::CloudFormation
# disables this behaviour. This value can safely be set per
# request on the session.
#
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
+ # in seconds.
+ #
# @option options [Boolean] :http_wire_trace (false) When `true`,
# HTTP debug output will be sent to the `:logger`.
#
@@ -312,23 +373,238 @@ module Aws::CloudFormation
# @!group API Operations
+ # Activate trusted access with Organizations. With trusted access
+ # between StackSets and Organizations activated, the management account
+ # has permissions to create and manage StackSets for your organization.
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateOrganizationsAccess AWS API Documentation
+ #
+ # @overload activate_organizations_access(params = {})
+ # @param [Hash] params ({})
+ def activate_organizations_access(params = {}, options = {})
+ req = build_request(:activate_organizations_access, params)
+ req.send_request(options)
+ end
+
+ # Activates a public third-party extension, making it available for use
+ # in stack templates. For more information, see [Using public
+ # extensions][1] in the *CloudFormation User Guide*.
+ #
+ # Once you have activated a public third-party extension in your account
+ # and Region, use [SetTypeConfiguration][2] to specify configuration
+ # properties for the extension. For more information, see [Configuring
+ # extensions at the account level][3] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
+ # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
+ #
+ # @option params [String] :type
+ # The extension type.
+ #
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`,
+ # and `PublisherId`.
+ #
+ # @option params [String] :public_type_arn
+ # The Amazon Resource Name (ARN) of the public extension.
+ #
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`,
+ # and `PublisherId`.
+ #
+ # @option params [String] :publisher_id
+ # The ID of the extension publisher.
+ #
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`,
+ # and `PublisherId`.
+ #
+ # @option params [String] :type_name
+ # The name of the extension.
+ #
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`,
+ # and `PublisherId`.
+ #
+ # @option params [String] :type_name_alias
+ # An alias to assign to the public extension, in this account and
+ # Region. If you specify an alias for the extension, CloudFormation
+ # treats the alias as the extension type name within this account and
+ # Region. You must use the alias to refer to the extension in your
+ # templates, API calls, and CloudFormation console.
+ #
+ # An extension alias must be unique within a given account and Region.
+ # You can activate the same public resource multiple times in the same
+ # account and Region, using different type name aliases.
+ #
+ # @option params [Boolean] :auto_update
+ # Whether to automatically update the extension in this account and
+ # Region when a new *minor* version is published by the extension
+ # publisher. Major versions released by the publisher must be manually
+ # updated.
+ #
+ # The default is `true`.
+ #
+ # @option params [Types::LoggingConfig] :logging_config
+ # Contains logging configuration information for an extension.
+ #
+ # @option params [String] :execution_role_arn
+ # The name of the IAM execution role to use to activate the extension.
+ #
+ # @option params [String] :version_bump
+ # Manually updates a previously-activated type to a new major or minor
+ # version, if available. You can also use this parameter to update the
+ # value of `AutoUpdate`.
+ #
+ # * `MAJOR`: CloudFormation updates the extension to the newest major
+ # version, if one is available.
+ #
+ # * `MINOR`: CloudFormation updates the extension to the newest minor
+ # version, if one is available.
+ #
+ # @option params [Integer] :major_version
+ # The major version of this extension you want to activate, if multiple
+ # major versions are available. The default is the latest major version.
+ # CloudFormation uses the latest available *minor* version of the major
+ # version selected.
+ #
+ # You can specify `MajorVersion` or `VersionBump`, but not both.
+ #
+ # @return [Types::ActivateTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ActivateTypeOutput#arn #arn} => String
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.activate_type({
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
+ # public_type_arn: "ThirdPartyTypeArn",
+ # publisher_id: "PublisherId",
+ # type_name: "TypeName",
+ # type_name_alias: "TypeName",
+ # auto_update: false,
+ # logging_config: {
+ # log_role_arn: "RoleArn", # required
+ # log_group_name: "LogGroupName", # required
+ # },
+ # execution_role_arn: "RoleArn",
+ # version_bump: "MAJOR", # accepts MAJOR, MINOR
+ # major_version: 1,
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.arn #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateType AWS API Documentation
+ #
+ # @overload activate_type(params = {})
+ # @param [Hash] params ({})
+ def activate_type(params = {}, options = {})
+ req = build_request(:activate_type, params)
+ req.send_request(options)
+ end
+
+ # Returns configuration data for the specified CloudFormation
+ # extensions, from the CloudFormation registry for the account and
+ # Region.
+ #
+ # For more information, see [Configuring extensions at the account
+ # level][1] in the *CloudFormation User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
+ #
+ # @option params [required, Array<Types::TypeConfigurationIdentifier>] :type_configuration_identifiers
+ # The list of identifiers for the desired extension configurations.
+ #
+ # @return [Types::BatchDescribeTypeConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::BatchDescribeTypeConfigurationsOutput#errors #errors} => Array<Types::BatchDescribeTypeConfigurationsError>
+ # * {Types::BatchDescribeTypeConfigurationsOutput#unprocessed_type_configurations #unprocessed_type_configurations} => Array<Types::TypeConfigurationIdentifier>
+ # * {Types::BatchDescribeTypeConfigurationsOutput#type_configurations #type_configurations} => Array<Types::TypeConfigurationDetails>
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.batch_describe_type_configurations({
+ # type_configuration_identifiers: [ # required
+ # {
+ # type_arn: "TypeArn",
+ # type_configuration_alias: "TypeConfigurationAlias",
+ # type_configuration_arn: "TypeConfigurationArn",
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
+ # type_name: "TypeName",
+ # },
+ # ],
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.errors #=> Array
+ # resp.errors[0].error_code #=> String
+ # resp.errors[0].error_message #=> String
+ # resp.errors[0].type_configuration_identifier.type_arn #=> String
+ # resp.errors[0].type_configuration_identifier.type_configuration_alias #=> String
+ # resp.errors[0].type_configuration_identifier.type_configuration_arn #=> String
+ # resp.errors[0].type_configuration_identifier.type #=> String, one of "RESOURCE", "MODULE", "HOOK"
+ # resp.errors[0].type_configuration_identifier.type_name #=> String
+ # resp.unprocessed_type_configurations #=> Array
+ # resp.unprocessed_type_configurations[0].type_arn #=> String
+ # resp.unprocessed_type_configurations[0].type_configuration_alias #=> String
+ # resp.unprocessed_type_configurations[0].type_configuration_arn #=> String
+ # resp.unprocessed_type_configurations[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
+ # resp.unprocessed_type_configurations[0].type_name #=> String
+ # resp.type_configurations #=> Array
+ # resp.type_configurations[0].arn #=> String
+ # resp.type_configurations[0].alias #=> String
+ # resp.type_configurations[0].configuration #=> String
+ # resp.type_configurations[0].last_updated #=> Time
+ # resp.type_configurations[0].type_arn #=> String
+ # resp.type_configurations[0].type_name #=> String
+ # resp.type_configurations[0].is_default_configuration #=> Boolean
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurations AWS API Documentation
+ #
+ # @overload batch_describe_type_configurations(params = {})
+ # @param [Hash] params ({})
+ def batch_describe_type_configurations(params = {}, options = {})
+ req = build_request(:batch_describe_type_configurations, params)
+ req.send_request(options)
+ end
+
# Cancels an update on the specified stack. If the call completes
# successfully, the stack rolls back the update and reverts to the
# previous stack configuration.
#
- # <note markdown="1"> You can cancel only stacks that are in the UPDATE\_IN\_PROGRESS state.
+ # <note markdown="1"> You can cancel only stacks that are in the `UPDATE_IN_PROGRESS` state.
#
# </note>
#
# @option params [required, String] :stack_name
- # The name or the unique stack ID that is associated with the stack.
+ # <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
+ # response that describes all resources in the account.
+ #
+ # The IAM policy below can be added to IAM policies when you want to
+ # limit resource-level permissions and avoid returning a response when
+ # no parameter is sent in the request:
+ #
+ # `\{ "Version": "2012-10-17", "Statement": [\{ "Effect": "Deny",
+ # "Action": "cloudformation:DescribeStacks", "NotResource":
+ # "arn:aws:cloudformation:*:*:stack/*/*" \}] \}`
+ #
+ # </note>
+ #
+ # The name or the unique stack ID that's associated with the stack.
#
# @option params [String] :client_request_token
# A unique identifier for this `CancelUpdateStack` request. Specify this
- # token if you plan to retry requests so that AWS CloudFormation knows
- # that you're not attempting to cancel an update on a stack with the
- # same name. You might retry `CancelUpdateStack` requests to ensure that
- # AWS CloudFormation successfully received them.
+ # token if you plan to retry requests so that CloudFormation knows that
+ # you're not attempting to cancel an update on a stack with the same
+ # name. You might retry `CancelUpdateStack` requests to ensure that
+ # CloudFormation successfully received them.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -348,7 +624,7 @@ module Aws::CloudFormation
req.send_request(options)
end
- # For a specified stack that is in the `UPDATE_ROLLBACK_FAILED` state,
+ # For a specified stack that's in the `UPDATE_ROLLBACK_FAILED` state,
# continues rolling it back to the `UPDATE_ROLLBACK_COMPLETE` state.
# Depending on the cause of the failure, you can manually [ fix the
# error][1] and continue the rollback. By continuing the rollback, you
@@ -356,11 +632,11 @@ module Aws::CloudFormation
# `UPDATE_ROLLBACK_COMPLETE` state), and then try to update the stack
# again.
#
- # A stack goes into the `UPDATE_ROLLBACK_FAILED` state when AWS
- # CloudFormation cannot roll back all changes after a failed stack
- # update. For example, you might have a stack that is rolling back to an
- # old database instance that was deleted outside of AWS CloudFormation.
- # Because AWS CloudFormation doesn't know the database was deleted, it
+ # A stack goes into the `UPDATE_ROLLBACK_FAILED` state when
+ # CloudFormation can't roll back all changes after a failed stack
+ # update. For example, you might have a stack that's rolling back to an
+ # old database instance that was deleted outside of CloudFormation.
+ # Because CloudFormation doesn't know the database was deleted, it
# assumes that the database instance still exists and attempts to roll
# back to it, causing the update rollback to fail.
#
@@ -380,33 +656,32 @@ module Aws::CloudFormation
# </note>
#
# @option params [String] :role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to roll back the
- # stack. AWS CloudFormation uses the role's credentials to make calls
- # on your behalf. AWS CloudFormation always uses this role for all
- # future operations on the stack. As long as users have permission to
- # operate on the stack, AWS CloudFormation uses this role even if the
- # users don't have permission to pass it. Ensure that the role grants
- # least privilege.
- #
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available, AWS
- # CloudFormation uses a temporary session that is generated from your
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to roll back the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf. CloudFormation always uses this role for all future operations
+ # on the stack. Provided that users have permission to operate on the
+ # stack, CloudFormation uses this role even if the users don't have
+ # permission to pass it. Ensure that the role grants least permission.
+ #
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
+ # CloudFormation uses a temporary session that's generated from your
# user credentials.
#
# @option params [Array<String>] :resources_to_skip
- # A list of the logical IDs of the resources that AWS CloudFormation
- # skips during the continue update rollback operation. You can specify
- # only resources that are in the `UPDATE_FAILED` state because a
- # rollback failed. You can't specify resources that are in the
- # `UPDATE_FAILED` state for other reasons, for example, because an
- # update was cancelled. To check why a resource update failed, use the
- # DescribeStackResources action, and view the resource status reason.
- #
- # Specify this property to skip rolling back resources that AWS
+ # A list of the logical IDs of the resources that CloudFormation skips
+ # during the continue update rollback operation. You can specify only
+ # resources that are in the `UPDATE_FAILED` state because a rollback
+ # failed. You can't specify resources that are in the `UPDATE_FAILED`
+ # state for other reasons, for example, because an update was canceled.
+ # To check why a resource update failed, use the DescribeStackResources
+ # action, and view the resource status reason.
+ #
+ # Specify this property to skip rolling back resources that
# CloudFormation can't successfully roll back. We recommend that you [
- # troubleshoot][1] resources before skipping them. AWS CloudFormation
- # sets the status of the specified resources to `UPDATE_COMPLETE` and
+ # troubleshoot][1] resources before skipping them. CloudFormation sets
+ # the status of the specified resources to `UPDATE_COMPLETE` and
# continues to roll back the stack. After the rollback is complete, the
# state of the skipped resources will be inconsistent with the state of
# the resources in the stack template. Before performing another stack
@@ -440,10 +715,10 @@ module Aws::CloudFormation
#
# @option params [String] :client_request_token
# A unique identifier for this `ContinueUpdateRollback` request. Specify
- # this token if you plan to retry requests so that AWS CloudFormation
- # knows that you're not attempting to continue the rollback to a stack
- # with the same name. You might retry `ContinueUpdateRollback` requests
- # to ensure that AWS CloudFormation successfully received them.
+ # this token if you plan to retry requests so that CloudFormation knows
+ # that you're not attempting to continue the rollback to a stack with
+ # the same name. You might retry `ContinueUpdateRollback` requests to
+ # ensure that CloudFormation successfully received them.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -469,36 +744,39 @@ module Aws::CloudFormation
# can review the changes before executing them. You can create a change
# set for a stack that doesn't exist or an existing stack. If you
# create a change set for a stack that doesn't exist, the change set
- # shows all of the resources that AWS CloudFormation will create. If you
- # create a change set for an existing stack, AWS CloudFormation compares
- # the stack's information with the information that you submit in the
+ # shows all of the resources that CloudFormation will create. If you
+ # create a change set for an existing stack, CloudFormation compares the
+ # stack's information with the information that you submit in the
# change set and lists the differences. Use change sets to understand
- # which resources AWS CloudFormation will create or change, and how it
- # will change resources in an existing stack, before you create or
- # update a stack.
+ # which resources CloudFormation will create or change, and how it will
+ # change resources in an existing stack, before you create or update a
+ # stack.
#
# To create a change set for a stack that doesn't exist, for the
# `ChangeSetType` parameter, specify `CREATE`. To create a change set
# for an existing stack, specify `UPDATE` for the `ChangeSetType`
# parameter. To create a change set for an import operation, specify
# `IMPORT` for the `ChangeSetType` parameter. After the
- # `CreateChangeSet` call successfully completes, AWS CloudFormation
- # starts creating the change set. To check the status of the change set
- # or to review it, use the DescribeChangeSet action.
+ # `CreateChangeSet` call successfully completes, CloudFormation starts
+ # creating the change set. To check the status of the change set or to
+ # review it, use the DescribeChangeSet action.
#
# When you are satisfied with the changes the change set will make,
- # execute the change set by using the ExecuteChangeSet action. AWS
+ # execute the change set by using the ExecuteChangeSet action.
# CloudFormation doesn't make changes until you execute the change set.
#
+ # To create a change set for the entire stack hierarchy, set
+ # `IncludeNestedStacks` to `True`.
+ #
# @option params [required, String] :stack_name
# The name or the unique ID of the stack for which you are creating a
- # change set. AWS CloudFormation generates the change set by comparing
- # this stack's information with the information that you submit, such
- # as a modified template or different parameter input values.
+ # change set. CloudFormation generates the change set by comparing this
+ # stack's information with the information that you submit, such as a
+ # modified template or different parameter input values.
#
# @option params [String] :template_body
# A structure that contains the body of the revised template, with a
- # minimum length of 1 byte and a maximum length of 51,200 bytes. AWS
+ # minimum length of 1 byte and a maximum length of 51,200 bytes.
# CloudFormation generates the change set by comparing this template
# with the template of the stack that you specified.
#
@@ -506,14 +784,15 @@ module Aws::CloudFormation
#
# @option params [String] :template_url
# The location of the file that contains the revised template. The URL
- # must point to a template (max size: 460,800 bytes) that is located in
- # an S3 bucket. AWS CloudFormation generates the change set by comparing
- # this template with the stack that you specified.
+ # must point to a template (max size: 460,800 bytes) that's located in
+ # an Amazon S3 bucket or a Systems Manager document. CloudFormation
+ # generates the change set by comparing this template with the stack
+ # that you specified.
#
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
#
# @option params [Boolean] :use_previous_template
- # Whether to reuse the template that is associated with the stack to
+ # Whether to reuse the template that's associated with the stack to
# create the change set.
#
# @option params [Array<Types::Parameter>] :parameters
@@ -522,16 +801,16 @@ module Aws::CloudFormation
#
# @option params [Array<String>] :capabilities
# In some cases, you must explicitly acknowledge that your stack
- # template contains certain capabilities in order for AWS CloudFormation
- # to create the stack.
+ # template contains certain capabilities in order for CloudFormation to
+ # create the stack.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stacks, you
- # must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stacks, you must explicitly acknowledge this by specifying one of
+ # these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -541,18 +820,18 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
- # CloudFormation returns an `InsufficientCapabilities` error.
+ # * If you don't specify either of these capabilities, CloudFormation
+ # returns an `InsufficientCapabilities` error.
#
- # If your stack template contains these resources, we recommend that
- # you review all permissions associated with them and edit their
+ # If your stack template contains these resources, we suggest that you
+ # review all permissions associated with them and edit their
# permissions if necessary.
#
# * [ AWS::IAM::AccessKey][1]
#
# * [ AWS::IAM::Group][2]
#
- # * [ AWS::IAM::InstanceProfile][3]
+ # * [AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
@@ -560,10 +839,10 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::User][6]
#
- # * [ AWS::IAM::UserToGroupAddition][7]
+ # * [AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
- # CloudFormation Templates][8].
+ # For more information, see [Acknowledging IAM resources in
+ # CloudFormation templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
#
@@ -577,22 +856,21 @@ module Aws::CloudFormation
# create a stack directly from the processed template, without first
# reviewing the resulting changes in a change set, you must
# acknowledge this capability. This includes the [AWS::Include][9] and
- # [AWS::Serverless][10] transforms, which are macros hosted by AWS
+ # [AWS::Serverless][10] transforms, which are macros hosted by
# CloudFormation.
#
- # <note markdown="1"> This capacity does not apply to creating change sets, and specifying
+ # <note markdown="1"> This capacity doesn't apply to creating change sets, and specifying
# it when creating change sets has no effect.
#
- # Also, change sets do not currently support nested stacks. If you
- # want to create a stack from a stack template that contains macros
- # *and* nested stacks, you must create or update the stack directly
- # from the template using the CreateStack or UpdateStack action, and
- # specifying this capability.
+ # If you want to create a stack from a stack template that contains
+ # macros *and* nested stacks, you must create or update the stack
+ # directly from the template using the CreateStack or UpdateStack
+ # action, and specifying this capability.
#
# </note>
#
- # For more information on macros, see [Using AWS CloudFormation Macros
- # to Perform Custom Processing on Templates][11].
+ # For more information about macros, see [Using CloudFormation macros
+ # to perform custom processing on templates][11].
#
#
#
@@ -614,44 +892,43 @@ module Aws::CloudFormation
# `AWS::EC2::*`, or `Custom::MyCustomInstance`.
#
# If the list of resource types doesn't include a resource type that
- # you're updating, the stack update fails. By default, AWS
- # CloudFormation grants permissions to all resource types. AWS Identity
- # and Access Management (IAM) uses this parameter for condition keys in
- # IAM policies for AWS CloudFormation. For more information, see
- # [Controlling Access with AWS Identity and Access Management][1] in the
- # AWS CloudFormation User Guide.
+ # you're updating, the stack update fails. By default, CloudFormation
+ # grants permissions to all resource types. Identity and Access
+ # Management (IAM) uses this parameter for condition keys in IAM
+ # policies for CloudFormation. For more information, see [Controlling
+ # access with Identity and Access Management][1] in the CloudFormation
+ # User Guide.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
#
# @option params [String] :role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes when executing
- # the change set. AWS CloudFormation uses the role's credentials to
- # make calls on your behalf. AWS CloudFormation uses this role for all
- # future operations on the stack. As long as users have permission to
- # operate on the stack, AWS CloudFormation uses this role even if the
- # users don't have permission to pass it. Ensure that the role grants
- # least privilege.
- #
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available, AWS
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes when executing the change set.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf. CloudFormation uses this role for all future operations on the
+ # stack. Provided that users have permission to operate on the stack,
+ # CloudFormation uses this role even if the users don't have permission
+ # to pass it. Ensure that the role grants least permission.
+ #
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
# CloudFormation uses a temporary session that is generated from your
# user credentials.
#
# @option params [Types::RollbackConfiguration] :rollback_configuration
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
#
# @option params [Array<String>] :notification_arns
# The Amazon Resource Names (ARNs) of Amazon Simple Notification Service
- # (Amazon SNS) topics that AWS CloudFormation associates with the stack.
- # To remove all associated notification topics, specify an empty list.
+ # (Amazon SNS) topics that CloudFormation associates with the stack. To
+ # remove all associated notification topics, specify an empty list.
#
# @option params [Array<Types::Tag>] :tags
- # Key-value pairs to associate with this stack. AWS CloudFormation also
+ # Key-value pairs to associate with this stack. CloudFormation also
# propagates these tags to resources in the stack. You can specify a
# maximum of 50 tags.
#
@@ -660,14 +937,14 @@ module Aws::CloudFormation
# sets that are associated with the specified stack.
#
# A change set name can contain only alphanumeric, case sensitive
- # characters and hyphens. It must start with an alphabetic character and
- # cannot exceed 128 characters.
+ # characters, and hyphens. It must start with an alphabetical character
+ # and can't exceed 128 characters.
#
# @option params [String] :client_token
# A unique identifier for this `CreateChangeSet` request. Specify this
- # token if you plan to retry requests so that AWS CloudFormation knows
- # that you're not attempting to create another change set with the same
- # name. You might retry `CreateChangeSet` requests to ensure that AWS
+ # token if you plan to retry requests so that CloudFormation knows that
+ # you're not attempting to create another change set with the same
+ # name. You might retry `CreateChangeSet` requests to ensure that
# CloudFormation successfully received them.
#
# @option params [String] :description
@@ -679,12 +956,12 @@ module Aws::CloudFormation
# specify `UPDATE`. To create a change set for an import operation,
# specify `IMPORT`.
#
- # If you create a change set for a new stack, AWS Cloudformation creates
- # a stack with a unique stack ID, but no template or resources. The
- # stack will be in the [ `REVIEW_IN_PROGRESS` ][1] state until you
- # execute the change set.
+ # If you create a change set for a new stack, CloudFormation creates a
+ # stack with a unique stack ID, but no template or resources. The stack
+ # will be in the [REVIEW\_IN\_PROGRESS][1] state until you execute the
+ # change set.
#
- # By default, AWS CloudFormation specifies `UPDATE`. You can't use the
+ # By default, CloudFormation specifies `UPDATE`. You can't use the
# `UPDATE` type to create a change set for a new stack or the `CREATE`
# type to create a change set for an existing stack.
#
@@ -695,6 +972,39 @@ module Aws::CloudFormation
# @option params [Array<Types::ResourceToImport>] :resources_to_import
# The resources to import into your stack.
#
+ # @option params [Boolean] :include_nested_stacks
+ # Creates a change set for the all nested stacks specified in the
+ # template. The default behavior of this action is set to `False`. To
+ # include nested sets in a change set, specify `True`.
+ #
+ # @option params [String] :on_stack_failure
+ # Determines what action will be taken if stack creation fails. If this
+ # parameter is specified, the `DisableRollback` parameter to the
+ # [ExecuteChangeSet][1] API operation must not be specified. This must
+ # be one of these values:
+ #
+ # * `DELETE` - Deletes the change set if the stack creation fails. This
+ # is only valid when the `ChangeSetType` parameter is set to `CREATE`.
+ # If the deletion of the stack fails, the status of the stack is
+ # `DELETE_FAILED`.
+ #
+ # * `DO_NOTHING` - if the stack creation fails, do nothing. This is
+ # equivalent to specifying `true` for the `DisableRollback` parameter
+ # to the [ExecuteChangeSet][1] API operation.
+ #
+ # * `ROLLBACK` - if the stack creation fails, roll back the stack. This
+ # is equivalent to specifying `false` for the `DisableRollback`
+ # parameter to the [ExecuteChangeSet][1] API operation.
+ #
+ # For nested stacks, when the `OnStackFailure` parameter is set to
+ # `DELETE` for the change set for the parent stack, any failure in a
+ # child stack will cause the parent stack creation to fail and all
+ # stacks to be deleted.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html
+ #
# @return [Types::CreateChangeSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateChangeSetOutput#id #id} => String
@@ -747,6 +1057,8 @@ module Aws::CloudFormation
# },
# },
# ],
+ # include_nested_stacks: false,
+ # on_stack_failure: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK, DELETE
# })
#
# @example Response structure
@@ -765,22 +1077,22 @@ module Aws::CloudFormation
# Creates a stack as specified in the template. After the call completes
# successfully, the stack creation starts. You can check the status of
- # the stack via the DescribeStacks API.
+ # the stack through the DescribeStacks operation.
#
# @option params [required, String] :stack_name
- # The name that is associated with the stack. The name must be unique in
+ # The name that's associated with the stack. The name must be unique in
# the Region in which you are creating the stack.
#
# <note markdown="1"> A stack name can contain only alphanumeric characters (case sensitive)
- # and hyphens. It must start with an alphabetic character and cannot be
- # longer than 128 characters.
+ # and hyphens. It must start with an alphabetical character and can't
+ # be longer than 128 characters.
#
# </note>
#
# @option params [String] :template_body
# Structure containing the template body with a minimum length of 1 byte
# and a maximum length of 51,200 bytes. For more information, go to
- # [Template Anatomy][1] in the AWS CloudFormation User Guide.
+ # [Template anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify either the `TemplateBody` or the
# `TemplateURL` parameter, but not both.
@@ -791,9 +1103,9 @@ module Aws::CloudFormation
#
# @option params [String] :template_url
# Location of file containing the template body. The URL must point to a
- # template (max size: 460,800 bytes) that is located in an Amazon S3
- # bucket. For more information, go to the [Template Anatomy][1] in the
- # AWS CloudFormation User Guide.
+ # template (max size: 460,800 bytes) that's located in an Amazon S3
+ # bucket or a Systems Manager document. For more information, go to the
+ # [Template anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify either the `TemplateBody` or the
# `TemplateURL` parameter, but not both.
@@ -818,7 +1130,7 @@ module Aws::CloudFormation
# Default: `false`
#
# @option params [Types::RollbackConfiguration] :rollback_configuration
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
#
@@ -828,22 +1140,22 @@ module Aws::CloudFormation
# the stack will be rolled back.
#
# @option params [Array<String>] :notification_arns
- # The Simple Notification Service (SNS) topic ARNs to publish stack
- # related events. You can find your SNS topic ARNs using the SNS console
- # or your Command Line Interface (CLI).
+ # The Amazon Simple Notification Service (Amazon SNS) topic ARNs to
+ # publish stack related events. You can find your Amazon SNS topic ARNs
+ # using the Amazon SNS console or your Command Line Interface (CLI).
#
# @option params [Array<String>] :capabilities
# In some cases, you must explicitly acknowledge that your stack
- # template contains certain capabilities in order for AWS CloudFormation
- # to create the stack.
+ # template contains certain capabilities in order for CloudFormation to
+ # create the stack.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stacks, you
- # must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stacks, you must explicitly acknowledge this by specifying one of
+ # these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -853,8 +1165,8 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
- # CloudFormation returns an `InsufficientCapabilities` error.
+ # * If you don't specify either of these capabilities, CloudFormation
+ # returns an `InsufficientCapabilities` error.
#
# If your stack template contains these resources, we recommend that
# you review all permissions associated with them and edit their
@@ -864,7 +1176,7 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::Group][2]
#
- # * [ AWS::IAM::InstanceProfile][3]
+ # * [AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
@@ -872,9 +1184,9 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::User][6]
#
- # * [ AWS::IAM::UserToGroupAddition][7]
+ # * [AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
@@ -889,24 +1201,23 @@ module Aws::CloudFormation
# create a stack directly from the processed template, without first
# reviewing the resulting changes in a change set, you must
# acknowledge this capability. This includes the [AWS::Include][9] and
- # [AWS::Serverless][10] transforms, which are macros hosted by AWS
+ # [AWS::Serverless][10] transforms, which are macros hosted by
# CloudFormation.
#
- # Change sets do not currently support nested stacks. If you want to
- # create a stack from a stack template that contains macros *and*
- # nested stacks, you must create the stack directly from the template
- # using this capability.
+ # If you want to create a stack from a stack template that contains
+ # macros *and* nested stacks, you must create the stack directly from
+ # the template using this capability.
#
# You should only create stacks directly from a stack template that
# contains macros if you know what processing the macro performs.
#
# Each macro relies on an underlying Lambda service function for
# processing stack templates. Be aware that the Lambda function owner
- # can update the function operation without AWS CloudFormation being
+ # can update the function operation without CloudFormation being
# notified.
#
- # For more information, see [Using AWS CloudFormation Macros to
- # Perform Custom Processing on Templates][11].
+ # For more information, see [Using CloudFormation macros to perform
+ # custom processing on templates][11].
#
#
#
@@ -926,48 +1237,48 @@ module Aws::CloudFormation
# The template resource types that you have permissions to work with for
# this create stack action, such as `AWS::EC2::Instance`, `AWS::EC2::*`,
# or `Custom::MyCustomInstance`. Use the following syntax to describe
- # template resource types: `AWS::*` (for all AWS resource), `Custom::*`
- # (for all custom resources), `Custom::logical_ID ` (for a specific
- # custom resource), `AWS::service_name::*` (for all resources of a
- # particular AWS service), and `AWS::service_name::resource_logical_ID `
- # (for a specific AWS resource).
+ # template resource types: `AWS::*` (for all Amazon Web Services
+ # resources), `Custom::*` (for all custom resources),
+ # `Custom::logical_ID ` (for a specific custom resource),
+ # `AWS::service_name::*` (for all resources of a particular Amazon Web
+ # Services service), and `AWS::service_name::resource_logical_ID ` (for
+ # a specific Amazon Web Services resource).
#
# If the list of resource types doesn't include a resource that you're
- # creating, the stack creation fails. By default, AWS CloudFormation
- # grants permissions to all resource types. AWS Identity and Access
- # Management (IAM) uses this parameter for AWS CloudFormation-specific
- # condition keys in IAM policies. For more information, see [Controlling
- # Access with AWS Identity and Access Management][1].
+ # creating, the stack creation fails. By default, CloudFormation grants
+ # permissions to all resource types. Identity and Access Management
+ # (IAM) uses this parameter for CloudFormation-specific condition keys
+ # in IAM policies. For more information, see [Controlling Access with
+ # Identity and Access Management][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
#
# @option params [String] :role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to create the
- # stack. AWS CloudFormation uses the role's credentials to make calls
- # on your behalf. AWS CloudFormation always uses this role for all
- # future operations on the stack. As long as users have permission to
- # operate on the stack, AWS CloudFormation uses this role even if the
- # users don't have permission to pass it. Ensure that the role grants
- # least privilege.
- #
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available, AWS
- # CloudFormation uses a temporary session that is generated from your
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to create the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf. CloudFormation always uses this role for all future operations
+ # on the stack. Provided that users have permission to operate on the
+ # stack, CloudFormation uses this role even if the users don't have
+ # permission to pass it. Ensure that the role grants least privilege.
+ #
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
+ # CloudFormation uses a temporary session that's generated from your
# user credentials.
#
# @option params [String] :on_failure
# Determines what action will be taken if stack creation fails. This
- # must be one of: DO\_NOTHING, ROLLBACK, or DELETE. You can specify
+ # must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify
# either `OnFailure` or `DisableRollback`, but not both.
#
# Default: `ROLLBACK`
#
# @option params [String] :stack_policy_body
# Structure containing the stack policy body. For more information, go
- # to [ Prevent Updates to Stack Resources][1] in the *AWS CloudFormation
+ # to [ Prevent Updates to Stack Resources][1] in the *CloudFormation
# User Guide*. You can specify either the `StackPolicyBody` or the
# `StackPolicyURL` parameter, but not both.
#
@@ -982,18 +1293,18 @@ module Aws::CloudFormation
# the `StackPolicyURL` parameter, but not both.
#
# @option params [Array<Types::Tag>] :tags
- # Key-value pairs to associate with this stack. AWS CloudFormation also
+ # Key-value pairs to associate with this stack. CloudFormation also
# propagates these tags to the resources created in the stack. A maximum
# number of 50 tags can be specified.
#
# @option params [String] :client_request_token
# A unique identifier for this `CreateStack` request. Specify this token
- # if you plan to retry requests so that AWS CloudFormation knows that
+ # if you plan to retry requests so that CloudFormation knows that
# you're not attempting to create a stack with the same name. You might
- # retry `CreateStack` requests to ensure that AWS CloudFormation
+ # retry `CreateStack` requests to ensure that CloudFormation
# successfully received them.
#
- # All events triggered by a given stack operation are assigned the same
+ # All events initiated by a given stack operation are assigned the same
# client request token, which you can use to track operations. For
# example, if you execute a `CreateStack` operation with the token
# `token1`, then all the `StackEvents` generated by that operation will
@@ -1012,11 +1323,11 @@ module Aws::CloudFormation
# user attempts to delete a stack with termination protection enabled,
# the operation fails and the stack remains unchanged. For more
# information, see [Protecting a Stack From Being Deleted][1] in the
- # *AWS CloudFormation User Guide*. Termination protection is disabled on
+ # *CloudFormation User Guide*. Termination protection is deactivated on
# stacks by default.
#
# For [nested stacks][2], termination protection is set on the root
- # stack and cannot be changed directly on the nested stack.
+ # stack and can't be changed directly on the nested stack.
#
#
#
@@ -1083,62 +1394,59 @@ module Aws::CloudFormation
end
# Creates stack instances for the specified accounts, within the
- # specified Regions. A stack instance refers to a stack in a specific
- # account and Region. You must specify at least one value for either
- # `Accounts` or `DeploymentTargets`, and you must specify at least one
- # value for `Regions`.
+ # specified Amazon Web Services Regions. A stack instance refers to a
+ # stack in a specific account and Region. You must specify at least one
+ # value for either `Accounts` or `DeploymentTargets`, and you must
+ # specify at least one value for `Regions`.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you want to create stack
# instances from.
#
# @option params [Array<String>] :accounts
- # \[`Self-managed` permissions\] The names of one or more AWS accounts
- # that you want to create stack instances in the specified Region(s)
- # for.
+ # \[Self-managed permissions\] The names of one or more Amazon Web
+ # Services accounts that you want to create stack instances in the
+ # specified Region(s) for.
#
# You can specify `Accounts` or `DeploymentTargets`, but not both.
#
# @option params [Types::DeploymentTargets] :deployment_targets
- # \[`Service-managed` permissions\] The AWS Organizations accounts for
- # which to create stack instances in the specified Regions.
+ # \[Service-managed permissions\] The Organizations accounts for which
+ # to create stack instances in the specified Amazon Web Services
+ # Regions.
#
# You can specify `Accounts` or `DeploymentTargets`, but not both.
#
# @option params [required, Array<String>] :regions
- # The names of one or more Regions where you want to create stack
- # instances using the specified AWS account(s).
+ # The names of one or more Amazon Web Services Regions where you want to
+ # create stack instances using the specified Amazon Web Services
+ # accounts.
#
# @option params [Array<Types::Parameter>] :parameter_overrides
# A list of stack set parameters whose values you want to override in
# the selected stack instances.
#
# Any overridden parameter values will be applied to all stack instances
- # in the specified accounts and Regions. When specifying parameters and
- # their values, be aware of how AWS CloudFormation sets parameter values
- # during stack instance operations:
+ # in the specified accounts and Amazon Web Services Regions. When
+ # specifying parameters and their values, be aware of how CloudFormation
+ # sets parameter values during stack instance operations:
#
# * To override the current value for a parameter, include the parameter
# and specify its value.
#
- # * To leave a parameter set to its present value, you can do one of the
- # following:
+ # * To leave an overridden parameter set to its present value, include
+ # the parameter and specify `UsePreviousValue` as `true`. (You can't
+ # specify both a value and set `UsePreviousValue` to `true`.)
#
- # * Do not include the parameter in the list.
+ # * To set an overridden parameter back to the value specified in the
+ # stack set, specify a parameter list but don't include the parameter
+ # in the list.
#
- # * Include the parameter and specify `UsePreviousValue` as `true`.
- # (You cannot specify both a value and set `UsePreviousValue` to
- # `true`.)
- #
- # * To set all overridden parameter back to the values specified in the
- # stack set, specify a parameter list but do not include any
- # parameters.
- #
- # * To leave all parameters set to their present values, do not specify
+ # * To leave all parameters set to their present values, don't specify
# this property at all.
#
# During stack set updates, any parameter values overridden for a stack
- # instance are not updated, but retain their overridden value.
+ # instance aren't updated, but retain their overridden value.
#
# You can only override the parameter *values* that are specified in the
# stack set; to add or delete a parameter itself, use
@@ -1149,17 +1457,16 @@ module Aws::CloudFormation
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
#
# @option params [Types::StackSetOperationPreferences] :operation_preferences
- # Preferences for how AWS CloudFormation performs this stack set
- # operation.
+ # Preferences for how CloudFormation performs this stack set operation.
#
# @option params [String] :operation_id
# The unique identifier for this stack set operation.
#
# The operation ID also functions as an idempotency token, to ensure
- # that AWS CloudFormation performs the stack set operation only once,
- # even if you retry the request multiple times. You might retry stack
- # set operation requests to ensure that AWS CloudFormation successfully
- # received them.
+ # that CloudFormation performs the stack set operation only once, even
+ # if you retry the request multiple times. You might retry stack set
+ # operation requests to ensure that CloudFormation successfully received
+ # them.
#
# If you don't specify an operation ID, the SDK generates one
# automatically.
@@ -1170,6 +1477,28 @@ module Aws::CloudFormation
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.**
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Types::CreateStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateStackInstancesOutput#operation_id #operation_id} => String
@@ -1181,7 +1510,9 @@ module Aws::CloudFormation
# accounts: ["Account"],
# deployment_targets: {
# accounts: ["Account"],
+ # accounts_url: "AccountsUrl",
# organizational_unit_ids: ["OrganizationalUnitId"],
+ # account_filter_type: "NONE", # accepts NONE, INTERSECTION, DIFFERENCE, UNION
# },
# regions: ["Region"], # required
# parameter_overrides: [
@@ -1193,6 +1524,7 @@ module Aws::CloudFormation
# },
# ],
# operation_preferences: {
+ # region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
# region_order: ["Region"],
# failure_tolerance_count: 1,
# failure_tolerance_percentage: 1,
@@ -1200,6 +1532,7 @@ module Aws::CloudFormation
# max_concurrent_percentage: 1,
# },
# operation_id: "ClientRequestToken",
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @example Response structure
@@ -1234,7 +1567,7 @@ module Aws::CloudFormation
# @option params [String] :template_body
# The structure that contains the template body, with a minimum length
# of 1 byte and a maximum length of 51,200 bytes. For more information,
- # see [Template Anatomy][1] in the AWS CloudFormation User Guide.
+ # see [Template Anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify either the TemplateBody or the
# TemplateURL parameter, but not both.
@@ -1246,8 +1579,9 @@ module Aws::CloudFormation
# @option params [String] :template_url
# The location of the file that contains the template body. The URL must
# point to a template (maximum size: 460,800 bytes) that's located in
- # an Amazon S3 bucket. For more information, see [Template Anatomy][1]
- # in the AWS CloudFormation User Guide.
+ # an Amazon S3 bucket or a Systems Manager document. For more
+ # information, see [Template Anatomy][1] in the CloudFormation User
+ # Guide.
#
# Conditional: You must specify either the TemplateBody or the
# TemplateURL parameter, but not both.
@@ -1256,21 +1590,25 @@ module Aws::CloudFormation
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
+ # @option params [String] :stack_id
+ # The stack ID you are importing into a new stack set. Specify the
+ # Amazon Resource Name (ARN) of the stack.
+ #
# @option params [Array<Types::Parameter>] :parameters
# The input parameters for the stack set template.
#
# @option params [Array<String>] :capabilities
# In some cases, you must explicitly acknowledge that your stack set
- # template contains certain capabilities in order for AWS CloudFormation
- # to create the stack set and related stack instances.
+ # template contains certain capabilities in order for CloudFormation to
+ # create the stack set and related stack instances.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stack sets,
- # you must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stack sets, you must explicitly acknowledge this by specifying one
+ # of these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -1280,8 +1618,8 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
- # CloudFormation returns an `InsufficientCapabilities` error.
+ # * If you don't specify either of these capabilities, CloudFormation
+ # returns an `InsufficientCapabilities` error.
#
# If your stack template contains these resources, we recommend that
# you review all permissions associated with them and edit their
@@ -1291,7 +1629,7 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::Group][2]
#
- # * [ AWS::IAM::InstanceProfile][3]
+ # * [AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
@@ -1299,27 +1637,28 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::User][6]
#
- # * [ AWS::IAM::UserToGroupAddition][7]
+ # * [AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
#
- # Some templates contain macros. If your stack template contains one
- # or more macros, and you choose to create a stack directly from the
- # processed template, without first reviewing the resulting changes in
- # a change set, you must acknowledge this capability. For more
- # information, see [Using AWS CloudFormation Macros to Perform Custom
- # Processing on Templates][9].
- #
- # <note markdown="1"> Stack sets do not currently support macros in stack templates. (This
- # includes the [AWS::Include][10] and [AWS::Serverless][11]
- # transforms, which are macros hosted by AWS CloudFormation.) Even if
- # you specify this capability, if you include a macro in your template
- # the stack set operation will fail.
+ # Some templates reference macros. If your stack set template
+ # references one or more macros, you must create the stack set
+ # directly from the processed template, without first reviewing the
+ # resulting changes in a change set. To create the stack set directly,
+ # you must acknowledge this capability. For more information, see
+ # [Using CloudFormation Macros to Perform Custom Processing on
+ # Templates][9].
#
- # </note>
+ # Stack sets with service-managed permissions don't currently support
+ # the use of macros in templates. (This includes the
+ # [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
+ # macros hosted by CloudFormation.) Even if you specify this
+ # capability for a stack set with service-managed permissions, if you
+ # reference a macro in your template the stack set operation will
+ # fail.
#
#
#
@@ -1337,24 +1676,24 @@ module Aws::CloudFormation
#
# @option params [Array<Types::Tag>] :tags
# The key-value pairs to associate with this stack set and the stacks
- # created from it. AWS CloudFormation also propagates these tags to
+ # created from it. CloudFormation also propagates these tags to
# supported resources that are created in the stacks. A maximum number
# of 50 tags can be specified.
#
- # If you specify tags as part of a `CreateStackSet` action, AWS
+ # If you specify tags as part of a `CreateStackSet` action,
# CloudFormation checks to see if you have the required IAM permission
# to tag resources. If you don't, the entire `CreateStackSet` action
# fails with an `access denied` error, and the stack set is not created.
#
# @option params [String] :administration_role_arn
- # The Amazon Resource Number (ARN) of the IAM role to use to create this
+ # The Amazon Resource Name (ARN) of the IAM role to use to create this
# stack set.
#
# Specify an IAM role only if you are using customized administrator
# roles to control which users or groups can manage specific stack sets
# within the same administrator account. For more information, see
# [Prerequisites: Granting Permissions for Stack Set Operations][1] in
- # the *AWS CloudFormation User Guide*.
+ # the *CloudFormation User Guide*.
#
#
#
@@ -1362,7 +1701,7 @@ module Aws::CloudFormation
#
# @option params [String] :execution_role_name
# The name of the IAM execution role to use to create the stack set. If
- # you do not specify an execution role, AWS CloudFormation uses the
+ # you do not specify an execution role, CloudFormation uses the
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
# operation.
#
@@ -1379,7 +1718,7 @@ module Aws::CloudFormation
# information, see [Grant Self-Managed Stack Set Permissions][1].
#
# * With `service-managed` permissions, StackSets automatically creates
- # the IAM roles required to deploy to accounts managed by AWS
+ # the IAM roles required to deploy to accounts managed by
# Organizations. For more information, see [Grant Service-Managed
# Stack Set Permissions][2].
#
@@ -1389,15 +1728,41 @@ module Aws::CloudFormation
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
#
# @option params [Types::AutoDeployment] :auto_deployment
- # Describes whether StackSets automatically deploys to AWS Organizations
+ # Describes whether StackSets automatically deploys to Organizations
# accounts that are added to the target organization or organizational
# unit (OU). Specify only if `PermissionModel` is `SERVICE_MANAGED`.
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * To create a stack set with service-managed permissions while signed
+ # in to the management account, specify `SELF`.
+ #
+ # * To create a stack set with service-managed permissions while signed
+ # in to a delegated administrator account, specify `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # admin in the management account. For more information, see [Register
+ # a delegated administrator][1] in the *CloudFormation User Guide*.
+ #
+ # Stack sets with service-managed permissions are created in the
+ # management account, including stack sets that are created by delegated
+ # administrators.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @option params [String] :client_request_token
# A unique identifier for this `CreateStackSet` request. Specify this
- # token if you plan to retry requests so that AWS CloudFormation knows
- # that you're not attempting to create another stack set with the same
- # name. You might retry `CreateStackSet` requests to ensure that AWS
+ # token if you plan to retry requests so that CloudFormation knows that
+ # you're not attempting to create another stack set with the same name.
+ # You might retry `CreateStackSet` requests to ensure that
# CloudFormation successfully received them.
#
# If you don't specify an operation ID, the SDK generates one
@@ -1406,6 +1771,10 @@ module Aws::CloudFormation
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.**
#
+ # @option params [Types::ManagedExecution] :managed_execution
+ # Describes whether StackSets performs non-conflicting operations
+ # concurrently and queues conflicting operations.
+ #
# @return [Types::CreateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateStackSetOutput#stack_set_id #stack_set_id} => String
@@ -1417,6 +1786,7 @@ module Aws::CloudFormation
# description: "Description",
# template_body: "TemplateBody",
# template_url: "TemplateURL",
+ # stack_id: "StackId",
# parameters: [
# {
# parameter_key: "ParameterKey",
@@ -1439,7 +1809,11 @@ module Aws::CloudFormation
# enabled: false,
# retain_stacks_on_account_removal: false,
# },
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# client_request_token: "ClientRequestToken",
+ # managed_execution: {
+ # active: false,
+ # },
# })
#
# @example Response structure
@@ -1455,19 +1829,85 @@ module Aws::CloudFormation
req.send_request(options)
end
+ # Deactivates trusted access with Organizations. If trusted access is
+ # deactivated, the management account does not have permissions to
+ # create and manage service-managed StackSets for your organization.
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateOrganizationsAccess AWS API Documentation
+ #
+ # @overload deactivate_organizations_access(params = {})
+ # @param [Hash] params ({})
+ def deactivate_organizations_access(params = {}, options = {})
+ req = build_request(:deactivate_organizations_access, params)
+ req.send_request(options)
+ end
+
+ # Deactivates a public extension that was previously activated in this
+ # account and Region.
+ #
+ # Once deactivated, an extension can't be used in any CloudFormation
+ # operation. This includes stack update operations where the stack
+ # template includes the extension, even if no updates are being made to
+ # the extension. In addition, deactivated extensions aren't
+ # automatically updated if a new version of the extension is released.
+ #
+ # @option params [String] :type_name
+ # The type name of the extension, in this account and Region. If you
+ # specified a type name alias when enabling the extension, use the type
+ # name alias.
+ #
+ # Conditional: You must specify either `Arn`, or `TypeName` and `Type`.
+ #
+ # @option params [String] :type
+ # The extension type.
+ #
+ # Conditional: You must specify either `Arn`, or `TypeName` and `Type`.
+ #
+ # @option params [String] :arn
+ # The Amazon Resource Name (ARN) for the extension, in this account and
+ # Region.
+ #
+ # Conditional: You must specify either `Arn`, or `TypeName` and `Type`.
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.deactivate_type({
+ # type_name: "TypeName",
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
+ # arn: "PrivateTypeArn",
+ # })
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateType AWS API Documentation
+ #
+ # @overload deactivate_type(params = {})
+ # @param [Hash] params ({})
+ def deactivate_type(params = {}, options = {})
+ req = build_request(:deactivate_type, params)
+ req.send_request(options)
+ end
+
# Deletes the specified change set. Deleting change sets ensures that no
# one executes the wrong change set.
#
- # If the call successfully completes, AWS CloudFormation successfully
+ # If the call successfully completes, CloudFormation successfully
# deleted the change set.
#
+ # If `IncludeNestedStacks` specifies `True` during the creation of the
+ # nested change set, then `DeleteChangeSet` will delete all change sets
+ # that belong to the stacks hierarchy and will also delete all change
+ # sets for nested stacks with the status of `REVIEW_IN_PROGRESS`.
+ #
# @option params [required, String] :change_set_name
# The name or Amazon Resource Name (ARN) of the change set that you want
# to delete.
#
# @option params [String] :stack_name
# If you specified the name of a change set to delete, specify the stack
- # name or ID (ARN) that is associated with it.
+ # name or Amazon Resource Name (ARN) that's associated with it.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -1488,40 +1928,40 @@ module Aws::CloudFormation
end
# Deletes a specified stack. Once the call completes successfully, stack
- # deletion starts. Deleted stacks do not show up in the DescribeStacks
- # API if the deletion has been completed successfully.
+ # deletion starts. Deleted stacks don't show up in the DescribeStacks
+ # operation if the deletion has been completed successfully.
#
# @option params [required, String] :stack_name
- # The name or the unique stack ID that is associated with the stack.
+ # The name or the unique stack ID that's associated with the stack.
#
# @option params [Array<String>] :retain_resources
# For stacks in the `DELETE_FAILED` state, a list of resource logical
# IDs that are associated with the resources you want to retain. During
- # deletion, AWS CloudFormation deletes the stack but does not delete the
+ # deletion, CloudFormation deletes the stack but doesn't delete the
# retained resources.
#
- # Retaining resources is useful when you cannot delete a resource, such
+ # Retaining resources is useful when you can't delete a resource, such
# as a non-empty S3 bucket, but you want to delete the stack.
#
# @option params [String] :role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to delete the
- # stack. AWS CloudFormation uses the role's credentials to make calls
- # on your behalf.
- #
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available, AWS
- # CloudFormation uses a temporary session that is generated from your
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to delete the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf.
+ #
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
+ # CloudFormation uses a temporary session that's generated from your
# user credentials.
#
# @option params [String] :client_request_token
# A unique identifier for this `DeleteStack` request. Specify this token
- # if you plan to retry requests so that AWS CloudFormation knows that
+ # if you plan to retry requests so that CloudFormation knows that
# you're not attempting to delete a stack with the same name. You might
- # retry `DeleteStack` requests to ensure that AWS CloudFormation
+ # retry `DeleteStack` requests to ensure that CloudFormation
# successfully received them.
#
- # All events triggered by a given stack operation are assigned the same
+ # All events initiated by a given stack operation are assigned the same
# client request token, which you can use to track operations. For
# example, if you execute a `CreateStack` operation with the token
# `token1`, then all the `StackEvents` generated by that operation will
@@ -1556,30 +1996,30 @@ module Aws::CloudFormation
end
# Deletes stack instances for the specified accounts, in the specified
- # Regions.
+ # Amazon Web Services Regions.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you want to delete stack
# instances for.
#
# @option params [Array<String>] :accounts
- # \[`Self-managed` permissions\] The names of the AWS accounts that you
- # want to delete stack instances for.
+ # \[Self-managed permissions\] The names of the Amazon Web Services
+ # accounts that you want to delete stack instances for.
#
# You can specify `Accounts` or `DeploymentTargets`, but not both.
#
# @option params [Types::DeploymentTargets] :deployment_targets
- # \[`Service-managed` permissions\] The AWS Organizations accounts from
- # which to delete stack instances.
+ # \[Service-managed permissions\] The Organizations accounts from which
+ # to delete stack instances.
#
# You can specify `Accounts` or `DeploymentTargets`, but not both.
#
# @option params [required, Array<String>] :regions
- # The Regions where you want to delete stack set instances.
+ # The Amazon Web Services Regions where you want to delete stack set
+ # instances.
#
# @option params [Types::StackSetOperationPreferences] :operation_preferences
- # Preferences for how AWS CloudFormation performs this stack set
- # operation.
+ # Preferences for how CloudFormation performs this stack set operation.
#
# @option params [required, Boolean] :retain_stacks
# Removes the stack instances from the specified stack set, but doesn't
@@ -1599,10 +2039,10 @@ module Aws::CloudFormation
# automatically.
#
# The operation ID also functions as an idempotency token, to ensure
- # that AWS CloudFormation performs the stack set operation only once,
- # even if you retry the request multiple times. You can retry stack set
- # operation requests to ensure that AWS CloudFormation successfully
- # received them.
+ # that CloudFormation performs the stack set operation only once, even
+ # if you retry the request multiple times. You can retry stack set
+ # operation requests to ensure that CloudFormation successfully received
+ # them.
#
# Repeating this stack set operation with a new operation ID retries all
# stack instances whose status is `OUTDATED`.
@@ -1610,6 +2050,28 @@ module Aws::CloudFormation
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.**
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Types::DeleteStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteStackInstancesOutput#operation_id #operation_id} => String
@@ -1621,10 +2083,13 @@ module Aws::CloudFormation
# accounts: ["Account"],
# deployment_targets: {
# accounts: ["Account"],
+ # accounts_url: "AccountsUrl",
# organizational_unit_ids: ["OrganizationalUnitId"],
+ # account_filter_type: "NONE", # accepts NONE, INTERSECTION, DIFFERENCE, UNION
# },
# regions: ["Region"], # required
# operation_preferences: {
+ # region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
# region_order: ["Region"],
# failure_tolerance_count: 1,
# failure_tolerance_percentage: 1,
@@ -1633,6 +2098,7 @@ module Aws::CloudFormation
# },
# retain_stacks: false, # required
# operation_id: "ClientRequestToken",
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @example Response structure
@@ -1648,20 +2114,43 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Deletes a stack set. Before you can delete a stack set, all of its
- # member stack instances must be deleted. For more information about how
- # to do this, see DeleteStackInstances.
+ # Deletes a stack set. Before you can delete a stack set, all its member
+ # stack instances must be deleted. For more information about how to
+ # complete this, see DeleteStackInstances.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you're deleting. You can
# obtain this value by running ListStackSets.
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_stack_set({
# stack_set_name: "StackSetName", # required
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackSet AWS API Documentation
@@ -1673,40 +2162,48 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Removes a type or type version from active use in the CloudFormation
- # registry. If a type or type version is deregistered, it cannot be used
- # in CloudFormation operations.
+ # Marks an extension or extension version as `DEPRECATED` in the
+ # CloudFormation registry, removing it from active use. Deprecated
+ # extensions or extension versions cannot be used in CloudFormation
+ # operations.
+ #
+ # To deregister an entire extension, you must individually deregister
+ # all active versions of that extension. If an extension has only a
+ # single active version, deregistering that version results in the
+ # extension itself being deregistered and marked as deprecated in the
+ # registry.
+ #
+ # You can't deregister the default version of an extension if there are
+ # other active version of that extension. If you do deregister the
+ # default version of an extension, the extension type itself is
+ # deregistered as well and marked as deprecated.
#
- # To deregister a type, you must individually deregister all registered
- # versions of that type. If a type has only a single registered version,
- # deregistering that version results in the type itself being
- # deregistered.
+ # To view the deprecation status of an extension or extension version,
+ # use [DescribeType][1].
#
- # You cannot deregister the default version of a type, unless it is the
- # only registered version of that type, in which case the type itself is
- # deregistered as well.
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
#
# @option params [String] :arn
- # The Amazon Resource Name (ARN) of the type.
+ # The Amazon Resource Name (ARN) of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type
- # The kind of type.
- #
- # Currently the only valid value is `RESOURCE`.
+ # The kind of extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_name
- # The name of the type.
+ # The name of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :version_id
- # The ID of a specific version of the type. The version ID is the value
- # at the end of the Amazon Resource Name (ARN) assigned to the type
- # version when it is registered.
+ # The ID of a specific version of the extension. The version ID is the
+ # value at the end of the Amazon Resource Name (ARN) assigned to the
+ # extension version when it is registered.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -1714,7 +2211,7 @@ module Aws::CloudFormation
#
# resp = client.deregister_type({
# arn: "PrivateTypeArn",
- # type: "RESOURCE", # accepts RESOURCE
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
# type_name: "TypeName",
# version_id: "TypeVersionId",
# })
@@ -1728,10 +2225,10 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Retrieves your account's AWS CloudFormation limits, such as the
- # maximum number of stacks that you can create in your account. For more
- # information about account limits, see [AWS CloudFormation Limits][1]
- # in the *AWS CloudFormation User Guide*.
+ # Retrieves your account's CloudFormation limits, such as the maximum
+ # number of stacks that you can create in your account. For more
+ # information about account limits, see [CloudFormation Quotas][1] in
+ # the *CloudFormation User Guide*.
#
#
#
@@ -1770,9 +2267,9 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Returns the inputs for the change set and a list of changes that AWS
+ # Returns the inputs for the change set and a list of changes that
# CloudFormation will make if you execute the change set. For more
- # information, see [Updating Stacks Using Change Sets][1] in the AWS
+ # information, see [Updating Stacks Using Change Sets][1] in the
# CloudFormation User Guide.
#
#
@@ -1809,6 +2306,10 @@ module Aws::CloudFormation
# * {Types::DescribeChangeSetOutput#tags #tags} => Array<Types::Tag>
# * {Types::DescribeChangeSetOutput#changes #changes} => Array<Types::Change>
# * {Types::DescribeChangeSetOutput#next_token #next_token} => String
+ # * {Types::DescribeChangeSetOutput#include_nested_stacks #include_nested_stacks} => Boolean
+ # * {Types::DescribeChangeSetOutput#parent_change_set_id #parent_change_set_id} => String
+ # * {Types::DescribeChangeSetOutput#root_change_set_id #root_change_set_id} => String
+ # * {Types::DescribeChangeSetOutput#on_stack_failure #on_stack_failure} => String
#
# @example Request syntax with placeholder values
#
@@ -1832,7 +2333,7 @@ module Aws::CloudFormation
# resp.parameters[0].resolved_value #=> String
# resp.creation_time #=> Time
# resp.execution_status #=> String, one of "UNAVAILABLE", "AVAILABLE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "OBSOLETE"
- # resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_COMPLETE", "FAILED"
+ # resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "FAILED"
# resp.status_reason #=> String
# resp.notification_arns #=> Array
# resp.notification_arns[0] #=> String
@@ -1847,7 +2348,8 @@ module Aws::CloudFormation
# resp.tags[0].value #=> String
# resp.changes #=> Array
# resp.changes[0].type #=> String, one of "Resource"
- # resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import"
+ # resp.changes[0].hook_invocation_count #=> Integer
+ # resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic"
# resp.changes[0].resource_change.logical_resource_id #=> String
# resp.changes[0].resource_change.physical_resource_id #=> String
# resp.changes[0].resource_change.resource_type #=> String
@@ -1861,7 +2363,14 @@ module Aws::CloudFormation
# resp.changes[0].resource_change.details[0].evaluation #=> String, one of "Static", "Dynamic"
# resp.changes[0].resource_change.details[0].change_source #=> String, one of "ResourceReference", "ParameterReference", "ResourceAttribute", "DirectModification", "Automatic"
# resp.changes[0].resource_change.details[0].causing_entity #=> String
+ # resp.changes[0].resource_change.change_set_id #=> String
+ # resp.changes[0].resource_change.module_info.type_hierarchy #=> String
+ # resp.changes[0].resource_change.module_info.logical_id_hierarchy #=> String
# resp.next_token #=> String
+ # resp.include_nested_stacks #=> Boolean
+ # resp.parent_change_set_id #=> String
+ # resp.root_change_set_id #=> String
+ # resp.on_stack_failure #=> String, one of "DO_NOTHING", "ROLLBACK", "DELETE"
#
#
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -1877,54 +2386,225 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Returns information about a stack drift detection operation. A stack
- # drift detection operation detects whether a stack's actual
- # configuration differs, or has *drifted*, from it's expected
- # configuration, as defined in the stack template and any values
- # specified as template parameters. A stack is considered to have
- # drifted if one or more of its resources have drifted. For more
- # information on stack and resource drift, see [Detecting Unregulated
- # Configuration Changes to Stacks and Resources][1].
- #
- # Use DetectStackDrift to initiate a stack drift detection operation.
- # `DetectStackDrift` returns a `StackDriftDetectionId` you can use to
- # monitor the progress of the operation using
- # `DescribeStackDriftDetectionStatus`. Once the drift detection
- # operation has completed, use DescribeStackResourceDrifts to return
- # drift information about the stack and its resources.
- #
+ # Returns hook-related information for the change set and a list of
+ # changes that CloudFormation makes when you run the change set.
#
+ # @option params [required, String] :change_set_name
+ # The name or Amazon Resource Name (ARN) of the change set that you want
+ # to describe.
#
- # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
+ # @option params [String] :stack_name
+ # If you specified the name of a change set, specify the stack name or
+ # stack ID (ARN) of the change set you want to describe.
#
- # @option params [required, String] :stack_drift_detection_id
- # The ID of the drift detection results of this operation.
+ # @option params [String] :next_token
+ # A string, provided by the `DescribeChangeSetHooks` response output,
+ # that identifies the next page of information that you want to
+ # retrieve.
#
- # AWS CloudFormation generates new results, with a new drift detection
- # ID, each time this operation is run. However, the number of drift
- # results AWS CloudFormation retains for any given stack, and for how
- # long, may vary.
+ # @option params [String] :logical_resource_id
+ # If specified, lists only the hooks related to the specified
+ # `LogicalResourceId`.
#
- # @return [Types::DescribeStackDriftDetectionStatusOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # @return [Types::DescribeChangeSetHooksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
- # * {Types::DescribeStackDriftDetectionStatusOutput#stack_id #stack_id} => String
- # * {Types::DescribeStackDriftDetectionStatusOutput#stack_drift_detection_id #stack_drift_detection_id} => String
- # * {Types::DescribeStackDriftDetectionStatusOutput#stack_drift_status #stack_drift_status} => String
- # * {Types::DescribeStackDriftDetectionStatusOutput#detection_status #detection_status} => String
- # * {Types::DescribeStackDriftDetectionStatusOutput#detection_status_reason #detection_status_reason} => String
- # * {Types::DescribeStackDriftDetectionStatusOutput#drifted_stack_resource_count #drifted_stack_resource_count} => Integer
- # * {Types::DescribeStackDriftDetectionStatusOutput#timestamp #timestamp} => Time
+ # * {Types::DescribeChangeSetHooksOutput#change_set_id #change_set_id} => String
+ # * {Types::DescribeChangeSetHooksOutput#change_set_name #change_set_name} => String
+ # * {Types::DescribeChangeSetHooksOutput#hooks #hooks} => Array<Types::ChangeSetHook>
+ # * {Types::DescribeChangeSetHooksOutput#status #status} => String
+ # * {Types::DescribeChangeSetHooksOutput#next_token #next_token} => String
+ # * {Types::DescribeChangeSetHooksOutput#stack_id #stack_id} => String
+ # * {Types::DescribeChangeSetHooksOutput#stack_name #stack_name} => String
#
# @example Request syntax with placeholder values
#
- # resp = client.describe_stack_drift_detection_status({
- # stack_drift_detection_id: "StackDriftDetectionId", # required
+ # resp = client.describe_change_set_hooks({
+ # change_set_name: "ChangeSetNameOrId", # required
+ # stack_name: "StackNameOrId",
+ # next_token: "NextToken",
+ # logical_resource_id: "LogicalResourceId",
# })
#
# @example Response structure
#
- # resp.stack_id #=> String
- # resp.stack_drift_detection_id #=> String
+ # resp.change_set_id #=> String
+ # resp.change_set_name #=> String
+ # resp.hooks #=> Array
+ # resp.hooks[0].invocation_point #=> String, one of "PRE_PROVISION"
+ # resp.hooks[0].failure_mode #=> String, one of "FAIL", "WARN"
+ # resp.hooks[0].type_name #=> String
+ # resp.hooks[0].type_version_id #=> String
+ # resp.hooks[0].type_configuration_version_id #=> String
+ # resp.hooks[0].target_details.target_type #=> String, one of "RESOURCE"
+ # resp.hooks[0].target_details.resource_target_details.logical_resource_id #=> String
+ # resp.hooks[0].target_details.resource_target_details.resource_type #=> String
+ # resp.hooks[0].target_details.resource_target_details.resource_action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic"
+ # resp.status #=> String, one of "PLANNING", "PLANNED", "UNAVAILABLE"
+ # resp.next_token #=> String
+ # resp.stack_id #=> String
+ # resp.stack_name #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSetHooks AWS API Documentation
+ #
+ # @overload describe_change_set_hooks(params = {})
+ # @param [Hash] params ({})
+ def describe_change_set_hooks(params = {}, options = {})
+ req = build_request(:describe_change_set_hooks, params)
+ req.send_request(options)
+ end
+
+ # Retrieves information about the account's `OrganizationAccess`
+ # status. This API can be called either by the management account or the
+ # delegated administrator by using the `CallAs` parameter. This API can
+ # also be called without the `CallAs` parameter by the management
+ # account.
+ #
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
+ # @return [Types::DescribeOrganizationsAccessOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::DescribeOrganizationsAccessOutput#status #status} => String
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.describe_organizations_access({
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.status #=> String, one of "ENABLED", "DISABLED", "DISABLED_PERMANENTLY"
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeOrganizationsAccess AWS API Documentation
+ #
+ # @overload describe_organizations_access(params = {})
+ # @param [Hash] params ({})
+ def describe_organizations_access(params = {}, options = {})
+ req = build_request(:describe_organizations_access, params)
+ req.send_request(options)
+ end
+
+ # Returns information about a CloudFormation extension publisher.
+ #
+ # If you don't supply a `PublisherId`, and you have registered as an
+ # extension publisher, `DescribePublisher` returns information about
+ # your own publisher account.
+ #
+ # For more information about registering as a publisher, see:
+ #
+ # * [RegisterPublisher][1]
+ #
+ # * [Publishing extensions to make them available for public use][2] in
+ # the *CloudFormation CLI User Guide*
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html
+ # [2]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html
+ #
+ # @option params [String] :publisher_id
+ # The ID of the extension publisher.
+ #
+ # If you don't supply a `PublisherId`, and you have registered as an
+ # extension publisher, `DescribePublisher` returns information about
+ # your own publisher account.
+ #
+ # @return [Types::DescribePublisherOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::DescribePublisherOutput#publisher_id #publisher_id} => String
+ # * {Types::DescribePublisherOutput#publisher_status #publisher_status} => String
+ # * {Types::DescribePublisherOutput#identity_provider #identity_provider} => String
+ # * {Types::DescribePublisherOutput#publisher_profile #publisher_profile} => String
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.describe_publisher({
+ # publisher_id: "PublisherId",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.publisher_id #=> String
+ # resp.publisher_status #=> String, one of "VERIFIED", "UNVERIFIED"
+ # resp.identity_provider #=> String, one of "AWS_Marketplace", "GitHub", "Bitbucket"
+ # resp.publisher_profile #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribePublisher AWS API Documentation
+ #
+ # @overload describe_publisher(params = {})
+ # @param [Hash] params ({})
+ def describe_publisher(params = {}, options = {})
+ req = build_request(:describe_publisher, params)
+ req.send_request(options)
+ end
+
+ # Returns information about a stack drift detection operation. A stack
+ # drift detection operation detects whether a stack's actual
+ # configuration differs, or has *drifted*, from its expected
+ # configuration, as defined in the stack template and any values
+ # specified as template parameters. A stack is considered to have
+ # drifted if one or more of its resources have drifted. For more
+ # information about stack and resource drift, see [Detecting Unregulated
+ # Configuration Changes to Stacks and Resources][1].
+ #
+ # Use DetectStackDrift to initiate a stack drift detection operation.
+ # `DetectStackDrift` returns a `StackDriftDetectionId` you can use to
+ # monitor the progress of the operation using
+ # `DescribeStackDriftDetectionStatus`. Once the drift detection
+ # operation has completed, use DescribeStackResourceDrifts to return
+ # drift information about the stack and its resources.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
+ #
+ # @option params [required, String] :stack_drift_detection_id
+ # The ID of the drift detection results of this operation.
+ #
+ # CloudFormation generates new results, with a new drift detection ID,
+ # each time this operation is run. However, the number of drift results
+ # CloudFormation retains for any given stack, and for how long, may
+ # vary.
+ #
+ # @return [Types::DescribeStackDriftDetectionStatusOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::DescribeStackDriftDetectionStatusOutput#stack_id #stack_id} => String
+ # * {Types::DescribeStackDriftDetectionStatusOutput#stack_drift_detection_id #stack_drift_detection_id} => String
+ # * {Types::DescribeStackDriftDetectionStatusOutput#stack_drift_status #stack_drift_status} => String
+ # * {Types::DescribeStackDriftDetectionStatusOutput#detection_status #detection_status} => String
+ # * {Types::DescribeStackDriftDetectionStatusOutput#detection_status_reason #detection_status_reason} => String
+ # * {Types::DescribeStackDriftDetectionStatusOutput#drifted_stack_resource_count #drifted_stack_resource_count} => Integer
+ # * {Types::DescribeStackDriftDetectionStatusOutput#timestamp #timestamp} => Time
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.describe_stack_drift_detection_status({
+ # stack_drift_detection_id: "StackDriftDetectionId", # required
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.stack_id #=> String
+ # resp.stack_drift_detection_id #=> String
# resp.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
# resp.detection_status #=> String, one of "DETECTION_IN_PROGRESS", "DETECTION_FAILED", "DETECTION_COMPLETE"
# resp.detection_status_reason #=> String
@@ -1942,7 +2622,7 @@ module Aws::CloudFormation
# Returns all stack related events for a specified stack in reverse
# chronological order. For more information about a stack's event
- # history, go to [Stacks][1] in the AWS CloudFormation User Guide.
+ # history, go to [Stacks][1] in the CloudFormation User Guide.
#
# <note markdown="1"> You can list events for stacks that have failed to create or have been
# deleted by specifying the unique stack identifier (stack ID).
@@ -1954,8 +2634,8 @@ module Aws::CloudFormation
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html
#
# @option params [String] :stack_name
- # The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # The name or the unique stack ID that's associated with the stack,
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -1992,10 +2672,15 @@ module Aws::CloudFormation
# resp.stack_events[0].physical_resource_id #=> String
# resp.stack_events[0].resource_type #=> String
# resp.stack_events[0].timestamp #=> Time
- # resp.stack_events[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE"
+ # resp.stack_events[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
# resp.stack_events[0].resource_status_reason #=> String
# resp.stack_events[0].resource_properties #=> String
# resp.stack_events[0].client_request_token #=> String
+ # resp.stack_events[0].hook_type #=> String
+ # resp.stack_events[0].hook_status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
+ # resp.stack_events[0].hook_status_reason #=> String
+ # resp.stack_events[0].hook_invocation_point #=> String, one of "PRE_PROVISION"
+ # resp.stack_events[0].hook_failure_mode #=> String, one of "FAIL", "WARN"
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackEvents AWS API Documentation
@@ -2007,22 +2692,45 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Returns the stack instance that's associated with the specified stack
- # set, AWS account, and Region.
+ # Returns the stack instance that's associated with the specified
+ # StackSet, Amazon Web Services account, and Amazon Web Services Region.
#
# For a list of stack instances that are associated with a specific
- # stack set, use ListStackInstances.
+ # StackSet, use ListStackInstances.
#
# @option params [required, String] :stack_set_name
# The name or the unique stack ID of the stack set that you want to get
# stack instance information for.
#
# @option params [required, String] :stack_instance_account
- # The ID of an AWS account that's associated with this stack instance.
+ # The ID of an Amazon Web Services account that's associated with this
+ # stack instance.
#
# @option params [required, String] :stack_instance_region
# The name of a Region that's associated with this stack instance.
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Types::DescribeStackInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStackInstanceOutput#stack_instance #stack_instance} => Types::StackInstance
@@ -2033,6 +2741,7 @@ module Aws::CloudFormation
# stack_set_name: "StackSetName", # required
# stack_instance_account: "Account", # required
# stack_instance_region: "Region", # required
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @example Response structure
@@ -2047,11 +2756,12 @@ module Aws::CloudFormation
# resp.stack_instance.parameter_overrides[0].use_previous_value #=> Boolean
# resp.stack_instance.parameter_overrides[0].resolved_value #=> String
# resp.stack_instance.status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
- # resp.stack_instance.stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE"
+ # resp.stack_instance.stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE", "SKIPPED_SUSPENDED_ACCOUNT"
# resp.stack_instance.status_reason #=> String
# resp.stack_instance.organizational_unit_id #=> String
# resp.stack_instance.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
# resp.stack_instance.last_drift_check_timestamp #=> Time
+ # resp.stack_instance.last_operation_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackInstance AWS API Documentation
#
@@ -2069,8 +2779,8 @@ module Aws::CloudFormation
# for up to 90 days after the stack has been deleted.
#
# @option params [required, String] :stack_name
- # The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # The name or the unique stack ID that's associated with the stack,
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -2103,12 +2813,14 @@ module Aws::CloudFormation
# resp.stack_resource_detail.physical_resource_id #=> String
# resp.stack_resource_detail.resource_type #=> String
# resp.stack_resource_detail.last_updated_timestamp #=> Time
- # resp.stack_resource_detail.resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE"
+ # resp.stack_resource_detail.resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
# resp.stack_resource_detail.resource_status_reason #=> String
# resp.stack_resource_detail.description #=> String
# resp.stack_resource_detail.metadata #=> String
# resp.stack_resource_detail.drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
# resp.stack_resource_detail.drift_information.last_check_timestamp #=> Time
+ # resp.stack_resource_detail.module_info.type_hierarchy #=> String
+ # resp.stack_resource_detail.module_info.logical_id_hierarchy #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResource AWS API Documentation
#
@@ -2121,13 +2833,13 @@ module Aws::CloudFormation
# Returns drift information for the resources that have been checked for
# drift in the specified stack. This includes actual and expected
- # configuration values for resources where AWS CloudFormation detects
+ # configuration values for resources where CloudFormation detects
# configuration drift.
#
# For a given stack, there will be one `StackResourceDrift` for each
- # stack resource that has been checked for drift. Resources that have
- # not yet been checked for drift are not included. Resources that do not
- # currently support drift detection are not checked, and so not
+ # stack resource that has been checked for drift. Resources that
+ # haven't yet been checked for drift aren't included. Resources that
+ # don't currently support drift detection aren't checked, and so not
# included. For a list of resources that support drift detection, see
# [Resources that Support Drift Detection][1].
#
@@ -2146,17 +2858,16 @@ module Aws::CloudFormation
# The resource drift status values to use as filters for the resource
# drift results returned.
#
- # * `DELETED`\: The resource differs from its expected template
+ # * `DELETED`: The resource differs from its expected template
# configuration in that the resource has been deleted.
#
- # * `MODIFIED`\: One or more resource properties differ from their
+ # * `MODIFIED`: One or more resource properties differ from their
# expected template values.
#
- # * `IN_SYNC`\: The resources's actual configuration matches its
- # expected template configuration.
+ # * `IN_SYNC`: The resource's actual configuration matches its expected
+ # template configuration.
#
- # * `NOT_CHECKED`\: AWS CloudFormation does not currently return this
- # value.
+ # * `NOT_CHECKED`: CloudFormation doesn't currently return this value.
#
# @option params [String] :next_token
# A string that identifies the next page of stack resource drift
@@ -2203,6 +2914,8 @@ module Aws::CloudFormation
# resp.stack_resource_drifts[0].property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
# resp.stack_resource_drifts[0].stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
# resp.stack_resource_drifts[0].timestamp #=> Time
+ # resp.stack_resource_drifts[0].module_info.type_hierarchy #=> String
+ # resp.stack_resource_drifts[0].module_info.logical_id_hierarchy #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResourceDrifts AWS API Documentation
@@ -2214,11 +2927,11 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Returns AWS resource descriptions for running and deleted stacks. If
- # `StackName` is specified, all the associated resources that are part
- # of the stack are returned. If `PhysicalResourceId` is specified, the
- # associated resources of the stack that the resource belongs to are
- # returned.
+ # Returns Amazon Web Services resource descriptions for running and
+ # deleted stacks. If `StackName` is specified, all the associated
+ # resources that are part of the stack are returned. If
+ # `PhysicalResourceId` is specified, the associated resources of the
+ # stack that the resource belongs to are returned.
#
# <note markdown="1"> Only the first 100 resources will be returned. If your stack has more
# resources than this, you should use `ListStackResources` instead.
@@ -2231,8 +2944,8 @@ module Aws::CloudFormation
# You must specify either `StackName` or `PhysicalResourceId`, but not
# both. In addition, you can specify `LogicalResourceId` to filter the
# returned result. For more information about resources, the
- # `LogicalResourceId` and `PhysicalResourceId`, go to the [AWS
- # CloudFormation User Guide][1].
+ # `LogicalResourceId` and `PhysicalResourceId`, go to the
+ # [CloudFormation User Guide][1].
#
# <note markdown="1"> A `ValidationError` is returned if you specify both `StackName` and
# `PhysicalResourceId` in the same request.
@@ -2245,7 +2958,7 @@ module Aws::CloudFormation
#
# @option params [String] :stack_name
# The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -2254,7 +2967,7 @@ module Aws::CloudFormation
#
# Default: There is no default value.
#
- # Required: Conditional. If you do not specify `StackName`, you must
+ # Required: Conditional. If you don't specify `StackName`, you must
# specify `PhysicalResourceId`.
#
# @option params [String] :logical_resource_id
@@ -2264,14 +2977,14 @@ module Aws::CloudFormation
#
# @option params [String] :physical_resource_id
# The name or unique identifier that corresponds to a physical instance
- # ID of a resource supported by AWS CloudFormation.
+ # ID of a resource supported by CloudFormation.
#
# For example, for an Amazon Elastic Compute Cloud (EC2) instance,
# `PhysicalResourceId` corresponds to the `InstanceId`. You can pass the
# EC2 `InstanceId` to `DescribeStackResources` to find which stack the
# instance belongs to and what other resources are part of the stack.
#
- # Required: Conditional. If you do not specify `PhysicalResourceId`, you
+ # Required: Conditional. If you don't specify `PhysicalResourceId`, you
# must specify `StackName`.
#
# Default: There is no default value.
@@ -2297,11 +3010,13 @@ module Aws::CloudFormation
# resp.stack_resources[0].physical_resource_id #=> String
# resp.stack_resources[0].resource_type #=> String
# resp.stack_resources[0].timestamp #=> Time
- # resp.stack_resources[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE"
+ # resp.stack_resources[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
# resp.stack_resources[0].resource_status_reason #=> String
# resp.stack_resources[0].description #=> String
# resp.stack_resources[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
# resp.stack_resources[0].drift_information.last_check_timestamp #=> Time
+ # resp.stack_resources[0].module_info.type_hierarchy #=> String
+ # resp.stack_resources[0].module_info.logical_id_hierarchy #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResources AWS API Documentation
#
@@ -2312,11 +3027,33 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Returns the description of the specified stack set.
+ # Returns the description of the specified StackSet.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set whose description you want.
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Types::DescribeStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStackSetOutput#stack_set #stack_set} => Types::StackSet
@@ -2325,6 +3062,7 @@ module Aws::CloudFormation
#
# resp = client.describe_stack_set({
# stack_set_name: "StackSetName", # required
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @example Response structure
@@ -2360,6 +3098,9 @@ module Aws::CloudFormation
# resp.stack_set.permission_model #=> String, one of "SERVICE_MANAGED", "SELF_MANAGED"
# resp.stack_set.organizational_unit_ids #=> Array
# resp.stack_set.organizational_unit_ids[0] #=> String
+ # resp.stack_set.managed_execution.active #=> Boolean
+ # resp.stack_set.regions #=> Array
+ # resp.stack_set.regions[0] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSet AWS API Documentation
#
@@ -2370,7 +3111,7 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Returns the description of the specified stack set operation.
+ # Returns the description of the specified StackSet operation.
#
# @option params [required, String] :stack_set_name
# The name or the unique stack ID of the stack set for the stack
@@ -2379,6 +3120,28 @@ module Aws::CloudFormation
# @option params [required, String] :operation_id
# The unique ID of the stack set operation.
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Types::DescribeStackSetOperationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStackSetOperationOutput#stack_set_operation #stack_set_operation} => Types::StackSetOperation
@@ -2388,6 +3151,7 @@ module Aws::CloudFormation
# resp = client.describe_stack_set_operation({
# stack_set_name: "StackSetName", # required
# operation_id: "ClientRequestToken", # required
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @example Response structure
@@ -2396,6 +3160,7 @@ module Aws::CloudFormation
# resp.stack_set_operation.stack_set_id #=> String
# resp.stack_set_operation.action #=> String, one of "CREATE", "UPDATE", "DELETE", "DETECT_DRIFT"
# resp.stack_set_operation.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "STOPPING", "STOPPED", "QUEUED"
+ # resp.stack_set_operation.operation_preferences.region_concurrency_type #=> String, one of "SEQUENTIAL", "PARALLEL"
# resp.stack_set_operation.operation_preferences.region_order #=> Array
# resp.stack_set_operation.operation_preferences.region_order[0] #=> String
# resp.stack_set_operation.operation_preferences.failure_tolerance_count #=> Integer
@@ -2409,8 +3174,10 @@ module Aws::CloudFormation
# resp.stack_set_operation.end_timestamp #=> Time
# resp.stack_set_operation.deployment_targets.accounts #=> Array
# resp.stack_set_operation.deployment_targets.accounts[0] #=> String
+ # resp.stack_set_operation.deployment_targets.accounts_url #=> String
# resp.stack_set_operation.deployment_targets.organizational_unit_ids #=> Array
# resp.stack_set_operation.deployment_targets.organizational_unit_ids[0] #=> String
+ # resp.stack_set_operation.deployment_targets.account_filter_type #=> String, one of "NONE", "INTERSECTION", "DIFFERENCE", "UNION"
# resp.stack_set_operation.stack_set_drift_detection_details.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "NOT_CHECKED"
# resp.stack_set_operation.stack_set_drift_detection_details.drift_detection_status #=> String, one of "COMPLETED", "FAILED", "PARTIAL_SUCCESS", "IN_PROGRESS", "STOPPED"
# resp.stack_set_operation.stack_set_drift_detection_details.last_drift_check_timestamp #=> Time
@@ -2419,6 +3186,8 @@ module Aws::CloudFormation
# resp.stack_set_operation.stack_set_drift_detection_details.in_sync_stack_instances_count #=> Integer
# resp.stack_set_operation.stack_set_drift_detection_details.in_progress_stack_instances_count #=> Integer
# resp.stack_set_operation.stack_set_drift_detection_details.failed_stack_instances_count #=> Integer
+ # resp.stack_set_operation.status_reason #=> String
+ # resp.stack_set_operation.status_details.failed_stack_instances_count #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSetOperation AWS API Documentation
#
@@ -2432,14 +3201,28 @@ module Aws::CloudFormation
# Returns the description for the specified stack; if no stack name was
# specified, then it returns the description for all the stacks created.
#
- # <note markdown="1"> If the stack does not exist, an `AmazonCloudFormationException` is
- # returned.
+ # <note markdown="1"> If the stack doesn't exist, an `ValidationError` is returned.
#
# </note>
#
# @option params [String] :stack_name
- # The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
+ # response that describes all resources in the account. This requires
+ # `ListStacks` and `DescribeStacks` permissions.
+ #
+ # The IAM policy below can be added to IAM policies when you want to
+ # limit resource-level permissions and avoid returning a response when
+ # no parameter is sent in the request:
+ #
+ # \\\{ "Version": "2012-10-17", "Statement": \[\\\{ "Effect":
+ # "Deny", "Action": "cloudformation:DescribeStacks",
+ # "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" \\}\]
+ # \\}
+ #
+ # </note>
+ #
+ # The name or the unique stack ID that's associated with the stack,
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -2485,7 +3268,7 @@ module Aws::CloudFormation
# resp.stacks[0].rollback_configuration.rollback_triggers[0].arn #=> String
# resp.stacks[0].rollback_configuration.rollback_triggers[0].type #=> String
# resp.stacks[0].rollback_configuration.monitoring_time_in_minutes #=> Integer
- # resp.stacks[0].stack_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_FAILED", "ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "REVIEW_IN_PROGRESS", "IMPORT_IN_PROGRESS", "IMPORT_COMPLETE", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE"
+ # resp.stacks[0].stack_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_FAILED", "ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "REVIEW_IN_PROGRESS", "IMPORT_IN_PROGRESS", "IMPORT_COMPLETE", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE"
# resp.stacks[0].stack_status_reason #=> String
# resp.stacks[0].disable_rollback #=> Boolean
# resp.stacks[0].notification_arns #=> Array
@@ -2528,37 +3311,45 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Returns detailed information about a type that has been registered.
+ # Returns detailed information about an extension that has been
+ # registered.
#
# If you specify a `VersionId`, `DescribeType` returns information about
- # that specific type version. Otherwise, it returns information about
- # the default type version.
+ # that specific extension version. Otherwise, it returns information
+ # about the default extension version.
#
# @option params [String] :type
- # The kind of type.
- #
- # Currently the only valid value is `RESOURCE`.
+ # The kind of extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_name
- # The name of the type.
+ # The name of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :arn
- # The Amazon Resource Name (ARN) of the type.
+ # The Amazon Resource Name (ARN) of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :version_id
- # The ID of a specific version of the type. The version ID is the value
- # at the end of the Amazon Resource Name (ARN) assigned to the type
- # version when it is registered.
+ # The ID of a specific version of the extension. The version ID is the
+ # value at the end of the Amazon Resource Name (ARN) assigned to the
+ # extension version when it is registered.
#
# If you specify a `VersionId`, `DescribeType` returns information about
- # that specific type version. Otherwise, it returns information about
- # the default type version.
+ # that specific extension version. Otherwise, it returns information
+ # about the default extension version.
+ #
+ # @option params [String] :publisher_id
+ # The publisher ID of the extension publisher.
+ #
+ # Extensions provided by Amazon Web Services are not assigned a
+ # publisher ID.
+ #
+ # @option params [String] :public_version_number
+ # The version number of a public third-party extension.
#
# @return [Types::DescribeTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -2567,46 +3358,75 @@ module Aws::CloudFormation
# * {Types::DescribeTypeOutput#type_name #type_name} => String
# * {Types::DescribeTypeOutput#default_version_id #default_version_id} => String
# * {Types::DescribeTypeOutput#is_default_version #is_default_version} => Boolean
+ # * {Types::DescribeTypeOutput#type_tests_status #type_tests_status} => String
+ # * {Types::DescribeTypeOutput#type_tests_status_description #type_tests_status_description} => String
# * {Types::DescribeTypeOutput#description #description} => String
# * {Types::DescribeTypeOutput#schema #schema} => String
# * {Types::DescribeTypeOutput#provisioning_type #provisioning_type} => String
# * {Types::DescribeTypeOutput#deprecated_status #deprecated_status} => String
# * {Types::DescribeTypeOutput#logging_config #logging_config} => Types::LoggingConfig
+ # * {Types::DescribeTypeOutput#required_activated_types #required_activated_types} => Array<Types::RequiredActivatedType>
# * {Types::DescribeTypeOutput#execution_role_arn #execution_role_arn} => String
# * {Types::DescribeTypeOutput#visibility #visibility} => String
# * {Types::DescribeTypeOutput#source_url #source_url} => String
# * {Types::DescribeTypeOutput#documentation_url #documentation_url} => String
# * {Types::DescribeTypeOutput#last_updated #last_updated} => Time
# * {Types::DescribeTypeOutput#time_created #time_created} => Time
+ # * {Types::DescribeTypeOutput#configuration_schema #configuration_schema} => String
+ # * {Types::DescribeTypeOutput#publisher_id #publisher_id} => String
+ # * {Types::DescribeTypeOutput#original_type_name #original_type_name} => String
+ # * {Types::DescribeTypeOutput#original_type_arn #original_type_arn} => String
+ # * {Types::DescribeTypeOutput#public_version_number #public_version_number} => String
+ # * {Types::DescribeTypeOutput#latest_public_version #latest_public_version} => String
+ # * {Types::DescribeTypeOutput#is_activated #is_activated} => Boolean
+ # * {Types::DescribeTypeOutput#auto_update #auto_update} => Boolean
#
# @example Request syntax with placeholder values
#
# resp = client.describe_type({
- # type: "RESOURCE", # accepts RESOURCE
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
# type_name: "TypeName",
# arn: "TypeArn",
# version_id: "TypeVersionId",
+ # publisher_id: "PublisherId",
+ # public_version_number: "PublicVersionNumber",
# })
#
# @example Response structure
#
# resp.arn #=> String
- # resp.type #=> String, one of "RESOURCE"
+ # resp.type #=> String, one of "RESOURCE", "MODULE", "HOOK"
# resp.type_name #=> String
# resp.default_version_id #=> String
# resp.is_default_version #=> Boolean
+ # resp.type_tests_status #=> String, one of "PASSED", "FAILED", "IN_PROGRESS", "NOT_TESTED"
+ # resp.type_tests_status_description #=> String
# resp.description #=> String
# resp.schema #=> String
# resp.provisioning_type #=> String, one of "NON_PROVISIONABLE", "IMMUTABLE", "FULLY_MUTABLE"
# resp.deprecated_status #=> String, one of "LIVE", "DEPRECATED"
# resp.logging_config.log_role_arn #=> String
# resp.logging_config.log_group_name #=> String
+ # resp.required_activated_types #=> Array
+ # resp.required_activated_types[0].type_name_alias #=> String
+ # resp.required_activated_types[0].original_type_name #=> String
+ # resp.required_activated_types[0].publisher_id #=> String
+ # resp.required_activated_types[0].supported_major_versions #=> Array
+ # resp.required_activated_types[0].supported_major_versions[0] #=> Integer
# resp.execution_role_arn #=> String
# resp.visibility #=> String, one of "PUBLIC", "PRIVATE"
# resp.source_url #=> String
# resp.documentation_url #=> String
# resp.last_updated #=> Time
# resp.time_created #=> Time
+ # resp.configuration_schema #=> String
+ # resp.publisher_id #=> String
+ # resp.original_type_name #=> String
+ # resp.original_type_arn #=> String
+ # resp.public_version_number #=> String
+ # resp.latest_public_version #=> String
+ # resp.is_activated #=> Boolean
+ # resp.auto_update #=> Boolean
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeType AWS API Documentation
#
@@ -2617,21 +3437,21 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Returns information about a type's registration, including its
+ # Returns information about an extension's registration, including its
# current status and type and version identifiers.
#
- # When you initiate a registration request using ` RegisterType `, you
- # can then use ` DescribeTypeRegistration ` to monitor the progress of
- # that registration request.
+ # When you initiate a registration request using RegisterType, you can
+ # then use DescribeTypeRegistration to monitor the progress of that
+ # registration request.
#
- # Once the registration request has completed, use ` DescribeType ` to
- # return detailed informaiton about a type.
+ # Once the registration request has completed, use DescribeType to
+ # return detailed information about an extension.
#
# @option params [required, String] :registration_token
# The identifier for this registration request.
#
# This registration token is generated by CloudFormation when you
- # initiate a registration request using ` RegisterType `.
+ # initiate a registration request using RegisterType.
#
# @return [Types::DescribeTypeRegistrationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -2668,16 +3488,15 @@ module Aws::CloudFormation
end
# Detects whether a stack's actual configuration differs, or has
- # *drifted*, from it's expected configuration, as defined in the stack
+ # *drifted*, from its expected configuration, as defined in the stack
# template and any values specified as template parameters. For each
- # resource in the stack that supports drift detection, AWS
- # CloudFormation compares the actual configuration of the resource with
- # its expected template configuration. Only resource properties
- # explicitly defined in the stack template are checked for drift. A
- # stack is considered to have drifted if one or more of its resources
- # differ from their expected template configurations. For more
- # information, see [Detecting Unregulated Configuration Changes to
- # Stacks and Resources][1].
+ # resource in the stack that supports drift detection, CloudFormation
+ # compares the actual configuration of the resource with its expected
+ # template configuration. Only resource properties explicitly defined in
+ # the stack template are checked for drift. A stack is considered to
+ # have drifted if one or more of its resources differ from their
+ # expected template configurations. For more information, see [Detecting
+ # Unregulated Configuration Changes to Stacks and Resources][1].
#
# Use `DetectStackDrift` to detect drift on all supported resources for
# a given stack, or DetectStackResourceDrift to detect drift on
@@ -2693,8 +3512,8 @@ module Aws::CloudFormation
# completed, use DescribeStackResourceDrifts to return drift information
# about the stack and its resources.
#
- # When detecting drift on a stack, AWS CloudFormation does not detect
- # drift on any nested stacks belonging to that stack. Perform
+ # When detecting drift on a stack, CloudFormation doesn't detect drift
+ # on any nested stacks belonging to that stack. Perform
# `DetectStackDrift` directly on the nested stack itself.
#
#
@@ -2733,20 +3552,20 @@ module Aws::CloudFormation
end
# Returns information about whether a resource's actual configuration
- # differs, or has *drifted*, from it's expected configuration, as
- # defined in the stack template and any values specified as template
- # parameters. This information includes actual and expected property
- # values for resources in which AWS CloudFormation detects drift. Only
- # resource properties explicitly defined in the stack template are
- # checked for drift. For more information about stack and resource
- # drift, see [Detecting Unregulated Configuration Changes to Stacks and
+ # differs, or has *drifted*, from its expected configuration, as defined
+ # in the stack template and any values specified as template parameters.
+ # This information includes actual and expected property values for
+ # resources in which CloudFormation detects drift. Only resource
+ # properties explicitly defined in the stack template are checked for
+ # drift. For more information about stack and resource drift, see
+ # [Detecting Unregulated Configuration Changes to Stacks and
# Resources][1].
#
# Use `DetectStackResourceDrift` to detect drift on individual
# resources, or DetectStackDrift to detect drift on all resources in a
# given stack that support drift detection.
#
- # Resources that do not currently support drift detection cannot be
+ # Resources that don't currently support drift detection can't be
# checked. For a list of resources that support drift detection, see
# [Resources that Support Drift Detection][2].
#
@@ -2791,6 +3610,8 @@ module Aws::CloudFormation
# resp.stack_resource_drift.property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
# resp.stack_resource_drift.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
# resp.stack_resource_drift.timestamp #=> Time
+ # resp.stack_resource_drift.module_info.type_hierarchy #=> String
+ # resp.stack_resource_drift.module_info.logical_id_hierarchy #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackResourceDrift AWS API Documentation
#
@@ -2804,40 +3625,40 @@ module Aws::CloudFormation
# Detect drift on a stack set. When CloudFormation performs drift
# detection on a stack set, it performs drift detection on the stack
# associated with each stack instance in the stack set. For more
- # information, see [How CloudFormation Performs Drift Detection on a
- # Stack Set][1].
+ # information, see [How CloudFormation performs drift detection on a
+ # stack set][1].
#
# `DetectStackSetDrift` returns the `OperationId` of the stack set drift
- # detection operation. Use this operation id with `
- # DescribeStackSetOperation ` to monitor the progress of the drift
+ # detection operation. Use this operation id with
+ # DescribeStackSetOperation to monitor the progress of the drift
# detection operation. The drift detection operation may take some time,
# depending on the number of stack instances included in the stack set,
- # as well as the number of resources included in each stack.
+ # in addition to the number of resources included in each stack.
#
# Once the operation has completed, use the following actions to return
# drift information:
#
- # * Use ` DescribeStackSet ` to return detailed informaiton about the
- # stack set, including detailed information about the last *completed*
- # drift operation performed on the stack set. (Information about drift
- # operations that are in progress is not included.)
+ # * Use DescribeStackSet to return detailed information about the stack
+ # set, including detailed information about the last *completed* drift
+ # operation performed on the stack set. (Information about drift
+ # operations that are in progress isn't included.)
#
- # * Use ` ListStackInstances ` to return a list of stack instances
- # belonging to the stack set, including the drift status and last
- # drift time checked of each instance.
+ # * Use ListStackInstances to return a list of stack instances belonging
+ # to the stack set, including the drift status and last drift time
+ # checked of each instance.
#
- # * Use ` DescribeStackInstance ` to return detailed information about a
+ # * Use DescribeStackInstance to return detailed information about a
# specific stack instance, including its drift status and last drift
# time checked.
#
- # For more information on performing a drift detection operation on a
- # stack set, see [Detecting Unmanaged Changes in Stack Sets][1].
+ # For more information about performing a drift detection operation on a
+ # stack set, see [Detecting unmanaged changes in stack sets][1].
#
# You can only run a single drift detection operation on a given stack
# set at one time.
#
- # To stop a drift detection stack set operation, use `
- # StopStackSetOperation `.
+ # To stop a drift detection stack set operation, use
+ # StopStackSetOperation.
#
#
#
@@ -2848,10 +3669,10 @@ module Aws::CloudFormation
# operation.
#
# @option params [Types::StackSetOperationPreferences] :operation_preferences
- # The user-specified preferences for how AWS CloudFormation performs a
- # stack set operation.
+ # The user-specified preferences for how CloudFormation performs a stack
+ # set operation.
#
- # For more information on maximum concurrent accounts and failure
+ # For more information about maximum concurrent accounts and failure
# tolerance, see [Stack set operation options][1].
#
#
@@ -2864,6 +3685,28 @@ module Aws::CloudFormation
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.**
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Types::DetectStackSetDriftOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DetectStackSetDriftOutput#operation_id #operation_id} => String
@@ -2873,6 +3716,7 @@ module Aws::CloudFormation
# resp = client.detect_stack_set_drift({
# stack_set_name: "StackSetNameOrId", # required
# operation_preferences: {
+ # region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
# region_order: ["Region"],
# failure_tolerance_count: 1,
# failure_tolerance_percentage: 1,
@@ -2880,6 +3724,7 @@ module Aws::CloudFormation
# max_concurrent_percentage: 1,
# },
# operation_id: "ClientRequestToken",
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @example Response structure
@@ -2896,13 +3741,13 @@ module Aws::CloudFormation
end
# Returns the estimated monthly cost of a template. The return value is
- # an AWS Simple Monthly Calculator URL with a query string that
- # describes the resources required to run the template.
+ # an Amazon Web Services Simple Monthly Calculator URL with a query
+ # string that describes the resources required to run the template.
#
# @option params [String] :template_body
# Structure containing the template body with a minimum length of 1 byte
# and a maximum length of 51,200 bytes. (For more information, go to
- # [Template Anatomy][1] in the AWS CloudFormation User Guide.)
+ # [Template Anatomy][1] in the CloudFormation User Guide.)
#
# Conditional: You must pass `TemplateBody` or `TemplateURL`. If both
# are passed, only `TemplateBody` is used.
@@ -2913,8 +3758,9 @@ module Aws::CloudFormation
#
# @option params [String] :template_url
# Location of file containing the template body. The URL must point to a
- # template that is located in an Amazon S3 bucket. For more information,
- # go to [Template Anatomy][1] in the AWS CloudFormation User Guide.
+ # template that's located in an Amazon S3 bucket or a Systems Manager
+ # document. For more information, go to [Template Anatomy][1] in the
+ # CloudFormation User Guide.
#
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
# are passed, only `TemplateBody` is used.
@@ -2960,31 +3806,55 @@ module Aws::CloudFormation
# Updates a stack using the input information that was provided when the
# specified change set was created. After the call successfully
- # completes, AWS CloudFormation starts updating the stack. Use the
+ # completes, CloudFormation starts updating the stack. Use the
# DescribeStacks action to view the status of the update.
#
- # When you execute a change set, AWS CloudFormation deletes all other
- # change sets associated with the stack because they aren't valid for
- # the updated stack.
+ # When you execute a change set, CloudFormation deletes all other change
+ # sets associated with the stack because they aren't valid for the
+ # updated stack.
#
- # If a stack policy is associated with the stack, AWS CloudFormation
+ # If a stack policy is associated with the stack, CloudFormation
# enforces the policy during the update. You can't specify a temporary
# stack policy that overrides the current policy.
#
+ # To create a change set for the entire stack hierarchy,
+ # `IncludeNestedStacks` must have been set to `True`.
+ #
# @option params [required, String] :change_set_name
- # The name or ARN of the change set that you want use to update the
- # specified stack.
+ # The name or Amazon Resource Name (ARN) of the change set that you want
+ # use to update the specified stack.
#
# @option params [String] :stack_name
# If you specified the name of a change set, specify the stack name or
- # ID (ARN) that is associated with the change set you want to execute.
+ # Amazon Resource Name (ARN) that's associated with the change set you
+ # want to execute.
#
# @option params [String] :client_request_token
# A unique identifier for this `ExecuteChangeSet` request. Specify this
- # token if you plan to retry requests so that AWS CloudFormation knows
- # that you're not attempting to execute a change set to update a stack
- # with the same name. You might retry `ExecuteChangeSet` requests to
- # ensure that AWS CloudFormation successfully received them.
+ # token if you plan to retry requests so that CloudFormation knows that
+ # you're not attempting to execute a change set to update a stack with
+ # the same name. You might retry `ExecuteChangeSet` requests to ensure
+ # that CloudFormation successfully received them.
+ #
+ # @option params [Boolean] :disable_rollback
+ # Preserves the state of previously provisioned resources when an
+ # operation fails. This parameter can't be specified when the
+ # `OnStackFailure` parameter to the [CreateChangeSet][1] API operation
+ # was specified.
+ #
+ # * `True` - if the stack creation fails, do nothing. This is equivalent
+ # to specifying `DO_NOTHING` for the `OnStackFailure` parameter to the
+ # [CreateChangeSet][1] API operation.
+ #
+ # * `False` - if the stack creation fails, roll back the stack. This is
+ # equivalent to specifying `ROLLBACK` for the `OnStackFailure`
+ # parameter to the [CreateChangeSet][1] API operation.
+ #
+ # Default: `True`
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -2994,6 +3864,7 @@ module Aws::CloudFormation
# change_set_name: "ChangeSetNameOrId", # required
# stack_name: "StackNameOrId",
# client_request_token: "ClientRequestToken",
+ # disable_rollback: false,
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ExecuteChangeSet AWS API Documentation
@@ -3009,7 +3880,7 @@ module Aws::CloudFormation
# have a policy, a null value is returned.
#
# @option params [required, String] :stack_name
- # The name or unique stack ID that is associated with the stack whose
+ # The name or unique stack ID that's associated with the stack whose
# policy you want to get.
#
# @return [Types::GetStackPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -3038,16 +3909,16 @@ module Aws::CloudFormation
# Returns the template body for a specified stack. You can get the
# template for running or deleted stacks.
#
- # For deleted stacks, GetTemplate returns the template for up to 90 days
- # after the stack has been deleted.
+ # For deleted stacks, `GetTemplate` returns the template for up to 90
+ # days after the stack has been deleted.
#
- # <note markdown="1"> If the template does not exist, a `ValidationError` is returned.
+ # <note markdown="1"> If the template doesn't exist, a `ValidationError` is returned.
#
# </note>
#
# @option params [String] :stack_name
- # The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # The name or the unique stack ID that's associated with the stack,
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -3057,19 +3928,19 @@ module Aws::CloudFormation
# Default: There is no default value.
#
# @option params [String] :change_set_name
- # The name or Amazon Resource Name (ARN) of a change set for which AWS
+ # The name or Amazon Resource Name (ARN) of a change set for which
# CloudFormation returns the associated template. If you specify a name,
# you must also specify the `StackName`.
#
# @option params [String] :template_stage
# For templates that include transforms, the stage of the template that
- # AWS CloudFormation returns. To get the user-submitted template,
- # specify `Original`. To get the template after AWS CloudFormation has
- # processed all transforms, specify `Processed`.
+ # CloudFormation returns. To get the user-submitted template, specify
+ # `Original`. To get the template after CloudFormation has processed all
+ # transforms, specify `Processed`.
#
# If the template doesn't include transforms, `Original` and
- # `Processed` return the same template. By default, AWS CloudFormation
- # specifies `Original`.
+ # `Processed` return the same template. By default, CloudFormation
+ # specifies `Processed`.
#
# @return [Types::GetTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -3110,13 +3981,12 @@ module Aws::CloudFormation
#
# For deleted stacks, `GetTemplateSummary` returns the template
# information for up to 90 days after the stack has been deleted. If the
- # template does not exist, a `ValidationError` is returned.
+ # template doesn't exist, a `ValidationError` is returned.
#
# @option params [String] :template_body
# Structure containing the template body with a minimum length of 1 byte
# and a maximum length of 51,200 bytes. For more information about
- # templates, see [Template Anatomy][1] in the AWS CloudFormation User
- # Guide.
+ # templates, see [Template anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify only one of the following parameters:
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
@@ -3127,9 +3997,9 @@ module Aws::CloudFormation
#
# @option params [String] :template_url
# Location of file containing the template body. The URL must point to a
- # template (max size: 460,800 bytes) that is located in an Amazon S3
- # bucket. For more information about templates, see [Template
- # Anatomy][1] in the AWS CloudFormation User Guide.
+ # template (max size: 460,800 bytes) that's located in an Amazon S3
+ # bucket or a Systems Manager document. For more information about
+ # templates, see [Template anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify only one of the following parameters:
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
@@ -3139,10 +4009,10 @@ module Aws::CloudFormation
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [String] :stack_name
- # The name or the stack ID that is associated with the stack, which are
- # not always interchangeable. For running stacks, you can specify either
- # the stack's name or its unique stack ID. For deleted stack, you must
- # specify the unique stack ID.
+ # The name or the stack ID that's associated with the stack, which
+ # aren't always interchangeable. For running stacks, you can specify
+ # either the stack's name or its unique stack ID. For deleted stack,
+ # you must specify the unique stack ID.
#
# Conditional: You must specify only one of the following parameters:
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
@@ -3154,6 +4024,28 @@ module Aws::CloudFormation
# Conditional: You must specify only one of the following parameters:
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Types::GetTemplateSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetTemplateSummaryOutput#parameters #parameters} => Array<Types::ParameterDeclaration>
@@ -3173,6 +4065,7 @@ module Aws::CloudFormation
# template_url: "TemplateURL",
# stack_name: "StackNameOrId",
# stack_set_name: "StackSetNameOrId",
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @example Response structure
@@ -3211,8 +4104,94 @@ module Aws::CloudFormation
req.send_request(options)
end
+ # Import existing stacks into a new stack sets. Use the stack import
+ # operation to import up to 10 stacks into a new stack set in the same
+ # account as the source stack or in a different administrator account
+ # and Region, by specifying the stack ID of the stack you intend to
+ # import.
+ #
+ # @option params [required, String] :stack_set_name
+ # The name of the stack set. The name must be unique in the Region where
+ # you create your stack set.
+ #
+ # @option params [Array<String>] :stack_ids
+ # The IDs of the stacks you are importing into a stack set. You import
+ # up to 10 stacks per stack set at a time.
+ #
+ # Specify either `StackIds` or `StackIdsUrl`.
+ #
+ # @option params [String] :stack_ids_url
+ # The Amazon S3 URL which contains list of stack ids to be inputted.
+ #
+ # Specify either `StackIds` or `StackIdsUrl`.
+ #
+ # @option params [Array<String>] :organizational_unit_ids
+ # The list of OU ID's to which the stacks being imported has to be
+ # mapped as deployment target.
+ #
+ # @option params [Types::StackSetOperationPreferences] :operation_preferences
+ # The user-specified preferences for how CloudFormation performs a stack
+ # set operation.
+ #
+ # For more information about maximum concurrent accounts and failure
+ # tolerance, see [Stack set operation options][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
+ #
+ # @option params [String] :operation_id
+ # A unique, user defined, identifier for the stack set operation.
+ #
+ # **A suitable default value is auto-generated.** You should normally
+ # not need to pass this option.**
+ #
+ # @option params [String] :call_as
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * For service managed stack sets, specify `DELEGATED_ADMIN`.
+ #
+ # @return [Types::ImportStacksToStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ImportStacksToStackSetOutput#operation_id #operation_id} => String
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.import_stacks_to_stack_set({
+ # stack_set_name: "StackSetNameOrId", # required
+ # stack_ids: ["StackId"],
+ # stack_ids_url: "StackIdsUrl",
+ # organizational_unit_ids: ["OrganizationalUnitId"],
+ # operation_preferences: {
+ # region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
+ # region_order: ["Region"],
+ # failure_tolerance_count: 1,
+ # failure_tolerance_percentage: 1,
+ # max_concurrent_count: 1,
+ # max_concurrent_percentage: 1,
+ # },
+ # operation_id: "ClientRequestToken",
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.operation_id #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSet AWS API Documentation
+ #
+ # @overload import_stacks_to_stack_set(params = {})
+ # @param [Hash] params ({})
+ def import_stacks_to_stack_set(params = {}, options = {})
+ req = build_request(:import_stacks_to_stack_set, params)
+ req.send_request(options)
+ end
+
# Returns the ID and status of each active change set for a stack. For
- # example, AWS CloudFormation lists change sets that are in the
+ # example, CloudFormation lists change sets that are in the
# `CREATE_IN_PROGRESS` or `CREATE_PENDING` state.
#
# @option params [required, String] :stack_name
@@ -3245,10 +4224,13 @@ module Aws::CloudFormation
# resp.summaries[0].change_set_id #=> String
# resp.summaries[0].change_set_name #=> String
# resp.summaries[0].execution_status #=> String, one of "UNAVAILABLE", "AVAILABLE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "OBSOLETE"
- # resp.summaries[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_COMPLETE", "FAILED"
+ # resp.summaries[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "FAILED"
# resp.summaries[0].status_reason #=> String
# resp.summaries[0].creation_time #=> Time
# resp.summaries[0].description #=> String
+ # resp.summaries[0].include_nested_stacks #=> Boolean
+ # resp.summaries[0].parent_change_set_id #=> String
+ # resp.summaries[0].root_change_set_id #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListChangeSets AWS API Documentation
@@ -3263,10 +4245,10 @@ module Aws::CloudFormation
# Lists all exported output values in the account and Region in which
# you call this action. Use this action to see the exported output
# values that you can import into other stacks. To import values, use
- # the [ `Fn::ImportValue` ][1] function.
+ # the [ Fn::ImportValue][1] function.
#
- # For more information, see [ AWS CloudFormation Export Stack Output
- # Values][2].
+ # For more information, see [ CloudFormation export stack output
+ # values][2].
#
#
#
@@ -3313,14 +4295,14 @@ module Aws::CloudFormation
# your account, see ListExports.
#
# For more information about importing an exported output value, see the
- # [ `Fn::ImportValue` ][1] function.
+ # [Fn::ImportValue][1] function.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html
#
# @option params [required, String] :export_name
- # The name of the exported output value. AWS CloudFormation returns the
+ # The name of the exported output value. CloudFormation returns the
# stack names that are importing this value.
#
# @option params [String] :next_token
@@ -3359,20 +4341,20 @@ module Aws::CloudFormation
# Returns summary information about stack instances that are associated
# with the specified stack set. You can filter for stack instances that
- # are associated with a specific AWS account name or Region, or that
- # have a specific status.
+ # are associated with a specific Amazon Web Services account name or
+ # Region, or that have a specific status.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you want to list stack
# instances for.
#
# @option params [String] :next_token
- # If the previous request didn't return all of the remaining results,
- # the response's `NextToken` parameter value is set to a token. To
- # retrieve the next set of results, call `ListStackInstances` again and
- # assign that token to the request object's `NextToken` parameter. If
- # there are no remaining results, the previous response object's
- # `NextToken` parameter is set to `null`.
+ # If the previous request didn't return all the remaining results, the
+ # response's `NextToken` parameter value is set to a token. To retrieve
+ # the next set of results, call `ListStackInstances` again and assign
+ # that token to the request object's `NextToken` parameter. If there
+ # are no remaining results, the previous response object's `NextToken`
+ # parameter is set to `null`.
#
# @option params [Integer] :max_results
# The maximum number of results to be returned with a single call. If
@@ -3381,14 +4363,37 @@ module Aws::CloudFormation
# request parameter to get the next set of results.
#
# @option params [Array<Types::StackInstanceFilter>] :filters
- # The status that stack instances are filtered by.
+ # The filter to apply to stack instances
#
# @option params [String] :stack_instance_account
- # The name of the AWS account that you want to list stack instances for.
+ # The name of the Amazon Web Services account that you want to list
+ # stack instances for.
#
# @option params [String] :stack_instance_region
# The name of the Region where you want to list stack instances.
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Types::ListStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListStackInstancesOutput#summaries #summaries} => Array<Types::StackInstanceSummary>
@@ -3404,12 +4409,13 @@ module Aws::CloudFormation
# max_results: 1,
# filters: [
# {
- # name: "DETAILED_STATUS", # accepts DETAILED_STATUS
+ # name: "DETAILED_STATUS", # accepts DETAILED_STATUS, LAST_OPERATION_ID
# values: "StackInstanceFilterValues",
# },
# ],
# stack_instance_account: "Account",
# stack_instance_region: "Region",
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @example Response structure
@@ -3421,10 +4427,11 @@ module Aws::CloudFormation
# resp.summaries[0].stack_id #=> String
# resp.summaries[0].status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
# resp.summaries[0].status_reason #=> String
- # resp.summaries[0].stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE"
+ # resp.summaries[0].stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE", "SKIPPED_SUSPENDED_ACCOUNT"
# resp.summaries[0].organizational_unit_id #=> String
# resp.summaries[0].drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
# resp.summaries[0].last_drift_check_timestamp #=> Time
+ # resp.summaries[0].last_operation_id #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstances AWS API Documentation
@@ -3443,7 +4450,7 @@ module Aws::CloudFormation
#
# @option params [required, String] :stack_name
# The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -3477,10 +4484,12 @@ module Aws::CloudFormation
# resp.stack_resource_summaries[0].physical_resource_id #=> String
# resp.stack_resource_summaries[0].resource_type #=> String
# resp.stack_resource_summaries[0].last_updated_timestamp #=> Time
- # resp.stack_resource_summaries[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE"
+ # resp.stack_resource_summaries[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
# resp.stack_resource_summaries[0].resource_status_reason #=> String
# resp.stack_resource_summaries[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
# resp.stack_resource_summaries[0].drift_information.last_check_timestamp #=> Time
+ # resp.stack_resource_summaries[0].module_info.type_hierarchy #=> String
+ # resp.stack_resource_summaries[0].module_info.logical_id_hierarchy #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackResources AWS API Documentation
@@ -3503,13 +4512,12 @@ module Aws::CloudFormation
# The ID of the stack set operation.
#
# @option params [String] :next_token
- # If the previous request didn't return all of the remaining results,
- # the response object's `NextToken` parameter value is set to a token.
- # To retrieve the next set of results, call
- # `ListStackSetOperationResults` again and assign that token to the
- # request object's `NextToken` parameter. If there are no remaining
- # results, the previous response object's `NextToken` parameter is set
- # to `null`.
+ # If the previous request didn't return all the remaining results, the
+ # response object's `NextToken` parameter value is set to a token. To
+ # retrieve the next set of results, call `ListStackSetOperationResults`
+ # again and assign that token to the request object's `NextToken`
+ # parameter. If there are no remaining results, the previous response
+ # object's `NextToken` parameter is set to `null`.
#
# @option params [Integer] :max_results
# The maximum number of results to be returned with a single call. If
@@ -3517,6 +4525,31 @@ module Aws::CloudFormation
# includes a `NextToken` value that you can assign to the `NextToken`
# request parameter to get the next set of results.
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
+ # @option params [Array<Types::OperationResultFilter>] :filters
+ # The filter to apply to operation results.
+ #
# @return [Types::ListStackSetOperationResultsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListStackSetOperationResultsOutput#summaries #summaries} => Array<Types::StackSetOperationResultSummary>
@@ -3531,6 +4564,13 @@ module Aws::CloudFormation
# operation_id: "ClientRequestToken", # required
# next_token: "NextToken",
# max_results: 1,
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
+ # filters: [
+ # {
+ # name: "OPERATION_RESULT_STATUS", # accepts OPERATION_RESULT_STATUS
+ # values: "OperationResultFilterValues",
+ # },
+ # ],
# })
#
# @example Response structure
@@ -3575,6 +4615,28 @@ module Aws::CloudFormation
# includes a `NextToken` value that you can assign to the `NextToken`
# request parameter to get the next set of results.
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Types::ListStackSetOperationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListStackSetOperationsOutput#summaries #summaries} => Array<Types::StackSetOperationSummary>
@@ -3588,6 +4650,7 @@ module Aws::CloudFormation
# stack_set_name: "StackSetName", # required
# next_token: "NextToken",
# max_results: 1,
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @example Response structure
@@ -3598,6 +4661,15 @@ module Aws::CloudFormation
# resp.summaries[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "STOPPING", "STOPPED", "QUEUED"
# resp.summaries[0].creation_timestamp #=> Time
# resp.summaries[0].end_timestamp #=> Time
+ # resp.summaries[0].status_reason #=> String
+ # resp.summaries[0].status_details.failed_stack_instances_count #=> Integer
+ # resp.summaries[0].operation_preferences.region_concurrency_type #=> String, one of "SEQUENTIAL", "PARALLEL"
+ # resp.summaries[0].operation_preferences.region_order #=> Array
+ # resp.summaries[0].operation_preferences.region_order[0] #=> String
+ # resp.summaries[0].operation_preferences.failure_tolerance_count #=> Integer
+ # resp.summaries[0].operation_preferences.failure_tolerance_percentage #=> Integer
+ # resp.summaries[0].operation_preferences.max_concurrent_count #=> Integer
+ # resp.summaries[0].operation_preferences.max_concurrent_percentage #=> Integer
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperations AWS API Documentation
@@ -3612,8 +4684,22 @@ module Aws::CloudFormation
# Returns summary information about stack sets that are associated with
# the user.
#
+ # * \[Self-managed permissions\] If you set the `CallAs` parameter to
+ # `SELF` while signed in to your Amazon Web Services account,
+ # `ListStackSets` returns all self-managed stack sets in your Amazon
+ # Web Services account.
+ #
+ # * \[Service-managed permissions\] If you set the `CallAs` parameter to
+ # `SELF` while signed in to the organization's management account,
+ # `ListStackSets` returns all stack sets in the management account.
+ #
+ # * \[Service-managed permissions\] If you set the `CallAs` parameter to
+ # `DELEGATED_ADMIN` while signed in to your member account,
+ # `ListStackSets` returns all stack sets with service-managed
+ # permissions in the management account.
+ #
# @option params [String] :next_token
- # If the previous paginated request didn't return all of the remaining
+ # If the previous paginated request didn't return all the remaining
# results, the response object's `NextToken` parameter value is set to
# a token. To retrieve the next set of results, call `ListStackSets`
# again and assign that token to the request object's `NextToken`
@@ -3630,10 +4716,32 @@ module Aws::CloudFormation
# The status of the stack sets that you want to get summary information
# about.
#
- # @return [Types::ListStackSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the management account or as a delegated
+ # administrator in a member account.
#
- # * {Types::ListStackSetsOutput#summaries #summaries} => Array<Types::StackSetSummary>
- # * {Types::ListStackSetsOutput#next_token #next_token} => String
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
+ # @return [Types::ListStackSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::ListStackSetsOutput#summaries #summaries} => Array<Types::StackSetSummary>
+ # * {Types::ListStackSetsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
@@ -3643,6 +4751,7 @@ module Aws::CloudFormation
# next_token: "NextToken",
# max_results: 1,
# status: "ACTIVE", # accepts ACTIVE, DELETED
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @example Response structure
@@ -3657,6 +4766,7 @@ module Aws::CloudFormation
# resp.summaries[0].permission_model #=> String, one of "SERVICE_MANAGED", "SELF_MANAGED"
# resp.summaries[0].drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
# resp.summaries[0].last_drift_check_timestamp #=> Time
+ # resp.summaries[0].managed_execution.active #=> Boolean
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSets AWS API Documentation
@@ -3696,7 +4806,7 @@ module Aws::CloudFormation
#
# resp = client.list_stacks({
# next_token: "NextToken",
- # stack_status_filter: ["CREATE_IN_PROGRESS"], # accepts CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE, REVIEW_IN_PROGRESS, IMPORT_IN_PROGRESS, IMPORT_COMPLETE, IMPORT_ROLLBACK_IN_PROGRESS, IMPORT_ROLLBACK_FAILED, IMPORT_ROLLBACK_COMPLETE
+ # stack_status_filter: ["CREATE_IN_PROGRESS"], # accepts CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE, REVIEW_IN_PROGRESS, IMPORT_IN_PROGRESS, IMPORT_COMPLETE, IMPORT_ROLLBACK_IN_PROGRESS, IMPORT_ROLLBACK_FAILED, IMPORT_ROLLBACK_COMPLETE
# })
#
# @example Response structure
@@ -3708,7 +4818,7 @@ module Aws::CloudFormation
# resp.stack_summaries[0].creation_time #=> Time
# resp.stack_summaries[0].last_updated_time #=> Time
# resp.stack_summaries[0].deletion_time #=> Time
- # resp.stack_summaries[0].stack_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_FAILED", "ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "REVIEW_IN_PROGRESS", "IMPORT_IN_PROGRESS", "IMPORT_COMPLETE", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE"
+ # resp.stack_summaries[0].stack_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_FAILED", "ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "REVIEW_IN_PROGRESS", "IMPORT_IN_PROGRESS", "IMPORT_COMPLETE", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE"
# resp.stack_summaries[0].stack_status_reason #=> String
# resp.stack_summaries[0].parent_id #=> String
# resp.stack_summaries[0].root_id #=> String
@@ -3725,27 +4835,25 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Returns a list of registration tokens for the specified type(s).
+ # Returns a list of registration tokens for the specified extension(s).
#
# @option params [String] :type
- # The kind of type.
- #
- # Currently the only valid value is `RESOURCE`.
+ # The kind of extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_name
- # The name of the type.
+ # The name of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_arn
- # The Amazon Resource Name (ARN) of the type.
+ # The Amazon Resource Name (ARN) of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :registration_status_filter
- # The current status of the type registration request.
+ # The current status of the extension registration request.
#
# The default is `IN_PROGRESS`.
#
@@ -3756,7 +4864,7 @@ module Aws::CloudFormation
# request parameter to get the next set of results.
#
# @option params [String] :next_token
- # If the previous paginated request didn't return all of the remaining
+ # If the previous paginated request didn't return all the remaining
# results, the response object's `NextToken` parameter value is set to
# a token. To retrieve the next set of results, call this action again
# and assign that token to the request object's `NextToken` parameter.
@@ -3773,7 +4881,7 @@ module Aws::CloudFormation
# @example Request syntax with placeholder values
#
# resp = client.list_type_registrations({
- # type: "RESOURCE", # accepts RESOURCE
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
# type_name: "TypeName",
# type_arn: "TypeArn",
# registration_status_filter: "COMPLETE", # accepts COMPLETE, IN_PROGRESS, FAILED
@@ -3796,23 +4904,22 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Returns summary information about the versions of a type.
+ # Returns summary information about the versions of an extension.
#
# @option params [String] :type
- # The kind of the type.
- #
- # Currently the only valid value is `RESOURCE`.
+ # The kind of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_name
- # The name of the type for which you want version summary information.
+ # The name of the extension for which you want version summary
+ # information.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :arn
- # The Amazon Resource Name (ARN) of the type for which you want version
- # summary information.
+ # The Amazon Resource Name (ARN) of the extension for which you want
+ # version summary information.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
@@ -3831,20 +4938,25 @@ module Aws::CloudFormation
# `NextToken` parameter is set to `null`.
#
# @option params [String] :deprecated_status
- # The deprecation status of the type versions that you want to get
+ # The deprecation status of the extension versions that you want to get
# summary information about.
#
# Valid values include:
#
- # * `LIVE`\: The type version is registered and can be used in
+ # * `LIVE`: The extension version is registered and can be used in
# CloudFormation operations, dependent on its provisioning behavior
# and visibility scope.
#
- # * `DEPRECATED`\: The type version has been deregistered and can no
+ # * `DEPRECATED`: The extension version has been deregistered and can no
# longer be used in CloudFormation operations.
#
# The default is `LIVE`.
#
+ # @option params [String] :publisher_id
+ # The publisher ID of the extension publisher.
+ #
+ # Extensions published by Amazon aren't assigned a publisher ID.
+ #
# @return [Types::ListTypeVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListTypeVersionsOutput#type_version_summaries #type_version_summaries} => Array<Types::TypeVersionSummary>
@@ -3855,24 +4967,26 @@ module Aws::CloudFormation
# @example Request syntax with placeholder values
#
# resp = client.list_type_versions({
- # type: "RESOURCE", # accepts RESOURCE
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
# type_name: "TypeName",
- # arn: "PrivateTypeArn",
+ # arn: "TypeArn",
# max_results: 1,
# next_token: "NextToken",
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
+ # publisher_id: "PublisherId",
# })
#
# @example Response structure
#
# resp.type_version_summaries #=> Array
- # resp.type_version_summaries[0].type #=> String, one of "RESOURCE"
+ # resp.type_version_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
# resp.type_version_summaries[0].type_name #=> String
# resp.type_version_summaries[0].version_id #=> String
# resp.type_version_summaries[0].is_default_version #=> Boolean
# resp.type_version_summaries[0].arn #=> String
# resp.type_version_summaries[0].time_created #=> Time
# resp.type_version_summaries[0].description #=> String
+ # resp.type_version_summaries[0].public_version_number #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeVersions AWS API Documentation
@@ -3884,52 +4998,73 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Returns summary information about types that have been registered with
- # CloudFormation.
+ # Returns summary information about extension that have been registered
+ # with CloudFormation.
#
# @option params [String] :visibility
- # The scope at which the type is visible and usable in CloudFormation
- # operations.
+ # The scope at which the extensions are visible and usable in
+ # CloudFormation operations.
#
# Valid values include:
#
- # * `PRIVATE`\: The type is only visible and usable within the account
- # in which it is registered. Currently, AWS CloudFormation marks any
- # types you create as `PRIVATE`.
+ # * `PRIVATE`: Extensions that are visible and usable within this
+ # account and Region. This includes:
+ #
+ # * Private extensions you have registered in this account and Region.
+ #
+ # * Public extensions that you have activated in this account and
+ # Region.
#
- # * `PUBLIC`\: The type is publically visible and usable within any
- # Amazon account.
+ # * `PUBLIC`: Extensions that are publicly visible and available to be
+ # activated within any Amazon Web Services account. This includes
+ # extensions from Amazon Web Services, in addition to third-party
+ # publishers.
#
# The default is `PRIVATE`.
#
# @option params [String] :provisioning_type
- # The provisioning behavior of the type. AWS CloudFormation determines
- # the provisioning type during registration, based on the types of
- # handlers in the schema handler package submitted.
+ # For resource types, the provisioning behavior of the resource type.
+ # CloudFormation determines the provisioning type during registration,
+ # based on the types of handlers in the schema handler package
+ # submitted.
#
# Valid values include:
#
- # * `FULLY_MUTABLE`\: The type includes an update handler to process
- # updates to the type during stack update operations.
+ # * `FULLY_MUTABLE`: The resource type includes an update handler to
+ # process updates to the type during stack update operations.
#
- # * `IMMUTABLE`\: The type does not include an update handler, so the
- # type cannot be updated and must instead be replaced during stack
- # update operations.
+ # * `IMMUTABLE`: The resource type doesn't include an update handler,
+ # so the type can't be updated and must instead be replaced during
+ # stack update operations.
#
- # * `NON_PROVISIONABLE`\: The type does not include create, read, and
- # delete handlers, and therefore cannot actually be provisioned.
+ # * `NON_PROVISIONABLE`: The resource type doesn't include create,
+ # read, and delete handlers, and therefore can't actually be
+ # provisioned.
+ #
+ # The default is `FULLY_MUTABLE`.
#
# @option params [String] :deprecated_status
- # The deprecation status of the types that you want to get summary
+ # The deprecation status of the extension that you want to get summary
# information about.
#
# Valid values include:
#
- # * `LIVE`\: The type is registered for use in CloudFormation
+ # * `LIVE`: The extension is registered for use in CloudFormation
# operations.
#
- # * `DEPRECATED`\: The type has been deregistered and can no longer be
- # used in CloudFormation operations.
+ # * `DEPRECATED`: The extension has been deregistered and can no longer
+ # be used in CloudFormation operations.
+ #
+ # @option params [String] :type
+ # The type of extension.
+ #
+ # @option params [Types::TypeFilters] :filters
+ # Filter criteria to use in determining which extensions to return.
+ #
+ # Filters must be compatible with `Visibility` to return valid results.
+ # For example, specifying `AWS_TYPES` for `Category` and `PRIVATE` for
+ # `Visibility` returns an empty list of types, but specifying `PUBLIC`
+ # for `Visibility` returns the desired list.
#
# @option params [Integer] :max_results
# The maximum number of results to be returned with a single call. If
@@ -3938,7 +5073,7 @@ module Aws::CloudFormation
# request parameter to get the next set of results.
#
# @option params [String] :next_token
- # If the previous paginated request didn't return all of the remaining
+ # If the previous paginated request didn't return all the remaining
# results, the response object's `NextToken` parameter value is set to
# a token. To retrieve the next set of results, call this action again
# and assign that token to the request object's `NextToken` parameter.
@@ -3958,6 +5093,12 @@ module Aws::CloudFormation
# visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
# provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
+ # filters: {
+ # category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
+ # publisher_id: "PublisherId",
+ # type_name_prefix: "TypeNamePrefix",
+ # },
# max_results: 1,
# next_token: "NextToken",
# })
@@ -3965,12 +5106,19 @@ module Aws::CloudFormation
# @example Response structure
#
# resp.type_summaries #=> Array
- # resp.type_summaries[0].type #=> String, one of "RESOURCE"
+ # resp.type_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
# resp.type_summaries[0].type_name #=> String
# resp.type_summaries[0].default_version_id #=> String
# resp.type_summaries[0].type_arn #=> String
# resp.type_summaries[0].last_updated #=> Time
# resp.type_summaries[0].description #=> String
+ # resp.type_summaries[0].publisher_id #=> String
+ # resp.type_summaries[0].original_type_name #=> String
+ # resp.type_summaries[0].public_version_number #=> String
+ # resp.type_summaries[0].latest_public_version #=> String
+ # resp.type_summaries[0].publisher_identity #=> String, one of "AWS_Marketplace", "GitHub", "Bitbucket"
+ # resp.type_summaries[0].publisher_name #=> String
+ # resp.type_summaries[0].is_activated #=> Boolean
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypes AWS API Documentation
@@ -3982,9 +5130,85 @@ module Aws::CloudFormation
req.send_request(options)
end
+ # Publishes the specified extension to the CloudFormation registry as a
+ # public extension in this Region. Public extensions are available for
+ # use by all CloudFormation users. For more information about publishing
+ # extensions, see [Publishing extensions to make them available for
+ # public use][1] in the *CloudFormation CLI User Guide*.
+ #
+ # To publish an extension, you must be registered as a publisher with
+ # CloudFormation. For more information, see [RegisterPublisher][2].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html
+ #
+ # @option params [String] :type
+ # The type of the extension.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ #
+ # @option params [String] :arn
+ # The Amazon Resource Name (ARN) of the extension.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ #
+ # @option params [String] :type_name
+ # The name of the extension.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ #
+ # @option params [String] :public_version_number
+ # The version number to assign to this version of the extension.
+ #
+ # Use the following format, and adhere to semantic versioning when
+ # assigning a version number to your extension:
+ #
+ # `MAJOR.MINOR.PATCH`
+ #
+ # For more information, see [Semantic Versioning 2.0.0][1].
+ #
+ # If you don't specify a version number, CloudFormation increments the
+ # version number by one minor version release.
+ #
+ # You cannot specify a version number the first time you publish a type.
+ # CloudFormation automatically sets the first version number to be
+ # `1.0.0`.
+ #
+ #
+ #
+ # [1]: https://semver.org/
+ #
+ # @return [Types::PublishTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::PublishTypeOutput#public_type_arn #public_type_arn} => String
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.publish_type({
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
+ # arn: "PrivateTypeArn",
+ # type_name: "TypeName",
+ # public_version_number: "PublicVersionNumber",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.public_type_arn #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/PublishType AWS API Documentation
+ #
+ # @overload publish_type(params = {})
+ # @param [Hash] params ({})
+ def publish_type(params = {}, options = {})
+ req = build_request(:publish_type, params)
+ req.send_request(options)
+ end
+
# Reports progress of a resource handler to CloudFormation.
#
- # Reserved for use by the [CloudFormation CLI][1]. Do not use this API
+ # Reserved for use by the [CloudFormation CLI][1]. Don't use this API
# in your code.
#
#
@@ -4049,7 +5273,7 @@ module Aws::CloudFormation
# operation_status: "PENDING", # required, accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
# current_operation_status: "PENDING", # accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
# status_message: "StatusMessage",
- # error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure
+ # error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure, InvalidTypeConfiguration, HandlerInternalFailure, NonCompliant, Unknown, UnsupportedTarget
# resource_model: "ResourceModel",
# client_request_token: "ClientRequestToken",
# })
@@ -4063,46 +5287,122 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Registers a type with the CloudFormation service. Registering a type
- # makes it available for use in CloudFormation templates in your AWS
- # account, and includes:
+ # Registers your account as a publisher of public extensions in the
+ # CloudFormation registry. Public extensions are available for use by
+ # all CloudFormation users. This publisher ID applies to your account in
+ # all Amazon Web Services Regions.
+ #
+ # For information about requirements for registering as a public
+ # extension publisher, see [Registering your account to publish
+ # CloudFormation extensions][1] in the *CloudFormation CLI User Guide*.
+ #
+ #
+ #
#
- # * Validating the resource schema
#
- # * Determining which handlers have been specified for the resource
+ # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs
#
- # * Making the resource type available for use in your account
+ # @option params [Boolean] :accept_terms_and_conditions
+ # Whether you accept the [Terms and Conditions][1] for publishing
+ # extensions in the CloudFormation registry. You must accept the terms
+ # and conditions in order to register to publish public extensions to
+ # the CloudFormation registry.
#
- # For more information on how to develop types and ready them for
- # registeration, see [Creating Resource Providers][1] in the
+ # The default is `false`.
+ #
+ #
+ #
+ # [1]: https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf
+ #
+ # @option params [String] :connection_arn
+ # If you are using a Bitbucket or GitHub account for identity
+ # verification, the Amazon Resource Name (ARN) for your connection to
+ # that account.
+ #
+ # For more information, see [Registering your account to publish
+ # CloudFormation extensions][1] in the *CloudFormation CLI User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs
+ #
+ # @return [Types::RegisterPublisherOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::RegisterPublisherOutput#publisher_id #publisher_id} => String
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.register_publisher({
+ # accept_terms_and_conditions: false,
+ # connection_arn: "ConnectionArn",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.publisher_id #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterPublisher AWS API Documentation
+ #
+ # @overload register_publisher(params = {})
+ # @param [Hash] params ({})
+ def register_publisher(params = {}, options = {})
+ req = build_request(:register_publisher, params)
+ req.send_request(options)
+ end
+
+ # Registers an extension with the CloudFormation service. Registering an
+ # extension makes it available for use in CloudFormation templates in
+ # your Amazon Web Services account, and includes:
+ #
+ # * Validating the extension schema.
+ #
+ # * Determining which handlers, if any, have been specified for the
+ # extension.
+ #
+ # * Making the extension available for use in your account.
+ #
+ # For more information about how to develop extensions and ready them
+ # for registration, see [Creating Resource Providers][1] in the
# *CloudFormation CLI User Guide*.
#
- # You can have a maximum of 50 resource type versions registered at a
- # time. This maximum is per account and per region. Use
- # [DeregisterType](AWSCloudFormation/latest/APIReference/API_DeregisterType.html)
- # to deregister specific resource type versions if necessary.
+ # You can have a maximum of 50 resource extension versions registered at
+ # a time. This maximum is per account and per Region. Use
+ # [DeregisterType][2] to deregister specific extension versions if
+ # necessary.
#
- # Once you have initiated a registration request using ` RegisterType `,
- # you can use ` DescribeTypeRegistration ` to monitor the progress of
- # the registration request.
+ # Once you have initiated a registration request using RegisterType, you
+ # can use DescribeTypeRegistration to monitor the progress of the
+ # registration request.
+ #
+ # Once you have registered a private extension in your account and
+ # Region, use [SetTypeConfiguration][3] to specify configuration
+ # properties for the extension. For more information, see [Configuring
+ # extensions at the account level][4] in the *CloudFormation User
+ # Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html
+ # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
+ # [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
#
# @option params [String] :type
- # The kind of type.
- #
- # Currently, the only valid value is `RESOURCE`.
+ # The kind of extension.
#
# @option params [required, String] :type_name
- # The name of the type being registered.
+ # The name of the extension being registered.
+ #
+ # We suggest that extension names adhere to the following patterns:
+ #
+ # * For resource types, *company\_or\_organization*::*service*::*type*.
#
- # We recommend that type names adhere to the following pattern:
- # *company\_or\_organization*\::*service*\::*type*.
+ # * For modules, *company\_or\_organization*::*service*::*type*::MODULE.
#
- # <note markdown="1"> The following organization namespaces are reserved and cannot be used
- # in your resource type names:
+ # * For hooks, *MyCompany*::*Testing*::*MyTestHook*.
+ #
+ # <note markdown="1"> The following organization namespaces are reserved and can't be used
+ # in your extension names:
#
# * `Alexa`
#
@@ -4119,48 +5419,60 @@ module Aws::CloudFormation
# </note>
#
# @option params [required, String] :schema_handler_package
- # A url to the S3 bucket containing the schema handler package that
- # contains the schema, event handlers, and associated files for the type
- # you want to register.
+ # A URL to the S3 bucket containing the extension project package that
+ # contains the necessary files for the extension you want to register.
#
- # For information on generating a schema handler package for the type
- # you want to register, see [submit][1] in the *CloudFormation CLI User
- # Guide*.
+ # For information about generating a schema handler package for the
+ # extension you want to register, see [submit][1] in the *CloudFormation
+ # CLI User Guide*.
#
- # <note markdown="1"> As part of registering a resource provider type, CloudFormation must
- # be able to access the S3 bucket which contains the schema handler
- # package for that resource provider. For more information, see [IAM
- # Permissions for Registering a Resource Provider][2] in the *AWS
- # CloudFormation User Guide*.
+ # <note markdown="1"> The user registering the extension must be able to access the package
+ # in the S3 bucket. That's, the user needs to have [GetObject][2]
+ # permissions for the schema handler package. For more information, see
+ # [Actions, Resources, and Condition Keys for Amazon S3][3] in the
+ # *Identity and Access Management User Guide*.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html
- # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register-permissions
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
+ # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html
#
# @option params [Types::LoggingConfig] :logging_config
- # Specifies logging configuration information for a type.
+ # Specifies logging configuration information for an extension.
#
# @option params [String] :execution_role_arn
# The Amazon Resource Name (ARN) of the IAM role for CloudFormation to
- # assume when invoking the resource provider. If your resource type
- # calls AWS APIs in any of its handlers, you must create an <i> <a
+ # assume when invoking the extension.
+ #
+ # For CloudFormation to assume the specified execution role, the role
+ # must contain a trust relationship with the CloudFormation service
+ # principle (`resources.cloudformation.amazonaws.com`). For more
+ # information about adding trust relationships, see [Modifying a role
+ # trust policy][1] in the *Identity and Access Management User Guide*.
+ #
+ # If your extension calls Amazon Web Services APIs in any of its
+ # handlers, you must create an <i> <a
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
# execution role</a> </i> that includes the necessary permissions to
- # call those AWS APIs, and provision that execution role in your
- # account. When CloudFormation needs to invoke the resource provider
+ # call those Amazon Web Services APIs, and provision that execution role
+ # in your account. When CloudFormation needs to invoke the resource type
# handler, CloudFormation assumes this execution role to create a
- # temporary session token, which it then passes to the resource provider
- # handler, thereby supplying your resource provider with the appropriate
+ # temporary session token, which it then passes to the resource type
+ # handler, thereby supplying your resource type with the appropriate
# credentials.
#
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy
+ #
# @option params [String] :client_request_token
# A unique identifier that acts as an idempotency key for this
# registration request. Specifying a client request token prevents
- # CloudFormation from generating more than one version of a type from
- # the same registeration request, even if the request is submitted
+ # CloudFormation from generating more than one version of an extension
+ # from the same registration request, even if the request is submitted
# multiple times.
#
# @return [Types::RegisterTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -4170,7 +5482,7 @@ module Aws::CloudFormation
# @example Request syntax with placeholder values
#
# resp = client.register_type({
- # type: "RESOURCE", # accepts RESOURCE
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
# type_name: "TypeName", # required
# schema_handler_package: "S3Url", # required
# logging_config: {
@@ -4194,6 +5506,62 @@ module Aws::CloudFormation
req.send_request(options)
end
+ # When specifying `RollbackStack`, you preserve the state of previously
+ # provisioned resources when an operation fails. You can check the
+ # status of the stack through the DescribeStacks operation.
+ #
+ # Rolls back the specified stack to the last known stable state from
+ # `CREATE_FAILED` or `UPDATE_FAILED` stack statuses.
+ #
+ # This operation will delete a stack if it doesn't contain a last known
+ # stable state. A last known stable state includes any status in a
+ # `*_COMPLETE`. This includes the following stack statuses.
+ #
+ # * `CREATE_COMPLETE`
+ #
+ # * `UPDATE_COMPLETE`
+ #
+ # * `UPDATE_ROLLBACK_COMPLETE`
+ #
+ # * `IMPORT_COMPLETE`
+ #
+ # * `IMPORT_ROLLBACK_COMPLETE`
+ #
+ # @option params [required, String] :stack_name
+ # The name that's associated with the stack.
+ #
+ # @option params [String] :role_arn
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # role that CloudFormation assumes to rollback the stack.
+ #
+ # @option params [String] :client_request_token
+ # A unique identifier for this `RollbackStack` request.
+ #
+ # @return [Types::RollbackStackOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::RollbackStackOutput#stack_id #stack_id} => String
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.rollback_stack({
+ # stack_name: "StackNameOrId", # required
+ # role_arn: "RoleARN",
+ # client_request_token: "ClientRequestToken",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.stack_id #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackStack AWS API Documentation
+ #
+ # @overload rollback_stack(params = {})
+ # @param [Hash] params ({})
+ def rollback_stack(params = {}, options = {})
+ req = build_request(:rollback_stack, params)
+ req.send_request(options)
+ end
+
# Sets a stack policy for a specified stack.
#
# @option params [required, String] :stack_name
@@ -4201,8 +5569,8 @@ module Aws::CloudFormation
#
# @option params [String] :stack_policy_body
# Structure containing the stack policy body. For more information, go
- # to [ Prevent Updates to Stack Resources][1] in the AWS CloudFormation
- # User Guide. You can specify either the `StackPolicyBody` or the
+ # to [ Prevent updates to stack resources][1] in the CloudFormation User
+ # Guide. You can specify either the `StackPolicyBody` or the
# `StackPolicyURL` parameter, but not both.
#
#
@@ -4211,9 +5579,9 @@ module Aws::CloudFormation
#
# @option params [String] :stack_policy_url
# Location of a file containing the stack policy. The URL must point to
- # a policy (maximum size: 16 KB) located in an S3 bucket in the same
- # Region as the stack. You can specify either the `StackPolicyBody` or
- # the `StackPolicyURL` parameter, but not both.
+ # a policy (maximum size: 16 KB) located in an Amazon S3 bucket in the
+ # same Amazon Web Services Region as the stack. You can specify either
+ # the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -4234,29 +5602,125 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Specify the default version of a type. The default version of a type
- # will be used in CloudFormation operations.
+ # Specifies the configuration data for a registered CloudFormation
+ # extension, in the given account and Region.
+ #
+ # To view the current configuration data for an extension, refer to the
+ # `ConfigurationSchema` element of [DescribeType][1]. For more
+ # information, see [Configuring extensions at the account level][2] in
+ # the *CloudFormation User Guide*.
+ #
+ # It's strongly recommended that you use dynamic references to restrict
+ # sensitive configuration definitions, such as third-party credentials.
+ # For more details on dynamic references, see [Using dynamic references
+ # to specify template values][3] in the *CloudFormation User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
+ # [3]: https://docs.aws.amazon.com/
+ #
+ # @option params [String] :type_arn
+ # The Amazon Resource Name (ARN) for the extension, in this account and
+ # Region.
+ #
+ # For public extensions, this will be the ARN assigned when you
+ # [activate the type][1] in this account and Region. For private
+ # extensions, this will be the ARN assigned when you [register the
+ # type][2] in this account and Region.
+ #
+ # Do not include the extension versions suffix at the end of the ARN.
+ # You can set the configuration for an extension, but not for a specific
+ # extension version.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
+ #
+ # @option params [required, String] :configuration
+ # The configuration data for the extension, in this account and Region.
+ #
+ # The configuration data must be formatted as JSON, and validate against
+ # the schema returned in the `ConfigurationSchema` response element of
+ # [DescribeType][1]. For more information, see [Defining account-level
+ # configuration data for an extension][2] in the *CloudFormation CLI
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
+ # [2]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
+ #
+ # @option params [String] :configuration_alias
+ # An alias by which to refer to this extension configuration data.
+ #
+ # Conditional: Specifying a configuration alias is required when setting
+ # a configuration for a resource type extension.
+ #
+ # @option params [String] :type_name
+ # The name of the extension.
+ #
+ # Conditional: You must specify `ConfigurationArn`, or `Type` and
+ # `TypeName`.
+ #
+ # @option params [String] :type
+ # The type of extension.
+ #
+ # Conditional: You must specify `ConfigurationArn`, or `Type` and
+ # `TypeName`.
+ #
+ # @return [Types::SetTypeConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::SetTypeConfigurationOutput#configuration_arn #configuration_arn} => String
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.set_type_configuration({
+ # type_arn: "TypeArn",
+ # configuration: "TypeConfiguration", # required
+ # configuration_alias: "TypeConfigurationAlias",
+ # type_name: "TypeName",
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.configuration_arn #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeConfiguration AWS API Documentation
+ #
+ # @overload set_type_configuration(params = {})
+ # @param [Hash] params ({})
+ def set_type_configuration(params = {}, options = {})
+ req = build_request(:set_type_configuration, params)
+ req.send_request(options)
+ end
+
+ # Specify the default version of an extension. The default version of an
+ # extension will be used in CloudFormation operations.
#
# @option params [String] :arn
- # The Amazon Resource Name (ARN) of the type for which you want version
- # summary information.
+ # The Amazon Resource Name (ARN) of the extension for which you want
+ # version summary information.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type
- # The kind of type.
+ # The kind of extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_name
- # The name of the type.
+ # The name of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :version_id
- # The ID of a specific version of the type. The version ID is the value
- # at the end of the Amazon Resource Name (ARN) assigned to the type
- # version when it is registered.
+ # The ID of a specific version of the extension. The version ID is the
+ # value at the end of the Amazon Resource Name (ARN) assigned to the
+ # extension version when it is registered.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
@@ -4264,7 +5728,7 @@ module Aws::CloudFormation
#
# resp = client.set_type_default_version({
# arn: "PrivateTypeArn",
- # type: "RESOURCE", # accepts RESOURCE
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
# type_name: "TypeName",
# version_id: "TypeVersionId",
# })
@@ -4279,12 +5743,12 @@ module Aws::CloudFormation
end
# Sends a signal to the specified resource with a success or failure
- # status. You can use the SignalResource API in conjunction with a
- # creation policy or update policy. AWS CloudFormation doesn't proceed
+ # status. You can use the `SignalResource` operation in conjunction with
+ # a creation policy or update policy. CloudFormation doesn't proceed
# with a stack creation or update until resources receive the required
# number of signals or the timeout period is exceeded. The
- # SignalResource API is useful in cases where you want to send signals
- # from anywhere other than an Amazon EC2 instance.
+ # `SignalResource` operation is useful in cases where you want to send
+ # signals from anywhere other than an Amazon EC2 instance.
#
# @option params [required, String] :stack_name
# The stack name or unique stack ID that includes the resource that you
@@ -4303,7 +5767,7 @@ module Aws::CloudFormation
#
# @option params [required, String] :status
# The status of the signal, which is either success or failure. A
- # failure signal causes AWS CloudFormation to immediately fail the stack
+ # failure signal causes CloudFormation to immediately fail the stack
# creation or update.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -4327,7 +5791,8 @@ module Aws::CloudFormation
end
# Stops an in-progress operation on a stack set and its associated stack
- # instances.
+ # instances. StackSets will cancel all the unstarted stack instance
+ # deployments and wait for those are in-progress to complete.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you want to stop the
@@ -4336,6 +5801,28 @@ module Aws::CloudFormation
# @option params [required, String] :operation_id
# The ID of the stack operation.
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
@@ -4343,6 +5830,7 @@ module Aws::CloudFormation
# resp = client.stop_stack_set_operation({
# stack_set_name: "StackSetName", # required
# operation_id: "ClientRequestToken", # required
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StopStackSetOperation AWS API Documentation
@@ -4354,9 +5842,120 @@ module Aws::CloudFormation
req.send_request(options)
end
+ # Tests a registered extension to make sure it meets all necessary
+ # requirements for being published in the CloudFormation registry.
+ #
+ # * For resource types, this includes passing all contracts tests
+ # defined for the type.
+ #
+ # * For modules, this includes determining if the module's model meets
+ # all necessary requirements.
+ #
+ # For more information, see [Testing your public extension prior to
+ # publishing][1] in the *CloudFormation CLI User Guide*.
+ #
+ # If you don't specify a version, CloudFormation uses the default
+ # version of the extension in your account and Region for testing.
+ #
+ # To perform testing, CloudFormation assumes the execution role
+ # specified when the type was registered. For more information, see
+ # [RegisterType][2].
+ #
+ # Once you've initiated testing on an extension using `TestType`, you
+ # can pass the returned `TypeVersionArn` into [DescribeType][3] to
+ # monitor the current test status and test status description for the
+ # extension.
+ #
+ # An extension must have a test status of `PASSED` before it can be
+ # published. For more information, see [Publishing extensions to make
+ # them available for public use][4] in the *CloudFormation CLI User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
+ # [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
+ # [4]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
+ #
+ # @option params [String] :arn
+ # The Amazon Resource Name (ARN) of the extension.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ #
+ # @option params [String] :type
+ # The type of the extension to test.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ #
+ # @option params [String] :type_name
+ # The name of the extension to test.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ #
+ # @option params [String] :version_id
+ # The version of the extension to test.
+ #
+ # You can specify the version id with either `Arn`, or with `TypeName`
+ # and `Type`.
+ #
+ # If you don't specify a version, CloudFormation uses the default
+ # version of the extension in this account and Region for testing.
+ #
+ # @option params [String] :log_delivery_bucket
+ # The S3 bucket to which CloudFormation delivers the contract test
+ # execution logs.
+ #
+ # CloudFormation delivers the logs by the time contract testing has
+ # completed and the extension has been assigned a test type status of
+ # `PASSED` or `FAILED`.
+ #
+ # The user calling `TestType` must be able to access items in the
+ # specified S3 bucket. Specifically, the user needs the following
+ # permissions:
+ #
+ # * `GetObject`
+ #
+ # * `PutObject`
+ #
+ # For more information, see [Actions, Resources, and Condition Keys for
+ # Amazon S3][1] in the *Amazon Web Services Identity and Access
+ # Management User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html
+ #
+ # @return [Types::TestTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::TestTypeOutput#type_version_arn #type_version_arn} => String
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.test_type({
+ # arn: "TypeArn",
+ # type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
+ # type_name: "TypeName",
+ # version_id: "TypeVersionId",
+ # log_delivery_bucket: "S3Bucket",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.type_version_arn #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TestType AWS API Documentation
+ #
+ # @overload test_type(params = {})
+ # @param [Hash] params ({})
+ def test_type(params = {}, options = {})
+ req = build_request(:test_type, params)
+ req.send_request(options)
+ end
+
# Updates a stack as specified in the template. After the call completes
# successfully, the stack update starts. You can check the status of the
- # stack via the DescribeStacks action.
+ # stack through the DescribeStacks action.
#
# To get a copy of the template for an existing stack, you can use the
# GetTemplate action.
@@ -4375,7 +5974,7 @@ module Aws::CloudFormation
# @option params [String] :template_body
# Structure containing the template body with a minimum length of 1 byte
# and a maximum length of 51,200 bytes. (For more information, go to
- # [Template Anatomy][1] in the AWS CloudFormation User Guide.)
+ # [Template Anatomy][1] in the CloudFormation User Guide.)
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
@@ -4387,8 +5986,9 @@ module Aws::CloudFormation
#
# @option params [String] :template_url
# Location of file containing the template body. The URL must point to a
- # template that is located in an Amazon S3 bucket. For more information,
- # go to [Template Anatomy][1] in the AWS CloudFormation User Guide.
+ # template that's located in an Amazon S3 bucket or a Systems Manager
+ # document. For more information, go to [Template Anatomy][1] in the
+ # CloudFormation User Guide.
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
@@ -4412,7 +6012,7 @@ module Aws::CloudFormation
# `StackPolicyDuringUpdateURL` parameter, but not both.
#
# If you want to update protected resources, specify a temporary
- # overriding stack policy during this update. If you do not specify a
+ # overriding stack policy during this update. If you don't specify a
# stack policy, the current policy that is associated with the stack
# will be used.
#
@@ -4424,7 +6024,7 @@ module Aws::CloudFormation
# parameter, but not both.
#
# If you want to update protected resources, specify a temporary
- # overriding stack policy during this update. If you do not specify a
+ # overriding stack policy during this update. If you don't specify a
# stack policy, the current policy that is associated with the stack
# will be used.
#
@@ -4438,16 +6038,16 @@ module Aws::CloudFormation
#
# @option params [Array<String>] :capabilities
# In some cases, you must explicitly acknowledge that your stack
- # template contains certain capabilities in order for AWS CloudFormation
- # to update the stack.
+ # template contains certain capabilities in order for CloudFormation to
+ # update the stack.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stacks, you
- # must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stacks, you must explicitly acknowledge this by specifying one of
+ # these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -4457,18 +6057,18 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
- # CloudFormation returns an `InsufficientCapabilities` error.
+ # * If you don't specify either of these capabilities, CloudFormation
+ # returns an `InsufficientCapabilities` error.
#
- # If your stack template contains these resources, we recommend that
- # you review all permissions associated with them and edit their
+ # If your stack template contains these resources, we suggest that you
+ # review all permissions associated with them and edit their
# permissions if necessary.
#
# * [ AWS::IAM::AccessKey][1]
#
# * [ AWS::IAM::Group][2]
#
- # * [ AWS::IAM::InstanceProfile][3]
+ # * [AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
@@ -4476,9 +6076,9 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::User][6]
#
- # * [ AWS::IAM::UserToGroupAddition][7]
+ # * [AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
@@ -4493,24 +6093,23 @@ module Aws::CloudFormation
# update a stack directly from the processed template, without first
# reviewing the resulting changes in a change set, you must
# acknowledge this capability. This includes the [AWS::Include][9] and
- # [AWS::Serverless][10] transforms, which are macros hosted by AWS
+ # [AWS::Serverless][10] transforms, which are macros hosted by
# CloudFormation.
#
- # Change sets do not currently support nested stacks. If you want to
- # update a stack from a stack template that contains macros *and*
- # nested stacks, you must update the stack directly from the template
- # using this capability.
+ # If you want to update a stack from a stack template that contains
+ # macros *and* nested stacks, you must update the stack directly from
+ # the template using this capability.
#
# You should only update stacks directly from a stack template that
# contains macros if you know what processing the macro performs.
#
# Each macro relies on an underlying Lambda service function for
# processing stack templates. Be aware that the Lambda function owner
- # can update the function operation without AWS CloudFormation being
+ # can update the function operation without CloudFormation being
# notified.
#
- # For more information, see [Using AWS CloudFormation Macros to
- # Perform Custom Processing on Templates][11].
+ # For more information, see [Using CloudFormation Macros to Perform
+ # Custom Processing on Templates][11].
#
#
#
@@ -4532,33 +6131,32 @@ module Aws::CloudFormation
# or `Custom::MyCustomInstance`.
#
# If the list of resource types doesn't include a resource that you're
- # updating, the stack update fails. By default, AWS CloudFormation
- # grants permissions to all resource types. AWS Identity and Access
- # Management (IAM) uses this parameter for AWS CloudFormation-specific
- # condition keys in IAM policies. For more information, see [Controlling
- # Access with AWS Identity and Access Management][1].
+ # updating, the stack update fails. By default, CloudFormation grants
+ # permissions to all resource types. Identity and Access Management
+ # (IAM) uses this parameter for CloudFormation-specific condition keys
+ # in IAM policies. For more information, see [Controlling Access with
+ # Identity and Access Management][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
#
# @option params [String] :role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to update the
- # stack. AWS CloudFormation uses the role's credentials to make calls
- # on your behalf. AWS CloudFormation always uses this role for all
- # future operations on the stack. As long as users have permission to
- # operate on the stack, AWS CloudFormation uses this role even if the
- # users don't have permission to pass it. Ensure that the role grants
- # least privilege.
- #
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available, AWS
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to update the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf. CloudFormation always uses this role for all future operations
+ # on the stack. Provided that users have permission to operate on the
+ # stack, CloudFormation uses this role even if the users don't have
+ # permission to pass it. Ensure that the role grants least privilege.
+ #
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
# CloudFormation uses a temporary session that is generated from your
# user credentials.
#
# @option params [Types::RollbackConfiguration] :rollback_configuration
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
#
@@ -4567,7 +6165,7 @@ module Aws::CloudFormation
# the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
#
# You might update the stack policy, for example, in order to protect a
- # new resource that you created during a stack update. If you do not
+ # new resource that you created during a stack update. If you don't
# specify a stack policy, the current policy that is associated with the
# stack is unchanged.
#
@@ -4578,29 +6176,35 @@ module Aws::CloudFormation
# the `StackPolicyURL` parameter, but not both.
#
# You might update the stack policy, for example, in order to protect a
- # new resource that you created during a stack update. If you do not
+ # new resource that you created during a stack update. If you don't
# specify a stack policy, the current policy that is associated with the
# stack is unchanged.
#
# @option params [Array<String>] :notification_arns
# Amazon Simple Notification Service topic Amazon Resource Names (ARNs)
- # that AWS CloudFormation associates with the stack. Specify an empty
- # list to remove all notification topics.
+ # that CloudFormation associates with the stack. Specify an empty list
+ # to remove all notification topics.
#
# @option params [Array<Types::Tag>] :tags
- # Key-value pairs to associate with this stack. AWS CloudFormation also
+ # Key-value pairs to associate with this stack. CloudFormation also
# propagates these tags to supported resources in the stack. You can
# specify a maximum number of 50 tags.
#
- # If you don't specify this parameter, AWS CloudFormation doesn't
- # modify the stack's tags. If you specify an empty value, AWS
- # CloudFormation removes all associated tags.
+ # If you don't specify this parameter, CloudFormation doesn't modify
+ # the stack's tags. If you specify an empty value, CloudFormation
+ # removes all associated tags.
+ #
+ # @option params [Boolean] :disable_rollback
+ # Preserve the state of previously provisioned resources when an
+ # operation fails.
+ #
+ # Default: `False`
#
# @option params [String] :client_request_token
# A unique identifier for this `UpdateStack` request. Specify this token
- # if you plan to retry requests so that AWS CloudFormation knows that
+ # if you plan to retry requests so that CloudFormation knows that
# you're not attempting to update a stack with the same name. You might
- # retry `UpdateStack` requests to ensure that AWS CloudFormation
+ # retry `UpdateStack` requests to ensure that CloudFormation
# successfully received them.
#
# All events triggered by a given stack operation are assigned the same
@@ -4659,6 +6263,7 @@ module Aws::CloudFormation
# value: "TagValue", # required
# },
# ],
+ # disable_rollback: false,
# client_request_token: "ClientRequestToken",
# })
#
@@ -4676,15 +6281,15 @@ module Aws::CloudFormation
end
# Updates the parameter values for stack instances for the specified
- # accounts, within the specified Regions. A stack instance refers to a
- # stack in a specific account and Region.
+ # accounts, within the specified Amazon Web Services Regions. A stack
+ # instance refers to a stack in a specific account and Region.
#
- # You can only update stack instances in Regions and accounts where they
- # already exist; to create additional stack instances, use
- # [CreateStackInstances][1].
+ # You can only update stack instances in Amazon Web Services Regions and
+ # accounts where they already exist; to create additional stack
+ # instances, use [CreateStackInstances][1].
#
# During stack set updates, any parameters overridden for a stack
- # instance are not updated, but retain their overridden value.
+ # instance aren't updated, but retain their overridden value.
#
# You can only update the parameter *values* that are specified in the
# stack set; to add or delete a parameter itself, use
@@ -4706,16 +6311,17 @@ module Aws::CloudFormation
# instances.
#
# @option params [Array<String>] :accounts
- # \[`Self-managed` permissions\] The names of one or more AWS accounts
- # for which you want to update parameter values for stack instances. The
- # overridden parameter values will be applied to all stack instances in
- # the specified accounts and Regions.
+ # \[Self-managed permissions\] The names of one or more Amazon Web
+ # Services accounts for which you want to update parameter values for
+ # stack instances. The overridden parameter values will be applied to
+ # all stack instances in the specified accounts and Amazon Web Services
+ # Regions.
#
# You can specify `Accounts` or `DeploymentTargets`, but not both.
#
# @option params [Types::DeploymentTargets] :deployment_targets
- # \[`Service-managed` permissions\] The AWS Organizations accounts for
- # which you want to update parameter values for stack instances. If your
+ # \[Service-managed permissions\] The Organizations accounts for which
+ # you want to update parameter values for stack instances. If your
# update targets OUs, the overridden parameter values only apply to the
# accounts that are currently in the target OUs and their child OUs.
# Accounts added to the target OUs and their child OUs in the future
@@ -4724,40 +6330,36 @@ module Aws::CloudFormation
# You can specify `Accounts` or `DeploymentTargets`, but not both.
#
# @option params [required, Array<String>] :regions
- # The names of one or more Regions in which you want to update parameter
- # values for stack instances. The overridden parameter values will be
- # applied to all stack instances in the specified accounts and Regions.
+ # The names of one or more Amazon Web Services Regions in which you want
+ # to update parameter values for stack instances. The overridden
+ # parameter values will be applied to all stack instances in the
+ # specified accounts and Amazon Web Services Regions.
#
# @option params [Array<Types::Parameter>] :parameter_overrides
# A list of input parameters whose values you want to update for the
# specified stack instances.
#
# Any overridden parameter values will be applied to all stack instances
- # in the specified accounts and Regions. When specifying parameters and
- # their values, be aware of how AWS CloudFormation sets parameter values
- # during stack instance update operations:
+ # in the specified accounts and Amazon Web Services Regions. When
+ # specifying parameters and their values, be aware of how CloudFormation
+ # sets parameter values during stack instance update operations:
#
# * To override the current value for a parameter, include the parameter
# and specify its value.
#
- # * To leave a parameter set to its present value, you can do one of the
- # following:
- #
- # * Do not include the parameter in the list.
- #
- # * Include the parameter and specify `UsePreviousValue` as `true`.
- # (You cannot specify both a value and set `UsePreviousValue` to
- # `true`.)
+ # * To leave an overridden parameter set to its present value, include
+ # the parameter and specify `UsePreviousValue` as `true`. (You can't
+ # specify both a value and set `UsePreviousValue` to `true`.)
#
- # * To set all overridden parameter back to the values specified in the
- # stack set, specify a parameter list but do not include any
- # parameters.
+ # * To set an overridden parameter back to the value specified in the
+ # stack set, specify a parameter list but don't include the parameter
+ # in the list.
#
- # * To leave all parameters set to their present values, do not specify
+ # * To leave all parameters set to their present values, don't specify
# this property at all.
#
# During stack set updates, any parameter values overridden for a stack
- # instance are not updated, but retain their overridden value.
+ # instance aren't updated, but retain their overridden value.
#
# You can only override the parameter *values* that are specified in the
# stack set; to add or delete a parameter itself, use `UpdateStackSet`
@@ -4774,17 +6376,16 @@ module Aws::CloudFormation
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
#
# @option params [Types::StackSetOperationPreferences] :operation_preferences
- # Preferences for how AWS CloudFormation performs this stack set
- # operation.
+ # Preferences for how CloudFormation performs this stack set operation.
#
# @option params [String] :operation_id
# The unique identifier for this stack set operation.
#
# The operation ID also functions as an idempotency token, to ensure
- # that AWS CloudFormation performs the stack set operation only once,
- # even if you retry the request multiple times. You might retry stack
- # set operation requests to ensure that AWS CloudFormation successfully
- # received them.
+ # that CloudFormation performs the stack set operation only once, even
+ # if you retry the request multiple times. You might retry stack set
+ # operation requests to ensure that CloudFormation successfully received
+ # them.
#
# If you don't specify an operation ID, the SDK generates one
# automatically.
@@ -4792,6 +6393,28 @@ module Aws::CloudFormation
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.**
#
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
# @return [Types::UpdateStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateStackInstancesOutput#operation_id #operation_id} => String
@@ -4803,7 +6426,9 @@ module Aws::CloudFormation
# accounts: ["Account"],
# deployment_targets: {
# accounts: ["Account"],
+ # accounts_url: "AccountsUrl",
# organizational_unit_ids: ["OrganizationalUnitId"],
+ # account_filter_type: "NONE", # accepts NONE, INTERSECTION, DIFFERENCE, UNION
# },
# regions: ["Region"], # required
# parameter_overrides: [
@@ -4815,6 +6440,7 @@ module Aws::CloudFormation
# },
# ],
# operation_preferences: {
+ # region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
# region_order: ["Region"],
# failure_tolerance_count: 1,
# failure_tolerance_percentage: 1,
@@ -4822,6 +6448,7 @@ module Aws::CloudFormation
# max_concurrent_percentage: 1,
# },
# operation_id: "ClientRequestToken",
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
# })
#
# @example Response structure
@@ -4838,7 +6465,7 @@ module Aws::CloudFormation
end
# Updates the stack set, and associated stack instances in the specified
- # accounts and Regions.
+ # accounts and Amazon Web Services Regions.
#
# Even if the stack set operation created by updating the stack set
# fails (completely or partially, below or above a specified failure
@@ -4855,7 +6482,7 @@ module Aws::CloudFormation
# @option params [String] :template_body
# The structure that contains the template body, with a minimum length
# of 1 byte and a maximum length of 51,200 bytes. For more information,
- # see [Template Anatomy][1] in the AWS CloudFormation User Guide.
+ # see [Template Anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
@@ -4867,8 +6494,9 @@ module Aws::CloudFormation
# @option params [String] :template_url
# The location of the file that contains the template body. The URL must
# point to a template (maximum size: 460,800 bytes) that is located in
- # an Amazon S3 bucket. For more information, see [Template Anatomy][1]
- # in the AWS CloudFormation User Guide.
+ # an Amazon S3 bucket or a Systems Manager document. For more
+ # information, see [Template Anatomy][1] in the CloudFormation User
+ # Guide.
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
@@ -4889,16 +6517,16 @@ module Aws::CloudFormation
#
# @option params [Array<String>] :capabilities
# In some cases, you must explicitly acknowledge that your stack
- # template contains certain capabilities in order for AWS CloudFormation
- # to update the stack set and its associated stack instances.
+ # template contains certain capabilities in order for CloudFormation to
+ # update the stack set and its associated stack instances.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stacks sets,
- # you must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stacks sets, you must explicitly acknowledge this by specifying one
+ # of these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -4908,8 +6536,8 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
- # CloudFormation returns an `InsufficientCapabilities` error.
+ # * If you don't specify either of these capabilities, CloudFormation
+ # returns an `InsufficientCapabilities` error.
#
# If your stack template contains these resources, we recommend that
# you review all permissions associated with them and edit their
@@ -4929,23 +6557,26 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
#
- # Some templates contain macros. If your stack template contains one
- # or more macros, and you choose to update a stack directly from the
- # processed template, without first reviewing the resulting changes in
- # a change set, you must acknowledge this capability. For more
- # information, see [Using AWS CloudFormation Macros to Perform Custom
- # Processing on Templates][9].
+ # Some templates reference macros. If your stack set template
+ # references one or more macros, you must update the stack set
+ # directly from the processed template, without first reviewing the
+ # resulting changes in a change set. To update the stack set directly,
+ # you must acknowledge this capability. For more information, see
+ # [Using CloudFormation Macros to Perform Custom Processing on
+ # Templates][9].
#
- # Stack sets do not currently support macros in stack templates. (This
- # includes the [AWS::Include][10] and [AWS::Serverless][11]
- # transforms, which are macros hosted by AWS CloudFormation.) Even if
- # you specify this capability, if you include a macro in your template
- # the stack set operation will fail.
+ # Stack sets with service-managed permissions do not currently support
+ # the use of macros in templates. (This includes the
+ # [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
+ # macros hosted by CloudFormation.) Even if you specify this
+ # capability for a stack set with service-managed permissions, if you
+ # reference a macro in your template the stack set operation will
+ # fail.
#
#
#
@@ -4963,48 +6594,47 @@ module Aws::CloudFormation
#
# @option params [Array<Types::Tag>] :tags
# The key-value pairs to associate with this stack set and the stacks
- # created from it. AWS CloudFormation also propagates these tags to
+ # created from it. CloudFormation also propagates these tags to
# supported resources that are created in the stacks. You can specify a
# maximum number of 50 tags.
#
# If you specify tags for this parameter, those tags replace any list of
# tags that are currently associated with this stack set. This means:
#
- # * If you don't specify this parameter, AWS CloudFormation doesn't
- # modify the stack's tags.
+ # * If you don't specify this parameter, CloudFormation doesn't modify
+ # the stack's tags.
#
# * If you specify *any* tags using this parameter, you must specify
# *all* the tags that you want associated with this stack set, even
- # tags you've specifed before (for example, when creating the stack
+ # tags you've specified before (for example, when creating the stack
# set or during a previous update of the stack set.). Any tags that
# you don't include in the updated list of tags are removed from the
# stack set, and therefore from the stacks and resources as well.
#
- # * If you specify an empty value, AWS CloudFormation removes all
- # currently associated tags.
+ # * If you specify an empty value, CloudFormation removes all currently
+ # associated tags.
#
- # If you specify new tags as part of an `UpdateStackSet` action, AWS
+ # If you specify new tags as part of an `UpdateStackSet` action,
# CloudFormation checks to see if you have the required IAM permission
# to tag resources. If you omit tags that are currently associated with
- # the stack set from the list of tags you specify, AWS CloudFormation
+ # the stack set from the list of tags you specify, CloudFormation
# assumes that you want to remove those tags from the stack set, and
# checks to see if you have permission to untag resources. If you don't
# have the necessary permission(s), the entire `UpdateStackSet` action
# fails with an `access denied` error, and the stack set is not updated.
#
# @option params [Types::StackSetOperationPreferences] :operation_preferences
- # Preferences for how AWS CloudFormation performs this stack set
- # operation.
+ # Preferences for how CloudFormation performs this stack set operation.
#
# @option params [String] :administration_role_arn
- # The Amazon Resource Number (ARN) of the IAM role to use to update this
+ # The Amazon Resource Name (ARN) of the IAM role to use to update this
# stack set.
#
# Specify an IAM role only if you are using customized administrator
# roles to control which users or groups can manage specific stack sets
# within the same administrator account. For more information, see
- # [Granting Permissions for Stack Set Operations][1] in the *AWS
- # CloudFormation User Guide*.
+ # [Granting Permissions for Stack Set Operations][1] in the
+ # *CloudFormation User Guide*.
#
# If you specified a customized administrator role when you created the
# stack set, you must specify a customized administrator role, even if
@@ -5017,7 +6647,7 @@ module Aws::CloudFormation
#
# @option params [String] :execution_role_name
# The name of the IAM execution role to use to update the stack set. If
- # you do not specify an execution role, AWS CloudFormation uses the
+ # you do not specify an execution role, CloudFormation uses the
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
# operation.
#
@@ -5025,27 +6655,27 @@ module Aws::CloudFormation
# to control which stack resources users and groups can include in their
# stack sets.
#
- # If you specify a customized execution role, AWS CloudFormation uses
- # that role to update the stack. If you do not specify a customized
- # execution role, AWS CloudFormation performs the update using the role
- # previously associated with the stack set, so long as you have
- # permissions to perform operations on the stack set.
+ # If you specify a customized execution role, CloudFormation uses that
+ # role to update the stack. If you do not specify a customized execution
+ # role, CloudFormation performs the update using the role previously
+ # associated with the stack set, so long as you have permissions to
+ # perform operations on the stack set.
#
# @option params [Types::DeploymentTargets] :deployment_targets
- # \[`Service-managed` permissions\] The AWS Organizations accounts in
- # which to update associated stack instances.
+ # \[Service-managed permissions\] The Organizations accounts in which to
+ # update associated stack instances.
#
# To update all the stack instances associated with this stack set, do
# not specify `DeploymentTargets` or `Regions`.
#
# If the stack set update includes changes to the template (that is, if
# `TemplateBody` or `TemplateURL` is specified), or the `Parameters`,
- # AWS CloudFormation marks all stack instances with a status of
- # `OUTDATED` prior to updating the stack instances in the specified
- # accounts and Regions. If the stack set update does not include changes
- # to the template or parameters, AWS CloudFormation updates the stack
- # instances in the specified accounts and Regions, while leaving all
- # other stack instances with their existing stack instance status.
+ # CloudFormation marks all stack instances with a status of `OUTDATED`
+ # prior to updating the stack instances in the specified accounts and
+ # Amazon Web Services Regions. If the stack set update doesn't include
+ # changes to the template or parameters, CloudFormation updates the
+ # stack instances in the specified accounts and Regions, while leaving
+ # all other stack instances with their existing stack instance status.
#
# @option params [String] :permission_model
# Describes how the IAM roles required for stack set operations are
@@ -5057,7 +6687,7 @@ module Aws::CloudFormation
# information, see [Grant Self-Managed Stack Set Permissions][1].
#
# * With `service-managed` permissions, StackSets automatically creates
- # the IAM roles required to deploy to accounts managed by AWS
+ # the IAM roles required to deploy to accounts managed by
# Organizations. For more information, see [Grant Service-Managed
# Stack Set Permissions][2].
#
@@ -5067,24 +6697,24 @@ module Aws::CloudFormation
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
#
# @option params [Types::AutoDeployment] :auto_deployment
- # \[`Service-managed` permissions\] Describes whether StackSets
- # automatically deploys to AWS Organizations accounts that are added to
- # a target organization or organizational unit (OU).
+ # \[Service-managed permissions\] Describes whether StackSets
+ # automatically deploys to Organizations accounts that are added to a
+ # target organization or organizational unit (OU).
#
- # If you specify `AutoDeployment`, do not specify `DeploymentTargets` or
+ # If you specify `AutoDeployment`, don't specify `DeploymentTargets` or
# `Regions`.
#
# @option params [String] :operation_id
# The unique ID for this stack set operation.
#
# The operation ID also functions as an idempotency token, to ensure
- # that AWS CloudFormation performs the stack set operation only once,
- # even if you retry the request multiple times. You might retry stack
- # set operation requests to ensure that AWS CloudFormation successfully
- # received them.
+ # that CloudFormation performs the stack set operation only once, even
+ # if you retry the request multiple times. You might retry stack set
+ # operation requests to ensure that CloudFormation successfully received
+ # them.
#
- # If you don't specify an operation ID, AWS CloudFormation generates
- # one automatically.
+ # If you don't specify an operation ID, CloudFormation generates one
+ # automatically.
#
# Repeating this stack set operation with a new operation ID retries all
# stack instances whose status is `OUTDATED`.
@@ -5093,40 +6723,67 @@ module Aws::CloudFormation
# not need to pass this option.**
#
# @option params [Array<String>] :accounts
- # \[`Self-managed` permissions\] The accounts in which to update
+ # \[Self-managed permissions\] The accounts in which to update
# associated stack instances. If you specify accounts, you must also
- # specify the Regions in which to update stack set instances.
+ # specify the Amazon Web Services Regions in which to update stack set
+ # instances.
#
- # To update *all* the stack instances associated with this stack set, do
- # not specify the `Accounts` or `Regions` properties.
+ # To update *all* the stack instances associated with this stack set,
+ # don't specify the `Accounts` or `Regions` properties.
#
# If the stack set update includes changes to the template (that is, if
# the `TemplateBody` or `TemplateURL` properties are specified), or the
- # `Parameters` property, AWS CloudFormation marks all stack instances
- # with a status of `OUTDATED` prior to updating the stack instances in
- # the specified accounts and Regions. If the stack set update does not
- # include changes to the template or parameters, AWS CloudFormation
- # updates the stack instances in the specified accounts and Regions,
- # while leaving all other stack instances with their existing stack
- # instance status.
+ # `Parameters` property, CloudFormation marks all stack instances with a
+ # status of `OUTDATED` prior to updating the stack instances in the
+ # specified accounts and Amazon Web Services Regions. If the stack set
+ # update does not include changes to the template or parameters,
+ # CloudFormation updates the stack instances in the specified accounts
+ # and Amazon Web Services Regions, while leaving all other stack
+ # instances with their existing stack instance status.
#
# @option params [Array<String>] :regions
- # The Regions in which to update associated stack instances. If you
- # specify Regions, you must also specify accounts in which to update
- # stack set instances.
+ # The Amazon Web Services Regions in which to update associated stack
+ # instances. If you specify Regions, you must also specify accounts in
+ # which to update stack set instances.
#
# To update *all* the stack instances associated with this stack set, do
# not specify the `Accounts` or `Regions` properties.
#
# If the stack set update includes changes to the template (that is, if
# the `TemplateBody` or `TemplateURL` properties are specified), or the
- # `Parameters` property, AWS CloudFormation marks all stack instances
- # with a status of `OUTDATED` prior to updating the stack instances in
- # the specified accounts and Regions. If the stack set update does not
- # include changes to the template or parameters, AWS CloudFormation
- # updates the stack instances in the specified accounts and Regions,
- # while leaving all other stack instances with their existing stack
- # instance status.
+ # `Parameters` property, CloudFormation marks all stack instances with a
+ # status of `OUTDATED` prior to updating the stack instances in the
+ # specified accounts and Regions. If the stack set update does not
+ # include changes to the template or parameters, CloudFormation updates
+ # the stack instances in the specified accounts and Regions, while
+ # leaving all other stack instances with their existing stack instance
+ # status.
+ #
+ # @option params [String] :call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as an
+ # account administrator in the organization's management account or as
+ # a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ #
+ # @option params [Types::ManagedExecution] :managed_execution
+ # Describes whether StackSets performs non-conflicting operations
+ # concurrently and queues conflicting operations.
#
# @return [Types::UpdateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
@@ -5156,6 +6813,7 @@ module Aws::CloudFormation
# },
# ],
# operation_preferences: {
+ # region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
# region_order: ["Region"],
# failure_tolerance_count: 1,
# failure_tolerance_percentage: 1,
@@ -5166,7 +6824,9 @@ module Aws::CloudFormation
# execution_role_name: "ExecutionRoleName",
# deployment_targets: {
# accounts: ["Account"],
+ # accounts_url: "AccountsUrl",
# organizational_unit_ids: ["OrganizationalUnitId"],
+ # account_filter_type: "NONE", # accepts NONE, INTERSECTION, DIFFERENCE, UNION
# },
# permission_model: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, SELF_MANAGED
# auto_deployment: {
@@ -5176,6 +6836,10 @@ module Aws::CloudFormation
# operation_id: "ClientRequestToken",
# accounts: ["Account"],
# regions: ["Region"],
+ # call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
+ # managed_execution: {
+ # active: false,
+ # },
# })
#
# @example Response structure
@@ -5194,11 +6858,11 @@ module Aws::CloudFormation
# Updates termination protection for the specified stack. If a user
# attempts to delete a stack with termination protection enabled, the
# operation fails and the stack remains unchanged. For more information,
- # see [Protecting a Stack From Being Deleted][1] in the *AWS
- # CloudFormation User Guide*.
+ # see [Protecting a Stack From Being Deleted][1] in the *CloudFormation
+ # User Guide*.
#
# For [nested stacks][2], termination protection is set on the root
- # stack and cannot be changed directly on the nested stack.
+ # stack and can't be changed directly on the nested stack.
#
#
#
@@ -5236,15 +6900,15 @@ module Aws::CloudFormation
req.send_request(options)
end
- # Validates a specified template. AWS CloudFormation first checks if the
- # template is valid JSON. If it isn't, AWS CloudFormation checks if the
- # template is valid YAML. If both these checks fail, AWS CloudFormation
+ # Validates a specified template. CloudFormation first checks if the
+ # template is valid JSON. If it isn't, CloudFormation checks if the
+ # template is valid YAML. If both these checks fail, CloudFormation
# returns a template validation error.
#
# @option params [String] :template_body
# Structure containing the template body with a minimum length of 1 byte
# and a maximum length of 51,200 bytes. For more information, go to
- # [Template Anatomy][1] in the AWS CloudFormation User Guide.
+ # [Template Anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
# are passed, only `TemplateBody` is used.
@@ -5256,8 +6920,8 @@ module Aws::CloudFormation
# @option params [String] :template_url
# Location of file containing the template body. The URL must point to a
# template (max size: 460,800 bytes) that is located in an Amazon S3
- # bucket. For more information, go to [Template Anatomy][1] in the AWS
- # CloudFormation User Guide.
+ # bucket or a Systems Manager document. For more information, go to
+ # [Template Anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
# are passed, only `TemplateBody` is used.
@@ -5317,7 +6981,7 @@ module Aws::CloudFormation
params: params,
config: config)
context[:gem_name] = 'aws-sdk-cloudformation'
- context[:gem_version] = '1.41.0'
+ context[:gem_version] = '1.82.0'
Seahorse::Client::Request.new(handlers, context)
end
diff --git a/lib/aws-sdk-cloudformation/client_api.rb b/lib/aws-sdk-cloudformation/client_api.rb
index d0f455f..aab5939 100644
--- a/lib/aws-sdk-cloudformation/client_api.rb
+++ b/lib/aws-sdk-cloudformation/client_api.rb
@@ -3,7 +3,7 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -13,29 +13,48 @@ module Aws::CloudFormation
include Seahorse::Model
+ AcceptTermsAndConditions = Shapes::BooleanShape.new(name: 'AcceptTermsAndConditions')
Account = Shapes::StringShape.new(name: 'Account')
+ AccountFilterType = Shapes::StringShape.new(name: 'AccountFilterType')
AccountGateResult = Shapes::StructureShape.new(name: 'AccountGateResult')
AccountGateStatus = Shapes::StringShape.new(name: 'AccountGateStatus')
AccountGateStatusReason = Shapes::StringShape.new(name: 'AccountGateStatusReason')
AccountLimit = Shapes::StructureShape.new(name: 'AccountLimit')
AccountLimitList = Shapes::ListShape.new(name: 'AccountLimitList')
AccountList = Shapes::ListShape.new(name: 'AccountList')
+ AccountsUrl = Shapes::StringShape.new(name: 'AccountsUrl')
+ ActivateOrganizationsAccessInput = Shapes::StructureShape.new(name: 'ActivateOrganizationsAccessInput')
+ ActivateOrganizationsAccessOutput = Shapes::StructureShape.new(name: 'ActivateOrganizationsAccessOutput')
+ ActivateTypeInput = Shapes::StructureShape.new(name: 'ActivateTypeInput')
+ ActivateTypeOutput = Shapes::StructureShape.new(name: 'ActivateTypeOutput')
AllowedValue = Shapes::StringShape.new(name: 'AllowedValue')
AllowedValues = Shapes::ListShape.new(name: 'AllowedValues')
AlreadyExistsException = Shapes::StructureShape.new(name: 'AlreadyExistsException')
Arn = Shapes::StringShape.new(name: 'Arn')
AutoDeployment = Shapes::StructureShape.new(name: 'AutoDeployment')
AutoDeploymentNullable = Shapes::BooleanShape.new(name: 'AutoDeploymentNullable')
+ AutoUpdate = Shapes::BooleanShape.new(name: 'AutoUpdate')
+ BatchDescribeTypeConfigurationsError = Shapes::StructureShape.new(name: 'BatchDescribeTypeConfigurationsError')
+ BatchDescribeTypeConfigurationsErrors = Shapes::ListShape.new(name: 'BatchDescribeTypeConfigurationsErrors')
+ BatchDescribeTypeConfigurationsInput = Shapes::StructureShape.new(name: 'BatchDescribeTypeConfigurationsInput')
+ BatchDescribeTypeConfigurationsOutput = Shapes::StructureShape.new(name: 'BatchDescribeTypeConfigurationsOutput')
BoxedInteger = Shapes::IntegerShape.new(name: 'BoxedInteger')
BoxedMaxResults = Shapes::IntegerShape.new(name: 'BoxedMaxResults')
CFNRegistryException = Shapes::StructureShape.new(name: 'CFNRegistryException')
+ CallAs = Shapes::StringShape.new(name: 'CallAs')
CancelUpdateStackInput = Shapes::StructureShape.new(name: 'CancelUpdateStackInput')
Capabilities = Shapes::ListShape.new(name: 'Capabilities')
CapabilitiesReason = Shapes::StringShape.new(name: 'CapabilitiesReason')
Capability = Shapes::StringShape.new(name: 'Capability')
+ Category = Shapes::StringShape.new(name: 'Category')
CausingEntity = Shapes::StringShape.new(name: 'CausingEntity')
Change = Shapes::StructureShape.new(name: 'Change')
ChangeAction = Shapes::StringShape.new(name: 'ChangeAction')
+ ChangeSetHook = Shapes::StructureShape.new(name: 'ChangeSetHook')
+ ChangeSetHookResourceTargetDetails = Shapes::StructureShape.new(name: 'ChangeSetHookResourceTargetDetails')
+ ChangeSetHookTargetDetails = Shapes::StructureShape.new(name: 'ChangeSetHookTargetDetails')
+ ChangeSetHooks = Shapes::ListShape.new(name: 'ChangeSetHooks')
+ ChangeSetHooksStatus = Shapes::StringShape.new(name: 'ChangeSetHooksStatus')
ChangeSetId = Shapes::StringShape.new(name: 'ChangeSetId')
ChangeSetName = Shapes::StringShape.new(name: 'ChangeSetName')
ChangeSetNameOrId = Shapes::StringShape.new(name: 'ChangeSetNameOrId')
@@ -50,6 +69,8 @@ module Aws::CloudFormation
Changes = Shapes::ListShape.new(name: 'Changes')
ClientRequestToken = Shapes::StringShape.new(name: 'ClientRequestToken')
ClientToken = Shapes::StringShape.new(name: 'ClientToken')
+ ConfigurationSchema = Shapes::StringShape.new(name: 'ConfigurationSchema')
+ ConnectionArn = Shapes::StringShape.new(name: 'ConnectionArn')
ContinueUpdateRollbackInput = Shapes::StructureShape.new(name: 'ContinueUpdateRollbackInput')
ContinueUpdateRollbackOutput = Shapes::StructureShape.new(name: 'ContinueUpdateRollbackOutput')
CreateChangeSetInput = Shapes::StructureShape.new(name: 'CreateChangeSetInput')
@@ -62,6 +83,10 @@ module Aws::CloudFormation
CreateStackSetOutput = Shapes::StructureShape.new(name: 'CreateStackSetOutput')
CreatedButModifiedException = Shapes::StructureShape.new(name: 'CreatedButModifiedException')
CreationTime = Shapes::TimestampShape.new(name: 'CreationTime')
+ DeactivateOrganizationsAccessInput = Shapes::StructureShape.new(name: 'DeactivateOrganizationsAccessInput')
+ DeactivateOrganizationsAccessOutput = Shapes::StructureShape.new(name: 'DeactivateOrganizationsAccessOutput')
+ DeactivateTypeInput = Shapes::StructureShape.new(name: 'DeactivateTypeInput')
+ DeactivateTypeOutput = Shapes::StructureShape.new(name: 'DeactivateTypeOutput')
DeleteChangeSetInput = Shapes::StructureShape.new(name: 'DeleteChangeSetInput')
DeleteChangeSetOutput = Shapes::StructureShape.new(name: 'DeleteChangeSetOutput')
DeleteStackInput = Shapes::StructureShape.new(name: 'DeleteStackInput')
@@ -76,8 +101,14 @@ module Aws::CloudFormation
DeregisterTypeOutput = Shapes::StructureShape.new(name: 'DeregisterTypeOutput')
DescribeAccountLimitsInput = Shapes::StructureShape.new(name: 'DescribeAccountLimitsInput')
DescribeAccountLimitsOutput = Shapes::StructureShape.new(name: 'DescribeAccountLimitsOutput')
+ DescribeChangeSetHooksInput = Shapes::StructureShape.new(name: 'DescribeChangeSetHooksInput')
+ DescribeChangeSetHooksOutput = Shapes::StructureShape.new(name: 'DescribeChangeSetHooksOutput')
DescribeChangeSetInput = Shapes::StructureShape.new(name: 'DescribeChangeSetInput')
DescribeChangeSetOutput = Shapes::StructureShape.new(name: 'DescribeChangeSetOutput')
+ DescribeOrganizationsAccessInput = Shapes::StructureShape.new(name: 'DescribeOrganizationsAccessInput')
+ DescribeOrganizationsAccessOutput = Shapes::StructureShape.new(name: 'DescribeOrganizationsAccessOutput')
+ DescribePublisherInput = Shapes::StructureShape.new(name: 'DescribePublisherInput')
+ DescribePublisherOutput = Shapes::StructureShape.new(name: 'DescribePublisherOutput')
DescribeStackDriftDetectionStatusInput = Shapes::StructureShape.new(name: 'DescribeStackDriftDetectionStatusInput')
DescribeStackDriftDetectionStatusOutput = Shapes::StructureShape.new(name: 'DescribeStackDriftDetectionStatusOutput')
DescribeStackEventsInput = Shapes::StructureShape.new(name: 'DescribeStackEventsInput')
@@ -111,6 +142,7 @@ module Aws::CloudFormation
DisableRollback = Shapes::BooleanShape.new(name: 'DisableRollback')
DriftedStackInstancesCount = Shapes::IntegerShape.new(name: 'DriftedStackInstancesCount')
EnableTerminationProtection = Shapes::BooleanShape.new(name: 'EnableTerminationProtection')
+ ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
EstimateTemplateCostInput = Shapes::StructureShape.new(name: 'EstimateTemplateCostInput')
EstimateTemplateCostOutput = Shapes::StructureShape.new(name: 'EstimateTemplateCostOutput')
@@ -134,13 +166,30 @@ module Aws::CloudFormation
GetTemplateSummaryInput = Shapes::StructureShape.new(name: 'GetTemplateSummaryInput')
GetTemplateSummaryOutput = Shapes::StructureShape.new(name: 'GetTemplateSummaryOutput')
HandlerErrorCode = Shapes::StringShape.new(name: 'HandlerErrorCode')
+ HookFailureMode = Shapes::StringShape.new(name: 'HookFailureMode')
+ HookInvocationCount = Shapes::IntegerShape.new(name: 'HookInvocationCount')
+ HookInvocationPoint = Shapes::StringShape.new(name: 'HookInvocationPoint')
+ HookStatus = Shapes::StringShape.new(name: 'HookStatus')
+ HookStatusReason = Shapes::StringShape.new(name: 'HookStatusReason')
+ HookTargetType = Shapes::StringShape.new(name: 'HookTargetType')
+ HookTargetTypeName = Shapes::StringShape.new(name: 'HookTargetTypeName')
+ HookType = Shapes::StringShape.new(name: 'HookType')
+ HookTypeConfigurationVersionId = Shapes::StringShape.new(name: 'HookTypeConfigurationVersionId')
+ HookTypeName = Shapes::StringShape.new(name: 'HookTypeName')
+ HookTypeVersionId = Shapes::StringShape.new(name: 'HookTypeVersionId')
+ IdentityProvider = Shapes::StringShape.new(name: 'IdentityProvider')
+ ImportStacksToStackSetInput = Shapes::StructureShape.new(name: 'ImportStacksToStackSetInput')
+ ImportStacksToStackSetOutput = Shapes::StructureShape.new(name: 'ImportStacksToStackSetOutput')
Imports = Shapes::ListShape.new(name: 'Imports')
InProgressStackInstancesCount = Shapes::IntegerShape.new(name: 'InProgressStackInstancesCount')
InSyncStackInstancesCount = Shapes::IntegerShape.new(name: 'InSyncStackInstancesCount')
+ IncludeNestedStacks = Shapes::BooleanShape.new(name: 'IncludeNestedStacks')
InsufficientCapabilitiesException = Shapes::StructureShape.new(name: 'InsufficientCapabilitiesException')
InvalidChangeSetStatusException = Shapes::StructureShape.new(name: 'InvalidChangeSetStatusException')
InvalidOperationException = Shapes::StructureShape.new(name: 'InvalidOperationException')
InvalidStateTransitionException = Shapes::StructureShape.new(name: 'InvalidStateTransitionException')
+ IsActivated = Shapes::BooleanShape.new(name: 'IsActivated')
+ IsDefaultConfiguration = Shapes::BooleanShape.new(name: 'IsDefaultConfiguration')
IsDefaultVersion = Shapes::BooleanShape.new(name: 'IsDefaultVersion')
Key = Shapes::StringShape.new(name: 'Key')
LastUpdatedTime = Shapes::TimestampShape.new(name: 'LastUpdatedTime')
@@ -173,12 +222,17 @@ module Aws::CloudFormation
ListTypesOutput = Shapes::StructureShape.new(name: 'ListTypesOutput')
LogGroupName = Shapes::StringShape.new(name: 'LogGroupName')
LoggingConfig = Shapes::StructureShape.new(name: 'LoggingConfig')
+ LogicalIdHierarchy = Shapes::StringShape.new(name: 'LogicalIdHierarchy')
LogicalResourceId = Shapes::StringShape.new(name: 'LogicalResourceId')
LogicalResourceIds = Shapes::ListShape.new(name: 'LogicalResourceIds')
+ MajorVersion = Shapes::IntegerShape.new(name: 'MajorVersion')
+ ManagedExecution = Shapes::StructureShape.new(name: 'ManagedExecution')
+ ManagedExecutionNullable = Shapes::BooleanShape.new(name: 'ManagedExecutionNullable')
MaxConcurrentCount = Shapes::IntegerShape.new(name: 'MaxConcurrentCount')
MaxConcurrentPercentage = Shapes::IntegerShape.new(name: 'MaxConcurrentPercentage')
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
Metadata = Shapes::StringShape.new(name: 'Metadata')
+ ModuleInfo = Shapes::StructureShape.new(name: 'ModuleInfo')
MonitoringTimeInMinutes = Shapes::IntegerShape.new(name: 'MonitoringTimeInMinutes')
NameAlreadyExistsException = Shapes::StructureShape.new(name: 'NameAlreadyExistsException')
NextToken = Shapes::StringShape.new(name: 'NextToken')
@@ -186,12 +240,18 @@ module Aws::CloudFormation
NotificationARN = Shapes::StringShape.new(name: 'NotificationARN')
NotificationARNs = Shapes::ListShape.new(name: 'NotificationARNs')
OnFailure = Shapes::StringShape.new(name: 'OnFailure')
+ OnStackFailure = Shapes::StringShape.new(name: 'OnStackFailure')
OperationIdAlreadyExistsException = Shapes::StructureShape.new(name: 'OperationIdAlreadyExistsException')
OperationInProgressException = Shapes::StructureShape.new(name: 'OperationInProgressException')
OperationNotFoundException = Shapes::StructureShape.new(name: 'OperationNotFoundException')
+ OperationResultFilter = Shapes::StructureShape.new(name: 'OperationResultFilter')
+ OperationResultFilterName = Shapes::StringShape.new(name: 'OperationResultFilterName')
+ OperationResultFilterValues = Shapes::StringShape.new(name: 'OperationResultFilterValues')
+ OperationResultFilters = Shapes::ListShape.new(name: 'OperationResultFilters')
OperationStatus = Shapes::StringShape.new(name: 'OperationStatus')
OperationStatusCheckFailedException = Shapes::StructureShape.new(name: 'OperationStatusCheckFailedException')
OptionalSecureUrl = Shapes::StringShape.new(name: 'OptionalSecureUrl')
+ OrganizationStatus = Shapes::StringShape.new(name: 'OrganizationStatus')
OrganizationalUnitId = Shapes::StringShape.new(name: 'OrganizationalUnitId')
OrganizationalUnitIdList = Shapes::ListShape.new(name: 'OrganizationalUnitIdList')
Output = Shapes::StructureShape.new(name: 'Output')
@@ -218,11 +278,21 @@ module Aws::CloudFormation
PropertyPath = Shapes::StringShape.new(name: 'PropertyPath')
PropertyValue = Shapes::StringShape.new(name: 'PropertyValue')
ProvisioningType = Shapes::StringShape.new(name: 'ProvisioningType')
+ PublicVersionNumber = Shapes::StringShape.new(name: 'PublicVersionNumber')
+ PublishTypeInput = Shapes::StructureShape.new(name: 'PublishTypeInput')
+ PublishTypeOutput = Shapes::StructureShape.new(name: 'PublishTypeOutput')
+ PublisherId = Shapes::StringShape.new(name: 'PublisherId')
+ PublisherName = Shapes::StringShape.new(name: 'PublisherName')
+ PublisherProfile = Shapes::StringShape.new(name: 'PublisherProfile')
+ PublisherStatus = Shapes::StringShape.new(name: 'PublisherStatus')
Reason = Shapes::StringShape.new(name: 'Reason')
RecordHandlerProgressInput = Shapes::StructureShape.new(name: 'RecordHandlerProgressInput')
RecordHandlerProgressOutput = Shapes::StructureShape.new(name: 'RecordHandlerProgressOutput')
Region = Shapes::StringShape.new(name: 'Region')
+ RegionConcurrencyType = Shapes::StringShape.new(name: 'RegionConcurrencyType')
RegionList = Shapes::ListShape.new(name: 'RegionList')
+ RegisterPublisherInput = Shapes::StructureShape.new(name: 'RegisterPublisherInput')
+ RegisterPublisherOutput = Shapes::StructureShape.new(name: 'RegisterPublisherOutput')
RegisterTypeInput = Shapes::StructureShape.new(name: 'RegisterTypeInput')
RegisterTypeOutput = Shapes::StructureShape.new(name: 'RegisterTypeOutput')
RegistrationStatus = Shapes::StringShape.new(name: 'RegistrationStatus')
@@ -231,6 +301,8 @@ module Aws::CloudFormation
RegistryType = Shapes::StringShape.new(name: 'RegistryType')
Replacement = Shapes::StringShape.new(name: 'Replacement')
RequestToken = Shapes::StringShape.new(name: 'RequestToken')
+ RequiredActivatedType = Shapes::StructureShape.new(name: 'RequiredActivatedType')
+ RequiredActivatedTypes = Shapes::ListShape.new(name: 'RequiredActivatedTypes')
RequiresRecreation = Shapes::StringShape.new(name: 'RequiresRecreation')
ResourceAttribute = Shapes::StringShape.new(name: 'ResourceAttribute')
ResourceChange = Shapes::StructureShape.new(name: 'ResourceChange')
@@ -262,11 +334,16 @@ module Aws::CloudFormation
RoleARN = Shapes::StringShape.new(name: 'RoleARN')
RoleArn = Shapes::StringShape.new(name: 'RoleArn')
RollbackConfiguration = Shapes::StructureShape.new(name: 'RollbackConfiguration')
+ RollbackStackInput = Shapes::StructureShape.new(name: 'RollbackStackInput')
+ RollbackStackOutput = Shapes::StructureShape.new(name: 'RollbackStackOutput')
RollbackTrigger = Shapes::StructureShape.new(name: 'RollbackTrigger')
RollbackTriggers = Shapes::ListShape.new(name: 'RollbackTriggers')
+ S3Bucket = Shapes::StringShape.new(name: 'S3Bucket')
S3Url = Shapes::StringShape.new(name: 'S3Url')
Scope = Shapes::ListShape.new(name: 'Scope')
SetStackPolicyInput = Shapes::StructureShape.new(name: 'SetStackPolicyInput')
+ SetTypeConfigurationInput = Shapes::StructureShape.new(name: 'SetTypeConfigurationInput')
+ SetTypeConfigurationOutput = Shapes::StructureShape.new(name: 'SetTypeConfigurationOutput')
SetTypeDefaultVersionInput = Shapes::StructureShape.new(name: 'SetTypeDefaultVersionInput')
SetTypeDefaultVersionOutput = Shapes::StructureShape.new(name: 'SetTypeDefaultVersionOutput')
SignalResourceInput = Shapes::StructureShape.new(name: 'SignalResourceInput')
@@ -280,6 +357,8 @@ module Aws::CloudFormation
StackEvent = Shapes::StructureShape.new(name: 'StackEvent')
StackEvents = Shapes::ListShape.new(name: 'StackEvents')
StackId = Shapes::StringShape.new(name: 'StackId')
+ StackIdList = Shapes::ListShape.new(name: 'StackIdList')
+ StackIdsUrl = Shapes::StringShape.new(name: 'StackIdsUrl')
StackInstance = Shapes::StructureShape.new(name: 'StackInstance')
StackInstanceComprehensiveStatus = Shapes::StructureShape.new(name: 'StackInstanceComprehensiveStatus')
StackInstanceDetailedStatus = Shapes::StringShape.new(name: 'StackInstanceDetailedStatus')
@@ -293,6 +372,7 @@ module Aws::CloudFormation
StackInstanceSummary = Shapes::StructureShape.new(name: 'StackInstanceSummary')
StackName = Shapes::StringShape.new(name: 'StackName')
StackNameOrId = Shapes::StringShape.new(name: 'StackNameOrId')
+ StackNotFoundException = Shapes::StructureShape.new(name: 'StackNotFoundException')
StackPolicyBody = Shapes::StringShape.new(name: 'StackPolicyBody')
StackPolicyDuringUpdateBody = Shapes::StringShape.new(name: 'StackPolicyDuringUpdateBody')
StackPolicyDuringUpdateURL = Shapes::StringShape.new(name: 'StackPolicyDuringUpdateURL')
@@ -325,6 +405,8 @@ module Aws::CloudFormation
StackSetOperationResultSummaries = Shapes::ListShape.new(name: 'StackSetOperationResultSummaries')
StackSetOperationResultSummary = Shapes::StructureShape.new(name: 'StackSetOperationResultSummary')
StackSetOperationStatus = Shapes::StringShape.new(name: 'StackSetOperationStatus')
+ StackSetOperationStatusDetails = Shapes::StructureShape.new(name: 'StackSetOperationStatusDetails')
+ StackSetOperationStatusReason = Shapes::StringShape.new(name: 'StackSetOperationStatusReason')
StackSetOperationSummaries = Shapes::ListShape.new(name: 'StackSetOperationSummaries')
StackSetOperationSummary = Shapes::StructureShape.new(name: 'StackSetOperationSummary')
StackSetStatus = Shapes::StringShape.new(name: 'StackSetStatus')
@@ -341,6 +423,8 @@ module Aws::CloudFormation
StatusMessage = Shapes::StringShape.new(name: 'StatusMessage')
StopStackSetOperationInput = Shapes::StructureShape.new(name: 'StopStackSetOperationInput')
StopStackSetOperationOutput = Shapes::StructureShape.new(name: 'StopStackSetOperationOutput')
+ SupportedMajorVersion = Shapes::IntegerShape.new(name: 'SupportedMajorVersion')
+ SupportedMajorVersions = Shapes::ListShape.new(name: 'SupportedMajorVersions')
Tag = Shapes::StructureShape.new(name: 'Tag')
TagKey = Shapes::StringShape.new(name: 'TagKey')
TagValue = Shapes::StringShape.new(name: 'TagValue')
@@ -351,6 +435,10 @@ module Aws::CloudFormation
TemplateParameters = Shapes::ListShape.new(name: 'TemplateParameters')
TemplateStage = Shapes::StringShape.new(name: 'TemplateStage')
TemplateURL = Shapes::StringShape.new(name: 'TemplateURL')
+ TestTypeInput = Shapes::StructureShape.new(name: 'TestTypeInput')
+ TestTypeOutput = Shapes::StructureShape.new(name: 'TestTypeOutput')
+ ThirdPartyType = Shapes::StringShape.new(name: 'ThirdPartyType')
+ ThirdPartyTypeArn = Shapes::StringShape.new(name: 'ThirdPartyTypeArn')
TimeoutMinutes = Shapes::IntegerShape.new(name: 'TimeoutMinutes')
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
TokenAlreadyExistsException = Shapes::StructureShape.new(name: 'TokenAlreadyExistsException')
@@ -359,14 +447,28 @@ module Aws::CloudFormation
TransformsList = Shapes::ListShape.new(name: 'TransformsList')
Type = Shapes::StringShape.new(name: 'Type')
TypeArn = Shapes::StringShape.new(name: 'TypeArn')
+ TypeConfiguration = Shapes::StringShape.new(name: 'TypeConfiguration')
+ TypeConfigurationAlias = Shapes::StringShape.new(name: 'TypeConfigurationAlias')
+ TypeConfigurationArn = Shapes::StringShape.new(name: 'TypeConfigurationArn')
+ TypeConfigurationDetails = Shapes::StructureShape.new(name: 'TypeConfigurationDetails')
+ TypeConfigurationDetailsList = Shapes::ListShape.new(name: 'TypeConfigurationDetailsList')
+ TypeConfigurationIdentifier = Shapes::StructureShape.new(name: 'TypeConfigurationIdentifier')
+ TypeConfigurationIdentifiers = Shapes::ListShape.new(name: 'TypeConfigurationIdentifiers')
+ TypeConfigurationNotFoundException = Shapes::StructureShape.new(name: 'TypeConfigurationNotFoundException')
+ TypeFilters = Shapes::StructureShape.new(name: 'TypeFilters')
+ TypeHierarchy = Shapes::StringShape.new(name: 'TypeHierarchy')
TypeName = Shapes::StringShape.new(name: 'TypeName')
+ TypeNamePrefix = Shapes::StringShape.new(name: 'TypeNamePrefix')
TypeNotFoundException = Shapes::StructureShape.new(name: 'TypeNotFoundException')
TypeSchema = Shapes::StringShape.new(name: 'TypeSchema')
TypeSummaries = Shapes::ListShape.new(name: 'TypeSummaries')
TypeSummary = Shapes::StructureShape.new(name: 'TypeSummary')
+ TypeTestsStatus = Shapes::StringShape.new(name: 'TypeTestsStatus')
+ TypeTestsStatusDescription = Shapes::StringShape.new(name: 'TypeTestsStatusDescription')
TypeVersionId = Shapes::StringShape.new(name: 'TypeVersionId')
TypeVersionSummaries = Shapes::ListShape.new(name: 'TypeVersionSummaries')
TypeVersionSummary = Shapes::StructureShape.new(name: 'TypeVersionSummary')
+ UnprocessedTypeConfigurations = Shapes::ListShape.new(name: 'UnprocessedTypeConfigurations')
UpdateStackInput = Shapes::StructureShape.new(name: 'UpdateStackInput')
UpdateStackInstancesInput = Shapes::StructureShape.new(name: 'UpdateStackInstancesInput')
UpdateStackInstancesOutput = Shapes::StructureShape.new(name: 'UpdateStackInstancesOutput')
@@ -382,6 +484,7 @@ module Aws::CloudFormation
ValidateTemplateOutput = Shapes::StructureShape.new(name: 'ValidateTemplateOutput')
Value = Shapes::StringShape.new(name: 'Value')
Version = Shapes::StringShape.new(name: 'Version')
+ VersionBump = Shapes::StringShape.new(name: 'VersionBump')
Visibility = Shapes::StringShape.new(name: 'Visibility')
AccountGateResult.add_member(:status, Shapes::ShapeRef.new(shape: AccountGateStatus, location_name: "Status"))
@@ -396,6 +499,25 @@ module Aws::CloudFormation
AccountList.member = Shapes::ShapeRef.new(shape: Account)
+ ActivateOrganizationsAccessInput.struct_class = Types::ActivateOrganizationsAccessInput
+
+ ActivateOrganizationsAccessOutput.struct_class = Types::ActivateOrganizationsAccessOutput
+
+ ActivateTypeInput.add_member(:type, Shapes::ShapeRef.new(shape: ThirdPartyType, location_name: "Type"))
+ ActivateTypeInput.add_member(:public_type_arn, Shapes::ShapeRef.new(shape: ThirdPartyTypeArn, location_name: "PublicTypeArn"))
+ ActivateTypeInput.add_member(:publisher_id, Shapes::ShapeRef.new(shape: PublisherId, location_name: "PublisherId"))
+ ActivateTypeInput.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeName"))
+ ActivateTypeInput.add_member(:type_name_alias, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeNameAlias"))
+ ActivateTypeInput.add_member(:auto_update, Shapes::ShapeRef.new(shape: AutoUpdate, location_name: "AutoUpdate"))
+ ActivateTypeInput.add_member(:logging_config, Shapes::ShapeRef.new(shape: LoggingConfig, location_name: "LoggingConfig"))
+ ActivateTypeInput.add_member(:execution_role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "ExecutionRoleArn"))
+ ActivateTypeInput.add_member(:version_bump, Shapes::ShapeRef.new(shape: VersionBump, location_name: "VersionBump"))
+ ActivateTypeInput.add_member(:major_version, Shapes::ShapeRef.new(shape: MajorVersion, location_name: "MajorVersion"))
+ ActivateTypeInput.struct_class = Types::ActivateTypeInput
+
+ ActivateTypeOutput.add_member(:arn, Shapes::ShapeRef.new(shape: PrivateTypeArn, location_name: "Arn"))
+ ActivateTypeOutput.struct_class = Types::ActivateTypeOutput
+
AllowedValues.member = Shapes::ShapeRef.new(shape: AllowedValue)
AlreadyExistsException.struct_class = Types::AlreadyExistsException
@@ -404,6 +526,21 @@ module Aws::CloudFormation
AutoDeployment.add_member(:retain_stacks_on_account_removal, Shapes::ShapeRef.new(shape: RetainStacksOnAccountRemovalNullable, location_name: "RetainStacksOnAccountRemoval"))
AutoDeployment.struct_class = Types::AutoDeployment
+ BatchDescribeTypeConfigurationsError.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode"))
+ BatchDescribeTypeConfigurationsError.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
+ BatchDescribeTypeConfigurationsError.add_member(:type_configuration_identifier, Shapes::ShapeRef.new(shape: TypeConfigurationIdentifier, location_name: "TypeConfigurationIdentifier"))
+ BatchDescribeTypeConfigurationsError.struct_class = Types::BatchDescribeTypeConfigurationsError
+
+ BatchDescribeTypeConfigurationsErrors.member = Shapes::ShapeRef.new(shape: BatchDescribeTypeConfigurationsError)
+
+ BatchDescribeTypeConfigurationsInput.add_member(:type_configuration_identifiers, Shapes::ShapeRef.new(shape: TypeConfigurationIdentifiers, required: true, location_name: "TypeConfigurationIdentifiers"))
+ BatchDescribeTypeConfigurationsInput.struct_class = Types::BatchDescribeTypeConfigurationsInput
+
+ BatchDescribeTypeConfigurationsOutput.add_member(:errors, Shapes::ShapeRef.new(shape: BatchDescribeTypeConfigurationsErrors, location_name: "Errors"))
+ BatchDescribeTypeConfigurationsOutput.add_member(:unprocessed_type_configurations, Shapes::ShapeRef.new(shape: UnprocessedTypeConfigurations, location_name: "UnprocessedTypeConfigurations"))
+ BatchDescribeTypeConfigurationsOutput.add_member(:type_configurations, Shapes::ShapeRef.new(shape: TypeConfigurationDetailsList, location_name: "TypeConfigurations"))
+ BatchDescribeTypeConfigurationsOutput.struct_class = Types::BatchDescribeTypeConfigurationsOutput
+
CFNRegistryException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
CFNRegistryException.struct_class = Types::CFNRegistryException
@@ -414,9 +551,29 @@ module Aws::CloudFormation
Capabilities.member = Shapes::ShapeRef.new(shape: Capability)
Change.add_member(:type, Shapes::ShapeRef.new(shape: ChangeType, location_name: "Type"))
+ Change.add_member(:hook_invocation_count, Shapes::ShapeRef.new(shape: HookInvocationCount, location_name: "HookInvocationCount"))
Change.add_member(:resource_change, Shapes::ShapeRef.new(shape: ResourceChange, location_name: "ResourceChange"))
Change.struct_class = Types::Change
+ ChangeSetHook.add_member(:invocation_point, Shapes::ShapeRef.new(shape: HookInvocationPoint, location_name: "InvocationPoint"))
+ ChangeSetHook.add_member(:failure_mode, Shapes::ShapeRef.new(shape: HookFailureMode, location_name: "FailureMode"))
+ ChangeSetHook.add_member(:type_name, Shapes::ShapeRef.new(shape: HookTypeName, location_name: "TypeName"))
+ ChangeSetHook.add_member(:type_version_id, Shapes::ShapeRef.new(shape: HookTypeVersionId, location_name: "TypeVersionId"))
+ ChangeSetHook.add_member(:type_configuration_version_id, Shapes::ShapeRef.new(shape: HookTypeConfigurationVersionId, location_name: "TypeConfigurationVersionId"))
+ ChangeSetHook.add_member(:target_details, Shapes::ShapeRef.new(shape: ChangeSetHookTargetDetails, location_name: "TargetDetails"))
+ ChangeSetHook.struct_class = Types::ChangeSetHook
+
+ ChangeSetHookResourceTargetDetails.add_member(:logical_resource_id, Shapes::ShapeRef.new(shape: LogicalResourceId, location_name: "LogicalResourceId"))
+ ChangeSetHookResourceTargetDetails.add_member(:resource_type, Shapes::ShapeRef.new(shape: HookTargetTypeName, location_name: "ResourceType"))
+ ChangeSetHookResourceTargetDetails.add_member(:resource_action, Shapes::ShapeRef.new(shape: ChangeAction, location_name: "ResourceAction"))
+ ChangeSetHookResourceTargetDetails.struct_class = Types::ChangeSetHookResourceTargetDetails
+
+ ChangeSetHookTargetDetails.add_member(:target_type, Shapes::ShapeRef.new(shape: HookTargetType, location_name: "TargetType"))
+ ChangeSetHookTargetDetails.add_member(:resource_target_details, Shapes::ShapeRef.new(shape: ChangeSetHookResourceTargetDetails, location_name: "ResourceTargetDetails"))
+ ChangeSetHookTargetDetails.struct_class = Types::ChangeSetHookTargetDetails
+
+ ChangeSetHooks.member = Shapes::ShapeRef.new(shape: ChangeSetHook)
+
ChangeSetNotFoundException.struct_class = Types::ChangeSetNotFoundException
ChangeSetSummaries.member = Shapes::ShapeRef.new(shape: ChangeSetSummary)
@@ -430,6 +587,9 @@ module Aws::CloudFormation
ChangeSetSummary.add_member(:status_reason, Shapes::ShapeRef.new(shape: ChangeSetStatusReason, location_name: "StatusReason"))
ChangeSetSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: CreationTime, location_name: "CreationTime"))
ChangeSetSummary.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
+ ChangeSetSummary.add_member(:include_nested_stacks, Shapes::ShapeRef.new(shape: IncludeNestedStacks, location_name: "IncludeNestedStacks"))
+ ChangeSetSummary.add_member(:parent_change_set_id, Shapes::ShapeRef.new(shape: ChangeSetId, location_name: "ParentChangeSetId"))
+ ChangeSetSummary.add_member(:root_change_set_id, Shapes::ShapeRef.new(shape: ChangeSetId, location_name: "RootChangeSetId"))
ChangeSetSummary.struct_class = Types::ChangeSetSummary
Changes.member = Shapes::ShapeRef.new(shape: Change)
@@ -458,6 +618,8 @@ module Aws::CloudFormation
CreateChangeSetInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
CreateChangeSetInput.add_member(:change_set_type, Shapes::ShapeRef.new(shape: ChangeSetType, location_name: "ChangeSetType"))
CreateChangeSetInput.add_member(:resources_to_import, Shapes::ShapeRef.new(shape: ResourcesToImport, location_name: "ResourcesToImport"))
+ CreateChangeSetInput.add_member(:include_nested_stacks, Shapes::ShapeRef.new(shape: IncludeNestedStacks, location_name: "IncludeNestedStacks"))
+ CreateChangeSetInput.add_member(:on_stack_failure, Shapes::ShapeRef.new(shape: OnStackFailure, location_name: "OnStackFailure"))
CreateChangeSetInput.struct_class = Types::CreateChangeSetInput
CreateChangeSetOutput.add_member(:id, Shapes::ShapeRef.new(shape: ChangeSetId, location_name: "Id"))
@@ -490,6 +652,7 @@ module Aws::CloudFormation
CreateStackInstancesInput.add_member(:parameter_overrides, Shapes::ShapeRef.new(shape: Parameters, location_name: "ParameterOverrides"))
CreateStackInstancesInput.add_member(:operation_preferences, Shapes::ShapeRef.new(shape: StackSetOperationPreferences, location_name: "OperationPreferences"))
CreateStackInstancesInput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId", metadata: {"idempotencyToken"=>true}))
+ CreateStackInstancesInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
CreateStackInstancesInput.struct_class = Types::CreateStackInstancesInput
CreateStackInstancesOutput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId"))
@@ -502,6 +665,7 @@ module Aws::CloudFormation
CreateStackSetInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
CreateStackSetInput.add_member(:template_body, Shapes::ShapeRef.new(shape: TemplateBody, location_name: "TemplateBody"))
CreateStackSetInput.add_member(:template_url, Shapes::ShapeRef.new(shape: TemplateURL, location_name: "TemplateURL"))
+ CreateStackSetInput.add_member(:stack_id, Shapes::ShapeRef.new(shape: StackId, location_name: "StackId"))
CreateStackSetInput.add_member(:parameters, Shapes::ShapeRef.new(shape: Parameters, location_name: "Parameters"))
CreateStackSetInput.add_member(:capabilities, Shapes::ShapeRef.new(shape: Capabilities, location_name: "Capabilities"))
CreateStackSetInput.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
@@ -509,7 +673,9 @@ module Aws::CloudFormation
CreateStackSetInput.add_member(:execution_role_name, Shapes::ShapeRef.new(shape: ExecutionRoleName, location_name: "ExecutionRoleName"))
CreateStackSetInput.add_member(:permission_model, Shapes::ShapeRef.new(shape: PermissionModels, location_name: "PermissionModel"))
CreateStackSetInput.add_member(:auto_deployment, Shapes::ShapeRef.new(shape: AutoDeployment, location_name: "AutoDeployment"))
+ CreateStackSetInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
CreateStackSetInput.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
+ CreateStackSetInput.add_member(:managed_execution, Shapes::ShapeRef.new(shape: ManagedExecution, location_name: "ManagedExecution"))
CreateStackSetInput.struct_class = Types::CreateStackSetInput
CreateStackSetOutput.add_member(:stack_set_id, Shapes::ShapeRef.new(shape: StackSetId, location_name: "StackSetId"))
@@ -517,6 +683,17 @@ module Aws::CloudFormation
CreatedButModifiedException.struct_class = Types::CreatedButModifiedException
+ DeactivateOrganizationsAccessInput.struct_class = Types::DeactivateOrganizationsAccessInput
+
+ DeactivateOrganizationsAccessOutput.struct_class = Types::DeactivateOrganizationsAccessOutput
+
+ DeactivateTypeInput.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeName"))
+ DeactivateTypeInput.add_member(:type, Shapes::ShapeRef.new(shape: ThirdPartyType, location_name: "Type"))
+ DeactivateTypeInput.add_member(:arn, Shapes::ShapeRef.new(shape: PrivateTypeArn, location_name: "Arn"))
+ DeactivateTypeInput.struct_class = Types::DeactivateTypeInput
+
+ DeactivateTypeOutput.struct_class = Types::DeactivateTypeOutput
+
DeleteChangeSetInput.add_member(:change_set_name, Shapes::ShapeRef.new(shape: ChangeSetNameOrId, required: true, location_name: "ChangeSetName"))
DeleteChangeSetInput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackNameOrId, location_name: "StackName"))
DeleteChangeSetInput.struct_class = Types::DeleteChangeSetInput
@@ -536,18 +713,22 @@ module Aws::CloudFormation
DeleteStackInstancesInput.add_member(:operation_preferences, Shapes::ShapeRef.new(shape: StackSetOperationPreferences, location_name: "OperationPreferences"))
DeleteStackInstancesInput.add_member(:retain_stacks, Shapes::ShapeRef.new(shape: RetainStacks, required: true, location_name: "RetainStacks"))
DeleteStackInstancesInput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId", metadata: {"idempotencyToken"=>true}))
+ DeleteStackInstancesInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
DeleteStackInstancesInput.struct_class = Types::DeleteStackInstancesInput
DeleteStackInstancesOutput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId"))
DeleteStackInstancesOutput.struct_class = Types::DeleteStackInstancesOutput
DeleteStackSetInput.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetName, required: true, location_name: "StackSetName"))
+ DeleteStackSetInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
DeleteStackSetInput.struct_class = Types::DeleteStackSetInput
DeleteStackSetOutput.struct_class = Types::DeleteStackSetOutput
DeploymentTargets.add_member(:accounts, Shapes::ShapeRef.new(shape: AccountList, location_name: "Accounts"))
+ DeploymentTargets.add_member(:accounts_url, Shapes::ShapeRef.new(shape: AccountsUrl, location_name: "AccountsUrl"))
DeploymentTargets.add_member(:organizational_unit_ids, Shapes::ShapeRef.new(shape: OrganizationalUnitIdList, location_name: "OrganizationalUnitIds"))
+ DeploymentTargets.add_member(:account_filter_type, Shapes::ShapeRef.new(shape: AccountFilterType, location_name: "AccountFilterType"))
DeploymentTargets.struct_class = Types::DeploymentTargets
DeregisterTypeInput.add_member(:arn, Shapes::ShapeRef.new(shape: PrivateTypeArn, location_name: "Arn"))
@@ -565,6 +746,21 @@ module Aws::CloudFormation
DescribeAccountLimitsOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
DescribeAccountLimitsOutput.struct_class = Types::DescribeAccountLimitsOutput
+ DescribeChangeSetHooksInput.add_member(:change_set_name, Shapes::ShapeRef.new(shape: ChangeSetNameOrId, required: true, location_name: "ChangeSetName"))
+ DescribeChangeSetHooksInput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackNameOrId, location_name: "StackName"))
+ DescribeChangeSetHooksInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+ DescribeChangeSetHooksInput.add_member(:logical_resource_id, Shapes::ShapeRef.new(shape: LogicalResourceId, location_name: "LogicalResourceId"))
+ DescribeChangeSetHooksInput.struct_class = Types::DescribeChangeSetHooksInput
+
+ DescribeChangeSetHooksOutput.add_member(:change_set_id, Shapes::ShapeRef.new(shape: ChangeSetId, location_name: "ChangeSetId"))
+ DescribeChangeSetHooksOutput.add_member(:change_set_name, Shapes::ShapeRef.new(shape: ChangeSetName, location_name: "ChangeSetName"))
+ DescribeChangeSetHooksOutput.add_member(:hooks, Shapes::ShapeRef.new(shape: ChangeSetHooks, location_name: "Hooks"))
+ DescribeChangeSetHooksOutput.add_member(:status, Shapes::ShapeRef.new(shape: ChangeSetHooksStatus, location_name: "Status"))
+ DescribeChangeSetHooksOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+ DescribeChangeSetHooksOutput.add_member(:stack_id, Shapes::ShapeRef.new(shape: StackId, location_name: "StackId"))
+ DescribeChangeSetHooksOutput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackName, location_name: "StackName"))
+ DescribeChangeSetHooksOutput.struct_class = Types::DescribeChangeSetHooksOutput
+
DescribeChangeSetInput.add_member(:change_set_name, Shapes::ShapeRef.new(shape: ChangeSetNameOrId, required: true, location_name: "ChangeSetName"))
DescribeChangeSetInput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackNameOrId, location_name: "StackName"))
DescribeChangeSetInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
@@ -586,8 +782,27 @@ module Aws::CloudFormation
DescribeChangeSetOutput.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
DescribeChangeSetOutput.add_member(:changes, Shapes::ShapeRef.new(shape: Changes, location_name: "Changes"))
DescribeChangeSetOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+ DescribeChangeSetOutput.add_member(:include_nested_stacks, Shapes::ShapeRef.new(shape: IncludeNestedStacks, location_name: "IncludeNestedStacks"))
+ DescribeChangeSetOutput.add_member(:parent_change_set_id, Shapes::ShapeRef.new(shape: ChangeSetId, location_name: "ParentChangeSetId"))
+ DescribeChangeSetOutput.add_member(:root_change_set_id, Shapes::ShapeRef.new(shape: ChangeSetId, location_name: "RootChangeSetId"))
+ DescribeChangeSetOutput.add_member(:on_stack_failure, Shapes::ShapeRef.new(shape: OnStackFailure, location_name: "OnStackFailure"))
DescribeChangeSetOutput.struct_class = Types::DescribeChangeSetOutput
+ DescribeOrganizationsAccessInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
+ DescribeOrganizationsAccessInput.struct_class = Types::DescribeOrganizationsAccessInput
+
+ DescribeOrganizationsAccessOutput.add_member(:status, Shapes::ShapeRef.new(shape: OrganizationStatus, location_name: "Status"))
+ DescribeOrganizationsAccessOutput.struct_class = Types::DescribeOrganizationsAccessOutput
+
+ DescribePublisherInput.add_member(:publisher_id, Shapes::ShapeRef.new(shape: PublisherId, location_name: "PublisherId"))
+ DescribePublisherInput.struct_class = Types::DescribePublisherInput
+
+ DescribePublisherOutput.add_member(:publisher_id, Shapes::ShapeRef.new(shape: PublisherId, location_name: "PublisherId"))
+ DescribePublisherOutput.add_member(:publisher_status, Shapes::ShapeRef.new(shape: PublisherStatus, location_name: "PublisherStatus"))
+ DescribePublisherOutput.add_member(:identity_provider, Shapes::ShapeRef.new(shape: IdentityProvider, location_name: "IdentityProvider"))
+ DescribePublisherOutput.add_member(:publisher_profile, Shapes::ShapeRef.new(shape: PublisherProfile, location_name: "PublisherProfile"))
+ DescribePublisherOutput.struct_class = Types::DescribePublisherOutput
+
DescribeStackDriftDetectionStatusInput.add_member(:stack_drift_detection_id, Shapes::ShapeRef.new(shape: StackDriftDetectionId, required: true, location_name: "StackDriftDetectionId"))
DescribeStackDriftDetectionStatusInput.struct_class = Types::DescribeStackDriftDetectionStatusInput
@@ -611,6 +826,7 @@ module Aws::CloudFormation
DescribeStackInstanceInput.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetName, required: true, location_name: "StackSetName"))
DescribeStackInstanceInput.add_member(:stack_instance_account, Shapes::ShapeRef.new(shape: Account, required: true, location_name: "StackInstanceAccount"))
DescribeStackInstanceInput.add_member(:stack_instance_region, Shapes::ShapeRef.new(shape: Region, required: true, location_name: "StackInstanceRegion"))
+ DescribeStackInstanceInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
DescribeStackInstanceInput.struct_class = Types::DescribeStackInstanceInput
DescribeStackInstanceOutput.add_member(:stack_instance, Shapes::ShapeRef.new(shape: StackInstance, location_name: "StackInstance"))
@@ -642,10 +858,12 @@ module Aws::CloudFormation
DescribeStackResourcesOutput.struct_class = Types::DescribeStackResourcesOutput
DescribeStackSetInput.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetName, required: true, location_name: "StackSetName"))
+ DescribeStackSetInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
DescribeStackSetInput.struct_class = Types::DescribeStackSetInput
DescribeStackSetOperationInput.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetName, required: true, location_name: "StackSetName"))
DescribeStackSetOperationInput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, required: true, location_name: "OperationId"))
+ DescribeStackSetOperationInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
DescribeStackSetOperationInput.struct_class = Types::DescribeStackSetOperationInput
DescribeStackSetOperationOutput.add_member(:stack_set_operation, Shapes::ShapeRef.new(shape: StackSetOperation, location_name: "StackSetOperation"))
@@ -666,6 +884,8 @@ module Aws::CloudFormation
DescribeTypeInput.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeName"))
DescribeTypeInput.add_member(:arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "Arn"))
DescribeTypeInput.add_member(:version_id, Shapes::ShapeRef.new(shape: TypeVersionId, location_name: "VersionId"))
+ DescribeTypeInput.add_member(:publisher_id, Shapes::ShapeRef.new(shape: PublisherId, location_name: "PublisherId"))
+ DescribeTypeInput.add_member(:public_version_number, Shapes::ShapeRef.new(shape: PublicVersionNumber, location_name: "PublicVersionNumber"))
DescribeTypeInput.struct_class = Types::DescribeTypeInput
DescribeTypeOutput.add_member(:arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "Arn"))
@@ -673,17 +893,28 @@ module Aws::CloudFormation
DescribeTypeOutput.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeName"))
DescribeTypeOutput.add_member(:default_version_id, Shapes::ShapeRef.new(shape: TypeVersionId, location_name: "DefaultVersionId"))
DescribeTypeOutput.add_member(:is_default_version, Shapes::ShapeRef.new(shape: IsDefaultVersion, location_name: "IsDefaultVersion"))
+ DescribeTypeOutput.add_member(:type_tests_status, Shapes::ShapeRef.new(shape: TypeTestsStatus, location_name: "TypeTestsStatus"))
+ DescribeTypeOutput.add_member(:type_tests_status_description, Shapes::ShapeRef.new(shape: TypeTestsStatusDescription, location_name: "TypeTestsStatusDescription"))
DescribeTypeOutput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
DescribeTypeOutput.add_member(:schema, Shapes::ShapeRef.new(shape: TypeSchema, location_name: "Schema"))
DescribeTypeOutput.add_member(:provisioning_type, Shapes::ShapeRef.new(shape: ProvisioningType, location_name: "ProvisioningType"))
DescribeTypeOutput.add_member(:deprecated_status, Shapes::ShapeRef.new(shape: DeprecatedStatus, location_name: "DeprecatedStatus"))
DescribeTypeOutput.add_member(:logging_config, Shapes::ShapeRef.new(shape: LoggingConfig, location_name: "LoggingConfig"))
+ DescribeTypeOutput.add_member(:required_activated_types, Shapes::ShapeRef.new(shape: RequiredActivatedTypes, location_name: "RequiredActivatedTypes"))
DescribeTypeOutput.add_member(:execution_role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "ExecutionRoleArn"))
DescribeTypeOutput.add_member(:visibility, Shapes::ShapeRef.new(shape: Visibility, location_name: "Visibility"))
DescribeTypeOutput.add_member(:source_url, Shapes::ShapeRef.new(shape: OptionalSecureUrl, location_name: "SourceUrl"))
DescribeTypeOutput.add_member(:documentation_url, Shapes::ShapeRef.new(shape: OptionalSecureUrl, location_name: "DocumentationUrl"))
DescribeTypeOutput.add_member(:last_updated, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastUpdated"))
DescribeTypeOutput.add_member(:time_created, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TimeCreated"))
+ DescribeTypeOutput.add_member(:configuration_schema, Shapes::ShapeRef.new(shape: ConfigurationSchema, location_name: "ConfigurationSchema"))
+ DescribeTypeOutput.add_member(:publisher_id, Shapes::ShapeRef.new(shape: PublisherId, location_name: "PublisherId"))
+ DescribeTypeOutput.add_member(:original_type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "OriginalTypeName"))
+ DescribeTypeOutput.add_member(:original_type_arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "OriginalTypeArn"))
+ DescribeTypeOutput.add_member(:public_version_number, Shapes::ShapeRef.new(shape: PublicVersionNumber, location_name: "PublicVersionNumber"))
+ DescribeTypeOutput.add_member(:latest_public_version, Shapes::ShapeRef.new(shape: PublicVersionNumber, location_name: "LatestPublicVersion"))
+ DescribeTypeOutput.add_member(:is_activated, Shapes::ShapeRef.new(shape: IsActivated, location_name: "IsActivated"))
+ DescribeTypeOutput.add_member(:auto_update, Shapes::ShapeRef.new(shape: AutoUpdate, location_name: "AutoUpdate"))
DescribeTypeOutput.struct_class = Types::DescribeTypeOutput
DescribeTypeRegistrationInput.add_member(:registration_token, Shapes::ShapeRef.new(shape: RegistrationToken, required: true, location_name: "RegistrationToken"))
@@ -712,6 +943,7 @@ module Aws::CloudFormation
DetectStackSetDriftInput.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetNameOrId, required: true, location_name: "StackSetName"))
DetectStackSetDriftInput.add_member(:operation_preferences, Shapes::ShapeRef.new(shape: StackSetOperationPreferences, location_name: "OperationPreferences"))
DetectStackSetDriftInput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId", metadata: {"idempotencyToken"=>true}))
+ DetectStackSetDriftInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
DetectStackSetDriftInput.struct_class = Types::DetectStackSetDriftInput
DetectStackSetDriftOutput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId"))
@@ -728,6 +960,7 @@ module Aws::CloudFormation
ExecuteChangeSetInput.add_member(:change_set_name, Shapes::ShapeRef.new(shape: ChangeSetNameOrId, required: true, location_name: "ChangeSetName"))
ExecuteChangeSetInput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackNameOrId, location_name: "StackName"))
ExecuteChangeSetInput.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
+ ExecuteChangeSetInput.add_member(:disable_rollback, Shapes::ShapeRef.new(shape: DisableRollback, location_name: "DisableRollback"))
ExecuteChangeSetInput.struct_class = Types::ExecuteChangeSetInput
ExecuteChangeSetOutput.struct_class = Types::ExecuteChangeSetOutput
@@ -758,6 +991,7 @@ module Aws::CloudFormation
GetTemplateSummaryInput.add_member(:template_url, Shapes::ShapeRef.new(shape: TemplateURL, location_name: "TemplateURL"))
GetTemplateSummaryInput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackNameOrId, location_name: "StackName"))
GetTemplateSummaryInput.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetNameOrId, location_name: "StackSetName"))
+ GetTemplateSummaryInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
GetTemplateSummaryInput.struct_class = Types::GetTemplateSummaryInput
GetTemplateSummaryOutput.add_member(:parameters, Shapes::ShapeRef.new(shape: ParameterDeclarations, location_name: "Parameters"))
@@ -771,6 +1005,18 @@ module Aws::CloudFormation
GetTemplateSummaryOutput.add_member(:resource_identifier_summaries, Shapes::ShapeRef.new(shape: ResourceIdentifierSummaries, location_name: "ResourceIdentifierSummaries"))
GetTemplateSummaryOutput.struct_class = Types::GetTemplateSummaryOutput
+ ImportStacksToStackSetInput.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetNameOrId, required: true, location_name: "StackSetName"))
+ ImportStacksToStackSetInput.add_member(:stack_ids, Shapes::ShapeRef.new(shape: StackIdList, location_name: "StackIds"))
+ ImportStacksToStackSetInput.add_member(:stack_ids_url, Shapes::ShapeRef.new(shape: StackIdsUrl, location_name: "StackIdsUrl"))
+ ImportStacksToStackSetInput.add_member(:organizational_unit_ids, Shapes::ShapeRef.new(shape: OrganizationalUnitIdList, location_name: "OrganizationalUnitIds"))
+ ImportStacksToStackSetInput.add_member(:operation_preferences, Shapes::ShapeRef.new(shape: StackSetOperationPreferences, location_name: "OperationPreferences"))
+ ImportStacksToStackSetInput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId", metadata: {"idempotencyToken"=>true}))
+ ImportStacksToStackSetInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
+ ImportStacksToStackSetInput.struct_class = Types::ImportStacksToStackSetInput
+
+ ImportStacksToStackSetOutput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId"))
+ ImportStacksToStackSetOutput.struct_class = Types::ImportStacksToStackSetOutput
+
Imports.member = Shapes::ShapeRef.new(shape: StackName)
InsufficientCapabilitiesException.struct_class = Types::InsufficientCapabilitiesException
@@ -812,6 +1058,7 @@ module Aws::CloudFormation
ListStackInstancesInput.add_member(:filters, Shapes::ShapeRef.new(shape: StackInstanceFilters, location_name: "Filters"))
ListStackInstancesInput.add_member(:stack_instance_account, Shapes::ShapeRef.new(shape: Account, location_name: "StackInstanceAccount"))
ListStackInstancesInput.add_member(:stack_instance_region, Shapes::ShapeRef.new(shape: Region, location_name: "StackInstanceRegion"))
+ ListStackInstancesInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
ListStackInstancesInput.struct_class = Types::ListStackInstancesInput
ListStackInstancesOutput.add_member(:summaries, Shapes::ShapeRef.new(shape: StackInstanceSummaries, location_name: "Summaries"))
@@ -830,6 +1077,8 @@ module Aws::CloudFormation
ListStackSetOperationResultsInput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, required: true, location_name: "OperationId"))
ListStackSetOperationResultsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
ListStackSetOperationResultsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
+ ListStackSetOperationResultsInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
+ ListStackSetOperationResultsInput.add_member(:filters, Shapes::ShapeRef.new(shape: OperationResultFilters, location_name: "Filters"))
ListStackSetOperationResultsInput.struct_class = Types::ListStackSetOperationResultsInput
ListStackSetOperationResultsOutput.add_member(:summaries, Shapes::ShapeRef.new(shape: StackSetOperationResultSummaries, location_name: "Summaries"))
@@ -839,6 +1088,7 @@ module Aws::CloudFormation
ListStackSetOperationsInput.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetName, required: true, location_name: "StackSetName"))
ListStackSetOperationsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
ListStackSetOperationsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
+ ListStackSetOperationsInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
ListStackSetOperationsInput.struct_class = Types::ListStackSetOperationsInput
ListStackSetOperationsOutput.add_member(:summaries, Shapes::ShapeRef.new(shape: StackSetOperationSummaries, location_name: "Summaries"))
@@ -848,6 +1098,7 @@ module Aws::CloudFormation
ListStackSetsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
ListStackSetsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
ListStackSetsInput.add_member(:status, Shapes::ShapeRef.new(shape: StackSetStatus, location_name: "Status"))
+ ListStackSetsInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
ListStackSetsInput.struct_class = Types::ListStackSetsInput
ListStackSetsOutput.add_member(:summaries, Shapes::ShapeRef.new(shape: StackSetSummaries, location_name: "Summaries"))
@@ -876,10 +1127,11 @@ module Aws::CloudFormation
ListTypeVersionsInput.add_member(:type, Shapes::ShapeRef.new(shape: RegistryType, location_name: "Type"))
ListTypeVersionsInput.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeName"))
- ListTypeVersionsInput.add_member(:arn, Shapes::ShapeRef.new(shape: PrivateTypeArn, location_name: "Arn"))
+ ListTypeVersionsInput.add_member(:arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "Arn"))
ListTypeVersionsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
ListTypeVersionsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
ListTypeVersionsInput.add_member(:deprecated_status, Shapes::ShapeRef.new(shape: DeprecatedStatus, location_name: "DeprecatedStatus"))
+ ListTypeVersionsInput.add_member(:publisher_id, Shapes::ShapeRef.new(shape: PublisherId, location_name: "PublisherId"))
ListTypeVersionsInput.struct_class = Types::ListTypeVersionsInput
ListTypeVersionsOutput.add_member(:type_version_summaries, Shapes::ShapeRef.new(shape: TypeVersionSummaries, location_name: "TypeVersionSummaries"))
@@ -889,6 +1141,8 @@ module Aws::CloudFormation
ListTypesInput.add_member(:visibility, Shapes::ShapeRef.new(shape: Visibility, location_name: "Visibility"))
ListTypesInput.add_member(:provisioning_type, Shapes::ShapeRef.new(shape: ProvisioningType, location_name: "ProvisioningType"))
ListTypesInput.add_member(:deprecated_status, Shapes::ShapeRef.new(shape: DeprecatedStatus, location_name: "DeprecatedStatus"))
+ ListTypesInput.add_member(:type, Shapes::ShapeRef.new(shape: RegistryType, location_name: "Type"))
+ ListTypesInput.add_member(:filters, Shapes::ShapeRef.new(shape: TypeFilters, location_name: "Filters"))
ListTypesInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
ListTypesInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
ListTypesInput.struct_class = Types::ListTypesInput
@@ -903,6 +1157,13 @@ module Aws::CloudFormation
LogicalResourceIds.member = Shapes::ShapeRef.new(shape: LogicalResourceId)
+ ManagedExecution.add_member(:active, Shapes::ShapeRef.new(shape: ManagedExecutionNullable, location_name: "Active"))
+ ManagedExecution.struct_class = Types::ManagedExecution
+
+ ModuleInfo.add_member(:type_hierarchy, Shapes::ShapeRef.new(shape: TypeHierarchy, location_name: "TypeHierarchy"))
+ ModuleInfo.add_member(:logical_id_hierarchy, Shapes::ShapeRef.new(shape: LogicalIdHierarchy, location_name: "LogicalIdHierarchy"))
+ ModuleInfo.struct_class = Types::ModuleInfo
+
NameAlreadyExistsException.struct_class = Types::NameAlreadyExistsException
NotificationARNs.member = Shapes::ShapeRef.new(shape: NotificationARN)
@@ -913,6 +1174,12 @@ module Aws::CloudFormation
OperationNotFoundException.struct_class = Types::OperationNotFoundException
+ OperationResultFilter.add_member(:name, Shapes::ShapeRef.new(shape: OperationResultFilterName, location_name: "Name"))
+ OperationResultFilter.add_member(:values, Shapes::ShapeRef.new(shape: OperationResultFilterValues, location_name: "Values"))
+ OperationResultFilter.struct_class = Types::OperationResultFilter
+
+ OperationResultFilters.member = Shapes::ShapeRef.new(shape: OperationResultFilter)
+
OperationStatusCheckFailedException.struct_class = Types::OperationStatusCheckFailedException
OrganizationalUnitIdList.member = Shapes::ShapeRef.new(shape: OrganizationalUnitId)
@@ -960,6 +1227,15 @@ module Aws::CloudFormation
PropertyDifferences.member = Shapes::ShapeRef.new(shape: PropertyDifference)
+ PublishTypeInput.add_member(:type, Shapes::ShapeRef.new(shape: ThirdPartyType, location_name: "Type"))
+ PublishTypeInput.add_member(:arn, Shapes::ShapeRef.new(shape: PrivateTypeArn, location_name: "Arn"))
+ PublishTypeInput.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeName"))
+ PublishTypeInput.add_member(:public_version_number, Shapes::ShapeRef.new(shape: PublicVersionNumber, location_name: "PublicVersionNumber"))
+ PublishTypeInput.struct_class = Types::PublishTypeInput
+
+ PublishTypeOutput.add_member(:public_type_arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "PublicTypeArn"))
+ PublishTypeOutput.struct_class = Types::PublishTypeOutput
+
RecordHandlerProgressInput.add_member(:bearer_token, Shapes::ShapeRef.new(shape: ClientToken, required: true, location_name: "BearerToken"))
RecordHandlerProgressInput.add_member(:operation_status, Shapes::ShapeRef.new(shape: OperationStatus, required: true, location_name: "OperationStatus"))
RecordHandlerProgressInput.add_member(:current_operation_status, Shapes::ShapeRef.new(shape: OperationStatus, location_name: "CurrentOperationStatus"))
@@ -973,6 +1249,13 @@ module Aws::CloudFormation
RegionList.member = Shapes::ShapeRef.new(shape: Region)
+ RegisterPublisherInput.add_member(:accept_terms_and_conditions, Shapes::ShapeRef.new(shape: AcceptTermsAndConditions, location_name: "AcceptTermsAndConditions"))
+ RegisterPublisherInput.add_member(:connection_arn, Shapes::ShapeRef.new(shape: ConnectionArn, location_name: "ConnectionArn"))
+ RegisterPublisherInput.struct_class = Types::RegisterPublisherInput
+
+ RegisterPublisherOutput.add_member(:publisher_id, Shapes::ShapeRef.new(shape: PublisherId, location_name: "PublisherId"))
+ RegisterPublisherOutput.struct_class = Types::RegisterPublisherOutput
+
RegisterTypeInput.add_member(:type, Shapes::ShapeRef.new(shape: RegistryType, location_name: "Type"))
RegisterTypeInput.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, required: true, location_name: "TypeName"))
RegisterTypeInput.add_member(:schema_handler_package, Shapes::ShapeRef.new(shape: S3Url, required: true, location_name: "SchemaHandlerPackage"))
@@ -986,6 +1269,14 @@ module Aws::CloudFormation
RegistrationTokenList.member = Shapes::ShapeRef.new(shape: RegistrationToken)
+ RequiredActivatedType.add_member(:type_name_alias, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeNameAlias"))
+ RequiredActivatedType.add_member(:original_type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "OriginalTypeName"))
+ RequiredActivatedType.add_member(:publisher_id, Shapes::ShapeRef.new(shape: PublisherId, location_name: "PublisherId"))
+ RequiredActivatedType.add_member(:supported_major_versions, Shapes::ShapeRef.new(shape: SupportedMajorVersions, location_name: "SupportedMajorVersions"))
+ RequiredActivatedType.struct_class = Types::RequiredActivatedType
+
+ RequiredActivatedTypes.member = Shapes::ShapeRef.new(shape: RequiredActivatedType)
+
ResourceChange.add_member(:action, Shapes::ShapeRef.new(shape: ChangeAction, location_name: "Action"))
ResourceChange.add_member(:logical_resource_id, Shapes::ShapeRef.new(shape: LogicalResourceId, location_name: "LogicalResourceId"))
ResourceChange.add_member(:physical_resource_id, Shapes::ShapeRef.new(shape: PhysicalResourceId, location_name: "PhysicalResourceId"))
@@ -993,6 +1284,8 @@ module Aws::CloudFormation
ResourceChange.add_member(:replacement, Shapes::ShapeRef.new(shape: Replacement, location_name: "Replacement"))
ResourceChange.add_member(:scope, Shapes::ShapeRef.new(shape: Scope, location_name: "Scope"))
ResourceChange.add_member(:details, Shapes::ShapeRef.new(shape: ResourceChangeDetails, location_name: "Details"))
+ ResourceChange.add_member(:change_set_id, Shapes::ShapeRef.new(shape: ChangeSetId, location_name: "ChangeSetId"))
+ ResourceChange.add_member(:module_info, Shapes::ShapeRef.new(shape: ModuleInfo, location_name: "ModuleInfo"))
ResourceChange.struct_class = Types::ResourceChange
ResourceChangeDetail.add_member(:target, Shapes::ShapeRef.new(shape: ResourceTargetDefinition, location_name: "Target"))
@@ -1037,6 +1330,14 @@ module Aws::CloudFormation
RollbackConfiguration.add_member(:monitoring_time_in_minutes, Shapes::ShapeRef.new(shape: MonitoringTimeInMinutes, location_name: "MonitoringTimeInMinutes"))
RollbackConfiguration.struct_class = Types::RollbackConfiguration
+ RollbackStackInput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackNameOrId, required: true, location_name: "StackName"))
+ RollbackStackInput.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleARN, location_name: "RoleARN"))
+ RollbackStackInput.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
+ RollbackStackInput.struct_class = Types::RollbackStackInput
+
+ RollbackStackOutput.add_member(:stack_id, Shapes::ShapeRef.new(shape: StackId, location_name: "StackId"))
+ RollbackStackOutput.struct_class = Types::RollbackStackOutput
+
RollbackTrigger.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "Arn"))
RollbackTrigger.add_member(:type, Shapes::ShapeRef.new(shape: Type, required: true, location_name: "Type"))
RollbackTrigger.struct_class = Types::RollbackTrigger
@@ -1050,6 +1351,16 @@ module Aws::CloudFormation
SetStackPolicyInput.add_member(:stack_policy_url, Shapes::ShapeRef.new(shape: StackPolicyURL, location_name: "StackPolicyURL"))
SetStackPolicyInput.struct_class = Types::SetStackPolicyInput
+ SetTypeConfigurationInput.add_member(:type_arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "TypeArn"))
+ SetTypeConfigurationInput.add_member(:configuration, Shapes::ShapeRef.new(shape: TypeConfiguration, required: true, location_name: "Configuration"))
+ SetTypeConfigurationInput.add_member(:configuration_alias, Shapes::ShapeRef.new(shape: TypeConfigurationAlias, location_name: "ConfigurationAlias"))
+ SetTypeConfigurationInput.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeName"))
+ SetTypeConfigurationInput.add_member(:type, Shapes::ShapeRef.new(shape: ThirdPartyType, location_name: "Type"))
+ SetTypeConfigurationInput.struct_class = Types::SetTypeConfigurationInput
+
+ SetTypeConfigurationOutput.add_member(:configuration_arn, Shapes::ShapeRef.new(shape: TypeConfigurationArn, location_name: "ConfigurationArn"))
+ SetTypeConfigurationOutput.struct_class = Types::SetTypeConfigurationOutput
+
SetTypeDefaultVersionInput.add_member(:arn, Shapes::ShapeRef.new(shape: PrivateTypeArn, location_name: "Arn"))
SetTypeDefaultVersionInput.add_member(:type, Shapes::ShapeRef.new(shape: RegistryType, location_name: "Type"))
SetTypeDefaultVersionInput.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeName"))
@@ -1107,10 +1418,17 @@ module Aws::CloudFormation
StackEvent.add_member(:resource_status_reason, Shapes::ShapeRef.new(shape: ResourceStatusReason, location_name: "ResourceStatusReason"))
StackEvent.add_member(:resource_properties, Shapes::ShapeRef.new(shape: ResourceProperties, location_name: "ResourceProperties"))
StackEvent.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
+ StackEvent.add_member(:hook_type, Shapes::ShapeRef.new(shape: HookType, location_name: "HookType"))
+ StackEvent.add_member(:hook_status, Shapes::ShapeRef.new(shape: HookStatus, location_name: "HookStatus"))
+ StackEvent.add_member(:hook_status_reason, Shapes::ShapeRef.new(shape: HookStatusReason, location_name: "HookStatusReason"))
+ StackEvent.add_member(:hook_invocation_point, Shapes::ShapeRef.new(shape: HookInvocationPoint, location_name: "HookInvocationPoint"))
+ StackEvent.add_member(:hook_failure_mode, Shapes::ShapeRef.new(shape: HookFailureMode, location_name: "HookFailureMode"))
StackEvent.struct_class = Types::StackEvent
StackEvents.member = Shapes::ShapeRef.new(shape: StackEvent)
+ StackIdList.member = Shapes::ShapeRef.new(shape: StackId)
+
StackInstance.add_member(:stack_set_id, Shapes::ShapeRef.new(shape: StackSetId, location_name: "StackSetId"))
StackInstance.add_member(:region, Shapes::ShapeRef.new(shape: Region, location_name: "Region"))
StackInstance.add_member(:account, Shapes::ShapeRef.new(shape: Account, location_name: "Account"))
@@ -1122,6 +1440,7 @@ module Aws::CloudFormation
StackInstance.add_member(:organizational_unit_id, Shapes::ShapeRef.new(shape: OrganizationalUnitId, location_name: "OrganizationalUnitId"))
StackInstance.add_member(:drift_status, Shapes::ShapeRef.new(shape: StackDriftStatus, location_name: "DriftStatus"))
StackInstance.add_member(:last_drift_check_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastDriftCheckTimestamp"))
+ StackInstance.add_member(:last_operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "LastOperationId"))
StackInstance.struct_class = Types::StackInstance
StackInstanceComprehensiveStatus.add_member(:detailed_status, Shapes::ShapeRef.new(shape: StackInstanceDetailedStatus, location_name: "DetailedStatus"))
@@ -1147,8 +1466,11 @@ module Aws::CloudFormation
StackInstanceSummary.add_member(:organizational_unit_id, Shapes::ShapeRef.new(shape: OrganizationalUnitId, location_name: "OrganizationalUnitId"))
StackInstanceSummary.add_member(:drift_status, Shapes::ShapeRef.new(shape: StackDriftStatus, location_name: "DriftStatus"))
StackInstanceSummary.add_member(:last_drift_check_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastDriftCheckTimestamp"))
+ StackInstanceSummary.add_member(:last_operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "LastOperationId"))
StackInstanceSummary.struct_class = Types::StackInstanceSummary
+ StackNotFoundException.struct_class = Types::StackNotFoundException
+
StackResource.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackName, location_name: "StackName"))
StackResource.add_member(:stack_id, Shapes::ShapeRef.new(shape: StackId, location_name: "StackId"))
StackResource.add_member(:logical_resource_id, Shapes::ShapeRef.new(shape: LogicalResourceId, required: true, location_name: "LogicalResourceId"))
@@ -1159,6 +1481,7 @@ module Aws::CloudFormation
StackResource.add_member(:resource_status_reason, Shapes::ShapeRef.new(shape: ResourceStatusReason, location_name: "ResourceStatusReason"))
StackResource.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
StackResource.add_member(:drift_information, Shapes::ShapeRef.new(shape: StackResourceDriftInformation, location_name: "DriftInformation"))
+ StackResource.add_member(:module_info, Shapes::ShapeRef.new(shape: ModuleInfo, location_name: "ModuleInfo"))
StackResource.struct_class = Types::StackResource
StackResourceDetail.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackName, location_name: "StackName"))
@@ -1172,6 +1495,7 @@ module Aws::CloudFormation
StackResourceDetail.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
StackResourceDetail.add_member(:metadata, Shapes::ShapeRef.new(shape: Metadata, location_name: "Metadata"))
StackResourceDetail.add_member(:drift_information, Shapes::ShapeRef.new(shape: StackResourceDriftInformation, location_name: "DriftInformation"))
+ StackResourceDetail.add_member(:module_info, Shapes::ShapeRef.new(shape: ModuleInfo, location_name: "ModuleInfo"))
StackResourceDetail.struct_class = Types::StackResourceDetail
StackResourceDrift.add_member(:stack_id, Shapes::ShapeRef.new(shape: StackId, required: true, location_name: "StackId"))
@@ -1184,6 +1508,7 @@ module Aws::CloudFormation
StackResourceDrift.add_member(:property_differences, Shapes::ShapeRef.new(shape: PropertyDifferences, location_name: "PropertyDifferences"))
StackResourceDrift.add_member(:stack_resource_drift_status, Shapes::ShapeRef.new(shape: StackResourceDriftStatus, required: true, location_name: "StackResourceDriftStatus"))
StackResourceDrift.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "Timestamp"))
+ StackResourceDrift.add_member(:module_info, Shapes::ShapeRef.new(shape: ModuleInfo, location_name: "ModuleInfo"))
StackResourceDrift.struct_class = Types::StackResourceDrift
StackResourceDriftInformation.add_member(:stack_resource_drift_status, Shapes::ShapeRef.new(shape: StackResourceDriftStatus, required: true, location_name: "StackResourceDriftStatus"))
@@ -1207,6 +1532,7 @@ module Aws::CloudFormation
StackResourceSummary.add_member(:resource_status, Shapes::ShapeRef.new(shape: ResourceStatus, required: true, location_name: "ResourceStatus"))
StackResourceSummary.add_member(:resource_status_reason, Shapes::ShapeRef.new(shape: ResourceStatusReason, location_name: "ResourceStatusReason"))
StackResourceSummary.add_member(:drift_information, Shapes::ShapeRef.new(shape: StackResourceDriftInformationSummary, location_name: "DriftInformation"))
+ StackResourceSummary.add_member(:module_info, Shapes::ShapeRef.new(shape: ModuleInfo, location_name: "ModuleInfo"))
StackResourceSummary.struct_class = Types::StackResourceSummary
StackResources.member = Shapes::ShapeRef.new(shape: StackResource)
@@ -1226,6 +1552,8 @@ module Aws::CloudFormation
StackSet.add_member(:auto_deployment, Shapes::ShapeRef.new(shape: AutoDeployment, location_name: "AutoDeployment"))
StackSet.add_member(:permission_model, Shapes::ShapeRef.new(shape: PermissionModels, location_name: "PermissionModel"))
StackSet.add_member(:organizational_unit_ids, Shapes::ShapeRef.new(shape: OrganizationalUnitIdList, location_name: "OrganizationalUnitIds"))
+ StackSet.add_member(:managed_execution, Shapes::ShapeRef.new(shape: ManagedExecution, location_name: "ManagedExecution"))
+ StackSet.add_member(:regions, Shapes::ShapeRef.new(shape: RegionList, location_name: "Regions"))
StackSet.struct_class = Types::StackSet
StackSetDriftDetectionDetails.add_member(:drift_status, Shapes::ShapeRef.new(shape: StackSetDriftStatus, location_name: "DriftStatus"))
@@ -1254,8 +1582,11 @@ module Aws::CloudFormation
StackSetOperation.add_member(:end_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTimestamp"))
StackSetOperation.add_member(:deployment_targets, Shapes::ShapeRef.new(shape: DeploymentTargets, location_name: "DeploymentTargets"))
StackSetOperation.add_member(:stack_set_drift_detection_details, Shapes::ShapeRef.new(shape: StackSetDriftDetectionDetails, location_name: "StackSetDriftDetectionDetails"))
+ StackSetOperation.add_member(:status_reason, Shapes::ShapeRef.new(shape: StackSetOperationStatusReason, location_name: "StatusReason"))
+ StackSetOperation.add_member(:status_details, Shapes::ShapeRef.new(shape: StackSetOperationStatusDetails, location_name: "StatusDetails"))
StackSetOperation.struct_class = Types::StackSetOperation
+ StackSetOperationPreferences.add_member(:region_concurrency_type, Shapes::ShapeRef.new(shape: RegionConcurrencyType, location_name: "RegionConcurrencyType"))
StackSetOperationPreferences.add_member(:region_order, Shapes::ShapeRef.new(shape: RegionList, location_name: "RegionOrder"))
StackSetOperationPreferences.add_member(:failure_tolerance_count, Shapes::ShapeRef.new(shape: FailureToleranceCount, location_name: "FailureToleranceCount"))
StackSetOperationPreferences.add_member(:failure_tolerance_percentage, Shapes::ShapeRef.new(shape: FailureTolerancePercentage, location_name: "FailureTolerancePercentage"))
@@ -1273,6 +1604,9 @@ module Aws::CloudFormation
StackSetOperationResultSummary.add_member(:organizational_unit_id, Shapes::ShapeRef.new(shape: OrganizationalUnitId, location_name: "OrganizationalUnitId"))
StackSetOperationResultSummary.struct_class = Types::StackSetOperationResultSummary
+ StackSetOperationStatusDetails.add_member(:failed_stack_instances_count, Shapes::ShapeRef.new(shape: FailedStackInstancesCount, location_name: "FailedStackInstancesCount"))
+ StackSetOperationStatusDetails.struct_class = Types::StackSetOperationStatusDetails
+
StackSetOperationSummaries.member = Shapes::ShapeRef.new(shape: StackSetOperationSummary)
StackSetOperationSummary.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId"))
@@ -1280,6 +1614,9 @@ module Aws::CloudFormation
StackSetOperationSummary.add_member(:status, Shapes::ShapeRef.new(shape: StackSetOperationStatus, location_name: "Status"))
StackSetOperationSummary.add_member(:creation_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTimestamp"))
StackSetOperationSummary.add_member(:end_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTimestamp"))
+ StackSetOperationSummary.add_member(:status_reason, Shapes::ShapeRef.new(shape: StackSetOperationStatusReason, location_name: "StatusReason"))
+ StackSetOperationSummary.add_member(:status_details, Shapes::ShapeRef.new(shape: StackSetOperationStatusDetails, location_name: "StatusDetails"))
+ StackSetOperationSummary.add_member(:operation_preferences, Shapes::ShapeRef.new(shape: StackSetOperationPreferences, location_name: "OperationPreferences"))
StackSetOperationSummary.struct_class = Types::StackSetOperationSummary
StackSetSummaries.member = Shapes::ShapeRef.new(shape: StackSetSummary)
@@ -1292,6 +1629,7 @@ module Aws::CloudFormation
StackSetSummary.add_member(:permission_model, Shapes::ShapeRef.new(shape: PermissionModels, location_name: "PermissionModel"))
StackSetSummary.add_member(:drift_status, Shapes::ShapeRef.new(shape: StackDriftStatus, location_name: "DriftStatus"))
StackSetSummary.add_member(:last_drift_check_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastDriftCheckTimestamp"))
+ StackSetSummary.add_member(:managed_execution, Shapes::ShapeRef.new(shape: ManagedExecution, location_name: "ManagedExecution"))
StackSetSummary.struct_class = Types::StackSetSummary
StackStatusFilter.member = Shapes::ShapeRef.new(shape: StackStatus)
@@ -1319,10 +1657,13 @@ module Aws::CloudFormation
StopStackSetOperationInput.add_member(:stack_set_name, Shapes::ShapeRef.new(shape: StackSetName, required: true, location_name: "StackSetName"))
StopStackSetOperationInput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, required: true, location_name: "OperationId"))
+ StopStackSetOperationInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
StopStackSetOperationInput.struct_class = Types::StopStackSetOperationInput
StopStackSetOperationOutput.struct_class = Types::StopStackSetOperationOutput
+ SupportedMajorVersions.member = Shapes::ShapeRef.new(shape: SupportedMajorVersion)
+
Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "Key"))
Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValue, required: true, location_name: "Value"))
Tag.struct_class = Types::Tag
@@ -1337,10 +1678,47 @@ module Aws::CloudFormation
TemplateParameters.member = Shapes::ShapeRef.new(shape: TemplateParameter)
+ TestTypeInput.add_member(:arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "Arn"))
+ TestTypeInput.add_member(:type, Shapes::ShapeRef.new(shape: ThirdPartyType, location_name: "Type"))
+ TestTypeInput.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeName"))
+ TestTypeInput.add_member(:version_id, Shapes::ShapeRef.new(shape: TypeVersionId, location_name: "VersionId"))
+ TestTypeInput.add_member(:log_delivery_bucket, Shapes::ShapeRef.new(shape: S3Bucket, location_name: "LogDeliveryBucket"))
+ TestTypeInput.struct_class = Types::TestTypeInput
+
+ TestTypeOutput.add_member(:type_version_arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "TypeVersionArn"))
+ TestTypeOutput.struct_class = Types::TestTypeOutput
+
TokenAlreadyExistsException.struct_class = Types::TokenAlreadyExistsException
TransformsList.member = Shapes::ShapeRef.new(shape: TransformName)
+ TypeConfigurationDetails.add_member(:arn, Shapes::ShapeRef.new(shape: TypeConfigurationArn, location_name: "Arn"))
+ TypeConfigurationDetails.add_member(:alias, Shapes::ShapeRef.new(shape: TypeConfigurationAlias, location_name: "Alias"))
+ TypeConfigurationDetails.add_member(:configuration, Shapes::ShapeRef.new(shape: TypeConfiguration, location_name: "Configuration"))
+ TypeConfigurationDetails.add_member(:last_updated, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastUpdated"))
+ TypeConfigurationDetails.add_member(:type_arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "TypeArn"))
+ TypeConfigurationDetails.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeName"))
+ TypeConfigurationDetails.add_member(:is_default_configuration, Shapes::ShapeRef.new(shape: IsDefaultConfiguration, location_name: "IsDefaultConfiguration"))
+ TypeConfigurationDetails.struct_class = Types::TypeConfigurationDetails
+
+ TypeConfigurationDetailsList.member = Shapes::ShapeRef.new(shape: TypeConfigurationDetails)
+
+ TypeConfigurationIdentifier.add_member(:type_arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "TypeArn"))
+ TypeConfigurationIdentifier.add_member(:type_configuration_alias, Shapes::ShapeRef.new(shape: TypeConfigurationAlias, location_name: "TypeConfigurationAlias"))
+ TypeConfigurationIdentifier.add_member(:type_configuration_arn, Shapes::ShapeRef.new(shape: TypeConfigurationArn, location_name: "TypeConfigurationArn"))
+ TypeConfigurationIdentifier.add_member(:type, Shapes::ShapeRef.new(shape: ThirdPartyType, location_name: "Type"))
+ TypeConfigurationIdentifier.add_member(:type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "TypeName"))
+ TypeConfigurationIdentifier.struct_class = Types::TypeConfigurationIdentifier
+
+ TypeConfigurationIdentifiers.member = Shapes::ShapeRef.new(shape: TypeConfigurationIdentifier)
+
+ TypeConfigurationNotFoundException.struct_class = Types::TypeConfigurationNotFoundException
+
+ TypeFilters.add_member(:category, Shapes::ShapeRef.new(shape: Category, location_name: "Category"))
+ TypeFilters.add_member(:publisher_id, Shapes::ShapeRef.new(shape: PublisherId, location_name: "PublisherId"))
+ TypeFilters.add_member(:type_name_prefix, Shapes::ShapeRef.new(shape: TypeNamePrefix, location_name: "TypeNamePrefix"))
+ TypeFilters.struct_class = Types::TypeFilters
+
TypeNotFoundException.struct_class = Types::TypeNotFoundException
TypeSummaries.member = Shapes::ShapeRef.new(shape: TypeSummary)
@@ -1351,6 +1729,13 @@ module Aws::CloudFormation
TypeSummary.add_member(:type_arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "TypeArn"))
TypeSummary.add_member(:last_updated, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastUpdated"))
TypeSummary.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
+ TypeSummary.add_member(:publisher_id, Shapes::ShapeRef.new(shape: PublisherId, location_name: "PublisherId"))
+ TypeSummary.add_member(:original_type_name, Shapes::ShapeRef.new(shape: TypeName, location_name: "OriginalTypeName"))
+ TypeSummary.add_member(:public_version_number, Shapes::ShapeRef.new(shape: PublicVersionNumber, location_name: "PublicVersionNumber"))
+ TypeSummary.add_member(:latest_public_version, Shapes::ShapeRef.new(shape: PublicVersionNumber, location_name: "LatestPublicVersion"))
+ TypeSummary.add_member(:publisher_identity, Shapes::ShapeRef.new(shape: IdentityProvider, location_name: "PublisherIdentity"))
+ TypeSummary.add_member(:publisher_name, Shapes::ShapeRef.new(shape: PublisherName, location_name: "PublisherName"))
+ TypeSummary.add_member(:is_activated, Shapes::ShapeRef.new(shape: IsActivated, location_name: "IsActivated"))
TypeSummary.struct_class = Types::TypeSummary
TypeVersionSummaries.member = Shapes::ShapeRef.new(shape: TypeVersionSummary)
@@ -1362,8 +1747,11 @@ module Aws::CloudFormation
TypeVersionSummary.add_member(:arn, Shapes::ShapeRef.new(shape: TypeArn, location_name: "Arn"))
TypeVersionSummary.add_member(:time_created, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TimeCreated"))
TypeVersionSummary.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
+ TypeVersionSummary.add_member(:public_version_number, Shapes::ShapeRef.new(shape: PublicVersionNumber, location_name: "PublicVersionNumber"))
TypeVersionSummary.struct_class = Types::TypeVersionSummary
+ UnprocessedTypeConfigurations.member = Shapes::ShapeRef.new(shape: TypeConfigurationIdentifier)
+
UpdateStackInput.add_member(:stack_name, Shapes::ShapeRef.new(shape: StackName, required: true, location_name: "StackName"))
UpdateStackInput.add_member(:template_body, Shapes::ShapeRef.new(shape: TemplateBody, location_name: "TemplateBody"))
UpdateStackInput.add_member(:template_url, Shapes::ShapeRef.new(shape: TemplateURL, location_name: "TemplateURL"))
@@ -1379,6 +1767,7 @@ module Aws::CloudFormation
UpdateStackInput.add_member(:stack_policy_url, Shapes::ShapeRef.new(shape: StackPolicyURL, location_name: "StackPolicyURL"))
UpdateStackInput.add_member(:notification_arns, Shapes::ShapeRef.new(shape: NotificationARNs, location_name: "NotificationARNs"))
UpdateStackInput.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
+ UpdateStackInput.add_member(:disable_rollback, Shapes::ShapeRef.new(shape: DisableRollback, location_name: "DisableRollback"))
UpdateStackInput.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
UpdateStackInput.struct_class = Types::UpdateStackInput
@@ -1389,6 +1778,7 @@ module Aws::CloudFormation
UpdateStackInstancesInput.add_member(:parameter_overrides, Shapes::ShapeRef.new(shape: Parameters, location_name: "ParameterOverrides"))
UpdateStackInstancesInput.add_member(:operation_preferences, Shapes::ShapeRef.new(shape: StackSetOperationPreferences, location_name: "OperationPreferences"))
UpdateStackInstancesInput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId", metadata: {"idempotencyToken"=>true}))
+ UpdateStackInstancesInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
UpdateStackInstancesInput.struct_class = Types::UpdateStackInstancesInput
UpdateStackInstancesOutput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId"))
@@ -1414,6 +1804,8 @@ module Aws::CloudFormation
UpdateStackSetInput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId", metadata: {"idempotencyToken"=>true}))
UpdateStackSetInput.add_member(:accounts, Shapes::ShapeRef.new(shape: AccountList, location_name: "Accounts"))
UpdateStackSetInput.add_member(:regions, Shapes::ShapeRef.new(shape: RegionList, location_name: "Regions"))
+ UpdateStackSetInput.add_member(:call_as, Shapes::ShapeRef.new(shape: CallAs, location_name: "CallAs"))
+ UpdateStackSetInput.add_member(:managed_execution, Shapes::ShapeRef.new(shape: ManagedExecution, location_name: "ManagedExecution"))
UpdateStackSetInput.struct_class = Types::UpdateStackSetInput
UpdateStackSetOutput.add_member(:operation_id, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "OperationId"))
@@ -1454,6 +1846,36 @@ module Aws::CloudFormation
"xmlNamespace" => "http://cloudformation.amazonaws.com/doc/2010-05-15/",
}
+ api.add_operation(:activate_organizations_access, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "ActivateOrganizationsAccess"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: ActivateOrganizationsAccessInput)
+ o.output = Shapes::ShapeRef.new(shape: ActivateOrganizationsAccessOutput)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidOperationException)
+ o.errors << Shapes::ShapeRef.new(shape: OperationNotFoundException)
+ end)
+
+ api.add_operation(:activate_type, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "ActivateType"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: ActivateTypeInput)
+ o.output = Shapes::ShapeRef.new(shape: ActivateTypeOutput)
+ o.errors << Shapes::ShapeRef.new(shape: CFNRegistryException)
+ o.errors << Shapes::ShapeRef.new(shape: TypeNotFoundException)
+ end)
+
+ api.add_operation(:batch_describe_type_configurations, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "BatchDescribeTypeConfigurations"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: BatchDescribeTypeConfigurationsInput)
+ o.output = Shapes::ShapeRef.new(shape: BatchDescribeTypeConfigurationsOutput)
+ o.errors << Shapes::ShapeRef.new(shape: TypeConfigurationNotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: CFNRegistryException)
+ end)
+
api.add_operation(:cancel_update_stack, Seahorse::Model::Operation.new.tap do |o|
o.name = "CancelUpdateStack"
o.http_method = "POST"
@@ -1520,6 +1942,26 @@ module Aws::CloudFormation
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
end)
+ api.add_operation(:deactivate_organizations_access, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "DeactivateOrganizationsAccess"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: DeactivateOrganizationsAccessInput)
+ o.output = Shapes::ShapeRef.new(shape: DeactivateOrganizationsAccessOutput)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidOperationException)
+ o.errors << Shapes::ShapeRef.new(shape: OperationNotFoundException)
+ end)
+
+ api.add_operation(:deactivate_type, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "DeactivateType"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: DeactivateTypeInput)
+ o.output = Shapes::ShapeRef.new(shape: DeactivateTypeOutput)
+ o.errors << Shapes::ShapeRef.new(shape: CFNRegistryException)
+ o.errors << Shapes::ShapeRef.new(shape: TypeNotFoundException)
+ end)
+
api.add_operation(:delete_change_set, Seahorse::Model::Operation.new.tap do |o|
o.name = "DeleteChangeSet"
o.http_method = "POST"
@@ -1593,6 +2035,34 @@ module Aws::CloudFormation
o.errors << Shapes::ShapeRef.new(shape: ChangeSetNotFoundException)
end)
+ api.add_operation(:describe_change_set_hooks, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "DescribeChangeSetHooks"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: DescribeChangeSetHooksInput)
+ o.output = Shapes::ShapeRef.new(shape: DescribeChangeSetHooksOutput)
+ o.errors << Shapes::ShapeRef.new(shape: ChangeSetNotFoundException)
+ end)
+
+ api.add_operation(:describe_organizations_access, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "DescribeOrganizationsAccess"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: DescribeOrganizationsAccessInput)
+ o.output = Shapes::ShapeRef.new(shape: DescribeOrganizationsAccessOutput)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidOperationException)
+ o.errors << Shapes::ShapeRef.new(shape: OperationNotFoundException)
+ end)
+
+ api.add_operation(:describe_publisher, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "DescribePublisher"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: DescribePublisherInput)
+ o.output = Shapes::ShapeRef.new(shape: DescribePublisherOutput)
+ o.errors << Shapes::ShapeRef.new(shape: CFNRegistryException)
+ end)
+
api.add_operation(:describe_stack_drift_detection_status, Seahorse::Model::Operation.new.tap do |o|
o.name = "DescribeStackDriftDetectionStatus"
o.http_method = "POST"
@@ -1778,6 +2248,21 @@ module Aws::CloudFormation
o.errors << Shapes::ShapeRef.new(shape: StackSetNotFoundException)
end)
+ api.add_operation(:import_stacks_to_stack_set, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "ImportStacksToStackSet"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: ImportStacksToStackSetInput)
+ o.output = Shapes::ShapeRef.new(shape: ImportStacksToStackSetOutput)
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+ o.errors << Shapes::ShapeRef.new(shape: StackSetNotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: InvalidOperationException)
+ o.errors << Shapes::ShapeRef.new(shape: OperationInProgressException)
+ o.errors << Shapes::ShapeRef.new(shape: OperationIdAlreadyExistsException)
+ o.errors << Shapes::ShapeRef.new(shape: StackNotFoundException)
+ o.errors << Shapes::ShapeRef.new(shape: StaleRequestException)
+ end)
+
api.add_operation(:list_change_sets, Seahorse::Model::Operation.new.tap do |o|
o.name = "ListChangeSets"
o.http_method = "POST"
@@ -1948,6 +2433,16 @@ module Aws::CloudFormation
)
end)
+ api.add_operation(:publish_type, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "PublishType"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: PublishTypeInput)
+ o.output = Shapes::ShapeRef.new(shape: PublishTypeOutput)
+ o.errors << Shapes::ShapeRef.new(shape: CFNRegistryException)
+ o.errors << Shapes::ShapeRef.new(shape: TypeNotFoundException)
+ end)
+
api.add_operation(:record_handler_progress, Seahorse::Model::Operation.new.tap do |o|
o.name = "RecordHandlerProgress"
o.http_method = "POST"
@@ -1958,6 +2453,15 @@ module Aws::CloudFormation
o.errors << Shapes::ShapeRef.new(shape: OperationStatusCheckFailedException)
end)
+ api.add_operation(:register_publisher, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "RegisterPublisher"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: RegisterPublisherInput)
+ o.output = Shapes::ShapeRef.new(shape: RegisterPublisherOutput)
+ o.errors << Shapes::ShapeRef.new(shape: CFNRegistryException)
+ end)
+
api.add_operation(:register_type, Seahorse::Model::Operation.new.tap do |o|
o.name = "RegisterType"
o.http_method = "POST"
@@ -1967,6 +2471,15 @@ module Aws::CloudFormation
o.errors << Shapes::ShapeRef.new(shape: CFNRegistryException)
end)
+ api.add_operation(:rollback_stack, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "RollbackStack"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: RollbackStackInput)
+ o.output = Shapes::ShapeRef.new(shape: RollbackStackOutput)
+ o.errors << Shapes::ShapeRef.new(shape: TokenAlreadyExistsException)
+ end)
+
api.add_operation(:set_stack_policy, Seahorse::Model::Operation.new.tap do |o|
o.name = "SetStackPolicy"
o.http_method = "POST"
@@ -1975,6 +2488,16 @@ module Aws::CloudFormation
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
end)
+ api.add_operation(:set_type_configuration, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "SetTypeConfiguration"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: SetTypeConfigurationInput)
+ o.output = Shapes::ShapeRef.new(shape: SetTypeConfigurationOutput)
+ o.errors << Shapes::ShapeRef.new(shape: CFNRegistryException)
+ o.errors << Shapes::ShapeRef.new(shape: TypeNotFoundException)
+ end)
+
api.add_operation(:set_type_default_version, Seahorse::Model::Operation.new.tap do |o|
o.name = "SetTypeDefaultVersion"
o.http_method = "POST"
@@ -2004,6 +2527,16 @@ module Aws::CloudFormation
o.errors << Shapes::ShapeRef.new(shape: InvalidOperationException)
end)
+ api.add_operation(:test_type, Seahorse::Model::Operation.new.tap do |o|
+ o.name = "TestType"
+ o.http_method = "POST"
+ o.http_request_uri = "/"
+ o.input = Shapes::ShapeRef.new(shape: TestTypeInput)
+ o.output = Shapes::ShapeRef.new(shape: TestTypeOutput)
+ o.errors << Shapes::ShapeRef.new(shape: CFNRegistryException)
+ o.errors << Shapes::ShapeRef.new(shape: TypeNotFoundException)
+ end)
+
api.add_operation(:update_stack, Seahorse::Model::Operation.new.tap do |o|
o.name = "UpdateStack"
o.http_method = "POST"
diff --git a/lib/aws-sdk-cloudformation/customizations.rb b/lib/aws-sdk-cloudformation/customizations.rb
index 6128fe8..717e1f2 100644
--- a/lib/aws-sdk-cloudformation/customizations.rb
+++ b/lib/aws-sdk-cloudformation/customizations.rb
@@ -2,7 +2,7 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing for info on making contributions:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
diff --git a/lib/aws-sdk-cloudformation/endpoint_parameters.rb b/lib/aws-sdk-cloudformation/endpoint_parameters.rb
new file mode 100644
index 0000000..04e54e0
--- /dev/null
+++ b/lib/aws-sdk-cloudformation/endpoint_parameters.rb
@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::CloudFormation
+ # Endpoint parameters used to influence endpoints per request.
+ #
+ # @!attribute region
+ # The AWS region used to dispatch the request.
+ #
+ # @return [String]
+ #
+ # @!attribute use_dual_stack
+ # When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
+ #
+ # @return [Boolean]
+ #
+ # @!attribute use_fips
+ # When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
+ #
+ # @return [Boolean]
+ #
+ # @!attribute endpoint
+ # Override the endpoint used to send this request
+ #
+ # @return [String]
+ #
+ EndpointParameters = Struct.new(
+ :region,
+ :use_dual_stack,
+ :use_fips,
+ :endpoint,
+ ) do
+ include Aws::Structure
+
+ # @api private
+ class << self
+ PARAM_MAP = {
+ 'Region' => :region,
+ 'UseDualStack' => :use_dual_stack,
+ 'UseFIPS' => :use_fips,
+ 'Endpoint' => :endpoint,
+ }.freeze
+ end
+
+ def initialize(options = {})
+ self[:region] = options[:region]
+ self[:use_dual_stack] = options[:use_dual_stack]
+ self[:use_dual_stack] = false if self[:use_dual_stack].nil?
+ if self[:use_dual_stack].nil?
+ raise ArgumentError, "Missing required EndpointParameter: :use_dual_stack"
+ end
+ self[:use_fips] = options[:use_fips]
+ self[:use_fips] = false if self[:use_fips].nil?
+ if self[:use_fips].nil?
+ raise ArgumentError, "Missing required EndpointParameter: :use_fips"
+ end
+ self[:endpoint] = options[:endpoint]
+ end
+ end
+end
diff --git a/lib/aws-sdk-cloudformation/endpoint_provider.rb b/lib/aws-sdk-cloudformation/endpoint_provider.rb
new file mode 100644
index 0000000..3a47201
--- /dev/null
+++ b/lib/aws-sdk-cloudformation/endpoint_provider.rb
@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::CloudFormation
+ class EndpointProvider
+ def resolve_endpoint(parameters)
+ region = parameters.region
+ use_dual_stack = parameters.use_dual_stack
+ use_fips = parameters.use_fips
+ endpoint = parameters.endpoint
+ if Aws::Endpoints::Matchers.set?(endpoint)
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
+ raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
+ end
+ if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+ raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
+ end
+ return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
+ end
+ if Aws::Endpoints::Matchers.set?(region)
+ if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
+ return Aws::Endpoints::Endpoint.new(url: "https://cloudformation-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+ end
+ raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
+ end
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+ if Aws::Endpoints::Matchers.string_equals?("aws-us-gov", Aws::Endpoints::Matchers.attr(partition_result, "name"))
+ return Aws::Endpoints::Endpoint.new(url: "https://cloudformation.#{region}.amazonaws.com", headers: {}, properties: {})
+ end
+ return Aws::Endpoints::Endpoint.new(url: "https://cloudformation-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
+ end
+ raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
+ end
+ if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
+ return Aws::Endpoints::Endpoint.new(url: "https://cloudformation.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
+ end
+ raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
+ end
+ return Aws::Endpoints::Endpoint.new(url: "https://cloudformation.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
+ end
+ end
+ raise ArgumentError, "Invalid Configuration: Missing Region"
+ raise ArgumentError, 'No endpoint could be resolved'
+
+ end
+ end
+end
diff --git a/lib/aws-sdk-cloudformation/endpoints.rb b/lib/aws-sdk-cloudformation/endpoints.rb
new file mode 100644
index 0000000..984e34f
--- /dev/null
+++ b/lib/aws-sdk-cloudformation/endpoints.rb
@@ -0,0 +1,982 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+module Aws::CloudFormation
+ # @api private
+ module Endpoints
+
+ class ActivateOrganizationsAccess
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ActivateType
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class BatchDescribeTypeConfigurations
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class CancelUpdateStack
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ContinueUpdateRollback
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class CreateChangeSet
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class CreateStack
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class CreateStackInstances
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class CreateStackSet
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DeactivateOrganizationsAccess
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DeactivateType
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DeleteChangeSet
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DeleteStack
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DeleteStackInstances
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DeleteStackSet
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DeregisterType
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeAccountLimits
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeChangeSet
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeChangeSetHooks
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeOrganizationsAccess
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribePublisher
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeStackDriftDetectionStatus
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeStackEvents
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeStackInstance
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeStackResource
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeStackResourceDrifts
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeStackResources
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeStackSet
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeStackSetOperation
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeStacks
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeType
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DescribeTypeRegistration
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DetectStackDrift
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DetectStackResourceDrift
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class DetectStackSetDrift
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class EstimateTemplateCost
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ExecuteChangeSet
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GetStackPolicy
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GetTemplate
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class GetTemplateSummary
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ImportStacksToStackSet
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListChangeSets
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListExports
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListImports
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListStackInstances
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListStackResources
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListStackSetOperationResults
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListStackSetOperations
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListStackSets
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListStacks
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListTypeRegistrations
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListTypeVersions
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ListTypes
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class PublishType
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class RecordHandlerProgress
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class RegisterPublisher
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class RegisterType
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class RollbackStack
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class SetStackPolicy
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class SetTypeConfiguration
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class SetTypeDefaultVersion
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class SignalResource
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class StopStackSetOperation
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class TestType
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class UpdateStack
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class UpdateStackInstances
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class UpdateStackSet
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class UpdateTerminationProtection
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ class ValidateTemplate
+ def self.build(context)
+ unless context.config.regional_endpoint
+ endpoint = context.config.endpoint.to_s
+ end
+ Aws::CloudFormation::EndpointParameters.new(
+ region: context.config.region,
+ use_dual_stack: context.config.use_dualstack_endpoint,
+ use_fips: context.config.use_fips_endpoint,
+ endpoint: endpoint,
+ )
+ end
+ end
+
+ end
+end
diff --git a/lib/aws-sdk-cloudformation/errors.rb b/lib/aws-sdk-cloudformation/errors.rb
index c466286..ec1d79f 100644
--- a/lib/aws-sdk-cloudformation/errors.rb
+++ b/lib/aws-sdk-cloudformation/errors.rb
@@ -3,7 +3,7 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -42,10 +42,12 @@ module Aws::CloudFormation
# * {OperationNotFoundException}
# * {OperationStatusCheckFailedException}
# * {StackInstanceNotFoundException}
+ # * {StackNotFoundException}
# * {StackSetNotEmptyException}
# * {StackSetNotFoundException}
# * {StaleRequestException}
# * {TokenAlreadyExistsException}
+ # * {TypeConfigurationNotFoundException}
# * {TypeNotFoundException}
#
# Additionally, error classes are dynamically generated for service errors based on the error code
@@ -209,6 +211,16 @@ module Aws::CloudFormation
end
end
+ class StackNotFoundException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::CloudFormation::Types::StackNotFoundException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+ end
+
class StackSetNotEmptyException < ServiceError
# @param [Seahorse::Client::RequestContext] context
@@ -249,6 +261,16 @@ module Aws::CloudFormation
end
end
+ class TypeConfigurationNotFoundException < ServiceError
+
+ # @param [Seahorse::Client::RequestContext] context
+ # @param [String] message
+ # @param [Aws::CloudFormation::Types::TypeConfigurationNotFoundException] data
+ def initialize(context, message, data = Aws::EmptyStructure.new)
+ super(context, message, data)
+ end
+ end
+
class TypeNotFoundException < ServiceError
# @param [Seahorse::Client::RequestContext] context
diff --git a/lib/aws-sdk-cloudformation/event.rb b/lib/aws-sdk-cloudformation/event.rb
index 256a448..41dc923 100644
--- a/lib/aws-sdk-cloudformation/event.rb
+++ b/lib/aws-sdk-cloudformation/event.rb
@@ -3,7 +3,7 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -60,8 +60,8 @@ module Aws::CloudFormation
data[:physical_resource_id]
end
- # Type of resource. (For more information, go to [ AWS Resource Types
- # Reference][1] in the AWS CloudFormation User Guide.)
+ # Type of resource. (For more information, go to [Amazon Web Services
+ # Resource Types Reference][1] in the CloudFormation User Guide.)
#
#
#
@@ -115,6 +115,42 @@ module Aws::CloudFormation
data[:client_request_token]
end
+ # The name of the hook.
+ # @return [String]
+ def hook_type
+ data[:hook_type]
+ end
+
+ # Provides the status of the change set hook.
+ # @return [String]
+ def hook_status
+ data[:hook_status]
+ end
+
+ # Provides the reason for the hook status.
+ # @return [String]
+ def hook_status_reason
+ data[:hook_status_reason]
+ end
+
+ # Invocation points are points in provisioning logic where hooks are
+ # initiated.
+ # @return [String]
+ def hook_invocation_point
+ data[:hook_invocation_point]
+ end
+
+ # Specify the hook failure mode for non-compliant resources in the
+ # followings ways.
+ #
+ # * `FAIL` Stops provisioning resources.
+ #
+ # * `WARN` Allows provisioning to continue with a warning message.
+ # @return [String]
+ def hook_failure_mode
+ data[:hook_failure_mode]
+ end
+
# @!endgroup
# @return [Client]
@@ -239,7 +275,9 @@ module Aws::CloudFormation
:retry
end
end
- Aws::Waiters::Waiter.new(options).wait({})
+ Aws::Plugins::UserAgent.feature('resource') do
+ Aws::Waiters::Waiter.new(options).wait({})
+ end
end
# @deprecated
diff --git a/lib/aws-sdk-cloudformation/plugins/endpoints.rb b/lib/aws-sdk-cloudformation/plugins/endpoints.rb
new file mode 100644
index 0000000..ca3f767
--- /dev/null
+++ b/lib/aws-sdk-cloudformation/plugins/endpoints.rb
@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+module Aws::CloudFormation
+ module Plugins
+ class Endpoints < Seahorse::Client::Plugin
+ option(
+ :endpoint_provider,
+ doc_type: 'Aws::CloudFormation::EndpointProvider',
+ docstring: 'The endpoint provider used to resolve endpoints. Any '\
+ 'object that responds to `#resolve_endpoint(parameters)` '\
+ 'where `parameters` is a Struct similar to '\
+ '`Aws::CloudFormation::EndpointParameters`'
+ ) do |cfg|
+ Aws::CloudFormation::EndpointProvider.new
+ end
+
+ # @api private
+ class Handler < Seahorse::Client::Handler
+ def call(context)
+ # If endpoint was discovered, do not resolve or apply the endpoint.
+ unless context[:discovered_endpoint]
+ params = parameters_for_operation(context)
+ endpoint = context.config.endpoint_provider.resolve_endpoint(params)
+
+ context.http_request.endpoint = endpoint.url
+ apply_endpoint_headers(context, endpoint.headers)
+ end
+
+ context[:endpoint_params] = params
+ context[:auth_scheme] =
+ Aws::Endpoints.resolve_auth_scheme(context, endpoint)
+
+ @handler.call(context)
+ end
+
+ private
+
+ def apply_endpoint_headers(context, headers)
+ headers.each do |key, values|
+ value = values
+ .compact
+ .map { |s| Seahorse::Util.escape_header_list_string(s.to_s) }
+ .join(',')
+
+ context.http_request.headers[key] = value
+ end
+ end
+
+ def parameters_for_operation(context)
+ case context.operation_name
+ when :activate_organizations_access
+ Aws::CloudFormation::Endpoints::ActivateOrganizationsAccess.build(context)
+ when :activate_type
+ Aws::CloudFormation::Endpoints::ActivateType.build(context)
+ when :batch_describe_type_configurations
+ Aws::CloudFormation::Endpoints::BatchDescribeTypeConfigurations.build(context)
+ when :cancel_update_stack
+ Aws::CloudFormation::Endpoints::CancelUpdateStack.build(context)
+ when :continue_update_rollback
+ Aws::CloudFormation::Endpoints::ContinueUpdateRollback.build(context)
+ when :create_change_set
+ Aws::CloudFormation::Endpoints::CreateChangeSet.build(context)
+ when :create_stack
+ Aws::CloudFormation::Endpoints::CreateStack.build(context)
+ when :create_stack_instances
+ Aws::CloudFormation::Endpoints::CreateStackInstances.build(context)
+ when :create_stack_set
+ Aws::CloudFormation::Endpoints::CreateStackSet.build(context)
+ when :deactivate_organizations_access
+ Aws::CloudFormation::Endpoints::DeactivateOrganizationsAccess.build(context)
+ when :deactivate_type
+ Aws::CloudFormation::Endpoints::DeactivateType.build(context)
+ when :delete_change_set
+ Aws::CloudFormation::Endpoints::DeleteChangeSet.build(context)
+ when :delete_stack
+ Aws::CloudFormation::Endpoints::DeleteStack.build(context)
+ when :delete_stack_instances
+ Aws::CloudFormation::Endpoints::DeleteStackInstances.build(context)
+ when :delete_stack_set
+ Aws::CloudFormation::Endpoints::DeleteStackSet.build(context)
+ when :deregister_type
+ Aws::CloudFormation::Endpoints::DeregisterType.build(context)
+ when :describe_account_limits
+ Aws::CloudFormation::Endpoints::DescribeAccountLimits.build(context)
+ when :describe_change_set
+ Aws::CloudFormation::Endpoints::DescribeChangeSet.build(context)
+ when :describe_change_set_hooks
+ Aws::CloudFormation::Endpoints::DescribeChangeSetHooks.build(context)
+ when :describe_organizations_access
+ Aws::CloudFormation::Endpoints::DescribeOrganizationsAccess.build(context)
+ when :describe_publisher
+ Aws::CloudFormation::Endpoints::DescribePublisher.build(context)
+ when :describe_stack_drift_detection_status
+ Aws::CloudFormation::Endpoints::DescribeStackDriftDetectionStatus.build(context)
+ when :describe_stack_events
+ Aws::CloudFormation::Endpoints::DescribeStackEvents.build(context)
+ when :describe_stack_instance
+ Aws::CloudFormation::Endpoints::DescribeStackInstance.build(context)
+ when :describe_stack_resource
+ Aws::CloudFormation::Endpoints::DescribeStackResource.build(context)
+ when :describe_stack_resource_drifts
+ Aws::CloudFormation::Endpoints::DescribeStackResourceDrifts.build(context)
+ when :describe_stack_resources
+ Aws::CloudFormation::Endpoints::DescribeStackResources.build(context)
+ when :describe_stack_set
+ Aws::CloudFormation::Endpoints::DescribeStackSet.build(context)
+ when :describe_stack_set_operation
+ Aws::CloudFormation::Endpoints::DescribeStackSetOperation.build(context)
+ when :describe_stacks
+ Aws::CloudFormation::Endpoints::DescribeStacks.build(context)
+ when :describe_type
+ Aws::CloudFormation::Endpoints::DescribeType.build(context)
+ when :describe_type_registration
+ Aws::CloudFormation::Endpoints::DescribeTypeRegistration.build(context)
+ when :detect_stack_drift
+ Aws::CloudFormation::Endpoints::DetectStackDrift.build(context)
+ when :detect_stack_resource_drift
+ Aws::CloudFormation::Endpoints::DetectStackResourceDrift.build(context)
+ when :detect_stack_set_drift
+ Aws::CloudFormation::Endpoints::DetectStackSetDrift.build(context)
+ when :estimate_template_cost
+ Aws::CloudFormation::Endpoints::EstimateTemplateCost.build(context)
+ when :execute_change_set
+ Aws::CloudFormation::Endpoints::ExecuteChangeSet.build(context)
+ when :get_stack_policy
+ Aws::CloudFormation::Endpoints::GetStackPolicy.build(context)
+ when :get_template
+ Aws::CloudFormation::Endpoints::GetTemplate.build(context)
+ when :get_template_summary
+ Aws::CloudFormation::Endpoints::GetTemplateSummary.build(context)
+ when :import_stacks_to_stack_set
+ Aws::CloudFormation::Endpoints::ImportStacksToStackSet.build(context)
+ when :list_change_sets
+ Aws::CloudFormation::Endpoints::ListChangeSets.build(context)
+ when :list_exports
+ Aws::CloudFormation::Endpoints::ListExports.build(context)
+ when :list_imports
+ Aws::CloudFormation::Endpoints::ListImports.build(context)
+ when :list_stack_instances
+ Aws::CloudFormation::Endpoints::ListStackInstances.build(context)
+ when :list_stack_resources
+ Aws::CloudFormation::Endpoints::ListStackResources.build(context)
+ when :list_stack_set_operation_results
+ Aws::CloudFormation::Endpoints::ListStackSetOperationResults.build(context)
+ when :list_stack_set_operations
+ Aws::CloudFormation::Endpoints::ListStackSetOperations.build(context)
+ when :list_stack_sets
+ Aws::CloudFormation::Endpoints::ListStackSets.build(context)
+ when :list_stacks
+ Aws::CloudFormation::Endpoints::ListStacks.build(context)
+ when :list_type_registrations
+ Aws::CloudFormation::Endpoints::ListTypeRegistrations.build(context)
+ when :list_type_versions
+ Aws::CloudFormation::Endpoints::ListTypeVersions.build(context)
+ when :list_types
+ Aws::CloudFormation::Endpoints::ListTypes.build(context)
+ when :publish_type
+ Aws::CloudFormation::Endpoints::PublishType.build(context)
+ when :record_handler_progress
+ Aws::CloudFormation::Endpoints::RecordHandlerProgress.build(context)
+ when :register_publisher
+ Aws::CloudFormation::Endpoints::RegisterPublisher.build(context)
+ when :register_type
+ Aws::CloudFormation::Endpoints::RegisterType.build(context)
+ when :rollback_stack
+ Aws::CloudFormation::Endpoints::RollbackStack.build(context)
+ when :set_stack_policy
+ Aws::CloudFormation::Endpoints::SetStackPolicy.build(context)
+ when :set_type_configuration
+ Aws::CloudFormation::Endpoints::SetTypeConfiguration.build(context)
+ when :set_type_default_version
+ Aws::CloudFormation::Endpoints::SetTypeDefaultVersion.build(context)
+ when :signal_resource
+ Aws::CloudFormation::Endpoints::SignalResource.build(context)
+ when :stop_stack_set_operation
+ Aws::CloudFormation::Endpoints::StopStackSetOperation.build(context)
+ when :test_type
+ Aws::CloudFormation::Endpoints::TestType.build(context)
+ when :update_stack
+ Aws::CloudFormation::Endpoints::UpdateStack.build(context)
+ when :update_stack_instances
+ Aws::CloudFormation::Endpoints::UpdateStackInstances.build(context)
+ when :update_stack_set
+ Aws::CloudFormation::Endpoints::UpdateStackSet.build(context)
+ when :update_termination_protection
+ Aws::CloudFormation::Endpoints::UpdateTerminationProtection.build(context)
+ when :validate_template
+ Aws::CloudFormation::Endpoints::ValidateTemplate.build(context)
+ end
+ end
+ end
+
+ def add_handlers(handlers, _config)
+ handlers.add(Handler, step: :build, priority: 75)
+ end
+ end
+ end
+end
diff --git a/lib/aws-sdk-cloudformation/resource.rb b/lib/aws-sdk-cloudformation/resource.rb
index 089b3f7..c99101f 100644
--- a/lib/aws-sdk-cloudformation/resource.rb
+++ b/lib/aws-sdk-cloudformation/resource.rb
@@ -3,7 +3,7 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -78,18 +78,18 @@ module Aws::CloudFormation
# })
# @param [Hash] options ({})
# @option options [required, String] :stack_name
- # The name that is associated with the stack. The name must be unique in
+ # The name that's associated with the stack. The name must be unique in
# the Region in which you are creating the stack.
#
# <note markdown="1"> A stack name can contain only alphanumeric characters (case sensitive)
- # and hyphens. It must start with an alphabetic character and cannot be
- # longer than 128 characters.
+ # and hyphens. It must start with an alphabetical character and can't
+ # be longer than 128 characters.
#
# </note>
# @option options [String] :template_body
# Structure containing the template body with a minimum length of 1 byte
# and a maximum length of 51,200 bytes. For more information, go to
- # [Template Anatomy][1] in the AWS CloudFormation User Guide.
+ # [Template anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify either the `TemplateBody` or the
# `TemplateURL` parameter, but not both.
@@ -99,9 +99,9 @@ module Aws::CloudFormation
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
# @option options [String] :template_url
# Location of file containing the template body. The URL must point to a
- # template (max size: 460,800 bytes) that is located in an Amazon S3
- # bucket. For more information, go to the [Template Anatomy][1] in the
- # AWS CloudFormation User Guide.
+ # template (max size: 460,800 bytes) that's located in an Amazon S3
+ # bucket or a Systems Manager document. For more information, go to the
+ # [Template anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify either the `TemplateBody` or the
# `TemplateURL` parameter, but not both.
@@ -123,7 +123,7 @@ module Aws::CloudFormation
#
# Default: `false`
# @option options [Types::RollbackConfiguration] :rollback_configuration
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
# @option options [Integer] :timeout_in_minutes
@@ -131,21 +131,21 @@ module Aws::CloudFormation
# CREATE\_FAILED; if `DisableRollback` is not set or is set to `false`,
# the stack will be rolled back.
# @option options [Array<String>] :notification_arns
- # The Simple Notification Service (SNS) topic ARNs to publish stack
- # related events. You can find your SNS topic ARNs using the SNS console
- # or your Command Line Interface (CLI).
+ # The Amazon Simple Notification Service (Amazon SNS) topic ARNs to
+ # publish stack related events. You can find your Amazon SNS topic ARNs
+ # using the Amazon SNS console or your Command Line Interface (CLI).
# @option options [Array<String>] :capabilities
# In some cases, you must explicitly acknowledge that your stack
- # template contains certain capabilities in order for AWS CloudFormation
- # to create the stack.
+ # template contains certain capabilities in order for CloudFormation to
+ # create the stack.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stacks, you
- # must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stacks, you must explicitly acknowledge this by specifying one of
+ # these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -155,8 +155,8 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
- # CloudFormation returns an `InsufficientCapabilities` error.
+ # * If you don't specify either of these capabilities, CloudFormation
+ # returns an `InsufficientCapabilities` error.
#
# If your stack template contains these resources, we recommend that
# you review all permissions associated with them and edit their
@@ -166,7 +166,7 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::Group][2]
#
- # * [ AWS::IAM::InstanceProfile][3]
+ # * [AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
@@ -174,9 +174,9 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::User][6]
#
- # * [ AWS::IAM::UserToGroupAddition][7]
+ # * [AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
@@ -191,24 +191,23 @@ module Aws::CloudFormation
# create a stack directly from the processed template, without first
# reviewing the resulting changes in a change set, you must
# acknowledge this capability. This includes the [AWS::Include][9] and
- # [AWS::Serverless][10] transforms, which are macros hosted by AWS
+ # [AWS::Serverless][10] transforms, which are macros hosted by
# CloudFormation.
#
- # Change sets do not currently support nested stacks. If you want to
- # create a stack from a stack template that contains macros *and*
- # nested stacks, you must create the stack directly from the template
- # using this capability.
+ # If you want to create a stack from a stack template that contains
+ # macros *and* nested stacks, you must create the stack directly from
+ # the template using this capability.
#
# You should only create stacks directly from a stack template that
# contains macros if you know what processing the macro performs.
#
# Each macro relies on an underlying Lambda service function for
# processing stack templates. Be aware that the Lambda function owner
- # can update the function operation without AWS CloudFormation being
+ # can update the function operation without CloudFormation being
# notified.
#
- # For more information, see [Using AWS CloudFormation Macros to
- # Perform Custom Processing on Templates][11].
+ # For more information, see [Using CloudFormation macros to perform
+ # custom processing on templates][11].
#
#
#
@@ -227,45 +226,45 @@ module Aws::CloudFormation
# The template resource types that you have permissions to work with for
# this create stack action, such as `AWS::EC2::Instance`, `AWS::EC2::*`,
# or `Custom::MyCustomInstance`. Use the following syntax to describe
- # template resource types: `AWS::*` (for all AWS resource), `Custom::*`
- # (for all custom resources), `Custom::logical_ID ` (for a specific
- # custom resource), `AWS::service_name::*` (for all resources of a
- # particular AWS service), and `AWS::service_name::resource_logical_ID `
- # (for a specific AWS resource).
+ # template resource types: `AWS::*` (for all Amazon Web Services
+ # resources), `Custom::*` (for all custom resources),
+ # `Custom::logical_ID ` (for a specific custom resource),
+ # `AWS::service_name::*` (for all resources of a particular Amazon Web
+ # Services service), and `AWS::service_name::resource_logical_ID ` (for
+ # a specific Amazon Web Services resource).
#
# If the list of resource types doesn't include a resource that you're
- # creating, the stack creation fails. By default, AWS CloudFormation
- # grants permissions to all resource types. AWS Identity and Access
- # Management (IAM) uses this parameter for AWS CloudFormation-specific
- # condition keys in IAM policies. For more information, see [Controlling
- # Access with AWS Identity and Access Management][1].
+ # creating, the stack creation fails. By default, CloudFormation grants
+ # permissions to all resource types. Identity and Access Management
+ # (IAM) uses this parameter for CloudFormation-specific condition keys
+ # in IAM policies. For more information, see [Controlling Access with
+ # Identity and Access Management][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
# @option options [String] :role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to create the
- # stack. AWS CloudFormation uses the role's credentials to make calls
- # on your behalf. AWS CloudFormation always uses this role for all
- # future operations on the stack. As long as users have permission to
- # operate on the stack, AWS CloudFormation uses this role even if the
- # users don't have permission to pass it. Ensure that the role grants
- # least privilege.
- #
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available, AWS
- # CloudFormation uses a temporary session that is generated from your
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to create the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf. CloudFormation always uses this role for all future operations
+ # on the stack. Provided that users have permission to operate on the
+ # stack, CloudFormation uses this role even if the users don't have
+ # permission to pass it. Ensure that the role grants least privilege.
+ #
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
+ # CloudFormation uses a temporary session that's generated from your
# user credentials.
# @option options [String] :on_failure
# Determines what action will be taken if stack creation fails. This
- # must be one of: DO\_NOTHING, ROLLBACK, or DELETE. You can specify
+ # must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify
# either `OnFailure` or `DisableRollback`, but not both.
#
# Default: `ROLLBACK`
# @option options [String] :stack_policy_body
# Structure containing the stack policy body. For more information, go
- # to [ Prevent Updates to Stack Resources][1] in the *AWS CloudFormation
+ # to [ Prevent Updates to Stack Resources][1] in the *CloudFormation
# User Guide*. You can specify either the `StackPolicyBody` or the
# `StackPolicyURL` parameter, but not both.
#
@@ -278,17 +277,17 @@ module Aws::CloudFormation
# Region as the stack. You can specify either the `StackPolicyBody` or
# the `StackPolicyURL` parameter, but not both.
# @option options [Array<Types::Tag>] :tags
- # Key-value pairs to associate with this stack. AWS CloudFormation also
+ # Key-value pairs to associate with this stack. CloudFormation also
# propagates these tags to the resources created in the stack. A maximum
# number of 50 tags can be specified.
# @option options [String] :client_request_token
# A unique identifier for this `CreateStack` request. Specify this token
- # if you plan to retry requests so that AWS CloudFormation knows that
+ # if you plan to retry requests so that CloudFormation knows that
# you're not attempting to create a stack with the same name. You might
- # retry `CreateStack` requests to ensure that AWS CloudFormation
+ # retry `CreateStack` requests to ensure that CloudFormation
# successfully received them.
#
- # All events triggered by a given stack operation are assigned the same
+ # All events initiated by a given stack operation are assigned the same
# client request token, which you can use to track operations. For
# example, if you execute a `CreateStack` operation with the token
# `token1`, then all the `StackEvents` generated by that operation will
@@ -306,11 +305,11 @@ module Aws::CloudFormation
# user attempts to delete a stack with termination protection enabled,
# the operation fails and the stack remains unchanged. For more
# information, see [Protecting a Stack From Being Deleted][1] in the
- # *AWS CloudFormation User Guide*. Termination protection is disabled on
+ # *CloudFormation User Guide*. Termination protection is deactivated on
# stacks by default.
#
# For [nested stacks][2], termination protection is set on the root
- # stack and cannot be changed directly on the nested stack.
+ # stack and can't be changed directly on the nested stack.
#
#
#
@@ -318,7 +317,9 @@ module Aws::CloudFormation
# [2]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
# @return [Stack]
def create_stack(options = {})
- @client.create_stack(options)
+ Aws::Plugins::UserAgent.feature('resource') do
+ @client.create_stack(options)
+ end
Stack.new(
name: options[:stack_name],
client: @client
@@ -352,8 +353,23 @@ module Aws::CloudFormation
# })
# @param [Hash] options ({})
# @option options [String] :stack_name
- # The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
+ # response that describes all resources in the account. This requires
+ # `ListStacks` and `DescribeStacks` permissions.
+ #
+ # The IAM policy below can be added to IAM policies when you want to
+ # limit resource-level permissions and avoid returning a response when
+ # no parameter is sent in the request:
+ #
+ # \\\{ "Version": "2012-10-17", "Statement": \[\\\{ "Effect":
+ # "Deny", "Action": "cloudformation:DescribeStacks",
+ # "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" \\}\]
+ # \\}
+ #
+ # </note>
+ #
+ # The name or the unique stack ID that's associated with the stack,
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -364,7 +380,9 @@ module Aws::CloudFormation
# @return [Stack::Collection]
def stacks(options = {})
batches = Enumerator.new do |y|
- resp = @client.describe_stacks(options)
+ resp = Aws::Plugins::UserAgent.feature('resource') do
+ @client.describe_stacks(options)
+ end
resp.each_page do |page|
batch = []
page.data.stacks.each do |s|
diff --git a/lib/aws-sdk-cloudformation/stack.rb b/lib/aws-sdk-cloudformation/stack.rb
index 9c219b6..3e1ded7 100644
--- a/lib/aws-sdk-cloudformation/stack.rb
+++ b/lib/aws-sdk-cloudformation/stack.rb
@@ -3,7 +3,7 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -78,7 +78,7 @@ module Aws::CloudFormation
data[:last_updated_time]
end
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
# @return [Types::RollbackConfiguration]
@@ -100,15 +100,16 @@ module Aws::CloudFormation
# Boolean to enable or disable rollback on stack creation failures:
#
- # * `true`\: disable rollback
+ # * `true`: disable rollback.
#
- # * `false`\: enable rollback
+ # * `false`: enable rollback.
# @return [Boolean]
def disable_rollback
data[:disable_rollback]
end
- # SNS topic ARNs to which stack related events are published.
+ # Amazon SNS topic Amazon Resource Names (ARNs) to which stack related
+ # events are published.
# @return [Array<String>]
def notification_arns
data[:notification_arns]
@@ -132,10 +133,10 @@ module Aws::CloudFormation
data[:outputs]
end
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that is associated with the stack. During a
- # stack operation, AWS CloudFormation uses this role's credentials to
- # make calls on your behalf.
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that's associated with the stack. During a stack
+ # operation, CloudFormation uses this role's credentials to make calls
+ # on your behalf.
# @return [String]
def role_arn
data[:role_arn]
@@ -150,9 +151,9 @@ module Aws::CloudFormation
# Whether termination protection is enabled for the stack.
#
# For [nested stacks][1], termination protection is set on the root
- # stack and cannot be changed directly on the nested stack. For more
+ # stack and can't be changed directly on the nested stack. For more
# information, see [Protecting a Stack From Being Deleted][2] in the
- # *AWS CloudFormation User Guide*.
+ # *CloudFormation User Guide*.
#
#
#
@@ -167,8 +168,8 @@ module Aws::CloudFormation
# stack ID of the direct parent of this stack. For the first level of
# nested stacks, the root stack is also the parent stack.
#
- # For more information, see [Working with Nested Stacks][1] in the *AWS
- # CloudFormation User Guide*.
+ # For more information, see [Working with Nested Stacks][1] in the
+ # *CloudFormation User Guide*.
#
#
#
@@ -182,8 +183,8 @@ module Aws::CloudFormation
# stack ID of the top-level stack to which the nested stack ultimately
# belongs.
#
- # For more information, see [Working with Nested Stacks][1] in the *AWS
- # CloudFormation User Guide*.
+ # For more information, see [Working with Nested Stacks][1] in the
+ # *CloudFormation User Guide*.
#
#
#
@@ -193,10 +194,10 @@ module Aws::CloudFormation
data[:root_id]
end
- # Information on whether a stack's actual configuration differs, or has
- # *drifted*, from it's expected configuration, as defined in the stack
- # template and any values specified as template parameters. For more
- # information, see [Detecting Unregulated Configuration Changes to
+ # Information about whether a stack's actual configuration differs, or
+ # has *drifted*, from its expected configuration, as defined in the
+ # stack template and any values specified as template parameters. For
+ # more information, see [Detecting Unregulated Configuration Changes to
# Stacks and Resources][1].
#
#
@@ -221,7 +222,9 @@ module Aws::CloudFormation
#
# @return [self]
def load
- resp = @client.describe_stacks(stack_name: @name)
+ resp = Aws::Plugins::UserAgent.feature('resource') do
+ @client.describe_stacks(stack_name: @name)
+ end
@data = resp.stacks[0]
self
end
@@ -266,7 +269,9 @@ module Aws::CloudFormation
options, params = separate_params_and_options(options)
waiter = Waiters::StackExists.new(options)
yield_waiter_and_warn(waiter, &block) if block_given?
- waiter.wait(params.merge(stack_name: @name))
+ Aws::Plugins::UserAgent.feature('resource') do
+ waiter.wait(params.merge(stack_name: @name))
+ end
Stack.new({
name: @name,
client: @client
@@ -367,7 +372,9 @@ module Aws::CloudFormation
:retry
end
end
- Aws::Waiters::Waiter.new(options).wait({})
+ Aws::Plugins::UserAgent.feature('resource') do
+ Aws::Waiters::Waiter.new(options).wait({})
+ end
end
# @!group Actions
@@ -380,14 +387,16 @@ module Aws::CloudFormation
# @param [Hash] options ({})
# @option options [String] :client_request_token
# A unique identifier for this `CancelUpdateStack` request. Specify this
- # token if you plan to retry requests so that AWS CloudFormation knows
- # that you're not attempting to cancel an update on a stack with the
- # same name. You might retry `CancelUpdateStack` requests to ensure that
- # AWS CloudFormation successfully received them.
+ # token if you plan to retry requests so that CloudFormation knows that
+ # you're not attempting to cancel an update on a stack with the same
+ # name. You might retry `CancelUpdateStack` requests to ensure that
+ # CloudFormation successfully received them.
# @return [EmptyStructure]
def cancel_update(options = {})
options = options.merge(stack_name: @name)
- resp = @client.cancel_update_stack(options)
+ resp = Aws::Plugins::UserAgent.feature('resource') do
+ @client.cancel_update_stack(options)
+ end
resp.data
end
@@ -435,7 +444,7 @@ module Aws::CloudFormation
# @option options [String] :template_body
# Structure containing the template body with a minimum length of 1 byte
# and a maximum length of 51,200 bytes. For more information, go to
- # [Template Anatomy][1] in the AWS CloudFormation User Guide.
+ # [Template anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify either the `TemplateBody` or the
# `TemplateURL` parameter, but not both.
@@ -445,9 +454,9 @@ module Aws::CloudFormation
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
# @option options [String] :template_url
# Location of file containing the template body. The URL must point to a
- # template (max size: 460,800 bytes) that is located in an Amazon S3
- # bucket. For more information, go to the [Template Anatomy][1] in the
- # AWS CloudFormation User Guide.
+ # template (max size: 460,800 bytes) that's located in an Amazon S3
+ # bucket or a Systems Manager document. For more information, go to the
+ # [Template anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify either the `TemplateBody` or the
# `TemplateURL` parameter, but not both.
@@ -469,7 +478,7 @@ module Aws::CloudFormation
#
# Default: `false`
# @option options [Types::RollbackConfiguration] :rollback_configuration
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
# @option options [Integer] :timeout_in_minutes
@@ -477,21 +486,21 @@ module Aws::CloudFormation
# CREATE\_FAILED; if `DisableRollback` is not set or is set to `false`,
# the stack will be rolled back.
# @option options [Array<String>] :notification_arns
- # The Simple Notification Service (SNS) topic ARNs to publish stack
- # related events. You can find your SNS topic ARNs using the SNS console
- # or your Command Line Interface (CLI).
+ # The Amazon Simple Notification Service (Amazon SNS) topic ARNs to
+ # publish stack related events. You can find your Amazon SNS topic ARNs
+ # using the Amazon SNS console or your Command Line Interface (CLI).
# @option options [Array<String>] :capabilities
# In some cases, you must explicitly acknowledge that your stack
- # template contains certain capabilities in order for AWS CloudFormation
- # to create the stack.
+ # template contains certain capabilities in order for CloudFormation to
+ # create the stack.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stacks, you
- # must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stacks, you must explicitly acknowledge this by specifying one of
+ # these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -501,8 +510,8 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
- # CloudFormation returns an `InsufficientCapabilities` error.
+ # * If you don't specify either of these capabilities, CloudFormation
+ # returns an `InsufficientCapabilities` error.
#
# If your stack template contains these resources, we recommend that
# you review all permissions associated with them and edit their
@@ -512,7 +521,7 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::Group][2]
#
- # * [ AWS::IAM::InstanceProfile][3]
+ # * [AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
@@ -520,9 +529,9 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::User][6]
#
- # * [ AWS::IAM::UserToGroupAddition][7]
+ # * [AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
@@ -537,24 +546,23 @@ module Aws::CloudFormation
# create a stack directly from the processed template, without first
# reviewing the resulting changes in a change set, you must
# acknowledge this capability. This includes the [AWS::Include][9] and
- # [AWS::Serverless][10] transforms, which are macros hosted by AWS
+ # [AWS::Serverless][10] transforms, which are macros hosted by
# CloudFormation.
#
- # Change sets do not currently support nested stacks. If you want to
- # create a stack from a stack template that contains macros *and*
- # nested stacks, you must create the stack directly from the template
- # using this capability.
+ # If you want to create a stack from a stack template that contains
+ # macros *and* nested stacks, you must create the stack directly from
+ # the template using this capability.
#
# You should only create stacks directly from a stack template that
# contains macros if you know what processing the macro performs.
#
# Each macro relies on an underlying Lambda service function for
# processing stack templates. Be aware that the Lambda function owner
- # can update the function operation without AWS CloudFormation being
+ # can update the function operation without CloudFormation being
# notified.
#
- # For more information, see [Using AWS CloudFormation Macros to
- # Perform Custom Processing on Templates][11].
+ # For more information, see [Using CloudFormation macros to perform
+ # custom processing on templates][11].
#
#
#
@@ -573,45 +581,45 @@ module Aws::CloudFormation
# The template resource types that you have permissions to work with for
# this create stack action, such as `AWS::EC2::Instance`, `AWS::EC2::*`,
# or `Custom::MyCustomInstance`. Use the following syntax to describe
- # template resource types: `AWS::*` (for all AWS resource), `Custom::*`
- # (for all custom resources), `Custom::logical_ID ` (for a specific
- # custom resource), `AWS::service_name::*` (for all resources of a
- # particular AWS service), and `AWS::service_name::resource_logical_ID `
- # (for a specific AWS resource).
+ # template resource types: `AWS::*` (for all Amazon Web Services
+ # resources), `Custom::*` (for all custom resources),
+ # `Custom::logical_ID ` (for a specific custom resource),
+ # `AWS::service_name::*` (for all resources of a particular Amazon Web
+ # Services service), and `AWS::service_name::resource_logical_ID ` (for
+ # a specific Amazon Web Services resource).
#
# If the list of resource types doesn't include a resource that you're
- # creating, the stack creation fails. By default, AWS CloudFormation
- # grants permissions to all resource types. AWS Identity and Access
- # Management (IAM) uses this parameter for AWS CloudFormation-specific
- # condition keys in IAM policies. For more information, see [Controlling
- # Access with AWS Identity and Access Management][1].
+ # creating, the stack creation fails. By default, CloudFormation grants
+ # permissions to all resource types. Identity and Access Management
+ # (IAM) uses this parameter for CloudFormation-specific condition keys
+ # in IAM policies. For more information, see [Controlling Access with
+ # Identity and Access Management][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
# @option options [String] :role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to create the
- # stack. AWS CloudFormation uses the role's credentials to make calls
- # on your behalf. AWS CloudFormation always uses this role for all
- # future operations on the stack. As long as users have permission to
- # operate on the stack, AWS CloudFormation uses this role even if the
- # users don't have permission to pass it. Ensure that the role grants
- # least privilege.
- #
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available, AWS
- # CloudFormation uses a temporary session that is generated from your
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to create the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf. CloudFormation always uses this role for all future operations
+ # on the stack. Provided that users have permission to operate on the
+ # stack, CloudFormation uses this role even if the users don't have
+ # permission to pass it. Ensure that the role grants least privilege.
+ #
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
+ # CloudFormation uses a temporary session that's generated from your
# user credentials.
# @option options [String] :on_failure
# Determines what action will be taken if stack creation fails. This
- # must be one of: DO\_NOTHING, ROLLBACK, or DELETE. You can specify
+ # must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify
# either `OnFailure` or `DisableRollback`, but not both.
#
# Default: `ROLLBACK`
# @option options [String] :stack_policy_body
# Structure containing the stack policy body. For more information, go
- # to [ Prevent Updates to Stack Resources][1] in the *AWS CloudFormation
+ # to [ Prevent Updates to Stack Resources][1] in the *CloudFormation
# User Guide*. You can specify either the `StackPolicyBody` or the
# `StackPolicyURL` parameter, but not both.
#
@@ -624,17 +632,17 @@ module Aws::CloudFormation
# Region as the stack. You can specify either the `StackPolicyBody` or
# the `StackPolicyURL` parameter, but not both.
# @option options [Array<Types::Tag>] :tags
- # Key-value pairs to associate with this stack. AWS CloudFormation also
+ # Key-value pairs to associate with this stack. CloudFormation also
# propagates these tags to the resources created in the stack. A maximum
# number of 50 tags can be specified.
# @option options [String] :client_request_token
# A unique identifier for this `CreateStack` request. Specify this token
- # if you plan to retry requests so that AWS CloudFormation knows that
+ # if you plan to retry requests so that CloudFormation knows that
# you're not attempting to create a stack with the same name. You might
- # retry `CreateStack` requests to ensure that AWS CloudFormation
+ # retry `CreateStack` requests to ensure that CloudFormation
# successfully received them.
#
- # All events triggered by a given stack operation are assigned the same
+ # All events initiated by a given stack operation are assigned the same
# client request token, which you can use to track operations. For
# example, if you execute a `CreateStack` operation with the token
# `token1`, then all the `StackEvents` generated by that operation will
@@ -652,11 +660,11 @@ module Aws::CloudFormation
# user attempts to delete a stack with termination protection enabled,
# the operation fails and the stack remains unchanged. For more
# information, see [Protecting a Stack From Being Deleted][1] in the
- # *AWS CloudFormation User Guide*. Termination protection is disabled on
+ # *CloudFormation User Guide*. Termination protection is deactivated on
# stacks by default.
#
# For [nested stacks][2], termination protection is set on the root
- # stack and cannot be changed directly on the nested stack.
+ # stack and can't be changed directly on the nested stack.
#
#
#
@@ -665,7 +673,9 @@ module Aws::CloudFormation
# @return [Types::CreateStackOutput]
def create(options = {})
options = options.merge(stack_name: @name)
- resp = @client.create_stack(options)
+ resp = Aws::Plugins::UserAgent.feature('resource') do
+ @client.create_stack(options)
+ end
resp.data
end
@@ -680,29 +690,29 @@ module Aws::CloudFormation
# @option options [Array<String>] :retain_resources
# For stacks in the `DELETE_FAILED` state, a list of resource logical
# IDs that are associated with the resources you want to retain. During
- # deletion, AWS CloudFormation deletes the stack but does not delete the
+ # deletion, CloudFormation deletes the stack but doesn't delete the
# retained resources.
#
- # Retaining resources is useful when you cannot delete a resource, such
+ # Retaining resources is useful when you can't delete a resource, such
# as a non-empty S3 bucket, but you want to delete the stack.
# @option options [String] :role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to delete the
- # stack. AWS CloudFormation uses the role's credentials to make calls
- # on your behalf.
- #
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available, AWS
- # CloudFormation uses a temporary session that is generated from your
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to delete the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf.
+ #
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
+ # CloudFormation uses a temporary session that's generated from your
# user credentials.
# @option options [String] :client_request_token
# A unique identifier for this `DeleteStack` request. Specify this token
- # if you plan to retry requests so that AWS CloudFormation knows that
+ # if you plan to retry requests so that CloudFormation knows that
# you're not attempting to delete a stack with the same name. You might
- # retry `DeleteStack` requests to ensure that AWS CloudFormation
+ # retry `DeleteStack` requests to ensure that CloudFormation
# successfully received them.
#
- # All events triggered by a given stack operation are assigned the same
+ # All events initiated by a given stack operation are assigned the same
# client request token, which you can use to track operations. For
# example, if you execute a `CreateStack` operation with the token
# `token1`, then all the `StackEvents` generated by that operation will
@@ -718,7 +728,9 @@ module Aws::CloudFormation
# @return [EmptyStructure]
def delete(options = {})
options = options.merge(stack_name: @name)
- resp = @client.delete_stack(options)
+ resp = Aws::Plugins::UserAgent.feature('resource') do
+ @client.delete_stack(options)
+ end
resp.data
end
@@ -759,13 +771,14 @@ module Aws::CloudFormation
# value: "TagValue", # required
# },
# ],
+ # disable_rollback: false,
# client_request_token: "ClientRequestToken",
# })
# @param [Hash] options ({})
# @option options [String] :template_body
# Structure containing the template body with a minimum length of 1 byte
# and a maximum length of 51,200 bytes. (For more information, go to
- # [Template Anatomy][1] in the AWS CloudFormation User Guide.)
+ # [Template Anatomy][1] in the CloudFormation User Guide.)
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
@@ -776,8 +789,9 @@ module Aws::CloudFormation
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
# @option options [String] :template_url
# Location of file containing the template body. The URL must point to a
- # template that is located in an Amazon S3 bucket. For more information,
- # go to [Template Anatomy][1] in the AWS CloudFormation User Guide.
+ # template that's located in an Amazon S3 bucket or a Systems Manager
+ # document. For more information, go to [Template Anatomy][1] in the
+ # CloudFormation User Guide.
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
@@ -799,7 +813,7 @@ module Aws::CloudFormation
# `StackPolicyDuringUpdateURL` parameter, but not both.
#
# If you want to update protected resources, specify a temporary
- # overriding stack policy during this update. If you do not specify a
+ # overriding stack policy during this update. If you don't specify a
# stack policy, the current policy that is associated with the stack
# will be used.
# @option options [String] :stack_policy_during_update_url
@@ -810,7 +824,7 @@ module Aws::CloudFormation
# parameter, but not both.
#
# If you want to update protected resources, specify a temporary
- # overriding stack policy during this update. If you do not specify a
+ # overriding stack policy during this update. If you don't specify a
# stack policy, the current policy that is associated with the stack
# will be used.
# @option options [Array<Types::Parameter>] :parameters
@@ -822,16 +836,16 @@ module Aws::CloudFormation
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html
# @option options [Array<String>] :capabilities
# In some cases, you must explicitly acknowledge that your stack
- # template contains certain capabilities in order for AWS CloudFormation
- # to update the stack.
+ # template contains certain capabilities in order for CloudFormation to
+ # update the stack.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stacks, you
- # must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stacks, you must explicitly acknowledge this by specifying one of
+ # these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -841,18 +855,18 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
- # CloudFormation returns an `InsufficientCapabilities` error.
+ # * If you don't specify either of these capabilities, CloudFormation
+ # returns an `InsufficientCapabilities` error.
#
- # If your stack template contains these resources, we recommend that
- # you review all permissions associated with them and edit their
+ # If your stack template contains these resources, we suggest that you
+ # review all permissions associated with them and edit their
# permissions if necessary.
#
# * [ AWS::IAM::AccessKey][1]
#
# * [ AWS::IAM::Group][2]
#
- # * [ AWS::IAM::InstanceProfile][3]
+ # * [AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
@@ -860,9 +874,9 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::User][6]
#
- # * [ AWS::IAM::UserToGroupAddition][7]
+ # * [AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
@@ -877,24 +891,23 @@ module Aws::CloudFormation
# update a stack directly from the processed template, without first
# reviewing the resulting changes in a change set, you must
# acknowledge this capability. This includes the [AWS::Include][9] and
- # [AWS::Serverless][10] transforms, which are macros hosted by AWS
+ # [AWS::Serverless][10] transforms, which are macros hosted by
# CloudFormation.
#
- # Change sets do not currently support nested stacks. If you want to
- # update a stack from a stack template that contains macros *and*
- # nested stacks, you must update the stack directly from the template
- # using this capability.
+ # If you want to update a stack from a stack template that contains
+ # macros *and* nested stacks, you must update the stack directly from
+ # the template using this capability.
#
# You should only update stacks directly from a stack template that
# contains macros if you know what processing the macro performs.
#
# Each macro relies on an underlying Lambda service function for
# processing stack templates. Be aware that the Lambda function owner
- # can update the function operation without AWS CloudFormation being
+ # can update the function operation without CloudFormation being
# notified.
#
- # For more information, see [Using AWS CloudFormation Macros to
- # Perform Custom Processing on Templates][11].
+ # For more information, see [Using CloudFormation Macros to Perform
+ # Custom Processing on Templates][11].
#
#
#
@@ -915,31 +928,30 @@ module Aws::CloudFormation
# or `Custom::MyCustomInstance`.
#
# If the list of resource types doesn't include a resource that you're
- # updating, the stack update fails. By default, AWS CloudFormation
- # grants permissions to all resource types. AWS Identity and Access
- # Management (IAM) uses this parameter for AWS CloudFormation-specific
- # condition keys in IAM policies. For more information, see [Controlling
- # Access with AWS Identity and Access Management][1].
+ # updating, the stack update fails. By default, CloudFormation grants
+ # permissions to all resource types. Identity and Access Management
+ # (IAM) uses this parameter for CloudFormation-specific condition keys
+ # in IAM policies. For more information, see [Controlling Access with
+ # Identity and Access Management][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
# @option options [String] :role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to update the
- # stack. AWS CloudFormation uses the role's credentials to make calls
- # on your behalf. AWS CloudFormation always uses this role for all
- # future operations on the stack. As long as users have permission to
- # operate on the stack, AWS CloudFormation uses this role even if the
- # users don't have permission to pass it. Ensure that the role grants
- # least privilege.
- #
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available, AWS
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to update the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf. CloudFormation always uses this role for all future operations
+ # on the stack. Provided that users have permission to operate on the
+ # stack, CloudFormation uses this role even if the users don't have
+ # permission to pass it. Ensure that the role grants least privilege.
+ #
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
# CloudFormation uses a temporary session that is generated from your
# user credentials.
# @option options [Types::RollbackConfiguration] :rollback_configuration
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
# @option options [String] :stack_policy_body
@@ -947,7 +959,7 @@ module Aws::CloudFormation
# the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
#
# You might update the stack policy, for example, in order to protect a
- # new resource that you created during a stack update. If you do not
+ # new resource that you created during a stack update. If you don't
# specify a stack policy, the current policy that is associated with the
# stack is unchanged.
# @option options [String] :stack_policy_url
@@ -957,26 +969,31 @@ module Aws::CloudFormation
# the `StackPolicyURL` parameter, but not both.
#
# You might update the stack policy, for example, in order to protect a
- # new resource that you created during a stack update. If you do not
+ # new resource that you created during a stack update. If you don't
# specify a stack policy, the current policy that is associated with the
# stack is unchanged.
# @option options [Array<String>] :notification_arns
# Amazon Simple Notification Service topic Amazon Resource Names (ARNs)
- # that AWS CloudFormation associates with the stack. Specify an empty
- # list to remove all notification topics.
+ # that CloudFormation associates with the stack. Specify an empty list
+ # to remove all notification topics.
# @option options [Array<Types::Tag>] :tags
- # Key-value pairs to associate with this stack. AWS CloudFormation also
+ # Key-value pairs to associate with this stack. CloudFormation also
# propagates these tags to supported resources in the stack. You can
# specify a maximum number of 50 tags.
#
- # If you don't specify this parameter, AWS CloudFormation doesn't
- # modify the stack's tags. If you specify an empty value, AWS
- # CloudFormation removes all associated tags.
+ # If you don't specify this parameter, CloudFormation doesn't modify
+ # the stack's tags. If you specify an empty value, CloudFormation
+ # removes all associated tags.
+ # @option options [Boolean] :disable_rollback
+ # Preserve the state of previously provisioned resources when an
+ # operation fails.
+ #
+ # Default: `False`
# @option options [String] :client_request_token
# A unique identifier for this `UpdateStack` request. Specify this token
- # if you plan to retry requests so that AWS CloudFormation knows that
+ # if you plan to retry requests so that CloudFormation knows that
# you're not attempting to update a stack with the same name. You might
- # retry `UpdateStack` requests to ensure that AWS CloudFormation
+ # retry `UpdateStack` requests to ensure that CloudFormation
# successfully received them.
#
# All events triggered by a given stack operation are assigned the same
@@ -995,7 +1012,9 @@ module Aws::CloudFormation
# @return [Types::UpdateStackOutput]
def update(options = {})
options = options.merge(stack_name: @name)
- resp = @client.update_stack(options)
+ resp = Aws::Plugins::UserAgent.feature('resource') do
+ @client.update_stack(options)
+ end
resp.data
end
@@ -1009,7 +1028,9 @@ module Aws::CloudFormation
def events(options = {})
batches = Enumerator.new do |y|
options = options.merge(stack_name: @name)
- resp = @client.describe_stack_events(options)
+ resp = Aws::Plugins::UserAgent.feature('resource') do
+ @client.describe_stack_events(options)
+ end
resp.each_page do |page|
batch = []
page.data.stack_events.each do |s|
@@ -1043,7 +1064,9 @@ module Aws::CloudFormation
def resource_summaries(options = {})
batches = Enumerator.new do |y|
options = options.merge(stack_name: @name)
- resp = @client.list_stack_resources(options)
+ resp = Aws::Plugins::UserAgent.feature('resource') do
+ @client.list_stack_resources(options)
+ end
resp.each_page do |page|
batch = []
page.data.stack_resource_summaries.each do |s|
diff --git a/lib/aws-sdk-cloudformation/stack_resource.rb b/lib/aws-sdk-cloudformation/stack_resource.rb
index 4c49f1f..897080f 100644
--- a/lib/aws-sdk-cloudformation/stack_resource.rb
+++ b/lib/aws-sdk-cloudformation/stack_resource.rb
@@ -3,7 +3,7 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -50,14 +50,14 @@ module Aws::CloudFormation
end
# The name or unique identifier that corresponds to a physical instance
- # ID of a resource supported by AWS CloudFormation.
+ # ID of a resource supported by CloudFormation.
# @return [String]
def physical_resource_id
data[:physical_resource_id]
end
- # Type of resource. ((For more information, go to [ AWS Resource Types
- # Reference][1] in the AWS CloudFormation User Guide.)
+ # Type of resource. For more information, go to [Amazon Web Services
+ # Resource Types Reference][1] in the CloudFormation User Guide.
#
#
#
@@ -92,8 +92,8 @@ module Aws::CloudFormation
end
# The content of the `Metadata` attribute declared for the resource. For
- # more information, see [Metadata Attribute][1] in the AWS
- # CloudFormation User Guide.
+ # more information, see [Metadata Attribute][1] in the CloudFormation
+ # User Guide.
#
#
#
@@ -117,6 +117,14 @@ module Aws::CloudFormation
data[:drift_information]
end
+ # Contains information about the module from which the resource was
+ # created, if the resource was created from a module included in the
+ # stack template.
+ # @return [Types::ModuleInfo]
+ def module_info
+ data[:module_info]
+ end
+
# @!endgroup
# @return [Client]
@@ -131,10 +139,12 @@ module Aws::CloudFormation
#
# @return [self]
def load
- resp = @client.describe_stack_resource(
+ resp = Aws::Plugins::UserAgent.feature('resource') do
+ @client.describe_stack_resource(
logical_resource_id: @logical_id,
stack_name: @stack_name
)
+ end
@data = resp.stack_resource_detail
self
end
@@ -249,7 +259,9 @@ module Aws::CloudFormation
:retry
end
end
- Aws::Waiters::Waiter.new(options).wait({})
+ Aws::Plugins::UserAgent.feature('resource') do
+ Aws::Waiters::Waiter.new(options).wait({})
+ end
end
# @!group Associations
diff --git a/lib/aws-sdk-cloudformation/stack_resource_summary.rb b/lib/aws-sdk-cloudformation/stack_resource_summary.rb
index fb3f32f..3612820 100644
--- a/lib/aws-sdk-cloudformation/stack_resource_summary.rb
+++ b/lib/aws-sdk-cloudformation/stack_resource_summary.rb
@@ -3,7 +3,7 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -50,8 +50,8 @@ module Aws::CloudFormation
data[:physical_resource_id]
end
- # Type of resource. (For more information, go to [ AWS Resource Types
- # Reference][1] in the AWS CloudFormation User Guide.)
+ # Type of resource. (For more information, go to [Amazon Web Services
+ # Resource Types Reference][1] in the CloudFormation User Guide.)
#
#
#
@@ -93,6 +93,14 @@ module Aws::CloudFormation
data[:drift_information]
end
+ # Contains information about the module from which the resource was
+ # created, if the resource was created from a module included in the
+ # stack template.
+ # @return [Types::ModuleInfo]
+ def module_info
+ data[:module_info]
+ end
+
# @!endgroup
# @return [Client]
@@ -217,7 +225,9 @@ module Aws::CloudFormation
:retry
end
end
- Aws::Waiters::Waiter.new(options).wait({})
+ Aws::Plugins::UserAgent.feature('resource') do
+ Aws::Waiters::Waiter.new(options).wait({})
+ end
end
# @!group Associations
diff --git a/lib/aws-sdk-cloudformation/types.rb b/lib/aws-sdk-cloudformation/types.rb
index 5826409..f49803e 100644
--- a/lib/aws-sdk-cloudformation/types.rb
+++ b/lib/aws-sdk-cloudformation/types.rb
@@ -3,7 +3,7 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -11,17 +11,17 @@ module Aws::CloudFormation
module Types
# Structure that contains the results of the account gate function which
- # AWS CloudFormation invokes, if present, before proceeding with a stack
- # set operation in an account and Region.
- #
- # For each account and Region, AWS CloudFormation lets you specify a
- # Lamdba function that encapsulates any requirements that must be met
- # before CloudFormation can proceed with a stack set operation in that
- # account and Region. CloudFormation invokes the function each time a
- # stack set operation is requested for that account and Region; if the
- # function returns `FAILED`, CloudFormation cancels the operation in
- # that account and Region, and sets the stack set operation result
- # status for that account and Region to `FAILED`.
+ # CloudFormation invokes, if present, before proceeding with a stack set
+ # operation in an account and Region.
+ #
+ # For each account and Region, CloudFormation lets you specify a Lambda
+ # function that encapsulates any requirements that must be met before
+ # CloudFormation can proceed with a stack set operation in that account
+ # and Region. CloudFormation invokes the function each time a stack set
+ # operation is requested for that account and Region; if the function
+ # returns `FAILED`, CloudFormation cancels the operation in that account
+ # and Region, and sets the stack set operation result status for that
+ # account and Region to `FAILED`.
#
# For more information, see [Configuring a target account gate][1].
#
@@ -32,32 +32,32 @@ module Aws::CloudFormation
# @!attribute [rw] status
# The status of the account gate function.
#
- # * `SUCCEEDED`\: The account gate function has determined that the
+ # * `SUCCEEDED`: The account gate function has determined that the
# account and Region passes any requirements for a stack set
- # operation to occur. AWS CloudFormation proceeds with the stack
+ # operation to occur. CloudFormation proceeds with the stack
# operation in that account and Region.
#
- # * `FAILED`\: The account gate function has determined that the
- # account and Region does not meet the requirements for a stack set
- # operation to occur. AWS CloudFormation cancels the stack set
- # operation in that account and Region, and sets the stack set
- # operation result status for that account and Region to `FAILED`.
+ # * `FAILED`: The account gate function has determined that the
+ # account and Region doesn't meet the requirements for a stack set
+ # operation to occur. CloudFormation cancels the stack set operation
+ # in that account and Region, and sets the stack set operation
+ # result status for that account and Region to `FAILED`.
#
- # * `SKIPPED`\: AWS CloudFormation has skipped calling the account
- # gate function for this account and Region, for one of the
- # following reasons:
+ # * `SKIPPED`: CloudFormation has skipped calling the account gate
+ # function for this account and Region, for one of the following
+ # reasons:
#
- # * An account gate function has not been specified for the account
- # and Region. AWS CloudFormation proceeds with the stack set
- # operation in this account and Region.
+ # * An account gate function hasn't been specified for the account
+ # and Region. CloudFormation proceeds with the stack set operation
+ # in this account and Region.
#
# * The `AWSCloudFormationStackSetExecutionRole` of the stack set
- # adminstration account lacks permissions to invoke the function.
- # AWS CloudFormation proceeds with the stack set operation in this
+ # administration account lacks permissions to invoke the function.
+ # CloudFormation proceeds with the stack set operation in this
# account and Region.
#
# * Either no action is necessary, or no action is possible, on the
- # stack. AWS CloudFormation skips the stack set operation in this
+ # stack. CloudFormation skips the stack set operation in this
# account and Region.
# @return [String]
#
@@ -86,8 +86,8 @@ module Aws::CloudFormation
# * Number of stack outputs
#
# For more information about these account limits, and other
- # CloudFormation limits, see [AWS CloudFormation Limits][1] in the *AWS
- # CloudFormation User Guide*.
+ # CloudFormation limits, see [CloudFormation quotas][1] in the
+ # *CloudFormation User Guide*.
#
#
#
@@ -101,7 +101,7 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] value
- # The value that is associated with the account limit name.
+ # The value that's associated with the account limit name.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/AccountLimit AWS API Documentation
@@ -113,27 +113,137 @@ module Aws::CloudFormation
include Aws::Structure
end
+ # @api private
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateOrganizationsAccessInput AWS API Documentation
+ #
+ class ActivateOrganizationsAccessInput < Aws::EmptyStructure; end
+
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateOrganizationsAccessOutput AWS API Documentation
+ #
+ class ActivateOrganizationsAccessOutput < Aws::EmptyStructure; end
+
+ # @!attribute [rw] type
+ # The extension type.
+ #
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`,
+ # `Type`, and `PublisherId`.
+ # @return [String]
+ #
+ # @!attribute [rw] public_type_arn
+ # The Amazon Resource Name (ARN) of the public extension.
+ #
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`,
+ # `Type`, and `PublisherId`.
+ # @return [String]
+ #
+ # @!attribute [rw] publisher_id
+ # The ID of the extension publisher.
+ #
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`,
+ # `Type`, and `PublisherId`.
+ # @return [String]
+ #
+ # @!attribute [rw] type_name
+ # The name of the extension.
+ #
+ # Conditional: You must specify `PublicTypeArn`, or `TypeName`,
+ # `Type`, and `PublisherId`.
+ # @return [String]
+ #
+ # @!attribute [rw] type_name_alias
+ # An alias to assign to the public extension, in this account and
+ # Region. If you specify an alias for the extension, CloudFormation
+ # treats the alias as the extension type name within this account and
+ # Region. You must use the alias to refer to the extension in your
+ # templates, API calls, and CloudFormation console.
+ #
+ # An extension alias must be unique within a given account and Region.
+ # You can activate the same public resource multiple times in the same
+ # account and Region, using different type name aliases.
+ # @return [String]
+ #
+ # @!attribute [rw] auto_update
+ # Whether to automatically update the extension in this account and
+ # Region when a new *minor* version is published by the extension
+ # publisher. Major versions released by the publisher must be manually
+ # updated.
+ #
+ # The default is `true`.
+ # @return [Boolean]
+ #
+ # @!attribute [rw] logging_config
+ # Contains logging configuration information for an extension.
+ # @return [Types::LoggingConfig]
+ #
+ # @!attribute [rw] execution_role_arn
+ # The name of the IAM execution role to use to activate the extension.
+ # @return [String]
+ #
+ # @!attribute [rw] version_bump
+ # Manually updates a previously-activated type to a new major or minor
+ # version, if available. You can also use this parameter to update the
+ # value of `AutoUpdate`.
+ #
+ # * `MAJOR`: CloudFormation updates the extension to the newest major
+ # version, if one is available.
+ #
+ # * `MINOR`: CloudFormation updates the extension to the newest minor
+ # version, if one is available.
+ # @return [String]
+ #
+ # @!attribute [rw] major_version
+ # The major version of this extension you want to activate, if
+ # multiple major versions are available. The default is the latest
+ # major version. CloudFormation uses the latest available *minor*
+ # version of the major version selected.
+ #
+ # You can specify `MajorVersion` or `VersionBump`, but not both.
+ # @return [Integer]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateTypeInput AWS API Documentation
+ #
+ class ActivateTypeInput < Struct.new(
+ :type,
+ :public_type_arn,
+ :publisher_id,
+ :type_name,
+ :type_name_alias,
+ :auto_update,
+ :logging_config,
+ :execution_role_arn,
+ :version_bump,
+ :major_version)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] arn
+ # The Amazon Resource Name (ARN) of the activated extension, in this
+ # account and Region.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateTypeOutput AWS API Documentation
+ #
+ class ActivateTypeOutput < Struct.new(
+ :arn)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# The resource with the name requested already exists.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/AlreadyExistsException AWS API Documentation
#
class AlreadyExistsException < Aws::EmptyStructure; end
- # \[`Service-managed` permissions\] Describes whether StackSets
- # automatically deploys to AWS Organizations accounts that are added to
- # a target organization or organizational unit (OU).
- #
- # @note When making an API call, you may pass AutoDeployment
- # data as a hash:
- #
- # {
- # enabled: false,
- # retain_stacks_on_account_removal: false,
- # }
+ # \[Service-managed permissions\] Describes whether StackSets
+ # automatically deploys to Organizations accounts that are added to a
+ # target organization or organizational unit (OU).
#
# @!attribute [rw] enabled
# If set to `true`, StackSets automatically deploys additional stack
- # instances to AWS Organizations accounts that are added to a target
+ # instances to Organizations accounts that are added to a target
# organization or organizational unit (OU) in the specified Regions.
# If an account is removed from a target organization or OU, StackSets
# deletes stack instances from the account in the specified Regions.
@@ -154,6 +264,69 @@ module Aws::CloudFormation
include Aws::Structure
end
+ # Detailed information concerning an error generated during the setting
+ # of configuration data for a CloudFormation extension.
+ #
+ # @!attribute [rw] error_code
+ # The error code.
+ # @return [String]
+ #
+ # @!attribute [rw] error_message
+ # The error message.
+ # @return [String]
+ #
+ # @!attribute [rw] type_configuration_identifier
+ # Identifying information for the configuration of a CloudFormation
+ # extension.
+ # @return [Types::TypeConfigurationIdentifier]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurationsError AWS API Documentation
+ #
+ class BatchDescribeTypeConfigurationsError < Struct.new(
+ :error_code,
+ :error_message,
+ :type_configuration_identifier)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] type_configuration_identifiers
+ # The list of identifiers for the desired extension configurations.
+ # @return [Array<Types::TypeConfigurationIdentifier>]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurationsInput AWS API Documentation
+ #
+ class BatchDescribeTypeConfigurationsInput < Struct.new(
+ :type_configuration_identifiers)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] errors
+ # A list of information concerning any errors generated during the
+ # setting of the specified configurations.
+ # @return [Array<Types::BatchDescribeTypeConfigurationsError>]
+ #
+ # @!attribute [rw] unprocessed_type_configurations
+ # A list of any of the specified extension configurations that
+ # CloudFormation could not process for any reason.
+ # @return [Array<Types::TypeConfigurationIdentifier>]
+ #
+ # @!attribute [rw] type_configurations
+ # A list of any of the specified extension configurations from the
+ # CloudFormation registry.
+ # @return [Array<Types::TypeConfigurationDetails>]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurationsOutput AWS API Documentation
+ #
+ class BatchDescribeTypeConfigurationsOutput < Struct.new(
+ :errors,
+ :unprocessed_type_configurations,
+ :type_configurations)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# An error occurred during a CloudFormation registry operation.
#
# @!attribute [rw] message
@@ -169,24 +342,29 @@ module Aws::CloudFormation
# The input for the CancelUpdateStack action.
#
- # @note When making an API call, you may pass CancelUpdateStackInput
- # data as a hash:
+ # @!attribute [rw] stack_name
+ # <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
+ # response that describes all resources in the account.
#
- # {
- # stack_name: "StackName", # required
- # client_request_token: "ClientRequestToken",
- # }
+ # The IAM policy below can be added to IAM policies when you want to
+ # limit resource-level permissions and avoid returning a response when
+ # no parameter is sent in the request:
#
- # @!attribute [rw] stack_name
- # The name or the unique stack ID that is associated with the stack.
+ # `\{ "Version": "2012-10-17", "Statement": [\{ "Effect": "Deny",
+ # "Action": "cloudformation:DescribeStacks", "NotResource":
+ # "arn:aws:cloudformation:*:*:stack/*/*" \}] \}`
+ #
+ # </note>
+ #
+ # The name or the unique stack ID that's associated with the stack.
# @return [String]
#
# @!attribute [rw] client_request_token
# A unique identifier for this `CancelUpdateStack` request. Specify
- # this token if you plan to retry requests so that AWS CloudFormation
+ # this token if you plan to retry requests so that CloudFormation
# knows that you're not attempting to cancel an update on a stack
# with the same name. You might retry `CancelUpdateStack` requests to
- # ensure that AWS CloudFormation successfully received them.
+ # ensure that CloudFormation successfully received them.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CancelUpdateStackInput AWS API Documentation
@@ -198,30 +376,145 @@ module Aws::CloudFormation
include Aws::Structure
end
- # The `Change` structure describes the changes AWS CloudFormation will
+ # The `Change` structure describes the changes CloudFormation will
# perform if you execute the change set.
#
# @!attribute [rw] type
- # The type of entity that AWS CloudFormation changes. Currently, the
- # only entity type is `Resource`.
+ # The type of entity that CloudFormation changes. Currently, the only
+ # entity type is `Resource`.
# @return [String]
#
+ # @!attribute [rw] hook_invocation_count
+ # Is either `null`, if no hooks invoke for the resource, or contains
+ # the number of hooks that will invoke for the resource.
+ # @return [Integer]
+ #
# @!attribute [rw] resource_change
# A `ResourceChange` structure that describes the resource and action
- # that AWS CloudFormation will perform.
+ # that CloudFormation will perform.
# @return [Types::ResourceChange]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/Change AWS API Documentation
#
class Change < Struct.new(
:type,
+ :hook_invocation_count,
:resource_change)
SENSITIVE = []
include Aws::Structure
end
+ # Specifies the resource, the hook, and the hook version to be invoked.
+ #
+ # @!attribute [rw] invocation_point
+ # Specifies the points in provisioning logic where a hook is invoked.
+ # @return [String]
+ #
+ # @!attribute [rw] failure_mode
+ # Specify the hook failure mode for non-compliant resources in the
+ # followings ways.
+ #
+ # * `FAIL` Stops provisioning resources.
+ #
+ # * `WARN` Allows provisioning to continue with a warning message.
+ # @return [String]
+ #
+ # @!attribute [rw] type_name
+ # The unique name for your hook. Specifies a three-part namespace for
+ # your hook, with a recommended pattern of
+ # `Organization::Service::Hook`.
+ #
+ # <note markdown="1"> The following organization namespaces are reserved and can't be
+ # used in your hook type names:
+ #
+ # * `Alexa`
+ #
+ # * `AMZN`
+ #
+ # * `Amazon`
+ #
+ # * `ASK`
+ #
+ # * `AWS`
+ #
+ # * `Custom`
+ #
+ # * `Dev`
+ #
+ # </note>
+ # @return [String]
+ #
+ # @!attribute [rw] type_version_id
+ # The version ID of the type specified.
+ # @return [String]
+ #
+ # @!attribute [rw] type_configuration_version_id
+ # The version ID of the type configuration.
+ # @return [String]
+ #
+ # @!attribute [rw] target_details
+ # Specifies details about the target that the hook will run against.
+ # @return [Types::ChangeSetHookTargetDetails]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ChangeSetHook AWS API Documentation
+ #
+ class ChangeSetHook < Struct.new(
+ :invocation_point,
+ :failure_mode,
+ :type_name,
+ :type_version_id,
+ :type_configuration_version_id,
+ :target_details)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # Specifies `RESOURCE` type target details for activated hooks.
+ #
+ # @!attribute [rw] logical_resource_id
+ # The resource's logical ID, which is defined in the stack's
+ # template.
+ # @return [String]
+ #
+ # @!attribute [rw] resource_type
+ # The type of CloudFormation resource, such as `AWS::S3::Bucket`.
+ # @return [String]
+ #
+ # @!attribute [rw] resource_action
+ # Specifies the action of the resource.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ChangeSetHookResourceTargetDetails AWS API Documentation
+ #
+ class ChangeSetHookResourceTargetDetails < Struct.new(
+ :logical_resource_id,
+ :resource_type,
+ :resource_action)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # Specifies target details for an activated hook.
+ #
+ # @!attribute [rw] target_type
+ # The name of the type.
+ # @return [String]
+ #
+ # @!attribute [rw] resource_target_details
+ # Required if `TargetType` is `RESOURCE`.
+ # @return [Types::ChangeSetHookResourceTargetDetails]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ChangeSetHookTargetDetails AWS API Documentation
+ #
+ class ChangeSetHookTargetDetails < Struct.new(
+ :target_type,
+ :resource_target_details)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# The specified change set name or ID doesn't exit. To view valid
- # change sets for a stack, use the `ListChangeSets` action.
+ # change sets for a stack, use the `ListChangeSets` operation.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ChangeSetNotFoundException AWS API Documentation
#
@@ -248,10 +541,10 @@ module Aws::CloudFormation
#
# @!attribute [rw] execution_status
# If the change set execution status is `AVAILABLE`, you can execute
- # the change set. If you can’t execute the change set, the status
+ # the change set. If you can't execute the change set, the status
# indicates why. For example, a change set might be in an
- # `UNAVAILABLE` state because AWS CloudFormation is still creating it
- # or in an `OBSOLETE` state because the stack was already updated.
+ # `UNAVAILABLE` state because CloudFormation is still creating it or
+ # in an `OBSOLETE` state because the stack was already updated.
# @return [String]
#
# @!attribute [rw] status
@@ -261,8 +554,8 @@ module Aws::CloudFormation
#
# @!attribute [rw] status_reason
# A description of the change set's status. For example, if your
- # change set is in the `FAILED` state, AWS CloudFormation shows the
- # error message.
+ # change set is in the `FAILED` state, CloudFormation shows the error
+ # message.
# @return [String]
#
# @!attribute [rw] creation_time
@@ -273,6 +566,19 @@ module Aws::CloudFormation
# Descriptive information about the change set.
# @return [String]
#
+ # @!attribute [rw] include_nested_stacks
+ # Specifies the current setting of `IncludeNestedStacks` for the
+ # change set.
+ # @return [Boolean]
+ #
+ # @!attribute [rw] parent_change_set_id
+ # The parent change set ID.
+ # @return [String]
+ #
+ # @!attribute [rw] root_change_set_id
+ # The root change set ID.
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ChangeSetSummary AWS API Documentation
#
class ChangeSetSummary < Struct.new(
@@ -284,23 +590,16 @@ module Aws::CloudFormation
:status,
:status_reason,
:creation_time,
- :description)
+ :description,
+ :include_nested_stacks,
+ :parent_change_set_id,
+ :root_change_set_id)
SENSITIVE = []
include Aws::Structure
end
# The input for the ContinueUpdateRollback action.
#
- # @note When making an API call, you may pass ContinueUpdateRollbackInput
- # data as a hash:
- #
- # {
- # stack_name: "StackNameOrId", # required
- # role_arn: "RoleARN",
- # resources_to_skip: ["ResourceToSkip"],
- # client_request_token: "ClientRequestToken",
- # }
- #
# @!attribute [rw] stack_name
# The name or the unique ID of the stack that you want to continue
# rolling back.
@@ -314,41 +613,40 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to roll back
- # the stack. AWS CloudFormation uses the role's credentials to make
- # calls on your behalf. AWS CloudFormation always uses this role for
- # all future operations on the stack. As long as users have permission
- # to operate on the stack, AWS CloudFormation uses this role even if
- # the users don't have permission to pass it. Ensure that the role
- # grants least privilege.
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to roll back the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf. CloudFormation always uses this role for all future
+ # operations on the stack. Provided that users have permission to
+ # operate on the stack, CloudFormation uses this role even if the
+ # users don't have permission to pass it. Ensure that the role grants
+ # least permission.
#
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available,
- # AWS CloudFormation uses a temporary session that is generated from
- # your user credentials.
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
+ # CloudFormation uses a temporary session that's generated from your
+ # user credentials.
# @return [String]
#
# @!attribute [rw] resources_to_skip
- # A list of the logical IDs of the resources that AWS CloudFormation
- # skips during the continue update rollback operation. You can specify
- # only resources that are in the `UPDATE_FAILED` state because a
- # rollback failed. You can't specify resources that are in the
- # `UPDATE_FAILED` state for other reasons, for example, because an
- # update was cancelled. To check why a resource update failed, use the
+ # A list of the logical IDs of the resources that CloudFormation skips
+ # during the continue update rollback operation. You can specify only
+ # resources that are in the `UPDATE_FAILED` state because a rollback
+ # failed. You can't specify resources that are in the `UPDATE_FAILED`
+ # state for other reasons, for example, because an update was
+ # canceled. To check why a resource update failed, use the
# DescribeStackResources action, and view the resource status reason.
#
- # Specify this property to skip rolling back resources that AWS
+ # Specify this property to skip rolling back resources that
# CloudFormation can't successfully roll back. We recommend that you
- # [ troubleshoot][1] resources before skipping them. AWS
- # CloudFormation sets the status of the specified resources to
- # `UPDATE_COMPLETE` and continues to roll back the stack. After the
- # rollback is complete, the state of the skipped resources will be
- # inconsistent with the state of the resources in the stack template.
- # Before performing another stack update, you must update the stack or
- # resources to be consistent with each other. If you don't,
- # subsequent stack updates might fail, and the stack will become
- # unrecoverable.
+ # [ troubleshoot][1] resources before skipping them. CloudFormation
+ # sets the status of the specified resources to `UPDATE_COMPLETE` and
+ # continues to roll back the stack. After the rollback is complete,
+ # the state of the skipped resources will be inconsistent with the
+ # state of the resources in the stack template. Before performing
+ # another stack update, you must update the stack or resources to be
+ # consistent with each other. If you don't, subsequent stack updates
+ # might fail, and the stack will become unrecoverable.
#
# Specify the minimum number of resources required to successfully
# roll back your stack. For example, a failed resource update might
@@ -377,10 +675,10 @@ module Aws::CloudFormation
#
# @!attribute [rw] client_request_token
# A unique identifier for this `ContinueUpdateRollback` request.
- # Specify this token if you plan to retry requests so that AWS
+ # Specify this token if you plan to retry requests so that
# CloudFormation knows that you're not attempting to continue the
# rollback to a stack with the same name. You might retry
- # `ContinueUpdateRollback` requests to ensure that AWS CloudFormation
+ # `ContinueUpdateRollback` requests to ensure that CloudFormation
# successfully received them.
# @return [String]
#
@@ -395,7 +693,7 @@ module Aws::CloudFormation
include Aws::Structure
end
- # The output for a ContinueUpdateRollback action.
+ # The output for a ContinueUpdateRollback operation.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ContinueUpdateRollbackOutput AWS API Documentation
#
@@ -403,66 +701,16 @@ module Aws::CloudFormation
# The input for the CreateChangeSet action.
#
- # @note When making an API call, you may pass CreateChangeSetInput
- # data as a hash:
- #
- # {
- # stack_name: "StackNameOrId", # required
- # template_body: "TemplateBody",
- # template_url: "TemplateURL",
- # use_previous_template: false,
- # parameters: [
- # {
- # parameter_key: "ParameterKey",
- # parameter_value: "ParameterValue",
- # use_previous_value: false,
- # resolved_value: "ParameterValue",
- # },
- # ],
- # capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
- # resource_types: ["ResourceType"],
- # role_arn: "RoleARN",
- # rollback_configuration: {
- # rollback_triggers: [
- # {
- # arn: "Arn", # required
- # type: "Type", # required
- # },
- # ],
- # monitoring_time_in_minutes: 1,
- # },
- # notification_arns: ["NotificationARN"],
- # tags: [
- # {
- # key: "TagKey", # required
- # value: "TagValue", # required
- # },
- # ],
- # change_set_name: "ChangeSetName", # required
- # client_token: "ClientToken",
- # description: "Description",
- # change_set_type: "CREATE", # accepts CREATE, UPDATE, IMPORT
- # resources_to_import: [
- # {
- # resource_type: "ResourceType", # required
- # logical_resource_id: "LogicalResourceId", # required
- # resource_identifier: { # required
- # "ResourceIdentifierPropertyKey" => "ResourceIdentifierPropertyValue",
- # },
- # },
- # ],
- # }
- #
# @!attribute [rw] stack_name
# The name or the unique ID of the stack for which you are creating a
- # change set. AWS CloudFormation generates the change set by comparing
+ # change set. CloudFormation generates the change set by comparing
# this stack's information with the information that you submit, such
# as a modified template or different parameter input values.
# @return [String]
#
# @!attribute [rw] template_body
# A structure that contains the body of the revised template, with a
- # minimum length of 1 byte and a maximum length of 51,200 bytes. AWS
+ # minimum length of 1 byte and a maximum length of 51,200 bytes.
# CloudFormation generates the change set by comparing this template
# with the template of the stack that you specified.
#
@@ -471,15 +719,16 @@ module Aws::CloudFormation
#
# @!attribute [rw] template_url
# The location of the file that contains the revised template. The URL
- # must point to a template (max size: 460,800 bytes) that is located
- # in an S3 bucket. AWS CloudFormation generates the change set by
- # comparing this template with the stack that you specified.
+ # must point to a template (max size: 460,800 bytes) that's located
+ # in an Amazon S3 bucket or a Systems Manager document. CloudFormation
+ # generates the change set by comparing this template with the stack
+ # that you specified.
#
# Conditional: You must specify only `TemplateBody` or `TemplateURL`.
# @return [String]
#
# @!attribute [rw] use_previous_template
- # Whether to reuse the template that is associated with the stack to
+ # Whether to reuse the template that's associated with the stack to
# create the change set.
# @return [Boolean]
#
@@ -490,16 +739,16 @@ module Aws::CloudFormation
#
# @!attribute [rw] capabilities
# In some cases, you must explicitly acknowledge that your stack
- # template contains certain capabilities in order for AWS
- # CloudFormation to create the stack.
+ # template contains certain capabilities in order for CloudFormation
+ # to create the stack.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stacks, you
- # must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stacks, you must explicitly acknowledge this by specifying one of
+ # these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -509,10 +758,10 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
+ # * If you don't specify either of these capabilities,
# CloudFormation returns an `InsufficientCapabilities` error.
#
- # If your stack template contains these resources, we recommend that
+ # If your stack template contains these resources, we suggest that
# you review all permissions associated with them and edit their
# permissions if necessary.
#
@@ -520,7 +769,7 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::Group][2]
#
- # * [ AWS::IAM::InstanceProfile][3]
+ # * [AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
@@ -528,10 +777,10 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::User][6]
#
- # * [ AWS::IAM::UserToGroupAddition][7]
+ # * [AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
- # CloudFormation Templates][8].
+ # For more information, see [Acknowledging IAM resources in
+ # CloudFormation templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
#
@@ -546,21 +795,20 @@ module Aws::CloudFormation
# reviewing the resulting changes in a change set, you must
# acknowledge this capability. This includes the [AWS::Include][9]
# and [AWS::Serverless][10] transforms, which are macros hosted by
- # AWS CloudFormation.
+ # CloudFormation.
#
- # <note markdown="1"> This capacity does not apply to creating change sets, and
+ # <note markdown="1"> This capacity doesn't apply to creating change sets, and
# specifying it when creating change sets has no effect.
#
- # Also, change sets do not currently support nested stacks. If you
- # want to create a stack from a stack template that contains macros
- # *and* nested stacks, you must create or update the stack directly
- # from the template using the CreateStack or UpdateStack action, and
- # specifying this capability.
+ # If you want to create a stack from a stack template that contains
+ # macros *and* nested stacks, you must create or update the stack
+ # directly from the template using the CreateStack or UpdateStack
+ # action, and specifying this capability.
#
# </note>
#
- # For more information on macros, see [Using AWS CloudFormation
- # Macros to Perform Custom Processing on Templates][11].
+ # For more information about macros, see [Using CloudFormation
+ # macros to perform custom processing on templates][11].
#
#
#
@@ -583,12 +831,12 @@ module Aws::CloudFormation
# `AWS::EC2::*`, or `Custom::MyCustomInstance`.
#
# If the list of resource types doesn't include a resource type that
- # you're updating, the stack update fails. By default, AWS
- # CloudFormation grants permissions to all resource types. AWS
- # Identity and Access Management (IAM) uses this parameter for
- # condition keys in IAM policies for AWS CloudFormation. For more
- # information, see [Controlling Access with AWS Identity and Access
- # Management][1] in the AWS CloudFormation User Guide.
+ # you're updating, the stack update fails. By default, CloudFormation
+ # grants permissions to all resource types. Identity and Access
+ # Management (IAM) uses this parameter for condition keys in IAM
+ # policies for CloudFormation. For more information, see [Controlling
+ # access with Identity and Access Management][1] in the CloudFormation
+ # User Guide.
#
#
#
@@ -596,38 +844,37 @@ module Aws::CloudFormation
# @return [Array<String>]
#
# @!attribute [rw] role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes when executing
- # the change set. AWS CloudFormation uses the role's credentials to
- # make calls on your behalf. AWS CloudFormation uses this role for all
- # future operations on the stack. As long as users have permission to
- # operate on the stack, AWS CloudFormation uses this role even if the
- # users don't have permission to pass it. Ensure that the role grants
- # least privilege.
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes when executing the change
+ # set. CloudFormation uses the role's credentials to make calls on
+ # your behalf. CloudFormation uses this role for all future operations
+ # on the stack. Provided that users have permission to operate on the
+ # stack, CloudFormation uses this role even if the users don't have
+ # permission to pass it. Ensure that the role grants least permission.
#
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available,
- # AWS CloudFormation uses a temporary session that is generated from
- # your user credentials.
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
+ # CloudFormation uses a temporary session that is generated from your
+ # user credentials.
# @return [String]
#
# @!attribute [rw] rollback_configuration
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
# @return [Types::RollbackConfiguration]
#
# @!attribute [rw] notification_arns
# The Amazon Resource Names (ARNs) of Amazon Simple Notification
- # Service (Amazon SNS) topics that AWS CloudFormation associates with
- # the stack. To remove all associated notification topics, specify an
+ # Service (Amazon SNS) topics that CloudFormation associates with the
+ # stack. To remove all associated notification topics, specify an
# empty list.
# @return [Array<String>]
#
# @!attribute [rw] tags
- # Key-value pairs to associate with this stack. AWS CloudFormation
- # also propagates these tags to resources in the stack. You can
- # specify a maximum of 50 tags.
+ # Key-value pairs to associate with this stack. CloudFormation also
+ # propagates these tags to resources in the stack. You can specify a
+ # maximum of 50 tags.
# @return [Array<Types::Tag>]
#
# @!attribute [rw] change_set_name
@@ -635,16 +882,16 @@ module Aws::CloudFormation
# sets that are associated with the specified stack.
#
# A change set name can contain only alphanumeric, case sensitive
- # characters and hyphens. It must start with an alphabetic character
- # and cannot exceed 128 characters.
+ # characters, and hyphens. It must start with an alphabetical
+ # character and can't exceed 128 characters.
# @return [String]
#
# @!attribute [rw] client_token
# A unique identifier for this `CreateChangeSet` request. Specify this
- # token if you plan to retry requests so that AWS CloudFormation knows
+ # token if you plan to retry requests so that CloudFormation knows
# that you're not attempting to create another change set with the
# same name. You might retry `CreateChangeSet` requests to ensure that
- # AWS CloudFormation successfully received them.
+ # CloudFormation successfully received them.
# @return [String]
#
# @!attribute [rw] description
@@ -657,14 +904,14 @@ module Aws::CloudFormation
# stack, specify `UPDATE`. To create a change set for an import
# operation, specify `IMPORT`.
#
- # If you create a change set for a new stack, AWS Cloudformation
- # creates a stack with a unique stack ID, but no template or
- # resources. The stack will be in the [ `REVIEW_IN_PROGRESS` ][1]
- # state until you execute the change set.
+ # If you create a change set for a new stack, CloudFormation creates a
+ # stack with a unique stack ID, but no template or resources. The
+ # stack will be in the [REVIEW\_IN\_PROGRESS][1] state until you
+ # execute the change set.
#
- # By default, AWS CloudFormation specifies `UPDATE`. You can't use
- # the `UPDATE` type to create a change set for a new stack or the
- # `CREATE` type to create a change set for an existing stack.
+ # By default, CloudFormation specifies `UPDATE`. You can't use the
+ # `UPDATE` type to create a change set for a new stack or the `CREATE`
+ # type to create a change set for an existing stack.
#
#
#
@@ -675,6 +922,41 @@ module Aws::CloudFormation
# The resources to import into your stack.
# @return [Array<Types::ResourceToImport>]
#
+ # @!attribute [rw] include_nested_stacks
+ # Creates a change set for the all nested stacks specified in the
+ # template. The default behavior of this action is set to `False`. To
+ # include nested sets in a change set, specify `True`.
+ # @return [Boolean]
+ #
+ # @!attribute [rw] on_stack_failure
+ # Determines what action will be taken if stack creation fails. If
+ # this parameter is specified, the `DisableRollback` parameter to the
+ # [ExecuteChangeSet][1] API operation must not be specified. This must
+ # be one of these values:
+ #
+ # * `DELETE` - Deletes the change set if the stack creation fails.
+ # This is only valid when the `ChangeSetType` parameter is set to
+ # `CREATE`. If the deletion of the stack fails, the status of the
+ # stack is `DELETE_FAILED`.
+ #
+ # * `DO_NOTHING` - if the stack creation fails, do nothing. This is
+ # equivalent to specifying `true` for the `DisableRollback`
+ # parameter to the [ExecuteChangeSet][1] API operation.
+ #
+ # * `ROLLBACK` - if the stack creation fails, roll back the stack.
+ # This is equivalent to specifying `false` for the `DisableRollback`
+ # parameter to the [ExecuteChangeSet][1] API operation.
+ #
+ # For nested stacks, when the `OnStackFailure` parameter is set to
+ # `DELETE` for the change set for the parent stack, any failure in a
+ # child stack will cause the parent stack creation to fail and all
+ # stacks to be deleted.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSetInput AWS API Documentation
#
class CreateChangeSetInput < Struct.new(
@@ -693,7 +975,9 @@ module Aws::CloudFormation
:client_token,
:description,
:change_set_type,
- :resources_to_import)
+ :resources_to_import,
+ :include_nested_stacks,
+ :on_stack_failure)
SENSITIVE = []
include Aws::Structure
end
@@ -719,56 +1003,13 @@ module Aws::CloudFormation
# The input for CreateStack action.
#
- # @note When making an API call, you may pass CreateStackInput
- # data as a hash:
- #
- # {
- # stack_name: "StackName", # required
- # template_body: "TemplateBody",
- # template_url: "TemplateURL",
- # parameters: [
- # {
- # parameter_key: "ParameterKey",
- # parameter_value: "ParameterValue",
- # use_previous_value: false,
- # resolved_value: "ParameterValue",
- # },
- # ],
- # disable_rollback: false,
- # rollback_configuration: {
- # rollback_triggers: [
- # {
- # arn: "Arn", # required
- # type: "Type", # required
- # },
- # ],
- # monitoring_time_in_minutes: 1,
- # },
- # timeout_in_minutes: 1,
- # notification_arns: ["NotificationARN"],
- # capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
- # resource_types: ["ResourceType"],
- # role_arn: "RoleARN",
- # on_failure: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK, DELETE
- # stack_policy_body: "StackPolicyBody",
- # stack_policy_url: "StackPolicyURL",
- # tags: [
- # {
- # key: "TagKey", # required
- # value: "TagValue", # required
- # },
- # ],
- # client_request_token: "ClientRequestToken",
- # enable_termination_protection: false,
- # }
- #
# @!attribute [rw] stack_name
- # The name that is associated with the stack. The name must be unique
+ # The name that's associated with the stack. The name must be unique
# in the Region in which you are creating the stack.
#
# <note markdown="1"> A stack name can contain only alphanumeric characters (case
- # sensitive) and hyphens. It must start with an alphabetic character
- # and cannot be longer than 128 characters.
+ # sensitive) and hyphens. It must start with an alphabetical character
+ # and can't be longer than 128 characters.
#
# </note>
# @return [String]
@@ -776,7 +1017,7 @@ module Aws::CloudFormation
# @!attribute [rw] template_body
# Structure containing the template body with a minimum length of 1
# byte and a maximum length of 51,200 bytes. For more information, go
- # to [Template Anatomy][1] in the AWS CloudFormation User Guide.
+ # to [Template anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify either the `TemplateBody` or the
# `TemplateURL` parameter, but not both.
@@ -788,9 +1029,9 @@ module Aws::CloudFormation
#
# @!attribute [rw] template_url
# Location of file containing the template body. The URL must point to
- # a template (max size: 460,800 bytes) that is located in an Amazon S3
- # bucket. For more information, go to the [Template Anatomy][1] in the
- # AWS CloudFormation User Guide.
+ # a template (max size: 460,800 bytes) that's located in an Amazon S3
+ # bucket or a Systems Manager document. For more information, go to
+ # the [Template anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must specify either the `TemplateBody` or the
# `TemplateURL` parameter, but not both.
@@ -818,7 +1059,7 @@ module Aws::CloudFormation
# @return [Boolean]
#
# @!attribute [rw] rollback_configuration
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
# @return [Types::RollbackConfiguration]
@@ -830,23 +1071,24 @@ module Aws::CloudFormation
# @return [Integer]
#
# @!attribute [rw] notification_arns
- # The Simple Notification Service (SNS) topic ARNs to publish stack
- # related events. You can find your SNS topic ARNs using the SNS
- # console or your Command Line Interface (CLI).
+ # The Amazon Simple Notification Service (Amazon SNS) topic ARNs to
+ # publish stack related events. You can find your Amazon SNS topic
+ # ARNs using the Amazon SNS console or your Command Line Interface
+ # (CLI).
# @return [Array<String>]
#
# @!attribute [rw] capabilities
# In some cases, you must explicitly acknowledge that your stack
- # template contains certain capabilities in order for AWS
- # CloudFormation to create the stack.
+ # template contains certain capabilities in order for CloudFormation
+ # to create the stack.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stacks, you
- # must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stacks, you must explicitly acknowledge this by specifying one of
+ # these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -856,7 +1098,7 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
+ # * If you don't specify either of these capabilities,
# CloudFormation returns an `InsufficientCapabilities` error.
#
# If your stack template contains these resources, we recommend that
@@ -867,7 +1109,7 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::Group][2]
#
- # * [ AWS::IAM::InstanceProfile][3]
+ # * [AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
@@ -875,9 +1117,9 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::User][6]
#
- # * [ AWS::IAM::UserToGroupAddition][7]
+ # * [AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
@@ -893,23 +1135,22 @@ module Aws::CloudFormation
# reviewing the resulting changes in a change set, you must
# acknowledge this capability. This includes the [AWS::Include][9]
# and [AWS::Serverless][10] transforms, which are macros hosted by
- # AWS CloudFormation.
+ # CloudFormation.
#
- # Change sets do not currently support nested stacks. If you want to
- # create a stack from a stack template that contains macros *and*
- # nested stacks, you must create the stack directly from the
- # template using this capability.
+ # If you want to create a stack from a stack template that contains
+ # macros *and* nested stacks, you must create the stack directly
+ # from the template using this capability.
#
# You should only create stacks directly from a stack template that
# contains macros if you know what processing the macro performs.
#
# Each macro relies on an underlying Lambda service function for
# processing stack templates. Be aware that the Lambda function
- # owner can update the function operation without AWS CloudFormation
+ # owner can update the function operation without CloudFormation
# being notified.
#
- # For more information, see [Using AWS CloudFormation Macros to
- # Perform Custom Processing on Templates][11].
+ # For more information, see [Using CloudFormation macros to perform
+ # custom processing on templates][11].
#
#
#
@@ -930,19 +1171,19 @@ module Aws::CloudFormation
# The template resource types that you have permissions to work with
# for this create stack action, such as `AWS::EC2::Instance`,
# `AWS::EC2::*`, or `Custom::MyCustomInstance`. Use the following
- # syntax to describe template resource types: `AWS::*` (for all AWS
- # resource), `Custom::*` (for all custom resources),
+ # syntax to describe template resource types: `AWS::*` (for all Amazon
+ # Web Services resources), `Custom::*` (for all custom resources),
# `Custom::logical_ID ` (for a specific custom resource),
- # `AWS::service_name::*` (for all resources of a particular AWS
- # service), and `AWS::service_name::resource_logical_ID ` (for a
- # specific AWS resource).
+ # `AWS::service_name::*` (for all resources of a particular Amazon Web
+ # Services service), and `AWS::service_name::resource_logical_ID `
+ # (for a specific Amazon Web Services resource).
#
# If the list of resource types doesn't include a resource that
- # you're creating, the stack creation fails. By default, AWS
- # CloudFormation grants permissions to all resource types. AWS
- # Identity and Access Management (IAM) uses this parameter for AWS
+ # you're creating, the stack creation fails. By default,
+ # CloudFormation grants permissions to all resource types. Identity
+ # and Access Management (IAM) uses this parameter for
# CloudFormation-specific condition keys in IAM policies. For more
- # information, see [Controlling Access with AWS Identity and Access
+ # information, see [Controlling Access with Identity and Access
# Management][1].
#
#
@@ -951,34 +1192,34 @@ module Aws::CloudFormation
# @return [Array<String>]
#
# @!attribute [rw] role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to create the
- # stack. AWS CloudFormation uses the role's credentials to make calls
- # on your behalf. AWS CloudFormation always uses this role for all
- # future operations on the stack. As long as users have permission to
- # operate on the stack, AWS CloudFormation uses this role even if the
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to create the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf. CloudFormation always uses this role for all future
+ # operations on the stack. Provided that users have permission to
+ # operate on the stack, CloudFormation uses this role even if the
# users don't have permission to pass it. Ensure that the role grants
# least privilege.
#
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available,
- # AWS CloudFormation uses a temporary session that is generated from
- # your user credentials.
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
+ # CloudFormation uses a temporary session that's generated from your
+ # user credentials.
# @return [String]
#
# @!attribute [rw] on_failure
# Determines what action will be taken if stack creation fails. This
- # must be one of: DO\_NOTHING, ROLLBACK, or DELETE. You can specify
- # either `OnFailure` or `DisableRollback`, but not both.
+ # must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can
+ # specify either `OnFailure` or `DisableRollback`, but not both.
#
# Default: `ROLLBACK`
# @return [String]
#
# @!attribute [rw] stack_policy_body
# Structure containing the stack policy body. For more information, go
- # to [ Prevent Updates to Stack Resources][1] in the *AWS
- # CloudFormation User Guide*. You can specify either the
- # `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
+ # to [ Prevent Updates to Stack Resources][1] in the *CloudFormation
+ # User Guide*. You can specify either the `StackPolicyBody` or the
+ # `StackPolicyURL` parameter, but not both.
#
#
#
@@ -993,19 +1234,19 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] tags
- # Key-value pairs to associate with this stack. AWS CloudFormation
- # also propagates these tags to the resources created in the stack. A
+ # Key-value pairs to associate with this stack. CloudFormation also
+ # propagates these tags to the resources created in the stack. A
# maximum number of 50 tags can be specified.
# @return [Array<Types::Tag>]
#
# @!attribute [rw] client_request_token
# A unique identifier for this `CreateStack` request. Specify this
- # token if you plan to retry requests so that AWS CloudFormation knows
+ # token if you plan to retry requests so that CloudFormation knows
# that you're not attempting to create a stack with the same name.
- # You might retry `CreateStack` requests to ensure that AWS
- # CloudFormation successfully received them.
+ # You might retry `CreateStack` requests to ensure that CloudFormation
+ # successfully received them.
#
- # All events triggered by a given stack operation are assigned the
+ # All events initiated by a given stack operation are assigned the
# same client request token, which you can use to track operations.
# For example, if you execute a `CreateStack` operation with the token
# `token1`, then all the `StackEvents` generated by that operation
@@ -1025,11 +1266,11 @@ module Aws::CloudFormation
# a user attempts to delete a stack with termination protection
# enabled, the operation fails and the stack remains unchanged. For
# more information, see [Protecting a Stack From Being Deleted][1] in
- # the *AWS CloudFormation User Guide*. Termination protection is
- # disabled on stacks by default.
+ # the *CloudFormation User Guide*. Termination protection is
+ # deactivated on stacks by default.
#
# For [nested stacks][2], termination protection is set on the root
- # stack and cannot be changed directly on the nested stack.
+ # stack and can't be changed directly on the nested stack.
#
#
#
@@ -1061,58 +1302,31 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass CreateStackInstancesInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # accounts: ["Account"],
- # deployment_targets: {
- # accounts: ["Account"],
- # organizational_unit_ids: ["OrganizationalUnitId"],
- # },
- # regions: ["Region"], # required
- # parameter_overrides: [
- # {
- # parameter_key: "ParameterKey",
- # parameter_value: "ParameterValue",
- # use_previous_value: false,
- # resolved_value: "ParameterValue",
- # },
- # ],
- # operation_preferences: {
- # region_order: ["Region"],
- # failure_tolerance_count: 1,
- # failure_tolerance_percentage: 1,
- # max_concurrent_count: 1,
- # max_concurrent_percentage: 1,
- # },
- # operation_id: "ClientRequestToken",
- # }
- #
# @!attribute [rw] stack_set_name
# The name or unique ID of the stack set that you want to create stack
# instances from.
# @return [String]
#
# @!attribute [rw] accounts
- # \[`Self-managed` permissions\] The names of one or more AWS accounts
- # that you want to create stack instances in the specified Region(s)
- # for.
+ # \[Self-managed permissions\] The names of one or more Amazon Web
+ # Services accounts that you want to create stack instances in the
+ # specified Region(s) for.
#
# You can specify `Accounts` or `DeploymentTargets`, but not both.
# @return [Array<String>]
#
# @!attribute [rw] deployment_targets
- # \[`Service-managed` permissions\] The AWS Organizations accounts for
- # which to create stack instances in the specified Regions.
+ # \[Service-managed permissions\] The Organizations accounts for which
+ # to create stack instances in the specified Amazon Web Services
+ # Regions.
#
# You can specify `Accounts` or `DeploymentTargets`, but not both.
# @return [Types::DeploymentTargets]
#
# @!attribute [rw] regions
- # The names of one or more Regions where you want to create stack
- # instances using the specified AWS account(s).
+ # The names of one or more Amazon Web Services Regions where you want
+ # to create stack instances using the specified Amazon Web Services
+ # accounts.
# @return [Array<String>]
#
# @!attribute [rw] parameter_overrides
@@ -1120,31 +1334,27 @@ module Aws::CloudFormation
# the selected stack instances.
#
# Any overridden parameter values will be applied to all stack
- # instances in the specified accounts and Regions. When specifying
- # parameters and their values, be aware of how AWS CloudFormation sets
- # parameter values during stack instance operations:
+ # instances in the specified accounts and Amazon Web Services Regions.
+ # When specifying parameters and their values, be aware of how
+ # CloudFormation sets parameter values during stack instance
+ # operations:
#
# * To override the current value for a parameter, include the
# parameter and specify its value.
#
- # * To leave a parameter set to its present value, you can do one of
- # the following:
- #
- # * Do not include the parameter in the list.
+ # * To leave an overridden parameter set to its present value, include
+ # the parameter and specify `UsePreviousValue` as `true`. (You
+ # can't specify both a value and set `UsePreviousValue` to `true`.)
#
- # * Include the parameter and specify `UsePreviousValue` as `true`.
- # (You cannot specify both a value and set `UsePreviousValue` to
- # `true`.)
+ # * To set an overridden parameter back to the value specified in the
+ # stack set, specify a parameter list but don't include the
+ # parameter in the list.
#
- # * To set all overridden parameter back to the values specified in
- # the stack set, specify a parameter list but do not include any
- # parameters.
- #
- # * To leave all parameters set to their present values, do not
+ # * To leave all parameters set to their present values, don't
# specify this property at all.
#
# During stack set updates, any parameter values overridden for a
- # stack instance are not updated, but retain their overridden value.
+ # stack instance aren't updated, but retain their overridden value.
#
# You can only override the parameter *values* that are specified in
# the stack set; to add or delete a parameter itself, use
@@ -1156,7 +1366,7 @@ module Aws::CloudFormation
# @return [Array<Types::Parameter>]
#
# @!attribute [rw] operation_preferences
- # Preferences for how AWS CloudFormation performs this stack set
+ # Preferences for how CloudFormation performs this stack set
# operation.
# @return [Types::StackSetOperationPreferences]
#
@@ -1164,10 +1374,10 @@ module Aws::CloudFormation
# The unique identifier for this stack set operation.
#
# The operation ID also functions as an idempotency token, to ensure
- # that AWS CloudFormation performs the stack set operation only once,
- # even if you retry the request multiple times. You might retry stack
- # set operation requests to ensure that AWS CloudFormation
- # successfully received them.
+ # that CloudFormation performs the stack set operation only once, even
+ # if you retry the request multiple times. You might retry stack set
+ # operation requests to ensure that CloudFormation successfully
+ # received them.
#
# If you don't specify an operation ID, the SDK generates one
# automatically.
@@ -1179,6 +1389,29 @@ module Aws::CloudFormation
# not need to pass this option.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackInstancesInput AWS API Documentation
#
class CreateStackInstancesInput < Struct.new(
@@ -1188,7 +1421,8 @@ module Aws::CloudFormation
:regions,
:parameter_overrides,
:operation_preferences,
- :operation_id)
+ :operation_id,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -1219,39 +1453,6 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass CreateStackSetInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # description: "Description",
- # template_body: "TemplateBody",
- # template_url: "TemplateURL",
- # parameters: [
- # {
- # parameter_key: "ParameterKey",
- # parameter_value: "ParameterValue",
- # use_previous_value: false,
- # resolved_value: "ParameterValue",
- # },
- # ],
- # capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
- # tags: [
- # {
- # key: "TagKey", # required
- # value: "TagValue", # required
- # },
- # ],
- # administration_role_arn: "RoleARN",
- # execution_role_name: "ExecutionRoleName",
- # permission_model: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, SELF_MANAGED
- # auto_deployment: {
- # enabled: false,
- # retain_stacks_on_account_removal: false,
- # },
- # client_request_token: "ClientRequestToken",
- # }
- #
# @!attribute [rw] stack_set_name
# The name to associate with the stack set. The name must be unique in
# the Region where you create your stack set.
@@ -1271,8 +1472,8 @@ module Aws::CloudFormation
# @!attribute [rw] template_body
# The structure that contains the template body, with a minimum length
# of 1 byte and a maximum length of 51,200 bytes. For more
- # information, see [Template Anatomy][1] in the AWS CloudFormation
- # User Guide.
+ # information, see [Template Anatomy][1] in the CloudFormation User
+ # Guide.
#
# Conditional: You must specify either the TemplateBody or the
# TemplateURL parameter, but not both.
@@ -1285,8 +1486,9 @@ module Aws::CloudFormation
# @!attribute [rw] template_url
# The location of the file that contains the template body. The URL
# must point to a template (maximum size: 460,800 bytes) that's
- # located in an Amazon S3 bucket. For more information, see [Template
- # Anatomy][1] in the AWS CloudFormation User Guide.
+ # located in an Amazon S3 bucket or a Systems Manager document. For
+ # more information, see [Template Anatomy][1] in the CloudFormation
+ # User Guide.
#
# Conditional: You must specify either the TemplateBody or the
# TemplateURL parameter, but not both.
@@ -1296,22 +1498,27 @@ module Aws::CloudFormation
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
# @return [String]
#
+ # @!attribute [rw] stack_id
+ # The stack ID you are importing into a new stack set. Specify the
+ # Amazon Resource Name (ARN) of the stack.
+ # @return [String]
+ #
# @!attribute [rw] parameters
# The input parameters for the stack set template.
# @return [Array<Types::Parameter>]
#
# @!attribute [rw] capabilities
# In some cases, you must explicitly acknowledge that your stack set
- # template contains certain capabilities in order for AWS
- # CloudFormation to create the stack set and related stack instances.
+ # template contains certain capabilities in order for CloudFormation
+ # to create the stack set and related stack instances.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stack sets,
- # you must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stack sets, you must explicitly acknowledge this by specifying one
+ # of these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -1321,7 +1528,7 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
+ # * If you don't specify either of these capabilities,
# CloudFormation returns an `InsufficientCapabilities` error.
#
# If your stack template contains these resources, we recommend that
@@ -1332,7 +1539,7 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::Group][2]
#
- # * [ AWS::IAM::InstanceProfile][3]
+ # * [AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
@@ -1340,27 +1547,28 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::User][6]
#
- # * [ AWS::IAM::UserToGroupAddition][7]
+ # * [AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
#
- # Some templates contain macros. If your stack template contains one
- # or more macros, and you choose to create a stack directly from the
- # processed template, without first reviewing the resulting changes
- # in a change set, you must acknowledge this capability. For more
- # information, see [Using AWS CloudFormation Macros to Perform
- # Custom Processing on Templates][9].
- #
- # <note markdown="1"> Stack sets do not currently support macros in stack templates.
- # (This includes the [AWS::Include][10] and [AWS::Serverless][11]
- # transforms, which are macros hosted by AWS CloudFormation.) Even
- # if you specify this capability, if you include a macro in your
- # template the stack set operation will fail.
+ # Some templates reference macros. If your stack set template
+ # references one or more macros, you must create the stack set
+ # directly from the processed template, without first reviewing the
+ # resulting changes in a change set. To create the stack set
+ # directly, you must acknowledge this capability. For more
+ # information, see [Using CloudFormation Macros to Perform Custom
+ # Processing on Templates][9].
#
- # </note>
+ # Stack sets with service-managed permissions don't currently
+ # support the use of macros in templates. (This includes the
+ # [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
+ # macros hosted by CloudFormation.) Even if you specify this
+ # capability for a stack set with service-managed permissions, if
+ # you reference a macro in your template the stack set operation
+ # will fail.
#
#
#
@@ -1379,11 +1587,11 @@ module Aws::CloudFormation
#
# @!attribute [rw] tags
# The key-value pairs to associate with this stack set and the stacks
- # created from it. AWS CloudFormation also propagates these tags to
+ # created from it. CloudFormation also propagates these tags to
# supported resources that are created in the stacks. A maximum number
# of 50 tags can be specified.
#
- # If you specify tags as part of a `CreateStackSet` action, AWS
+ # If you specify tags as part of a `CreateStackSet` action,
# CloudFormation checks to see if you have the required IAM permission
# to tag resources. If you don't, the entire `CreateStackSet` action
# fails with an `access denied` error, and the stack set is not
@@ -1391,14 +1599,14 @@ module Aws::CloudFormation
# @return [Array<Types::Tag>]
#
# @!attribute [rw] administration_role_arn
- # The Amazon Resource Number (ARN) of the IAM role to use to create
- # this stack set.
+ # The Amazon Resource Name (ARN) of the IAM role to use to create this
+ # stack set.
#
# Specify an IAM role only if you are using customized administrator
# roles to control which users or groups can manage specific stack
# sets within the same administrator account. For more information,
# see [Prerequisites: Granting Permissions for Stack Set
- # Operations][1] in the *AWS CloudFormation User Guide*.
+ # Operations][1] in the *CloudFormation User Guide*.
#
#
#
@@ -1407,7 +1615,7 @@ module Aws::CloudFormation
#
# @!attribute [rw] execution_role_name
# The name of the IAM execution role to use to create the stack set.
- # If you do not specify an execution role, AWS CloudFormation uses the
+ # If you do not specify an execution role, CloudFormation uses the
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
# operation.
#
@@ -1427,8 +1635,8 @@ module Aws::CloudFormation
#
# * With `service-managed` permissions, StackSets automatically
# creates the IAM roles required to deploy to accounts managed by
- # AWS Organizations. For more information, see [Grant
- # Service-Managed Stack Set Permissions][2].
+ # Organizations. For more information, see [Grant Service-Managed
+ # Stack Set Permissions][2].
#
#
#
@@ -1437,18 +1645,46 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] auto_deployment
- # Describes whether StackSets automatically deploys to AWS
- # Organizations accounts that are added to the target organization or
- # organizational unit (OU). Specify only if `PermissionModel` is
- # `SERVICE_MANAGED`.
+ # Describes whether StackSets automatically deploys to Organizations
+ # accounts that are added to the target organization or organizational
+ # unit (OU). Specify only if `PermissionModel` is `SERVICE_MANAGED`.
# @return [Types::AutoDeployment]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * To create a stack set with service-managed permissions while
+ # signed in to the management account, specify `SELF`.
+ #
+ # * To create a stack set with service-managed permissions while
+ # signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # admin in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ # Stack sets with service-managed permissions are created in the
+ # management account, including stack sets that are created by
+ # delegated administrators.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @!attribute [rw] client_request_token
# A unique identifier for this `CreateStackSet` request. Specify this
- # token if you plan to retry requests so that AWS CloudFormation knows
+ # token if you plan to retry requests so that CloudFormation knows
# that you're not attempting to create another stack set with the
# same name. You might retry `CreateStackSet` requests to ensure that
- # AWS CloudFormation successfully received them.
+ # CloudFormation successfully received them.
#
# If you don't specify an operation ID, the SDK generates one
# automatically.
@@ -1457,6 +1693,11 @@ module Aws::CloudFormation
# not need to pass this option.
# @return [String]
#
+ # @!attribute [rw] managed_execution
+ # Describes whether StackSets performs non-conflicting operations
+ # concurrently and queues conflicting operations.
+ # @return [Types::ManagedExecution]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackSetInput AWS API Documentation
#
class CreateStackSetInput < Struct.new(
@@ -1464,6 +1705,7 @@ module Aws::CloudFormation
:description,
:template_body,
:template_url,
+ :stack_id,
:parameters,
:capabilities,
:tags,
@@ -1471,7 +1713,9 @@ module Aws::CloudFormation
:execution_role_name,
:permission_model,
:auto_deployment,
- :client_request_token)
+ :call_as,
+ :client_request_token,
+ :managed_execution)
SENSITIVE = []
include Aws::Structure
end
@@ -1494,31 +1738,71 @@ module Aws::CloudFormation
#
class CreatedButModifiedException < Aws::EmptyStructure; end
- # The input for the DeleteChangeSet action.
+ # @api private
#
- # @note When making an API call, you may pass DeleteChangeSetInput
- # data as a hash:
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateOrganizationsAccessInput AWS API Documentation
#
- # {
- # change_set_name: "ChangeSetNameOrId", # required
- # stack_name: "StackNameOrId",
- # }
+ class DeactivateOrganizationsAccessInput < Aws::EmptyStructure; end
+
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateOrganizationsAccessOutput AWS API Documentation
#
- # @!attribute [rw] change_set_name
- # The name or Amazon Resource Name (ARN) of the change set that you
- # want to delete.
+ class DeactivateOrganizationsAccessOutput < Aws::EmptyStructure; end
+
+ # @!attribute [rw] type_name
+ # The type name of the extension, in this account and Region. If you
+ # specified a type name alias when enabling the extension, use the
+ # type name alias.
+ #
+ # Conditional: You must specify either `Arn`, or `TypeName` and
+ # `Type`.
# @return [String]
#
- # @!attribute [rw] stack_name
- # If you specified the name of a change set to delete, specify the
- # stack name or ID (ARN) that is associated with it.
+ # @!attribute [rw] type
+ # The extension type.
+ #
+ # Conditional: You must specify either `Arn`, or `TypeName` and
+ # `Type`.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteChangeSetInput AWS API Documentation
+ # @!attribute [rw] arn
+ # The Amazon Resource Name (ARN) for the extension, in this account
+ # and Region.
#
- class DeleteChangeSetInput < Struct.new(
- :change_set_name,
- :stack_name)
+ # Conditional: You must specify either `Arn`, or `TypeName` and
+ # `Type`.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateTypeInput AWS API Documentation
+ #
+ class DeactivateTypeInput < Struct.new(
+ :type_name,
+ :type,
+ :arn)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateTypeOutput AWS API Documentation
+ #
+ class DeactivateTypeOutput < Aws::EmptyStructure; end
+
+ # The input for the DeleteChangeSet action.
+ #
+ # @!attribute [rw] change_set_name
+ # The name or Amazon Resource Name (ARN) of the change set that you
+ # want to delete.
+ # @return [String]
+ #
+ # @!attribute [rw] stack_name
+ # If you specified the name of a change set to delete, specify the
+ # stack name or Amazon Resource Name (ARN) that's associated with it.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteChangeSetInput AWS API Documentation
+ #
+ class DeleteChangeSetInput < Struct.new(
+ :change_set_name,
+ :stack_name)
SENSITIVE = []
include Aws::Structure
end
@@ -1531,50 +1815,40 @@ module Aws::CloudFormation
# The input for DeleteStack action.
#
- # @note When making an API call, you may pass DeleteStackInput
- # data as a hash:
- #
- # {
- # stack_name: "StackName", # required
- # retain_resources: ["LogicalResourceId"],
- # role_arn: "RoleARN",
- # client_request_token: "ClientRequestToken",
- # }
- #
# @!attribute [rw] stack_name
- # The name or the unique stack ID that is associated with the stack.
+ # The name or the unique stack ID that's associated with the stack.
# @return [String]
#
# @!attribute [rw] retain_resources
# For stacks in the `DELETE_FAILED` state, a list of resource logical
# IDs that are associated with the resources you want to retain.
- # During deletion, AWS CloudFormation deletes the stack but does not
+ # During deletion, CloudFormation deletes the stack but doesn't
# delete the retained resources.
#
- # Retaining resources is useful when you cannot delete a resource,
+ # Retaining resources is useful when you can't delete a resource,
# such as a non-empty S3 bucket, but you want to delete the stack.
# @return [Array<String>]
#
# @!attribute [rw] role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to delete the
- # stack. AWS CloudFormation uses the role's credentials to make calls
- # on your behalf.
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to delete the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf.
#
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available,
- # AWS CloudFormation uses a temporary session that is generated from
- # your user credentials.
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
+ # CloudFormation uses a temporary session that's generated from your
+ # user credentials.
# @return [String]
#
# @!attribute [rw] client_request_token
# A unique identifier for this `DeleteStack` request. Specify this
- # token if you plan to retry requests so that AWS CloudFormation knows
+ # token if you plan to retry requests so that CloudFormation knows
# that you're not attempting to delete a stack with the same name.
- # You might retry `DeleteStack` requests to ensure that AWS
- # CloudFormation successfully received them.
+ # You might retry `DeleteStack` requests to ensure that CloudFormation
+ # successfully received them.
#
- # All events triggered by a given stack operation are assigned the
+ # All events initiated by a given stack operation are assigned the
# same client request token, which you can use to track operations.
# For example, if you execute a `CreateStack` operation with the token
# `token1`, then all the `StackEvents` generated by that operation
@@ -1600,53 +1874,32 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass DeleteStackInstancesInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # accounts: ["Account"],
- # deployment_targets: {
- # accounts: ["Account"],
- # organizational_unit_ids: ["OrganizationalUnitId"],
- # },
- # regions: ["Region"], # required
- # operation_preferences: {
- # region_order: ["Region"],
- # failure_tolerance_count: 1,
- # failure_tolerance_percentage: 1,
- # max_concurrent_count: 1,
- # max_concurrent_percentage: 1,
- # },
- # retain_stacks: false, # required
- # operation_id: "ClientRequestToken",
- # }
- #
# @!attribute [rw] stack_set_name
# The name or unique ID of the stack set that you want to delete stack
# instances for.
# @return [String]
#
# @!attribute [rw] accounts
- # \[`Self-managed` permissions\] The names of the AWS accounts that
- # you want to delete stack instances for.
+ # \[Self-managed permissions\] The names of the Amazon Web Services
+ # accounts that you want to delete stack instances for.
#
# You can specify `Accounts` or `DeploymentTargets`, but not both.
# @return [Array<String>]
#
# @!attribute [rw] deployment_targets
- # \[`Service-managed` permissions\] The AWS Organizations accounts
- # from which to delete stack instances.
+ # \[Service-managed permissions\] The Organizations accounts from
+ # which to delete stack instances.
#
# You can specify `Accounts` or `DeploymentTargets`, but not both.
# @return [Types::DeploymentTargets]
#
# @!attribute [rw] regions
- # The Regions where you want to delete stack set instances.
+ # The Amazon Web Services Regions where you want to delete stack set
+ # instances.
# @return [Array<String>]
#
# @!attribute [rw] operation_preferences
- # Preferences for how AWS CloudFormation performs this stack set
+ # Preferences for how CloudFormation performs this stack set
# operation.
# @return [Types::StackSetOperationPreferences]
#
@@ -1669,10 +1922,10 @@ module Aws::CloudFormation
# automatically.
#
# The operation ID also functions as an idempotency token, to ensure
- # that AWS CloudFormation performs the stack set operation only once,
- # even if you retry the request multiple times. You can retry stack
- # set operation requests to ensure that AWS CloudFormation
- # successfully received them.
+ # that CloudFormation performs the stack set operation only once, even
+ # if you retry the request multiple times. You can retry stack set
+ # operation requests to ensure that CloudFormation successfully
+ # received them.
#
# Repeating this stack set operation with a new operation ID retries
# all stack instances whose status is `OUTDATED`.
@@ -1681,6 +1934,29 @@ module Aws::CloudFormation
# not need to pass this option.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackInstancesInput AWS API Documentation
#
class DeleteStackInstancesInput < Struct.new(
@@ -1690,7 +1966,8 @@ module Aws::CloudFormation
:regions,
:operation_preferences,
:retain_stacks,
- :operation_id)
+ :operation_id,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -1707,22 +1984,39 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass DeleteStackSetInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # }
- #
# @!attribute [rw] stack_set_name
# The name or unique ID of the stack set that you're deleting. You
# can obtain this value by running ListStackSets.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackSetInput AWS API Documentation
#
class DeleteStackSetInput < Struct.new(
- :stack_set_name)
+ :stack_set_name,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -1731,79 +2025,91 @@ module Aws::CloudFormation
#
class DeleteStackSetOutput < Aws::EmptyStructure; end
- # \[`Service-managed` permissions\] The AWS Organizations accounts to
- # which StackSets deploys. StackSets does not deploy stack instances to
- # the organization master account, even if the master account is in your
- # organization or in an OU in your organization.
+ # \[Service-managed permissions\] The Organizations accounts to which
+ # StackSets deploys. StackSets doesn't deploy stack instances to the
+ # organization management account, even if the organization management
+ # account is in your organization or in an OU in your organization.
#
# For update operations, you can specify either `Accounts` or
# `OrganizationalUnitIds`. For create and delete operations, specify
# `OrganizationalUnitIds`.
#
- # @note When making an API call, you may pass DeploymentTargets
- # data as a hash:
- #
- # {
- # accounts: ["Account"],
- # organizational_unit_ids: ["OrganizationalUnitId"],
- # }
- #
# @!attribute [rw] accounts
- # The names of one or more AWS accounts for which you want to deploy
- # stack set updates.
+ # The names of one or more Amazon Web Services accounts for which you
+ # want to deploy stack set updates.
# @return [Array<String>]
#
+ # @!attribute [rw] accounts_url
+ # Returns the value of the `AccountsUrl` property.
+ # @return [String]
+ #
# @!attribute [rw] organizational_unit_ids
# The organization root ID or organizational unit (OU) IDs to which
# StackSets deploys.
# @return [Array<String>]
#
+ # @!attribute [rw] account_filter_type
+ # Limit deployment targets to individual accounts or include
+ # additional accounts with provided OUs.
+ #
+ # The following is a list of possible values for the
+ # `AccountFilterType` operation.
+ #
+ # * `INTERSECTION`: StackSets deploys to the accounts specified in
+ # `Accounts` parameter.
+ #
+ # * `DIFFERENCE`: StackSets excludes the accounts specified in
+ # `Accounts` parameter. This enables user to avoid certain accounts
+ # within an OU such as suspended accounts.
+ #
+ # * `UNION`: StackSets includes additional accounts deployment
+ # targets.
+ #
+ # This is the default value if `AccountFilterType` is not provided.
+ # This enables user to update an entire OU and individual accounts
+ # from a different OU in one request, which used to be two separate
+ # requests.
+ #
+ # * `NONE`: Deploys to all the accounts in specified organizational
+ # units (OU).
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeploymentTargets AWS API Documentation
#
class DeploymentTargets < Struct.new(
:accounts,
- :organizational_unit_ids)
+ :accounts_url,
+ :organizational_unit_ids,
+ :account_filter_type)
SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass DeregisterTypeInput
- # data as a hash:
- #
- # {
- # arn: "PrivateTypeArn",
- # type: "RESOURCE", # accepts RESOURCE
- # type_name: "TypeName",
- # version_id: "TypeVersionId",
- # }
- #
# @!attribute [rw] arn
- # The Amazon Resource Name (ARN) of the type.
+ # The Amazon Resource Name (ARN) of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or
# `Arn`.
# @return [String]
#
# @!attribute [rw] type
- # The kind of type.
- #
- # Currently the only valid value is `RESOURCE`.
+ # The kind of extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or
# `Arn`.
# @return [String]
#
# @!attribute [rw] type_name
- # The name of the type.
+ # The name of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or
# `Arn`.
# @return [String]
#
# @!attribute [rw] version_id
- # The ID of a specific version of the type. The version ID is the
+ # The ID of a specific version of the extension. The version ID is the
# value at the end of the Amazon Resource Name (ARN) assigned to the
- # type version when it is registered.
+ # extension version when it is registered.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeregisterTypeInput AWS API Documentation
@@ -1823,13 +2129,6 @@ module Aws::CloudFormation
# The input for the DescribeAccountLimits action.
#
- # @note When making an API call, you may pass DescribeAccountLimitsInput
- # data as a hash:
- #
- # {
- # next_token: "NextToken",
- # }
- #
# @!attribute [rw] next_token
# A string that identifies the next page of limits that you want to
# retrieve.
@@ -1846,7 +2145,7 @@ module Aws::CloudFormation
# The output for the DescribeAccountLimits action.
#
# @!attribute [rw] account_limits
- # An account limit structure that contain a list of AWS CloudFormation
+ # An account limit structure that contain a list of CloudFormation
# account limits and their values.
# @return [Array<Types::AccountLimit>]
#
@@ -1865,16 +2164,81 @@ module Aws::CloudFormation
include Aws::Structure
end
- # The input for the DescribeChangeSet action.
+ # @!attribute [rw] change_set_name
+ # The name or Amazon Resource Name (ARN) of the change set that you
+ # want to describe.
+ # @return [String]
+ #
+ # @!attribute [rw] stack_name
+ # If you specified the name of a change set, specify the stack name or
+ # stack ID (ARN) of the change set you want to describe.
+ # @return [String]
+ #
+ # @!attribute [rw] next_token
+ # A string, provided by the `DescribeChangeSetHooks` response output,
+ # that identifies the next page of information that you want to
+ # retrieve.
+ # @return [String]
+ #
+ # @!attribute [rw] logical_resource_id
+ # If specified, lists only the hooks related to the specified
+ # `LogicalResourceId`.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSetHooksInput AWS API Documentation
+ #
+ class DescribeChangeSetHooksInput < Struct.new(
+ :change_set_name,
+ :stack_name,
+ :next_token,
+ :logical_resource_id)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] change_set_id
+ # The change set identifier (stack ID).
+ # @return [String]
+ #
+ # @!attribute [rw] change_set_name
+ # The change set name.
+ # @return [String]
+ #
+ # @!attribute [rw] hooks
+ # List of hook objects.
+ # @return [Array<Types::ChangeSetHook>]
+ #
+ # @!attribute [rw] status
+ # Provides the status of the change set hook.
+ # @return [String]
#
- # @note When making an API call, you may pass DescribeChangeSetInput
- # data as a hash:
+ # @!attribute [rw] next_token
+ # Pagination token, `null` or empty if no more results.
+ # @return [String]
+ #
+ # @!attribute [rw] stack_id
+ # The stack identifier (stack ID).
+ # @return [String]
+ #
+ # @!attribute [rw] stack_name
+ # The stack name.
+ # @return [String]
#
- # {
- # change_set_name: "ChangeSetNameOrId", # required
- # stack_name: "StackNameOrId",
- # next_token: "NextToken",
- # }
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSetHooksOutput AWS API Documentation
+ #
+ class DescribeChangeSetHooksOutput < Struct.new(
+ :change_set_id,
+ :change_set_name,
+ :hooks,
+ :status,
+ :next_token,
+ :stack_id,
+ :stack_name)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The input for the DescribeChangeSet action.
#
# @!attribute [rw] change_set_name
# The name or Amazon Resource Name (ARN) of the change set that you
@@ -1908,15 +2272,16 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] change_set_id
- # The ARN of the change set.
+ # The Amazon Resource Name (ARN) of the change set.
# @return [String]
#
# @!attribute [rw] stack_id
- # The ARN of the stack that is associated with the change set.
+ # The Amazon Resource Name (ARN) of the stack that's associated with
+ # the change set.
# @return [String]
#
# @!attribute [rw] stack_name
- # The name of the stack that is associated with the change set.
+ # The name of the stack that's associated with the change set.
# @return [String]
#
# @!attribute [rw] description
@@ -1939,10 +2304,10 @@ module Aws::CloudFormation
#
# @!attribute [rw] execution_status
# If the change set execution status is `AVAILABLE`, you can execute
- # the change set. If you can’t execute the change set, the status
+ # the change set. If you can't execute the change set, the status
# indicates why. For example, a change set might be in an
- # `UNAVAILABLE` state because AWS CloudFormation is still creating it
- # or in an `OBSOLETE` state because the stack was already updated.
+ # `UNAVAILABLE` state because CloudFormation is still creating it or
+ # in an `OBSOLETE` state because the stack was already updated.
# @return [String]
#
# @!attribute [rw] status
@@ -1952,7 +2317,7 @@ module Aws::CloudFormation
#
# @!attribute [rw] status_reason
# A description of the change set's status. For example, if your
- # attempt to create a change set failed, AWS CloudFormation shows the
+ # attempt to create a change set failed, CloudFormation shows the
# error message.
# @return [String]
#
@@ -1963,7 +2328,7 @@ module Aws::CloudFormation
# @return [Array<String>]
#
# @!attribute [rw] rollback_configuration
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
# @return [Types::RollbackConfiguration]
@@ -1979,7 +2344,7 @@ module Aws::CloudFormation
# @return [Array<Types::Tag>]
#
# @!attribute [rw] changes
- # A list of `Change` structures that describes the resources AWS
+ # A list of `Change` structures that describes the resources
# CloudFormation changes if you execute the change set.
# @return [Array<Types::Change>]
#
@@ -1988,6 +2353,44 @@ module Aws::CloudFormation
# of changes. If there is no additional page, this value is null.
# @return [String]
#
+ # @!attribute [rw] include_nested_stacks
+ # Verifies if `IncludeNestedStacks` is set to `True`.
+ # @return [Boolean]
+ #
+ # @!attribute [rw] parent_change_set_id
+ # Specifies the change set ID of the parent change set in the current
+ # nested change set hierarchy.
+ # @return [String]
+ #
+ # @!attribute [rw] root_change_set_id
+ # Specifies the change set ID of the root change set in the current
+ # nested change set hierarchy.
+ # @return [String]
+ #
+ # @!attribute [rw] on_stack_failure
+ # Determines what action will be taken if stack creation fails. When
+ # this parameter is specified, the `DisableRollback` parameter to the
+ # [ExecuteChangeSet][1] API operation must not be specified. This must
+ # be one of these values:
+ #
+ # * `DELETE` - Deletes the change set if the stack creation fails.
+ # This is only valid when the `ChangeSetType` parameter is set to
+ # `CREATE`. If the deletion of the stack fails, the status of the
+ # stack is `DELETE_FAILED`.
+ #
+ # * `DO_NOTHING` - if the stack creation fails, do nothing. This is
+ # equivalent to specifying `true` for the `DisableRollback`
+ # parameter to the [ExecuteChangeSet][1] API operation.
+ #
+ # * `ROLLBACK` - if the stack creation fails, roll back the stack.
+ # This is equivalent to specifying `false` for the `DisableRollback`
+ # parameter to the [ExecuteChangeSet][1] API operation.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSetOutput AWS API Documentation
#
class DescribeChangeSetOutput < Struct.new(
@@ -2006,24 +2409,108 @@ module Aws::CloudFormation
:capabilities,
:tags,
:changes,
- :next_token)
+ :next_token,
+ :include_nested_stacks,
+ :parent_change_set_id,
+ :root_change_set_id,
+ :on_stack_failure)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeOrganizationsAccessInput AWS API Documentation
+ #
+ class DescribeOrganizationsAccessInput < Struct.new(
+ :call_as)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] status
+ # Presents the status of the `OrganizationAccess`.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeOrganizationsAccessOutput AWS API Documentation
+ #
+ class DescribeOrganizationsAccessOutput < Struct.new(
+ :status)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] publisher_id
+ # The ID of the extension publisher.
+ #
+ # If you don't supply a `PublisherId`, and you have registered as an
+ # extension publisher, `DescribePublisher` returns information about
+ # your own publisher account.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribePublisherInput AWS API Documentation
+ #
+ class DescribePublisherInput < Struct.new(
+ :publisher_id)
SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass DescribeStackDriftDetectionStatusInput
- # data as a hash:
+ # @!attribute [rw] publisher_id
+ # The ID of the extension publisher.
+ # @return [String]
+ #
+ # @!attribute [rw] publisher_status
+ # Whether the publisher is verified. Currently, all registered
+ # publishers are verified.
+ # @return [String]
+ #
+ # @!attribute [rw] identity_provider
+ # The type of account used as the identity provider when registering
+ # this publisher with CloudFormation.
+ # @return [String]
+ #
+ # @!attribute [rw] publisher_profile
+ # The URL to the publisher's profile with the identity provider.
+ # @return [String]
#
- # {
- # stack_drift_detection_id: "StackDriftDetectionId", # required
- # }
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribePublisherOutput AWS API Documentation
#
+ class DescribePublisherOutput < Struct.new(
+ :publisher_id,
+ :publisher_status,
+ :identity_provider,
+ :publisher_profile)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# @!attribute [rw] stack_drift_detection_id
# The ID of the drift detection results of this operation.
#
- # AWS CloudFormation generates new results, with a new drift detection
- # ID, each time this operation is run. However, the number of drift
- # results AWS CloudFormation retains for any given stack, and for how
+ # CloudFormation generates new results, with a new drift detection ID,
+ # each time this operation is run. However, the number of drift
+ # results CloudFormation retains for any given stack, and for how
# long, may vary.
# @return [String]
#
@@ -2042,47 +2529,47 @@ module Aws::CloudFormation
# @!attribute [rw] stack_drift_detection_id
# The ID of the drift detection results of this operation.
#
- # AWS CloudFormation generates new results, with a new drift detection
- # ID, each time this operation is run. However, the number of reports
- # AWS CloudFormation retains for any given stack, and for how long,
- # may vary.
+ # CloudFormation generates new results, with a new drift detection ID,
+ # each time this operation is run. However, the number of reports
+ # CloudFormation retains for any given stack, and for how long, may
+ # vary.
# @return [String]
#
# @!attribute [rw] stack_drift_status
# Status of the stack's actual configuration compared to its expected
# configuration.
#
- # * `DRIFTED`\: The stack differs from its expected template
+ # * `DRIFTED`: The stack differs from its expected template
# configuration. A stack is considered to have drifted if one or
# more of its resources have drifted.
#
- # * `NOT_CHECKED`\: AWS CloudFormation has not checked if the stack
- # differs from its expected template configuration.
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the stack differs
+ # from its expected template configuration.
#
- # * `IN_SYNC`\: The stack's actual configuration matches its expected
+ # * `IN_SYNC`: The stack's actual configuration matches its expected
# template configuration.
#
- # * `UNKNOWN`\: This value is reserved for future use.
+ # * `UNKNOWN`: This value is reserved for future use.
# @return [String]
#
# @!attribute [rw] detection_status
# The status of the stack drift detection operation.
#
- # * `DETECTION_COMPLETE`\: The stack drift detection operation has
+ # * `DETECTION_COMPLETE`: The stack drift detection operation has
# successfully completed for all resources in the stack that support
- # drift detection. (Resources that do not currently support stack
+ # drift detection. (Resources that don't currently support stack
# detection remain unchecked.)
#
- # If you specified logical resource IDs for AWS CloudFormation to
- # use as a filter for the stack drift detection operation, only the
+ # If you specified logical resource IDs for CloudFormation to use as
+ # a filter for the stack drift detection operation, only the
# resources with those logical IDs are checked for drift.
#
- # * `DETECTION_FAILED`\: The stack drift detection operation has
- # failed for at least one resource in the stack. Results will be
- # available for resources on which AWS CloudFormation successfully
- # completed drift detection.
+ # * `DETECTION_FAILED`: The stack drift detection operation has failed
+ # for at least one resource in the stack. Results will be available
+ # for resources on which CloudFormation successfully completed drift
+ # detection.
#
- # * `DETECTION_IN_PROGRESS`\: The stack drift detection operation is
+ # * `DETECTION_IN_PROGRESS`: The stack drift detection operation is
# currently in progress.
# @return [String]
#
@@ -2118,17 +2605,9 @@ module Aws::CloudFormation
# The input for DescribeStackEvents action.
#
- # @note When making an API call, you may pass DescribeStackEventsInput
- # data as a hash:
- #
- # {
- # stack_name: "StackName",
- # next_token: "NextToken",
- # }
- #
# @!attribute [rw] stack_name
- # The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # The name or the unique stack ID that's associated with the stack,
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -2173,35 +2652,50 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass DescribeStackInstanceInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # stack_instance_account: "Account", # required
- # stack_instance_region: "Region", # required
- # }
- #
# @!attribute [rw] stack_set_name
# The name or the unique stack ID of the stack set that you want to
# get stack instance information for.
# @return [String]
#
# @!attribute [rw] stack_instance_account
- # The ID of an AWS account that's associated with this stack
- # instance.
+ # The ID of an Amazon Web Services account that's associated with
+ # this stack instance.
# @return [String]
#
# @!attribute [rw] stack_instance_region
# The name of a Region that's associated with this stack instance.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackInstanceInput AWS API Documentation
#
class DescribeStackInstanceInput < Struct.new(
:stack_set_name,
:stack_instance_account,
- :stack_instance_region)
+ :stack_instance_region,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -2218,16 +2712,6 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass DescribeStackResourceDriftsInput
- # data as a hash:
- #
- # {
- # stack_name: "StackNameOrId", # required
- # stack_resource_drift_status_filters: ["IN_SYNC"], # accepts IN_SYNC, MODIFIED, DELETED, NOT_CHECKED
- # next_token: "NextToken",
- # max_results: 1,
- # }
- #
# @!attribute [rw] stack_name
# The name of the stack for which you want drift information.
# @return [String]
@@ -2236,16 +2720,16 @@ module Aws::CloudFormation
# The resource drift status values to use as filters for the resource
# drift results returned.
#
- # * `DELETED`\: The resource differs from its expected template
+ # * `DELETED`: The resource differs from its expected template
# configuration in that the resource has been deleted.
#
- # * `MODIFIED`\: One or more resource properties differ from their
+ # * `MODIFIED`: One or more resource properties differ from their
# expected template values.
#
- # * `IN_SYNC`\: The resources's actual configuration matches its
+ # * `IN_SYNC`: The resource's actual configuration matches its
# expected template configuration.
#
- # * `NOT_CHECKED`\: AWS CloudFormation does not currently return this
+ # * `NOT_CHECKED`: CloudFormation doesn't currently return this
# value.
# @return [Array<String>]
#
@@ -2275,13 +2759,13 @@ module Aws::CloudFormation
# @!attribute [rw] stack_resource_drifts
# Drift information for the resources that have been checked for drift
# in the specified stack. This includes actual and expected
- # configuration values for resources where AWS CloudFormation detects
+ # configuration values for resources where CloudFormation detects
# drift.
#
# For a given stack, there will be one `StackResourceDrift` for each
- # stack resource that has been checked for drift. Resources that have
- # not yet been checked for drift are not included. Resources that do
- # not currently support drift detection are not checked, and so not
+ # stack resource that has been checked for drift. Resources that
+ # haven't yet been checked for drift aren't included. Resources that
+ # do not currently support drift detection aren't checked, and so not
# included. For a list of resources that support drift detection, see
# [Resources that Support Drift Detection][1].
#
@@ -2291,7 +2775,7 @@ module Aws::CloudFormation
# @return [Array<Types::StackResourceDrift>]
#
# @!attribute [rw] next_token
- # If the request doesn't return all of the remaining results,
+ # If the request doesn't return all the remaining results,
# `NextToken` is set to a token. To retrieve the next set of results,
# call `DescribeStackResourceDrifts` again and assign that token to
# the request object's `NextToken` parameter. If the request returns
@@ -2309,17 +2793,9 @@ module Aws::CloudFormation
# The input for DescribeStackResource action.
#
- # @note When making an API call, you may pass DescribeStackResourceInput
- # data as a hash:
- #
- # {
- # stack_name: "StackName", # required
- # logical_resource_id: "LogicalResourceId", # required
- # }
- #
# @!attribute [rw] stack_name
- # The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # The name or the unique stack ID that's associated with the stack,
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -2361,18 +2837,9 @@ module Aws::CloudFormation
# The input for DescribeStackResources action.
#
- # @note When making an API call, you may pass DescribeStackResourcesInput
- # data as a hash:
- #
- # {
- # stack_name: "StackName",
- # logical_resource_id: "LogicalResourceId",
- # physical_resource_id: "PhysicalResourceId",
- # }
- #
# @!attribute [rw] stack_name
# The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -2381,7 +2848,7 @@ module Aws::CloudFormation
#
# Default: There is no default value.
#
- # Required: Conditional. If you do not specify `StackName`, you must
+ # Required: Conditional. If you don't specify `StackName`, you must
# specify `PhysicalResourceId`.
# @return [String]
#
@@ -2393,7 +2860,7 @@ module Aws::CloudFormation
#
# @!attribute [rw] physical_resource_id
# The name or unique identifier that corresponds to a physical
- # instance ID of a resource supported by AWS CloudFormation.
+ # instance ID of a resource supported by CloudFormation.
#
# For example, for an Amazon Elastic Compute Cloud (EC2) instance,
# `PhysicalResourceId` corresponds to the `InstanceId`. You can pass
@@ -2401,7 +2868,7 @@ module Aws::CloudFormation
# the instance belongs to and what other resources are part of the
# stack.
#
- # Required: Conditional. If you do not specify `PhysicalResourceId`,
+ # Required: Conditional. If you don't specify `PhysicalResourceId`,
# you must specify `StackName`.
#
# Default: There is no default value.
@@ -2431,33 +2898,42 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass DescribeStackSetInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # }
- #
# @!attribute [rw] stack_set_name
# The name or unique ID of the stack set whose description you want.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSetInput AWS API Documentation
#
class DescribeStackSetInput < Struct.new(
- :stack_set_name)
+ :stack_set_name,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass DescribeStackSetOperationInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # operation_id: "ClientRequestToken", # required
- # }
- #
# @!attribute [rw] stack_set_name
# The name or the unique stack ID of the stack set for the stack
# operation.
@@ -2467,11 +2943,35 @@ module Aws::CloudFormation
# The unique ID of the stack set operation.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSetOperationInput AWS API Documentation
#
class DescribeStackSetOperationInput < Struct.new(
:stack_set_name,
- :operation_id)
+ :operation_id,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -2502,17 +3002,24 @@ module Aws::CloudFormation
# The input for DescribeStacks action.
#
- # @note When making an API call, you may pass DescribeStacksInput
- # data as a hash:
+ # @!attribute [rw] stack_name
+ # <note markdown="1"> If you don't pass a parameter to `StackName`, the API returns a
+ # response that describes all resources in the account. This requires
+ # `ListStacks` and `DescribeStacks` permissions.
#
- # {
- # stack_name: "StackName",
- # next_token: "NextToken",
- # }
+ # The IAM policy below can be added to IAM policies when you want to
+ # limit resource-level permissions and avoid returning a response when
+ # no parameter is sent in the request:
#
- # @!attribute [rw] stack_name
- # The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # \\\{ "Version": "2012-10-17", "Statement": \[\\\{ "Effect":
+ # "Deny", "Action": "cloudformation:DescribeStacks",
+ # "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" \\}\]
+ # \\}
+ #
+ # </note>
+ #
+ # The name or the unique stack ID that's associated with the stack,
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -2557,47 +3064,46 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass DescribeTypeInput
- # data as a hash:
- #
- # {
- # type: "RESOURCE", # accepts RESOURCE
- # type_name: "TypeName",
- # arn: "TypeArn",
- # version_id: "TypeVersionId",
- # }
- #
# @!attribute [rw] type
- # The kind of type.
- #
- # Currently the only valid value is `RESOURCE`.
+ # The kind of extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or
# `Arn`.
# @return [String]
#
# @!attribute [rw] type_name
- # The name of the type.
+ # The name of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or
# `Arn`.
# @return [String]
#
# @!attribute [rw] arn
- # The Amazon Resource Name (ARN) of the type.
+ # The Amazon Resource Name (ARN) of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or
# `Arn`.
# @return [String]
#
# @!attribute [rw] version_id
- # The ID of a specific version of the type. The version ID is the
+ # The ID of a specific version of the extension. The version ID is the
# value at the end of the Amazon Resource Name (ARN) assigned to the
- # type version when it is registered.
+ # extension version when it is registered.
#
# If you specify a `VersionId`, `DescribeType` returns information
- # about that specific type version. Otherwise, it returns information
- # about the default type version.
+ # about that specific extension version. Otherwise, it returns
+ # information about the default extension version.
+ # @return [String]
+ #
+ # @!attribute [rw] publisher_id
+ # The publisher ID of the extension publisher.
+ #
+ # Extensions provided by Amazon Web Services are not assigned a
+ # publisher ID.
+ # @return [String]
+ #
+ # @!attribute [rw] public_version_number
+ # The version number of a public third-party extension.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeInput AWS API Documentation
@@ -2606,44 +3112,107 @@ module Aws::CloudFormation
:type,
:type_name,
:arn,
- :version_id)
+ :version_id,
+ :publisher_id,
+ :public_version_number)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] arn
- # The Amazon Resource Name (ARN) of the type.
+ # The Amazon Resource Name (ARN) of the extension.
# @return [String]
#
# @!attribute [rw] type
- # The kind of type.
- #
- # Currently the only valid value is `RESOURCE`.
+ # The kind of extension.
# @return [String]
#
# @!attribute [rw] type_name
- # The name of the registered type.
+ # The name of the extension.
+ #
+ # If the extension is a public third-party type you have activated
+ # with a type name alias, CloudFormation returns the type name alias.
+ # For more information, see [ActivateType][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
# @return [String]
#
# @!attribute [rw] default_version_id
- # The ID of the default version of the type. The default version is
- # used when the type version is not specified.
+ # The ID of the default version of the extension. The default version
+ # is used when the extension version isn't specified.
+ #
+ # This applies only to private extensions you have registered in your
+ # account. For public extensions, both those provided by Amazon Web
+ # Services and published by third parties, CloudFormation returns
+ # `null`. For more information, see [RegisterType][1].
+ #
+ # To set the default version of an extension, use
+ # SetTypeDefaultVersion.
#
- # To set the default version of a type, use ` SetTypeDefaultVersion `.
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
# @return [String]
#
# @!attribute [rw] is_default_version
- # Whether the specified type version is set as the default version.
+ # Whether the specified extension version is set as the default
+ # version.
+ #
+ # This applies only to private extensions you have registered in your
+ # account, and extensions published by Amazon Web Services. For public
+ # third-party extensions, whether they are activated in your account,
+ # CloudFormation returns `null`.
# @return [Boolean]
#
+ # @!attribute [rw] type_tests_status
+ # The contract test status of the registered extension version. To
+ # return the extension test status of a specific extension version,
+ # you must specify `VersionId`.
+ #
+ # This applies only to registered private extension versions.
+ # CloudFormation doesn't return this information for public
+ # extensions, whether they are activated in your account.
+ #
+ # * `PASSED`: The extension has passed all its contract tests.
+ #
+ # An extension must have a test status of `PASSED` before it can be
+ # published. For more information, see [Publishing extensions to
+ # make them available for public use][1] in the *CloudFormation
+ # Command Line Interface User Guide*.
+ #
+ # * `FAILED`: The extension has failed one or more contract tests.
+ #
+ # * `IN_PROGRESS`: Contract tests are currently being performed on the
+ # extension.
+ #
+ # * `NOT_TESTED`: Contract tests haven't been performed on the
+ # extension.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html
+ # @return [String]
+ #
+ # @!attribute [rw] type_tests_status_description
+ # The description of the test status. To return the extension test
+ # status of a specific extension version, you must specify
+ # `VersionId`.
+ #
+ # This applies only to registered private extension versions.
+ # CloudFormation doesn't return this information for public
+ # extensions, whether they are activated in your account.
+ # @return [String]
+ #
# @!attribute [rw] description
- # The description of the registered type.
+ # The description of the extension.
# @return [String]
#
# @!attribute [rw] schema
- # The schema that defines the type.
+ # The schema that defines the extension.
#
- # For more information on type schemas, see [Resource Provider
+ # For more information about extension schemas, see [Resource Provider
# Schema][1] in the *CloudFormation CLI User Guide*.
#
#
@@ -2652,21 +3221,22 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] provisioning_type
- # The provisioning behavior of the type. AWS CloudFormation determines
- # the provisioning type during registration, based on the types of
- # handlers in the schema handler package submitted.
+ # For resource type extensions, the provisioning behavior of the
+ # resource type. CloudFormation determines the provisioning type
+ # during registration, based on the types of handlers in the schema
+ # handler package submitted.
#
# Valid values include:
#
- # * `FULLY_MUTABLE`\: The type includes an update handler to process
- # updates to the type during stack update operations.
+ # * `FULLY_MUTABLE`: The resource type includes an update handler to
+ # process updates to the type during stack update operations.
#
- # * `IMMUTABLE`\: The type does not include an update handler, so the
- # type cannot be updated and must instead be replaced during stack
- # update operations.
+ # * `IMMUTABLE`: The resource type doesn't include an update handler,
+ # so the type can't be updated and must instead be replaced during
+ # stack update operations.
#
- # * `NON_PROVISIONABLE`\: The type does not include all of the
- # following handlers, and therefore cannot actually be provisioned.
+ # * `NON_PROVISIONABLE`: The resource type doesn't include all the
+ # following handlers, and therefore can't actually be provisioned.
#
# * create
#
@@ -2676,63 +3246,184 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] deprecated_status
- # The deprecation status of the type.
+ # The deprecation status of the extension version.
#
# Valid values include:
#
- # * `LIVE`\: The type is registered and can be used in CloudFormation
- # operations, dependent on its provisioning behavior and visibility
- # scope.
+ # * `LIVE`: The extension is activated or registered and can be used
+ # in CloudFormation operations, dependent on its provisioning
+ # behavior and visibility scope.
+ #
+ # * `DEPRECATED`: The extension has been deactivated or deregistered
+ # and can no longer be used in CloudFormation operations.
#
- # * `DEPRECATED`\: The type has been deregistered and can no longer be
- # used in CloudFormation operations.
+ # For public third-party extensions, CloudFormation returns `null`.
# @return [String]
#
# @!attribute [rw] logging_config
- # Contains logging configuration information for a type.
+ # Contains logging configuration information for private extensions.
+ # This applies only to private extensions you have registered in your
+ # account. For public extensions, both those provided by Amazon Web
+ # Services and published by third parties, CloudFormation returns
+ # `null`. For more information, see [RegisterType][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
# @return [Types::LoggingConfig]
#
+ # @!attribute [rw] required_activated_types
+ # For extensions that are modules, the public third-party extensions
+ # that must be activated in your account in order for the module
+ # itself to be activated.
+ # @return [Array<Types::RequiredActivatedType>]
+ #
# @!attribute [rw] execution_role_arn
# The Amazon Resource Name (ARN) of the IAM execution role used to
- # register the type. If your resource type calls AWS APIs in any of
- # its handlers, you must create an <i> <a
+ # register the extension. This applies only to private extensions you
+ # have registered in your account. For more information, see
+ # [RegisterType][1].
+ #
+ # If the registered extension calls any Amazon Web Services APIs, you
+ # must create an <i> <a
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
# execution role</a> </i> that includes the necessary permissions to
- # call those AWS APIs, and provision that execution role in your
- # account. CloudFormation then assumes that execution role to provide
- # your resource type with the appropriate credentials.
+ # call those Amazon Web Services APIs, and provision that execution
+ # role in your account. CloudFormation then assumes that execution
+ # role to provide your extension with the appropriate credentials.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
# @return [String]
#
# @!attribute [rw] visibility
- # The scope at which the type is visible and usable in CloudFormation
- # operations.
+ # The scope at which the extension is visible and usable in
+ # CloudFormation operations.
#
# Valid values include:
#
- # * `PRIVATE`\: The type is only visible and usable within the account
- # in which it is registered. Currently, AWS CloudFormation marks any
- # types you register as `PRIVATE`.
+ # * `PRIVATE`: The extension is only visible and usable within the
+ # account in which it is registered. CloudFormation marks any
+ # extensions you register as `PRIVATE`.
#
- # * `PUBLIC`\: The type is publically visible and usable within any
- # Amazon account.
+ # * `PUBLIC`: The extension is publicly visible and usable within any
+ # Amazon Web Services account.
# @return [String]
#
# @!attribute [rw] source_url
- # The URL of the source code for the type.
+ # The URL of the source code for the extension.
# @return [String]
#
# @!attribute [rw] documentation_url
- # The URL of a page providing detailed documentation for this type.
+ # The URL of a page providing detailed documentation for this
+ # extension.
# @return [String]
#
# @!attribute [rw] last_updated
- # When the specified type version was registered.
+ # When the specified extension version was registered. This applies
+ # only to:
+ #
+ # * Private extensions you have registered in your account. For more
+ # information, see [RegisterType][1].
+ #
+ # * Public extensions you have activated in your account with
+ # auto-update specified. For more information, see
+ # [ActivateType][2].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
# @return [Time]
#
# @!attribute [rw] time_created
- # When the specified type version was registered.
+ # When the specified private extension version was registered or
+ # activated in your account.
# @return [Time]
#
+ # @!attribute [rw] configuration_schema
+ # A JSON string that represent the current configuration data for the
+ # extension in this account and Region.
+ #
+ # To set the configuration data for an extension, use
+ # [SetTypeConfiguration][1]. For more information, see [Configuring
+ # extensions at the account level][2] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
+ # @return [String]
+ #
+ # @!attribute [rw] publisher_id
+ # The publisher ID of the extension publisher.
+ #
+ # This applies only to public third-party extensions. For private
+ # registered extensions, and extensions provided by Amazon Web
+ # Services, CloudFormation returns `null`.
+ # @return [String]
+ #
+ # @!attribute [rw] original_type_name
+ # For public extensions that have been activated for this account and
+ # Region, the type name of the public extension.
+ #
+ # If you specified a `TypeNameAlias` when enabling the extension in
+ # this account and Region, CloudFormation treats that alias as the
+ # extension's type name within the account and Region, not the type
+ # name of the public extension. For more information, see [Specifying
+ # aliases to refer to extensions][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
+ # @return [String]
+ #
+ # @!attribute [rw] original_type_arn
+ # For public extensions that have been activated for this account and
+ # Region, the Amazon Resource Name (ARN) of the public extension.
+ # @return [String]
+ #
+ # @!attribute [rw] public_version_number
+ # The version number of a public third-party extension.
+ #
+ # This applies only if you specify a public extension you have
+ # activated in your account, or specify a public extension without
+ # specifying a version. For all other extensions, CloudFormation
+ # returns `null`.
+ # @return [String]
+ #
+ # @!attribute [rw] latest_public_version
+ # The latest version of a public extension *that is available* for
+ # use.
+ #
+ # This only applies if you specify a public extension, and you don't
+ # specify a version. For all other requests, CloudFormation returns
+ # `null`.
+ # @return [String]
+ #
+ # @!attribute [rw] is_activated
+ # Whether the extension is activated in the account and Region.
+ #
+ # This only applies to public third-party extensions. For all other
+ # extensions, CloudFormation returns `null`.
+ # @return [Boolean]
+ #
+ # @!attribute [rw] auto_update
+ # Whether CloudFormation automatically updates the extension in this
+ # account and Region when a new *minor* version is published by the
+ # extension publisher. Major versions released by the publisher must
+ # be manually updated. For more information, see [Activating public
+ # extensions for use in your account][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable
+ # @return [Boolean]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeOutput AWS API Documentation
#
class DescribeTypeOutput < Struct.new(
@@ -2741,33 +3432,37 @@ module Aws::CloudFormation
:type_name,
:default_version_id,
:is_default_version,
+ :type_tests_status,
+ :type_tests_status_description,
:description,
:schema,
:provisioning_type,
:deprecated_status,
:logging_config,
+ :required_activated_types,
:execution_role_arn,
:visibility,
:source_url,
:documentation_url,
:last_updated,
- :time_created)
+ :time_created,
+ :configuration_schema,
+ :publisher_id,
+ :original_type_name,
+ :original_type_arn,
+ :public_version_number,
+ :latest_public_version,
+ :is_activated,
+ :auto_update)
SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass DescribeTypeRegistrationInput
- # data as a hash:
- #
- # {
- # registration_token: "RegistrationToken", # required
- # }
- #
# @!attribute [rw] registration_token
# The identifier for this registration request.
#
# This registration token is generated by CloudFormation when you
- # initiate a registration request using ` RegisterType `.
+ # initiate a registration request using RegisterType.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeRegistrationInput AWS API Documentation
@@ -2779,23 +3474,23 @@ module Aws::CloudFormation
end
# @!attribute [rw] progress_status
- # The current status of the type registration request.
+ # The current status of the extension registration request.
# @return [String]
#
# @!attribute [rw] description
- # The description of the type registration request.
+ # The description of the extension registration request.
# @return [String]
#
# @!attribute [rw] type_arn
- # The Amazon Resource Name (ARN) of the type being registered.
+ # The Amazon Resource Name (ARN) of the extension being registered.
#
# For registration requests with a `ProgressStatus` of other than
# `COMPLETE`, this will be `null`.
# @return [String]
#
# @!attribute [rw] type_version_arn
- # The Amazon Resource Name (ARN) of this specific version of the type
- # being registered.
+ # The Amazon Resource Name (ARN) of this specific version of the
+ # extension being registered.
#
# For registration requests with a `ProgressStatus` of other than
# `COMPLETE`, this will be `null`.
@@ -2812,14 +3507,6 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass DetectStackDriftInput
- # data as a hash:
- #
- # {
- # stack_name: "StackNameOrId", # required
- # logical_resource_ids: ["LogicalResourceId"],
- # }
- #
# @!attribute [rw] stack_name
# The name of the stack for which you want to detect drift.
# @return [String]
@@ -2840,9 +3527,9 @@ module Aws::CloudFormation
# @!attribute [rw] stack_drift_detection_id
# The ID of the drift detection results of this operation.
#
- # AWS CloudFormation generates new results, with a new drift detection
- # ID, each time this operation is run. However, the number of drift
- # results AWS CloudFormation retains for any given stack, and for how
+ # CloudFormation generates new results, with a new drift detection ID,
+ # each time this operation is run. However, the number of drift
+ # results CloudFormation retains for any given stack, and for how
# long, may vary.
# @return [String]
#
@@ -2854,14 +3541,6 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass DetectStackResourceDriftInput
- # data as a hash:
- #
- # {
- # stack_name: "StackNameOrId", # required
- # logical_resource_id: "LogicalResourceId", # required
- # }
- #
# @!attribute [rw] stack_name
# The name of the stack to which the resource belongs.
# @return [String]
@@ -2894,31 +3573,16 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass DetectStackSetDriftInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetNameOrId", # required
- # operation_preferences: {
- # region_order: ["Region"],
- # failure_tolerance_count: 1,
- # failure_tolerance_percentage: 1,
- # max_concurrent_count: 1,
- # max_concurrent_percentage: 1,
- # },
- # operation_id: "ClientRequestToken",
- # }
- #
# @!attribute [rw] stack_set_name
# The name of the stack set on which to perform the drift detection
# operation.
# @return [String]
#
# @!attribute [rw] operation_preferences
- # The user-specified preferences for how AWS CloudFormation performs a
+ # The user-specified preferences for how CloudFormation performs a
# stack set operation.
#
- # For more information on maximum concurrent accounts and failure
+ # For more information about maximum concurrent accounts and failure
# tolerance, see [Stack set operation options][1].
#
#
@@ -2933,12 +3597,36 @@ module Aws::CloudFormation
# not need to pass this option.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackSetDriftInput AWS API Documentation
#
class DetectStackSetDriftInput < Struct.new(
:stack_set_name,
:operation_preferences,
- :operation_id)
+ :operation_id,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -2946,7 +3634,7 @@ module Aws::CloudFormation
# @!attribute [rw] operation_id
# The ID of the drift detection stack set operation.
#
- # you can use this operation id with ` DescribeStackSetOperation ` to
+ # You can use this operation ID with DescribeStackSetOperation to
# monitor the progress of the drift detection operation.
# @return [String]
#
@@ -2960,26 +3648,10 @@ module Aws::CloudFormation
# The input for an EstimateTemplateCost action.
#
- # @note When making an API call, you may pass EstimateTemplateCostInput
- # data as a hash:
- #
- # {
- # template_body: "TemplateBody",
- # template_url: "TemplateURL",
- # parameters: [
- # {
- # parameter_key: "ParameterKey",
- # parameter_value: "ParameterValue",
- # use_previous_value: false,
- # resolved_value: "ParameterValue",
- # },
- # ],
- # }
- #
# @!attribute [rw] template_body
# Structure containing the template body with a minimum length of 1
# byte and a maximum length of 51,200 bytes. (For more information, go
- # to [Template Anatomy][1] in the AWS CloudFormation User Guide.)
+ # to [Template Anatomy][1] in the CloudFormation User Guide.)
#
# Conditional: You must pass `TemplateBody` or `TemplateURL`. If both
# are passed, only `TemplateBody` is used.
@@ -2991,9 +3663,9 @@ module Aws::CloudFormation
#
# @!attribute [rw] template_url
# Location of file containing the template body. The URL must point to
- # a template that is located in an Amazon S3 bucket. For more
- # information, go to [Template Anatomy][1] in the AWS CloudFormation
- # User Guide.
+ # a template that's located in an Amazon S3 bucket or a Systems
+ # Manager document. For more information, go to [Template Anatomy][1]
+ # in the CloudFormation User Guide.
#
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
# are passed, only `TemplateBody` is used.
@@ -3020,8 +3692,8 @@ module Aws::CloudFormation
# The output for a EstimateTemplateCost action.
#
# @!attribute [rw] url
- # An AWS Simple Monthly Calculator URL with a query string that
- # describes the resources required to run the template.
+ # An Amazon Web Services Simple Monthly Calculator URL with a query
+ # string that describes the resources required to run the template.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/EstimateTemplateCostOutput AWS API Documentation
@@ -3034,40 +3706,53 @@ module Aws::CloudFormation
# The input for the ExecuteChangeSet action.
#
- # @note When making an API call, you may pass ExecuteChangeSetInput
- # data as a hash:
- #
- # {
- # change_set_name: "ChangeSetNameOrId", # required
- # stack_name: "StackNameOrId",
- # client_request_token: "ClientRequestToken",
- # }
- #
# @!attribute [rw] change_set_name
- # The name or ARN of the change set that you want use to update the
- # specified stack.
+ # The name or Amazon Resource Name (ARN) of the change set that you
+ # want use to update the specified stack.
# @return [String]
#
# @!attribute [rw] stack_name
# If you specified the name of a change set, specify the stack name or
- # ID (ARN) that is associated with the change set you want to execute.
+ # Amazon Resource Name (ARN) that's associated with the change set
+ # you want to execute.
# @return [String]
#
# @!attribute [rw] client_request_token
# A unique identifier for this `ExecuteChangeSet` request. Specify
- # this token if you plan to retry requests so that AWS CloudFormation
+ # this token if you plan to retry requests so that CloudFormation
# knows that you're not attempting to execute a change set to update
# a stack with the same name. You might retry `ExecuteChangeSet`
- # requests to ensure that AWS CloudFormation successfully received
- # them.
+ # requests to ensure that CloudFormation successfully received them.
# @return [String]
#
+ # @!attribute [rw] disable_rollback
+ # Preserves the state of previously provisioned resources when an
+ # operation fails. This parameter can't be specified when the
+ # `OnStackFailure` parameter to the [CreateChangeSet][1] API operation
+ # was specified.
+ #
+ # * `True` - if the stack creation fails, do nothing. This is
+ # equivalent to specifying `DO_NOTHING` for the `OnStackFailure`
+ # parameter to the [CreateChangeSet][1] API operation.
+ #
+ # * `False` - if the stack creation fails, roll back the stack. This
+ # is equivalent to specifying `ROLLBACK` for the `OnStackFailure`
+ # parameter to the [CreateChangeSet][1] API operation.
+ #
+ # Default: `True`
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html
+ # @return [Boolean]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ExecuteChangeSetInput AWS API Documentation
#
class ExecuteChangeSetInput < Struct.new(
:change_set_name,
:stack_name,
- :client_request_token)
+ :client_request_token,
+ :disable_rollback)
SENSITIVE = []
include Aws::Structure
end
@@ -3110,15 +3795,8 @@ module Aws::CloudFormation
# The input for the GetStackPolicy action.
#
- # @note When making an API call, you may pass GetStackPolicyInput
- # data as a hash:
- #
- # {
- # stack_name: "StackName", # required
- # }
- #
# @!attribute [rw] stack_name
- # The name or unique stack ID that is associated with the stack whose
+ # The name or unique stack ID that's associated with the stack whose
# policy you want to get.
# @return [String]
#
@@ -3134,8 +3812,8 @@ module Aws::CloudFormation
#
# @!attribute [rw] stack_policy_body
# Structure containing the stack policy body. (For more information,
- # go to [ Prevent Updates to Stack Resources][1] in the AWS
- # CloudFormation User Guide.)
+ # go to [ Prevent Updates to Stack Resources][1] in the CloudFormation
+ # User Guide.)
#
#
#
@@ -3152,18 +3830,9 @@ module Aws::CloudFormation
# The input for a GetTemplate action.
#
- # @note When making an API call, you may pass GetTemplateInput
- # data as a hash:
- #
- # {
- # stack_name: "StackName",
- # change_set_name: "ChangeSetNameOrId",
- # template_stage: "Original", # accepts Original, Processed
- # }
- #
# @!attribute [rw] stack_name
- # The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # The name or the unique stack ID that's associated with the stack,
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -3174,20 +3843,20 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] change_set_name
- # The name or Amazon Resource Name (ARN) of a change set for which AWS
+ # The name or Amazon Resource Name (ARN) of a change set for which
# CloudFormation returns the associated template. If you specify a
# name, you must also specify the `StackName`.
# @return [String]
#
# @!attribute [rw] template_stage
# For templates that include transforms, the stage of the template
- # that AWS CloudFormation returns. To get the user-submitted template,
- # specify `Original`. To get the template after AWS CloudFormation has
+ # that CloudFormation returns. To get the user-submitted template,
+ # specify `Original`. To get the template after CloudFormation has
# processed all transforms, specify `Processed`.
#
# If the template doesn't include transforms, `Original` and
- # `Processed` return the same template. By default, AWS CloudFormation
- # specifies `Original`.
+ # `Processed` return the same template. By default, CloudFormation
+ # specifies `Processed`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplateInput AWS API Documentation
@@ -3204,9 +3873,9 @@ module Aws::CloudFormation
#
# @!attribute [rw] template_body
# Structure containing the template body. (For more information, go to
- # [Template Anatomy][1] in the AWS CloudFormation User Guide.)
+ # [Template Anatomy][1] in the CloudFormation User Guide.)
#
- # AWS CloudFormation returns the same template that was used when the
+ # CloudFormation returns the same template that was used when the
# stack was created.
#
#
@@ -3217,7 +3886,7 @@ module Aws::CloudFormation
# @!attribute [rw] stages_available
# The stage of the template that you can retrieve. For stacks, the
# `Original` and `Processed` templates are always available. For
- # change sets, the `Original` template is always available. After AWS
+ # change sets, the `Original` template is always available. After
# CloudFormation finishes creating the change set, the `Processed`
# template becomes available.
# @return [Array<String>]
@@ -3233,20 +3902,10 @@ module Aws::CloudFormation
# The input for the GetTemplateSummary action.
#
- # @note When making an API call, you may pass GetTemplateSummaryInput
- # data as a hash:
- #
- # {
- # template_body: "TemplateBody",
- # template_url: "TemplateURL",
- # stack_name: "StackNameOrId",
- # stack_set_name: "StackSetNameOrId",
- # }
- #
# @!attribute [rw] template_body
# Structure containing the template body with a minimum length of 1
# byte and a maximum length of 51,200 bytes. For more information
- # about templates, see [Template Anatomy][1] in the AWS CloudFormation
+ # about templates, see [Template anatomy][1] in the CloudFormation
# User Guide.
#
# Conditional: You must specify only one of the following parameters:
@@ -3259,9 +3918,10 @@ module Aws::CloudFormation
#
# @!attribute [rw] template_url
# Location of file containing the template body. The URL must point to
- # a template (max size: 460,800 bytes) that is located in an Amazon S3
- # bucket. For more information about templates, see [Template
- # Anatomy][1] in the AWS CloudFormation User Guide.
+ # a template (max size: 460,800 bytes) that's located in an Amazon S3
+ # bucket or a Systems Manager document. For more information about
+ # templates, see [Template anatomy][1] in the CloudFormation User
+ # Guide.
#
# Conditional: You must specify only one of the following parameters:
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
@@ -3272,8 +3932,8 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] stack_name
- # The name or the stack ID that is associated with the stack, which
- # are not always interchangeable. For running stacks, you can specify
+ # The name or the stack ID that's associated with the stack, which
+ # aren't always interchangeable. For running stacks, you can specify
# either the stack's name or its unique stack ID. For deleted stack,
# you must specify the unique stack ID.
#
@@ -3289,13 +3949,37 @@ module Aws::CloudFormation
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplateSummaryInput AWS API Documentation
#
class GetTemplateSummaryInput < Struct.new(
:template_body,
:template_url,
:stack_name,
- :stack_set_name)
+ :stack_set_name,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -3308,18 +3992,18 @@ module Aws::CloudFormation
# @return [Array<Types::ParameterDeclaration>]
#
# @!attribute [rw] description
- # The value that is defined in the `Description` property of the
+ # The value that's defined in the `Description` property of the
# template.
# @return [String]
#
# @!attribute [rw] capabilities
# The capabilities found within the template. If your template
- # contains IAM resources, you must specify the CAPABILITY\_IAM or
- # CAPABILITY\_NAMED\_IAM value for this parameter when you use the
+ # contains IAM resources, you must specify the `CAPABILITY_IAM` or
+ # `CAPABILITY_NAMED_IAM` value for this parameter when you use the
# CreateStack or UpdateStack actions with your template; otherwise,
- # those actions return an InsufficientCapabilities error.
+ # those actions return an `InsufficientCapabilities` error.
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][1].
#
#
@@ -3339,12 +4023,12 @@ module Aws::CloudFormation
# @return [Array<String>]
#
# @!attribute [rw] version
- # The AWS template format version, which identifies the capabilities
- # of the template.
+ # The Amazon Web Services template format version, which identifies
+ # the capabilities of the template.
# @return [String]
#
# @!attribute [rw] metadata
- # The value that is defined for the `Metadata` property of the
+ # The value that's defined for the `Metadata` property of the
# template.
# @return [String]
#
@@ -3376,6 +4060,83 @@ module Aws::CloudFormation
include Aws::Structure
end
+ # @!attribute [rw] stack_set_name
+ # The name of the stack set. The name must be unique in the Region
+ # where you create your stack set.
+ # @return [String]
+ #
+ # @!attribute [rw] stack_ids
+ # The IDs of the stacks you are importing into a stack set. You import
+ # up to 10 stacks per stack set at a time.
+ #
+ # Specify either `StackIds` or `StackIdsUrl`.
+ # @return [Array<String>]
+ #
+ # @!attribute [rw] stack_ids_url
+ # The Amazon S3 URL which contains list of stack ids to be inputted.
+ #
+ # Specify either `StackIds` or `StackIdsUrl`.
+ # @return [String]
+ #
+ # @!attribute [rw] organizational_unit_ids
+ # The list of OU ID's to which the stacks being imported has to be
+ # mapped as deployment target.
+ # @return [Array<String>]
+ #
+ # @!attribute [rw] operation_preferences
+ # The user-specified preferences for how CloudFormation performs a
+ # stack set operation.
+ #
+ # For more information about maximum concurrent accounts and failure
+ # tolerance, see [Stack set operation options][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
+ # @return [Types::StackSetOperationPreferences]
+ #
+ # @!attribute [rw] operation_id
+ # A unique, user defined, identifier for the stack set operation.
+ #
+ # **A suitable default value is auto-generated.** You should normally
+ # not need to pass this option.
+ # @return [String]
+ #
+ # @!attribute [rw] call_as
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * For service managed stack sets, specify `DELEGATED_ADMIN`.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSetInput AWS API Documentation
+ #
+ class ImportStacksToStackSetInput < Struct.new(
+ :stack_set_name,
+ :stack_ids,
+ :stack_ids_url,
+ :organizational_unit_ids,
+ :operation_preferences,
+ :operation_id,
+ :call_as)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] operation_id
+ # The unique identifier for the stack set operation.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSetOutput AWS API Documentation
+ #
+ class ImportStacksToStackSetOutput < Struct.new(
+ :operation_id)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# The template contains resources with capabilities that weren't
# specified in the Capabilities parameter.
#
@@ -3398,7 +4159,7 @@ module Aws::CloudFormation
class InvalidOperationException < Aws::EmptyStructure; end
# Error reserved for use by the [CloudFormation CLI][1]. CloudFormation
- # does not return this error to users.
+ # doesn't return this error to users.
#
#
#
@@ -3410,8 +4171,8 @@ module Aws::CloudFormation
# The quota for the resource has already been reached.
#
- # For information on resource and stack limitations, see [Limits][1] in
- # the *AWS CloudFormation User Guide*.
+ # For information about resource and stack limitations, see
+ # [CloudFormation quotas][1] in the *CloudFormation User Guide*.
#
#
#
@@ -3423,14 +4184,6 @@ module Aws::CloudFormation
# The input for the ListChangeSets action.
#
- # @note When making an API call, you may pass ListChangeSetsInput
- # data as a hash:
- #
- # {
- # stack_name: "StackNameOrId", # required
- # next_token: "NextToken",
- # }
- #
# @!attribute [rw] stack_name
# The name or the Amazon Resource Name (ARN) of the stack for which
# you want to list change sets.
@@ -3459,7 +4212,8 @@ module Aws::CloudFormation
#
# @!attribute [rw] next_token
# If the output exceeds 1 MB, a string that identifies the next page
- # of change sets. If there is no additional page, this value is null.
+ # of change sets. If there is no additional page, this value is
+ # `null`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListChangeSetsOutput AWS API Documentation
@@ -3471,13 +4225,6 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass ListExportsInput
- # data as a hash:
- #
- # {
- # next_token: "NextToken",
- # }
- #
# @!attribute [rw] next_token
# A string (provided by the ListExports response output) that
# identifies the next page of exported output values that you asked to
@@ -3511,17 +4258,9 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass ListImportsInput
- # data as a hash:
- #
- # {
- # export_name: "ExportName", # required
- # next_token: "NextToken",
- # }
- #
# @!attribute [rw] export_name
- # The name of the exported output value. AWS CloudFormation returns
- # the stack names that are importing this value.
+ # The name of the exported output value. CloudFormation returns the
+ # stack names that are importing this value.
# @return [String]
#
# @!attribute [rw] next_token
@@ -3558,30 +4297,13 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass ListStackInstancesInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # next_token: "NextToken",
- # max_results: 1,
- # filters: [
- # {
- # name: "DETAILED_STATUS", # accepts DETAILED_STATUS
- # values: "StackInstanceFilterValues",
- # },
- # ],
- # stack_instance_account: "Account",
- # stack_instance_region: "Region",
- # }
- #
# @!attribute [rw] stack_set_name
# The name or unique ID of the stack set that you want to list stack
# instances for.
# @return [String]
#
# @!attribute [rw] next_token
- # If the previous request didn't return all of the remaining results,
+ # If the previous request didn't return all the remaining results,
# the response's `NextToken` parameter value is set to a token. To
# retrieve the next set of results, call `ListStackInstances` again
# and assign that token to the request object's `NextToken`
@@ -3597,18 +4319,41 @@ module Aws::CloudFormation
# @return [Integer]
#
# @!attribute [rw] filters
- # The status that stack instances are filtered by.
+ # The filter to apply to stack instances
# @return [Array<Types::StackInstanceFilter>]
#
# @!attribute [rw] stack_instance_account
- # The name of the AWS account that you want to list stack instances
- # for.
+ # The name of the Amazon Web Services account that you want to list
+ # stack instances for.
# @return [String]
#
# @!attribute [rw] stack_instance_region
# The name of the Region where you want to list stack instances.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstancesInput AWS API Documentation
#
class ListStackInstancesInput < Struct.new(
@@ -3617,7 +4362,8 @@ module Aws::CloudFormation
:max_results,
:filters,
:stack_instance_account,
- :stack_instance_region)
+ :stack_instance_region,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -3628,7 +4374,7 @@ module Aws::CloudFormation
# @return [Array<Types::StackInstanceSummary>]
#
# @!attribute [rw] next_token
- # If the request doesn't return all of the remaining results,
+ # If the request doesn't return all the remaining results,
# `NextToken` is set to a token. To retrieve the next set of results,
# call `ListStackInstances` again and assign that token to the request
# object's `NextToken` parameter. If the request returns all results,
@@ -3646,17 +4392,9 @@ module Aws::CloudFormation
# The input for the ListStackResource action.
#
- # @note When making an API call, you may pass ListStackResourcesInput
- # data as a hash:
- #
- # {
- # stack_name: "StackName", # required
- # next_token: "NextToken",
- # }
- #
# @!attribute [rw] stack_name
# The name or the unique stack ID that is associated with the stack,
- # which are not always interchangeable:
+ # which aren't always interchangeable:
#
# * Running stacks: You can specify either the stack's name or its
# unique stack ID.
@@ -3701,16 +4439,6 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass ListStackSetOperationResultsInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # operation_id: "ClientRequestToken", # required
- # next_token: "NextToken",
- # max_results: 1,
- # }
- #
# @!attribute [rw] stack_set_name
# The name or unique ID of the stack set that you want to get
# operation results for.
@@ -3721,7 +4449,7 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] next_token
- # If the previous request didn't return all of the remaining results,
+ # If the previous request didn't return all the remaining results,
# the response object's `NextToken` parameter value is set to a
# token. To retrieve the next set of results, call
# `ListStackSetOperationResults` again and assign that token to the
@@ -3737,13 +4465,42 @@ module Aws::CloudFormation
# request parameter to get the next set of results.
# @return [Integer]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
+ # @!attribute [rw] filters
+ # The filter to apply to operation results.
+ # @return [Array<Types::OperationResultFilter>]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperationResultsInput AWS API Documentation
#
class ListStackSetOperationResultsInput < Struct.new(
:stack_set_name,
:operation_id,
:next_token,
- :max_results)
+ :max_results,
+ :call_as,
+ :filters)
SENSITIVE = []
include Aws::Structure
end
@@ -3751,7 +4508,7 @@ module Aws::CloudFormation
# @!attribute [rw] summaries
# A list of `StackSetOperationResultSummary` structures that contain
# information about the specified operation results, for accounts and
- # Regions that are included in the operation.
+ # Amazon Web Services Regions that are included in the operation.
# @return [Array<Types::StackSetOperationResultSummary>]
#
# @!attribute [rw] next_token
@@ -3771,15 +4528,6 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass ListStackSetOperationsInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # next_token: "NextToken",
- # max_results: 1,
- # }
- #
# @!attribute [rw] stack_set_name
# The name or unique ID of the stack set that you want to get
# operation summaries for.
@@ -3802,12 +4550,36 @@ module Aws::CloudFormation
# request parameter to get the next set of results.
# @return [Integer]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperationsInput AWS API Documentation
#
class ListStackSetOperationsInput < Struct.new(
:stack_set_name,
:next_token,
- :max_results)
+ :max_results,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -3834,19 +4606,10 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass ListStackSetsInput
- # data as a hash:
- #
- # {
- # next_token: "NextToken",
- # max_results: 1,
- # status: "ACTIVE", # accepts ACTIVE, DELETED
- # }
- #
# @!attribute [rw] next_token
- # If the previous paginated request didn't return all of the
- # remaining results, the response object's `NextToken` parameter
- # value is set to a token. To retrieve the next set of results, call
+ # If the previous paginated request didn't return all the remaining
+ # results, the response object's `NextToken` parameter value is set
+ # to a token. To retrieve the next set of results, call
# `ListStackSets` again and assign that token to the request object's
# `NextToken` parameter. If there are no remaining results, the
# previous response object's `NextToken` parameter is set to `null`.
@@ -3864,12 +4627,36 @@ module Aws::CloudFormation
# information about.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the management account or as a delegated
+ # administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetsInput AWS API Documentation
#
class ListStackSetsInput < Struct.new(
:next_token,
:max_results,
- :status)
+ :status,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -3898,14 +4685,6 @@ module Aws::CloudFormation
# The input for ListStacks action.
#
- # @note When making an API call, you may pass ListStacksInput
- # data as a hash:
- #
- # {
- # next_token: "NextToken",
- # stack_status_filter: ["CREATE_IN_PROGRESS"], # accepts CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE, REVIEW_IN_PROGRESS, IMPORT_IN_PROGRESS, IMPORT_COMPLETE, IMPORT_ROLLBACK_IN_PROGRESS, IMPORT_ROLLBACK_FAILED, IMPORT_ROLLBACK_COMPLETE
- # }
- #
# @!attribute [rw] next_token
# A string that identifies the next page of stacks that you want to
# retrieve.
@@ -3949,43 +4728,29 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass ListTypeRegistrationsInput
- # data as a hash:
- #
- # {
- # type: "RESOURCE", # accepts RESOURCE
- # type_name: "TypeName",
- # type_arn: "TypeArn",
- # registration_status_filter: "COMPLETE", # accepts COMPLETE, IN_PROGRESS, FAILED
- # max_results: 1,
- # next_token: "NextToken",
- # }
- #
# @!attribute [rw] type
- # The kind of type.
- #
- # Currently the only valid value is `RESOURCE`.
+ # The kind of extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or
# `Arn`.
# @return [String]
#
# @!attribute [rw] type_name
- # The name of the type.
+ # The name of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or
# `Arn`.
# @return [String]
#
# @!attribute [rw] type_arn
- # The Amazon Resource Name (ARN) of the type.
+ # The Amazon Resource Name (ARN) of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or
# `Arn`.
# @return [String]
#
# @!attribute [rw] registration_status_filter
- # The current status of the type registration request.
+ # The current status of the extension registration request.
#
# The default is `IN_PROGRESS`.
# @return [String]
@@ -3998,12 +4763,12 @@ module Aws::CloudFormation
# @return [Integer]
#
# @!attribute [rw] next_token
- # If the previous paginated request didn't return all of the
- # remaining results, the response object's `NextToken` parameter
- # value is set to a token. To retrieve the next set of results, call
- # this action again and assign that token to the request object's
- # `NextToken` parameter. If there are no remaining results, the
- # previous response object's `NextToken` parameter is set to `null`.
+ # If the previous paginated request didn't return all the remaining
+ # results, the response object's `NextToken` parameter value is set
+ # to a token. To retrieve the next set of results, call this action
+ # again and assign that token to the request object's `NextToken`
+ # parameter. If there are no remaining results, the previous response
+ # object's `NextToken` parameter is set to `null`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeRegistrationsInput AWS API Documentation
@@ -4020,14 +4785,14 @@ module Aws::CloudFormation
end
# @!attribute [rw] registration_token_list
- # A list of type registration tokens.
+ # A list of extension registration tokens.
#
- # Use ` DescribeTypeRegistration ` to return detailed information
- # about a type registration request.
+ # Use DescribeTypeRegistration to return detailed information about a
+ # type registration request.
# @return [Array<String>]
#
# @!attribute [rw] next_token
- # If the request doesn't return all of the remaining results,
+ # If the request doesn't return all the remaining results,
# `NextToken` is set to a token. To retrieve the next set of results,
# call this action again and assign that token to the request
# object's `NextToken` parameter. If the request returns all results,
@@ -4043,36 +4808,23 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass ListTypeVersionsInput
- # data as a hash:
- #
- # {
- # type: "RESOURCE", # accepts RESOURCE
- # type_name: "TypeName",
- # arn: "PrivateTypeArn",
- # max_results: 1,
- # next_token: "NextToken",
- # deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
- # }
- #
# @!attribute [rw] type
- # The kind of the type.
- #
- # Currently the only valid value is `RESOURCE`.
+ # The kind of the extension.
#
# Conditional: You must specify either `TypeName` and `Type`, or
# `Arn`.
# @return [String]
#
# @!attribute [rw] type_name
- # The name of the type for which you want version summary information.
+ # The name of the extension for which you want version summary
+ # information.
#
# Conditional: You must specify either `TypeName` and `Type`, or
# `Arn`.
# @return [String]
#
# @!attribute [rw] arn
- # The Amazon Resource Name (ARN) of the type for which you want
+ # The Amazon Resource Name (ARN) of the extension for which you want
# version summary information.
#
# Conditional: You must specify either `TypeName` and `Type`, or
@@ -4096,21 +4848,27 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] deprecated_status
- # The deprecation status of the type versions that you want to get
- # summary information about.
+ # The deprecation status of the extension versions that you want to
+ # get summary information about.
#
# Valid values include:
#
- # * `LIVE`\: The type version is registered and can be used in
+ # * `LIVE`: The extension version is registered and can be used in
# CloudFormation operations, dependent on its provisioning behavior
# and visibility scope.
#
- # * `DEPRECATED`\: The type version has been deregistered and can no
- # longer be used in CloudFormation operations.
+ # * `DEPRECATED`: The extension version has been deregistered and can
+ # no longer be used in CloudFormation operations.
#
# The default is `LIVE`.
# @return [String]
#
+ # @!attribute [rw] publisher_id
+ # The publisher ID of the extension publisher.
+ #
+ # Extensions published by Amazon aren't assigned a publisher ID.
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeVersionsInput AWS API Documentation
#
class ListTypeVersionsInput < Struct.new(
@@ -4119,14 +4877,15 @@ module Aws::CloudFormation
:arn,
:max_results,
:next_token,
- :deprecated_status)
+ :deprecated_status,
+ :publisher_id)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] type_version_summaries
# A list of `TypeVersionSummary` structures that contain information
- # about the specified type's versions.
+ # about the specified extension's versions.
# @return [Array<Types::TypeVersionSummary>]
#
# @!attribute [rw] next_token
@@ -4146,64 +4905,77 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass ListTypesInput
- # data as a hash:
- #
- # {
- # visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
- # provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
- # deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
- # max_results: 1,
- # next_token: "NextToken",
- # }
- #
# @!attribute [rw] visibility
- # The scope at which the type is visible and usable in CloudFormation
- # operations.
+ # The scope at which the extensions are visible and usable in
+ # CloudFormation operations.
#
# Valid values include:
#
- # * `PRIVATE`\: The type is only visible and usable within the account
- # in which it is registered. Currently, AWS CloudFormation marks any
- # types you create as `PRIVATE`.
+ # * `PRIVATE`: Extensions that are visible and usable within this
+ # account and Region. This includes:
#
- # * `PUBLIC`\: The type is publically visible and usable within any
- # Amazon account.
+ # * Private extensions you have registered in this account and
+ # Region.
+ #
+ # * Public extensions that you have activated in this account and
+ # Region.
+ #
+ # * `PUBLIC`: Extensions that are publicly visible and available to be
+ # activated within any Amazon Web Services account. This includes
+ # extensions from Amazon Web Services, in addition to third-party
+ # publishers.
#
# The default is `PRIVATE`.
# @return [String]
#
# @!attribute [rw] provisioning_type
- # The provisioning behavior of the type. AWS CloudFormation determines
- # the provisioning type during registration, based on the types of
- # handlers in the schema handler package submitted.
+ # For resource types, the provisioning behavior of the resource type.
+ # CloudFormation determines the provisioning type during registration,
+ # based on the types of handlers in the schema handler package
+ # submitted.
#
# Valid values include:
#
- # * `FULLY_MUTABLE`\: The type includes an update handler to process
- # updates to the type during stack update operations.
+ # * `FULLY_MUTABLE`: The resource type includes an update handler to
+ # process updates to the type during stack update operations.
#
- # * `IMMUTABLE`\: The type does not include an update handler, so the
- # type cannot be updated and must instead be replaced during stack
- # update operations.
+ # * `IMMUTABLE`: The resource type doesn't include an update handler,
+ # so the type can't be updated and must instead be replaced during
+ # stack update operations.
#
- # * `NON_PROVISIONABLE`\: The type does not include create, read, and
- # delete handlers, and therefore cannot actually be provisioned.
+ # * `NON_PROVISIONABLE`: The resource type doesn't include create,
+ # read, and delete handlers, and therefore can't actually be
+ # provisioned.
+ #
+ # The default is `FULLY_MUTABLE`.
# @return [String]
#
# @!attribute [rw] deprecated_status
- # The deprecation status of the types that you want to get summary
+ # The deprecation status of the extension that you want to get summary
# information about.
#
# Valid values include:
#
- # * `LIVE`\: The type is registered for use in CloudFormation
+ # * `LIVE`: The extension is registered for use in CloudFormation
# operations.
#
- # * `DEPRECATED`\: The type has been deregistered and can no longer be
- # used in CloudFormation operations.
+ # * `DEPRECATED`: The extension has been deregistered and can no
+ # longer be used in CloudFormation operations.
+ # @return [String]
+ #
+ # @!attribute [rw] type
+ # The type of extension.
# @return [String]
#
+ # @!attribute [rw] filters
+ # Filter criteria to use in determining which extensions to return.
+ #
+ # Filters must be compatible with `Visibility` to return valid
+ # results. For example, specifying `AWS_TYPES` for `Category` and
+ # `PRIVATE` for `Visibility` returns an empty list of types, but
+ # specifying `PUBLIC` for `Visibility` returns the desired list.
+ # @return [Types::TypeFilters]
+ #
# @!attribute [rw] max_results
# The maximum number of results to be returned with a single call. If
# the number of available results exceeds this maximum, the response
@@ -4212,12 +4984,12 @@ module Aws::CloudFormation
# @return [Integer]
#
# @!attribute [rw] next_token
- # If the previous paginated request didn't return all of the
- # remaining results, the response object's `NextToken` parameter
- # value is set to a token. To retrieve the next set of results, call
- # this action again and assign that token to the request object's
- # `NextToken` parameter. If there are no remaining results, the
- # previous response object's `NextToken` parameter is set to `null`.
+ # If the previous paginated request didn't return all the remaining
+ # results, the response object's `NextToken` parameter value is set
+ # to a token. To retrieve the next set of results, call this action
+ # again and assign that token to the request object's `NextToken`
+ # parameter. If there are no remaining results, the previous response
+ # object's `NextToken` parameter is set to `null`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypesInput AWS API Documentation
@@ -4226,6 +4998,8 @@ module Aws::CloudFormation
:visibility,
:provisioning_type,
:deprecated_status,
+ :type,
+ :filters,
:max_results,
:next_token)
SENSITIVE = []
@@ -4234,11 +5008,11 @@ module Aws::CloudFormation
# @!attribute [rw] type_summaries
# A list of `TypeSummary` structures that contain information about
- # the specified types.
+ # the specified extensions.
# @return [Array<Types::TypeSummary>]
#
# @!attribute [rw] next_token
- # If the request doesn't return all of the remaining results,
+ # If the request doesn't return all the remaining results,
# `NextToken` is set to a token. To retrieve the next set of results,
# call this action again and assign that token to the request
# object's `NextToken` parameter. If the request returns all results,
@@ -4254,24 +5028,16 @@ module Aws::CloudFormation
include Aws::Structure
end
- # Contains logging configuration information for a type.
- #
- # @note When making an API call, you may pass LoggingConfig
- # data as a hash:
- #
- # {
- # log_role_arn: "RoleArn", # required
- # log_group_name: "LogGroupName", # required
- # }
+ # Contains logging configuration information for an extension.
#
# @!attribute [rw] log_role_arn
- # The ARN of the role that CloudFormation should assume when sending
- # log entries to CloudWatch logs.
+ # The Amazon Resource Name (ARN) of the role that CloudFormation
+ # should assume when sending log entries to CloudWatch Logs.
# @return [String]
#
# @!attribute [rw] log_group_name
- # The Amazon CloudWatch log group to which CloudFormation sends error
- # logging information when invoking the type's handlers.
+ # The Amazon CloudWatch Logs group to which CloudFormation sends error
+ # logging information when invoking the extension's handlers.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/LoggingConfig AWS API Documentation
@@ -4283,6 +5049,86 @@ module Aws::CloudFormation
include Aws::Structure
end
+ # Describes whether StackSets performs non-conflicting operations
+ # concurrently and queues conflicting operations.
+ #
+ # @!attribute [rw] active
+ # When `true`, StackSets performs non-conflicting operations
+ # concurrently and queues conflicting operations. After conflicting
+ # operations finish, StackSets starts queued operations in request
+ # order.
+ #
+ # <note markdown="1"> If there are already running or queued operations, StackSets queues
+ # all incoming operations even if they are non-conflicting.
+ #
+ # You can't modify your stack set's execution configuration while
+ # there are running or queued operations for that stack set.
+ #
+ # </note>
+ #
+ # When `false` (default), StackSets performs one operation at a time
+ # in request order.
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ManagedExecution AWS API Documentation
+ #
+ class ManagedExecution < Struct.new(
+ :active)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # Contains information about the module from which the resource was
+ # created, if the resource was created from a module included in the
+ # stack template.
+ #
+ # For more information about modules, see [Using modules to encapsulate
+ # and reuse resource configurations][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html
+ #
+ # @!attribute [rw] type_hierarchy
+ # A concatenated list of the module type or types containing the
+ # resource. Module types are listed starting with the inner-most
+ # nested module, and separated by `/`.
+ #
+ # In the following example, the resource was created from a module of
+ # type `AWS::First::Example::MODULE`, that's nested inside a parent
+ # module of type `AWS::Second::Example::MODULE`.
+ #
+ # `AWS::First::Example::MODULE/AWS::Second::Example::MODULE`
+ # @return [String]
+ #
+ # @!attribute [rw] logical_id_hierarchy
+ # A concatenated list of the logical IDs of the module or modules
+ # containing the resource. Modules are listed starting with the
+ # inner-most nested module, and separated by `/`.
+ #
+ # In the following example, the resource was created from a module,
+ # `moduleA`, that's nested inside a parent module, `moduleB`.
+ #
+ # `moduleA/moduleB`
+ #
+ # For more information, see [Referencing resources in a module][1] in
+ # the *CloudFormation User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-ref-resources
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ModuleInfo AWS API Documentation
+ #
+ class ModuleInfo < Struct.new(
+ :type_hierarchy,
+ :logical_id_hierarchy)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# The specified name is already in use.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/NameAlreadyExistsException AWS API Documentation
@@ -4308,8 +5154,27 @@ module Aws::CloudFormation
#
class OperationNotFoundException < Aws::EmptyStructure; end
+ # The status that operation results are filtered by.
+ #
+ # @!attribute [rw] name
+ # The type of filter to apply.
+ # @return [String]
+ #
+ # @!attribute [rw] values
+ # The value to filter by.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/OperationResultFilter AWS API Documentation
+ #
+ class OperationResultFilter < Struct.new(
+ :name,
+ :values)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# Error reserved for use by the [CloudFormation CLI][1]. CloudFormation
- # does not return this error to users.
+ # doesn't return this error to users.
#
#
#
@@ -4350,20 +5215,10 @@ module Aws::CloudFormation
# The Parameter data type.
#
- # @note When making an API call, you may pass Parameter
- # data as a hash:
- #
- # {
- # parameter_key: "ParameterKey",
- # parameter_value: "ParameterValue",
- # use_previous_value: false,
- # resolved_value: "ParameterValue",
- # }
- #
# @!attribute [rw] parameter_key
# The key associated with the parameter. If you don't specify a key
- # and value for a particular parameter, AWS CloudFormation uses the
- # default value that is specified in your template.
+ # and value for a particular parameter, CloudFormation uses the
+ # default value that's specified in your template.
# @return [String]
#
# @!attribute [rw] parameter_value
@@ -4377,9 +5232,9 @@ module Aws::CloudFormation
# @return [Boolean]
#
# @!attribute [rw] resolved_value
- # Read-only. The value that corresponds to a Systems Manager parameter
- # key. This field is returned only for [ `SSM` parameter types][1] in
- # the template.
+ # Read-only. The value that corresponds to a SSM parameter key. This
+ # field is returned only for [ SSM][1] parameter types in the
+ # template.
#
#
#
@@ -4397,10 +5252,9 @@ module Aws::CloudFormation
include Aws::Structure
end
- # A set of criteria that AWS CloudFormation uses to validate parameter
+ # A set of criteria that CloudFormation uses to validate parameter
# values. Although other constraints might be defined in the stack
- # template, AWS CloudFormation returns only the `AllowedValues`
- # property.
+ # template, CloudFormation returns only the `AllowedValues` property.
#
# @!attribute [rw] allowed_values
# A list of values that are permitted for a parameter.
@@ -4417,7 +5271,7 @@ module Aws::CloudFormation
# The ParameterDeclaration data type.
#
# @!attribute [rw] parameter_key
- # The name that is associated with the parameter.
+ # The name that's associated with the parameter.
# @return [String]
#
# @!attribute [rw] default_value
@@ -4430,16 +5284,15 @@ module Aws::CloudFormation
#
# @!attribute [rw] no_echo
# Flag that indicates whether the parameter value is shown as plain
- # text in logs and in the AWS Management Console.
+ # text in logs and in the Amazon Web Services Management Console.
# @return [Boolean]
#
# @!attribute [rw] description
- # The description that is associate with the parameter.
+ # The description that's associate with the parameter.
# @return [String]
#
# @!attribute [rw] parameter_constraints
- # The criteria that AWS CloudFormation uses to validate parameter
- # values.
+ # The criteria that CloudFormation uses to validate parameter values.
# @return [Types::ParameterConstraints]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ParameterDeclaration AWS API Documentation
@@ -4455,11 +5308,11 @@ module Aws::CloudFormation
include Aws::Structure
end
- # Context information that enables AWS CloudFormation to uniquely
- # identify a resource. AWS CloudFormation uses context key-value pairs
- # in cases where a resource's logical and physical IDs are not enough
- # to uniquely identify that resource. Each context key-value pair
- # specifies a resource that contains the targeted resource.
+ # Context information that enables CloudFormation to uniquely identify a
+ # resource. CloudFormation uses context key-value pairs in cases where a
+ # resource's logical and physical IDs aren't enough to uniquely
+ # identify that resource. Each context key-value pair specifies a
+ # resource that contains the targeted resource.
#
# @!attribute [rw] key
# The resource context key.
@@ -4505,13 +5358,13 @@ module Aws::CloudFormation
# @!attribute [rw] difference_type
# The type of property difference.
#
- # * `ADD`\: A value has been added to a resource property that is an
+ # * `ADD`: A value has been added to a resource property that's an
# array or list data type.
#
- # * `REMOVE`\: The property has been removed from the current resource
+ # * `REMOVE`: The property has been removed from the current resource
# configuration.
#
- # * `NOT_EQUAL`\: The current property value differs from its expected
+ # * `NOT_EQUAL`: The current property value differs from its expected
# value (as defined in the stack template and any values specified
# as template parameters).
# @return [String]
@@ -4527,19 +5380,70 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass RecordHandlerProgressInput
- # data as a hash:
+ # @!attribute [rw] type
+ # The type of the extension.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ # @return [String]
+ #
+ # @!attribute [rw] arn
+ # The Amazon Resource Name (ARN) of the extension.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ # @return [String]
+ #
+ # @!attribute [rw] type_name
+ # The name of the extension.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ # @return [String]
+ #
+ # @!attribute [rw] public_version_number
+ # The version number to assign to this version of the extension.
+ #
+ # Use the following format, and adhere to semantic versioning when
+ # assigning a version number to your extension:
+ #
+ # `MAJOR.MINOR.PATCH`
+ #
+ # For more information, see [Semantic Versioning 2.0.0][1].
+ #
+ # If you don't specify a version number, CloudFormation increments
+ # the version number by one minor version release.
+ #
+ # You cannot specify a version number the first time you publish a
+ # type. CloudFormation automatically sets the first version number to
+ # be `1.0.0`.
+ #
+ #
+ #
+ # [1]: https://semver.org/
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/PublishTypeInput AWS API Documentation
+ #
+ class PublishTypeInput < Struct.new(
+ :type,
+ :arn,
+ :type_name,
+ :public_version_number)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] public_type_arn
+ # The Amazon Resource Name (ARN) assigned to the public extension upon
+ # publication.
+ # @return [String]
#
- # {
- # bearer_token: "ClientToken", # required
- # operation_status: "PENDING", # required, accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
- # current_operation_status: "PENDING", # accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
- # status_message: "StatusMessage",
- # error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure
- # resource_model: "ResourceModel",
- # client_request_token: "ClientRequestToken",
- # }
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/PublishTypeOutput AWS API Documentation
#
+ class PublishTypeOutput < Struct.new(
+ :public_type_arn)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# @!attribute [rw] bearer_token
# Reserved for use by the [CloudFormation CLI][1].
#
@@ -4614,35 +5518,74 @@ module Aws::CloudFormation
#
class RecordHandlerProgressOutput < Aws::EmptyStructure; end
- # @note When making an API call, you may pass RegisterTypeInput
- # data as a hash:
- #
- # {
- # type: "RESOURCE", # accepts RESOURCE
- # type_name: "TypeName", # required
- # schema_handler_package: "S3Url", # required
- # logging_config: {
- # log_role_arn: "RoleArn", # required
- # log_group_name: "LogGroupName", # required
- # },
- # execution_role_arn: "RoleArn",
- # client_request_token: "RequestToken",
- # }
+ # @!attribute [rw] accept_terms_and_conditions
+ # Whether you accept the [Terms and Conditions][1] for publishing
+ # extensions in the CloudFormation registry. You must accept the terms
+ # and conditions in order to register to publish public extensions to
+ # the CloudFormation registry.
#
- # @!attribute [rw] type
- # The kind of type.
+ # The default is `false`.
+ #
+ #
+ #
+ # [1]: https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf
+ # @return [Boolean]
#
- # Currently, the only valid value is `RESOURCE`.
+ # @!attribute [rw] connection_arn
+ # If you are using a Bitbucket or GitHub account for identity
+ # verification, the Amazon Resource Name (ARN) for your connection to
+ # that account.
+ #
+ # For more information, see [Registering your account to publish
+ # CloudFormation extensions][1] in the *CloudFormation CLI User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterPublisherInput AWS API Documentation
+ #
+ class RegisterPublisherInput < Struct.new(
+ :accept_terms_and_conditions,
+ :connection_arn)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] publisher_id
+ # The ID assigned this account by CloudFormation for publishing
+ # extensions.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterPublisherOutput AWS API Documentation
+ #
+ class RegisterPublisherOutput < Struct.new(
+ :publisher_id)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] type
+ # The kind of extension.
# @return [String]
#
# @!attribute [rw] type_name
- # The name of the type being registered.
+ # The name of the extension being registered.
+ #
+ # We suggest that extension names adhere to the following patterns:
#
- # We recommend that type names adhere to the following pattern:
- # *company\_or\_organization*\::*service*\::*type*.
+ # * For resource types,
+ # *company\_or\_organization*::*service*::*type*.
#
- # <note markdown="1"> The following organization namespaces are reserved and cannot be
- # used in your resource type names:
+ # * For modules,
+ # *company\_or\_organization*::*service*::*type*::MODULE.
+ #
+ # * For hooks, *MyCompany*::*Testing*::*MyTestHook*.
+ #
+ # <note markdown="1"> The following organization namespaces are reserved and can't be
+ # used in your extension names:
#
# * `Alexa`
#
@@ -4660,51 +5603,63 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] schema_handler_package
- # A url to the S3 bucket containing the schema handler package that
- # contains the schema, event handlers, and associated files for the
- # type you want to register.
+ # A URL to the S3 bucket containing the extension project package that
+ # contains the necessary files for the extension you want to register.
#
- # For information on generating a schema handler package for the type
- # you want to register, see [submit][1] in the *CloudFormation CLI
- # User Guide*.
+ # For information about generating a schema handler package for the
+ # extension you want to register, see [submit][1] in the
+ # *CloudFormation CLI User Guide*.
#
- # <note markdown="1"> As part of registering a resource provider type, CloudFormation must
- # be able to access the S3 bucket which contains the schema handler
- # package for that resource provider. For more information, see [IAM
- # Permissions for Registering a Resource Provider][2] in the *AWS
- # CloudFormation User Guide*.
+ # <note markdown="1"> The user registering the extension must be able to access the
+ # package in the S3 bucket. That's, the user needs to have
+ # [GetObject][2] permissions for the schema handler package. For more
+ # information, see [Actions, Resources, and Condition Keys for Amazon
+ # S3][3] in the *Identity and Access Management User Guide*.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html
- # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register-permissions
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
+ # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html
# @return [String]
#
# @!attribute [rw] logging_config
- # Specifies logging configuration information for a type.
+ # Specifies logging configuration information for an extension.
# @return [Types::LoggingConfig]
#
# @!attribute [rw] execution_role_arn
# The Amazon Resource Name (ARN) of the IAM role for CloudFormation to
- # assume when invoking the resource provider. If your resource type
- # calls AWS APIs in any of its handlers, you must create an <i> <a
+ # assume when invoking the extension.
+ #
+ # For CloudFormation to assume the specified execution role, the role
+ # must contain a trust relationship with the CloudFormation service
+ # principle (`resources.cloudformation.amazonaws.com`). For more
+ # information about adding trust relationships, see [Modifying a role
+ # trust policy][1] in the *Identity and Access Management User Guide*.
+ #
+ # If your extension calls Amazon Web Services APIs in any of its
+ # handlers, you must create an <i> <a
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
# execution role</a> </i> that includes the necessary permissions to
- # call those AWS APIs, and provision that execution role in your
- # account. When CloudFormation needs to invoke the resource provider
- # handler, CloudFormation assumes this execution role to create a
- # temporary session token, which it then passes to the resource
- # provider handler, thereby supplying your resource provider with the
+ # call those Amazon Web Services APIs, and provision that execution
+ # role in your account. When CloudFormation needs to invoke the
+ # resource type handler, CloudFormation assumes this execution role to
+ # create a temporary session token, which it then passes to the
+ # resource type handler, thereby supplying your resource type with the
# appropriate credentials.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy
# @return [String]
#
# @!attribute [rw] client_request_token
# A unique identifier that acts as an idempotency key for this
# registration request. Specifying a client request token prevents
- # CloudFormation from generating more than one version of a type from
- # the same registeration request, even if the request is submitted
+ # CloudFormation from generating more than one version of an extension
+ # from the same registration request, even if the request is submitted
# multiple times.
# @return [String]
#
@@ -4724,8 +5679,8 @@ module Aws::CloudFormation
# @!attribute [rw] registration_token
# The identifier for this registration request.
#
- # Use this registration token when calling ` DescribeTypeRegistration
- # `, which returns information about the status and IDs of the type
+ # Use this registration token when calling DescribeTypeRegistration,
+ # which returns information about the status and IDs of the extension
# registration.
# @return [String]
#
@@ -4737,14 +5692,68 @@ module Aws::CloudFormation
include Aws::Structure
end
+ # For extensions that are modules, a public third-party extension that
+ # must be activated in your account in order for the module itself to be
+ # activated.
+ #
+ # For more information, see [Activating public modules for use in your
+ # account][1] in the *CloudFormation User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-enabling
+ #
+ # @!attribute [rw] type_name_alias
+ # An alias assigned to the public extension, in this account and
+ # Region. If you specify an alias for the extension, CloudFormation
+ # treats the alias as the extension type name within this account and
+ # Region. You must use the alias to refer to the extension in your
+ # templates, API calls, and CloudFormation console.
+ # @return [String]
+ #
+ # @!attribute [rw] original_type_name
+ # The type name of the public extension.
+ #
+ # If you specified a `TypeNameAlias` when enabling the extension in
+ # this account and Region, CloudFormation treats that alias as the
+ # extension's type name within the account and Region, not the type
+ # name of the public extension. For more information, see [Specifying
+ # aliases to refer to extensions][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
+ # @return [String]
+ #
+ # @!attribute [rw] publisher_id
+ # The publisher ID of the extension publisher.
+ # @return [String]
+ #
+ # @!attribute [rw] supported_major_versions
+ # A list of the major versions of the extension type that the macro
+ # supports.
+ # @return [Array<Integer>]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RequiredActivatedType AWS API Documentation
+ #
+ class RequiredActivatedType < Struct.new(
+ :type_name_alias,
+ :original_type_name,
+ :publisher_id,
+ :supported_major_versions)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# The `ResourceChange` structure describes the resource and the action
- # that AWS CloudFormation will perform on it if you execute this change
- # set.
+ # that CloudFormation will perform on it if you execute this change set.
#
# @!attribute [rw] action
- # The action that AWS CloudFormation takes on the resource, such as
- # `Add` (adds a new resource), `Modify` (changes a resource), or
- # `Remove` (deletes a resource).
+ # The action that CloudFormation takes on the resource, such as `Add`
+ # (adds a new resource), `Modify` (changes a resource), `Remove`
+ # (deletes a resource), `Import` (imports a resource), or `Dynamic`
+ # (exact action for the resource can't be determined).
# @return [String]
#
# @!attribute [rw] logical_resource_id
@@ -4758,11 +5767,11 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] resource_type
- # The type of AWS CloudFormation resource, such as `AWS::S3::Bucket`.
+ # The type of CloudFormation resource, such as `AWS::S3::Bucket`.
# @return [String]
#
# @!attribute [rw] replacement
- # For the `Modify` action, indicates whether AWS CloudFormation will
+ # For the `Modify` action, indicates whether CloudFormation will
# replace the resource by creating a new one and deleting the old one.
# This value depends on the value of the `RequiresRecreation` property
# in the `ResourceTargetDefinition` structure. For example, if the
@@ -4785,10 +5794,20 @@ module Aws::CloudFormation
#
# @!attribute [rw] details
# For the `Modify` action, a list of `ResourceChangeDetail` structures
- # that describes the changes that AWS CloudFormation will make to the
+ # that describes the changes that CloudFormation will make to the
# resource.
# @return [Array<Types::ResourceChangeDetail>]
#
+ # @!attribute [rw] change_set_id
+ # The change set ID of the nested change set.
+ # @return [String]
+ #
+ # @!attribute [rw] module_info
+ # Contains information about the module from which the resource was
+ # created, if the resource was created from a module included in the
+ # stack template.
+ # @return [Types::ModuleInfo]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ResourceChange AWS API Documentation
#
class ResourceChange < Struct.new(
@@ -4798,36 +5817,38 @@ module Aws::CloudFormation
:resource_type,
:replacement,
:scope,
- :details)
+ :details,
+ :change_set_id,
+ :module_info)
SENSITIVE = []
include Aws::Structure
end
# For a resource with `Modify` as the action, the `ResourceChange`
- # structure describes the changes AWS CloudFormation will make to that
+ # structure describes the changes CloudFormation will make to that
# resource.
#
# @!attribute [rw] target
# A `ResourceTargetDefinition` structure that describes the field that
- # AWS CloudFormation will change and whether the resource will be
+ # CloudFormation will change and whether the resource will be
# recreated.
# @return [Types::ResourceTargetDefinition]
#
# @!attribute [rw] evaluation
- # Indicates whether AWS CloudFormation can determine the target value,
- # and whether the target value will change before you execute a change
+ # Indicates whether CloudFormation can determine the target value, and
+ # whether the target value will change before you execute a change
# set.
#
- # For `Static` evaluations, AWS CloudFormation can determine that the
+ # For `Static` evaluations, CloudFormation can determine that the
# target value will change, and its value. For example, if you
- # directly modify the `InstanceType` property of an EC2 instance, AWS
+ # directly modify the `InstanceType` property of an EC2 instance,
# CloudFormation knows that this property value will change, and its
# value, so this is a `Static` evaluation.
#
- # For `Dynamic` evaluations, cannot determine the target value because
+ # For `Dynamic` evaluations, can't determine the target value because
# it depends on the result of an intrinsic function, such as a `Ref`
# or `Fn::GetAtt` intrinsic function, when the stack is updated. For
- # example, if your template includes a reference to a resource that is
+ # example, if your template includes a reference to a resource that's
# conditionally recreated, the value of the reference (the physical ID
# of the resource) might change, depending on if the resource is
# recreated. If the resource is recreated, it will have a new physical
@@ -4855,16 +5876,16 @@ module Aws::CloudFormation
#
# * `Automatic` entities are `AWS::CloudFormation::Stack` resource
# types, which are also known as nested stacks. If you made no
- # changes to the `AWS::CloudFormation::Stack` resource, AWS
+ # changes to the `AWS::CloudFormation::Stack` resource,
# CloudFormation sets the `ChangeSource` to `Automatic` because the
# nested stack's template might have changed. Changes to a nested
- # stack's template aren't visible to AWS CloudFormation until you
- # run an update on the parent stack.
+ # stack's template aren't visible to CloudFormation until you run
+ # an update on the parent stack.
# @return [String]
#
# @!attribute [rw] causing_entity
# The identity of the entity that triggered this change. This entity
- # is a member of the group that is specified by the `ChangeSource`
+ # is a member of the group that's specified by the `ChangeSource`
# field. For example, if you modified the value of the `KeyPairName`
# parameter, the `CausingEntity` is the name of the parameter
# (`KeyPairName`).
@@ -4915,7 +5936,7 @@ module Aws::CloudFormation
include Aws::Structure
end
- # The field that AWS CloudFormation will change, such as the name of a
+ # The field that CloudFormation will change, such as the name of a
# resource's property, and whether the resource will be recreated.
#
# @!attribute [rw] attribute
@@ -4934,7 +5955,7 @@ module Aws::CloudFormation
# to this property causes the resource to be recreated. The value can
# be `Never`, `Always`, or `Conditionally`. To determine the
# conditions for a `Conditionally` recreation, see the update behavior
- # for that [property][1] in the AWS CloudFormation User Guide.
+ # for that [property][1] in the CloudFormation User Guide.
#
#
#
@@ -4953,22 +5974,11 @@ module Aws::CloudFormation
# Describes the target resource of an import operation.
#
- # @note When making an API call, you may pass ResourceToImport
- # data as a hash:
- #
- # {
- # resource_type: "ResourceType", # required
- # logical_resource_id: "LogicalResourceId", # required
- # resource_identifier: { # required
- # "ResourceIdentifierPropertyKey" => "ResourceIdentifierPropertyValue",
- # },
- # }
- #
# @!attribute [rw] resource_type
# The type of resource to import into your stack, such as
# `AWS::S3::Bucket`. For a list of supported resource types, see
- # [Resources that support import operations][1] in the AWS
- # CloudFormation User Guide.
+ # [Resources that support import operations][1] in the CloudFormation
+ # User Guide.
#
#
#
@@ -4996,39 +6006,26 @@ module Aws::CloudFormation
include Aws::Structure
end
- # Structure containing the rollback triggers for AWS CloudFormation to
+ # Structure containing the rollback triggers for CloudFormation to
# monitor during stack creation and updating operations, and for the
# specified monitoring period afterwards.
#
- # Rollback triggers enable you to have AWS CloudFormation monitor the
- # state of your application during stack creation and updating, and to
- # roll back that operation if the application breaches the threshold of
- # any of the alarms you've specified. For more information, see
- # [Monitor and Roll Back Stack Operations][1].
+ # Rollback triggers enable you to have CloudFormation monitor the state
+ # of your application during stack creation and updating, and to roll
+ # back that operation if the application breaches the threshold of any
+ # of the alarms you've specified. For more information, see [Monitor
+ # and Roll Back Stack Operations][1].
#
#
#
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html
#
- # @note When making an API call, you may pass RollbackConfiguration
- # data as a hash:
- #
- # {
- # rollback_triggers: [
- # {
- # arn: "Arn", # required
- # type: "Type", # required
- # },
- # ],
- # monitoring_time_in_minutes: 1,
- # }
- #
# @!attribute [rw] rollback_triggers
# The triggers to monitor during stack creation or update actions.
#
- # By default, AWS CloudFormation saves the rollback triggers specified
- # for a stack and applies them to any subsequent update operations for
- # the stack, unless you specify otherwise. If you do specify rollback
+ # By default, CloudFormation saves the rollback triggers specified for
+ # a stack and applies them to any subsequent update operations for the
+ # stack, unless you specify otherwise. If you do specify rollback
# triggers for this parameter, those triggers replace any list of
# triggers previously specified for the stack. This means:
#
@@ -5037,7 +6034,7 @@ module Aws::CloudFormation
#
# * To specify new or updated rollback triggers, you must specify
# *all* the triggers that you want used for this stack, even
- # triggers you've specifed before (for example, when creating the
+ # triggers you've specified before (for example, when creating the
# stack or during a previous stack update). Any triggers that you
# don't include in the updated list of triggers are no longer
# applied to the stack.
@@ -5056,7 +6053,7 @@ module Aws::CloudFormation
#
# The default is 0 minutes.
#
- # If you specify a monitoring period but do not specify any rollback
+ # If you specify a monitoring period but don't specify any rollback
# triggers, CloudFormation still waits the specified period of time
# before cleaning up old resources after update operations. You can
# use this monitoring period to perform any manual stack validation
@@ -5082,20 +6079,47 @@ module Aws::CloudFormation
include Aws::Structure
end
- # A rollback trigger AWS CloudFormation monitors during creation and
+ # @!attribute [rw] stack_name
+ # The name that's associated with the stack.
+ # @return [String]
+ #
+ # @!attribute [rw] role_arn
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # role that CloudFormation assumes to rollback the stack.
+ # @return [String]
+ #
+ # @!attribute [rw] client_request_token
+ # A unique identifier for this `RollbackStack` request.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackStackInput AWS API Documentation
+ #
+ class RollbackStackInput < Struct.new(
+ :stack_name,
+ :role_arn,
+ :client_request_token)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] stack_id
+ # Unique identifier of the stack.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackStackOutput AWS API Documentation
+ #
+ class RollbackStackOutput < Struct.new(
+ :stack_id)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # A rollback trigger CloudFormation monitors during creation and
# updating of stacks. If any of the alarms you specify goes to ALARM
# state during the stack operation or within the specified monitoring
# period afterwards, CloudFormation rolls back the entire stack
# operation.
#
- # @note When making an API call, you may pass RollbackTrigger
- # data as a hash:
- #
- # {
- # arn: "Arn", # required
- # type: "Type", # required
- # }
- #
# @!attribute [rw] arn
# The Amazon Resource Name (ARN) of the rollback trigger.
#
@@ -5104,12 +6128,14 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] type
- # The resource type of the rollback trigger. Currently,
- # [AWS::CloudWatch::Alarm][1] is the only supported resource type.
+ # The resource type of the rollback trigger. Specify either
+ # [AWS::CloudWatch::Alarm][1] or [AWS::CloudWatch::CompositeAlarm][2]
+ # resource types.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackTrigger AWS API Documentation
@@ -5123,15 +6149,6 @@ module Aws::CloudFormation
# The input for the SetStackPolicy action.
#
- # @note When making an API call, you may pass SetStackPolicyInput
- # data as a hash:
- #
- # {
- # stack_name: "StackName", # required
- # stack_policy_body: "StackPolicyBody",
- # stack_policy_url: "StackPolicyURL",
- # }
- #
# @!attribute [rw] stack_name
# The name or unique stack ID that you want to associate a policy
# with.
@@ -5139,9 +6156,9 @@ module Aws::CloudFormation
#
# @!attribute [rw] stack_policy_body
# Structure containing the stack policy body. For more information, go
- # to [ Prevent Updates to Stack Resources][1] in the AWS
- # CloudFormation User Guide. You can specify either the
- # `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
+ # to [ Prevent updates to stack resources][1] in the CloudFormation
+ # User Guide. You can specify either the `StackPolicyBody` or the
+ # `StackPolicyURL` parameter, but not both.
#
#
#
@@ -5150,9 +6167,10 @@ module Aws::CloudFormation
#
# @!attribute [rw] stack_policy_url
# Location of a file containing the stack policy. The URL must point
- # to a policy (maximum size: 16 KB) located in an S3 bucket in the
- # same Region as the stack. You can specify either the
- # `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
+ # to a policy (maximum size: 16 KB) located in an Amazon S3 bucket in
+ # the same Amazon Web Services Region as the stack. You can specify
+ # either the `StackPolicyBody` or the `StackPolicyURL` parameter, but
+ # not both.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetStackPolicyInput AWS API Documentation
@@ -5165,70 +6183,134 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass SetTypeDefaultVersionInput
- # data as a hash:
+ # @!attribute [rw] type_arn
+ # The Amazon Resource Name (ARN) for the extension, in this account
+ # and Region.
#
- # {
- # arn: "PrivateTypeArn",
- # type: "RESOURCE", # accepts RESOURCE
- # type_name: "TypeName",
- # version_id: "TypeVersionId",
- # }
+ # For public extensions, this will be the ARN assigned when you
+ # [activate the type][1] in this account and Region. For private
+ # extensions, this will be the ARN assigned when you [register the
+ # type][2] in this account and Region.
#
- # @!attribute [rw] arn
- # The Amazon Resource Name (ARN) of the type for which you want
- # version summary information.
+ # Do not include the extension versions suffix at the end of the ARN.
+ # You can set the configuration for an extension, but not for a
+ # specific extension version.
#
- # Conditional: You must specify either `TypeName` and `Type`, or
- # `Arn`.
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
# @return [String]
#
- # @!attribute [rw] type
- # The kind of type.
+ # @!attribute [rw] configuration
+ # The configuration data for the extension, in this account and
+ # Region.
#
- # Conditional: You must specify either `TypeName` and `Type`, or
- # `Arn`.
+ # The configuration data must be formatted as JSON, and validate
+ # against the schema returned in the `ConfigurationSchema` response
+ # element of [DescribeType][1]. For more information, see [Defining
+ # account-level configuration data for an extension][2] in the
+ # *CloudFormation CLI User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html
+ # [2]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration
+ # @return [String]
+ #
+ # @!attribute [rw] configuration_alias
+ # An alias by which to refer to this extension configuration data.
+ #
+ # Conditional: Specifying a configuration alias is required when
+ # setting a configuration for a resource type extension.
# @return [String]
#
# @!attribute [rw] type_name
- # The name of the type.
+ # The name of the extension.
#
- # Conditional: You must specify either `TypeName` and `Type`, or
- # `Arn`.
+ # Conditional: You must specify `ConfigurationArn`, or `Type` and
+ # `TypeName`.
# @return [String]
#
- # @!attribute [rw] version_id
- # The ID of a specific version of the type. The version ID is the
- # value at the end of the Amazon Resource Name (ARN) assigned to the
- # type version when it is registered.
+ # @!attribute [rw] type
+ # The type of extension.
+ #
+ # Conditional: You must specify `ConfigurationArn`, or `Type` and
+ # `TypeName`.
# @return [String]
#
- # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeDefaultVersionInput AWS API Documentation
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeConfigurationInput AWS API Documentation
#
- class SetTypeDefaultVersionInput < Struct.new(
- :arn,
- :type,
+ class SetTypeConfigurationInput < Struct.new(
+ :type_arn,
+ :configuration,
+ :configuration_alias,
:type_name,
- :version_id)
+ :type)
SENSITIVE = []
include Aws::Structure
end
- # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeDefaultVersionOutput AWS API Documentation
+ # @!attribute [rw] configuration_arn
+ # The Amazon Resource Name (ARN) for the configuration data, in this
+ # account and Region.
#
- class SetTypeDefaultVersionOutput < Aws::EmptyStructure; end
-
- # The input for the SignalResource action.
+ # Conditional: You must specify `ConfigurationArn`, or `Type` and
+ # `TypeName`.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeConfigurationOutput AWS API Documentation
+ #
+ class SetTypeConfigurationOutput < Struct.new(
+ :configuration_arn)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] arn
+ # The Amazon Resource Name (ARN) of the extension for which you want
+ # version summary information.
+ #
+ # Conditional: You must specify either `TypeName` and `Type`, or
+ # `Arn`.
+ # @return [String]
+ #
+ # @!attribute [rw] type
+ # The kind of extension.
+ #
+ # Conditional: You must specify either `TypeName` and `Type`, or
+ # `Arn`.
+ # @return [String]
+ #
+ # @!attribute [rw] type_name
+ # The name of the extension.
+ #
+ # Conditional: You must specify either `TypeName` and `Type`, or
+ # `Arn`.
+ # @return [String]
#
- # @note When making an API call, you may pass SignalResourceInput
- # data as a hash:
+ # @!attribute [rw] version_id
+ # The ID of a specific version of the extension. The version ID is the
+ # value at the end of the Amazon Resource Name (ARN) assigned to the
+ # extension version when it is registered.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeDefaultVersionInput AWS API Documentation
+ #
+ class SetTypeDefaultVersionInput < Struct.new(
+ :arn,
+ :type,
+ :type_name,
+ :version_id)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeDefaultVersionOutput AWS API Documentation
#
- # {
- # stack_name: "StackNameOrId", # required
- # logical_resource_id: "LogicalResourceId", # required
- # unique_id: "ResourceSignalUniqueId", # required
- # status: "SUCCESS", # required, accepts SUCCESS, FAILURE
- # }
+ class SetTypeDefaultVersionOutput < Aws::EmptyStructure; end
+
+ # The input for the SignalResource action.
#
# @!attribute [rw] stack_name
# The stack name or unique stack ID that includes the resource that
@@ -5250,8 +6332,8 @@ module Aws::CloudFormation
#
# @!attribute [rw] status
# The status of the signal, which is either success or failure. A
- # failure signal causes AWS CloudFormation to immediately fail the
- # stack creation or update.
+ # failure signal causes CloudFormation to immediately fail the stack
+ # creation or update.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SignalResourceInput AWS API Documentation
@@ -5301,7 +6383,7 @@ module Aws::CloudFormation
# @return [Time]
#
# @!attribute [rw] rollback_configuration
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
# @return [Types::RollbackConfiguration]
@@ -5317,13 +6399,14 @@ module Aws::CloudFormation
# @!attribute [rw] disable_rollback
# Boolean to enable or disable rollback on stack creation failures:
#
- # * `true`\: disable rollback
+ # * `true`: disable rollback.
#
- # * `false`\: enable rollback
+ # * `false`: enable rollback.
# @return [Boolean]
#
# @!attribute [rw] notification_arns
- # SNS topic ARNs to which stack related events are published.
+ # Amazon SNS topic Amazon Resource Names (ARNs) to which stack related
+ # events are published.
# @return [Array<String>]
#
# @!attribute [rw] timeout_in_minutes
@@ -5339,10 +6422,10 @@ module Aws::CloudFormation
# @return [Array<Types::Output>]
#
# @!attribute [rw] role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that is associated with the stack. During a
- # stack operation, AWS CloudFormation uses this role's credentials to
- # make calls on your behalf.
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that's associated with the stack. During a stack
+ # operation, CloudFormation uses this role's credentials to make
+ # calls on your behalf.
# @return [String]
#
# @!attribute [rw] tags
@@ -5353,9 +6436,9 @@ module Aws::CloudFormation
# Whether termination protection is enabled for the stack.
#
# For [nested stacks][1], termination protection is set on the root
- # stack and cannot be changed directly on the nested stack. For more
+ # stack and can't be changed directly on the nested stack. For more
# information, see [Protecting a Stack From Being Deleted][2] in the
- # *AWS CloudFormation User Guide*.
+ # *CloudFormation User Guide*.
#
#
#
@@ -5370,7 +6453,7 @@ module Aws::CloudFormation
# stack.
#
# For more information, see [Working with Nested Stacks][1] in the
- # *AWS CloudFormation User Guide*.
+ # *CloudFormation User Guide*.
#
#
#
@@ -5383,7 +6466,7 @@ module Aws::CloudFormation
# ultimately belongs.
#
# For more information, see [Working with Nested Stacks][1] in the
- # *AWS CloudFormation User Guide*.
+ # *CloudFormation User Guide*.
#
#
#
@@ -5391,8 +6474,8 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] drift_information
- # Information on whether a stack's actual configuration differs, or
- # has *drifted*, from it's expected configuration, as defined in the
+ # Information about whether a stack's actual configuration differs,
+ # or has *drifted*, from its expected configuration, as defined in the
# stack template and any values specified as template parameters. For
# more information, see [Detecting Unregulated Configuration Changes
# to Stacks and Resources][1].
@@ -5441,17 +6524,17 @@ module Aws::CloudFormation
# Status of the stack's actual configuration compared to its expected
# template configuration.
#
- # * `DRIFTED`\: The stack differs from its expected template
+ # * `DRIFTED`: The stack differs from its expected template
# configuration. A stack is considered to have drifted if one or
# more of its resources have drifted.
#
- # * `NOT_CHECKED`\: AWS CloudFormation has not checked if the stack
- # differs from its expected template configuration.
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the stack differs
+ # from its expected template configuration.
#
- # * `IN_SYNC`\: The stack's actual configuration matches its expected
+ # * `IN_SYNC`: The stack's actual configuration matches its expected
# template configuration.
#
- # * `UNKNOWN`\: This value is reserved for future use.
+ # * `UNKNOWN`: This value is reserved for future use.
# @return [String]
#
# @!attribute [rw] last_check_timestamp
@@ -5479,17 +6562,17 @@ module Aws::CloudFormation
# Status of the stack's actual configuration compared to its expected
# template configuration.
#
- # * `DRIFTED`\: The stack differs from its expected template
+ # * `DRIFTED`: The stack differs from its expected template
# configuration. A stack is considered to have drifted if one or
# more of its resources have drifted.
#
- # * `NOT_CHECKED`\: AWS CloudFormation has not checked if the stack
- # differs from its expected template configuration.
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the stack differs
+ # from its expected template configuration.
#
- # * `IN_SYNC`\: The stack's actual configuration matches its expected
+ # * `IN_SYNC`: The stack's actual configuration matches its expected
# template configuration.
#
- # * `UNKNOWN`\: This value is reserved for future use.
+ # * `UNKNOWN`: This value is reserved for future use.
# @return [String]
#
# @!attribute [rw] last_check_timestamp
@@ -5531,8 +6614,8 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] resource_type
- # Type of resource. (For more information, go to [ AWS Resource Types
- # Reference][1] in the AWS CloudFormation User Guide.)
+ # Type of resource. (For more information, go to [Amazon Web Services
+ # Resource Types Reference][1] in the CloudFormation User Guide.)
#
#
#
@@ -5573,6 +6656,32 @@ module Aws::CloudFormation
# `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`.
# @return [String]
#
+ # @!attribute [rw] hook_type
+ # The name of the hook.
+ # @return [String]
+ #
+ # @!attribute [rw] hook_status
+ # Provides the status of the change set hook.
+ # @return [String]
+ #
+ # @!attribute [rw] hook_status_reason
+ # Provides the reason for the hook status.
+ # @return [String]
+ #
+ # @!attribute [rw] hook_invocation_point
+ # Invocation points are points in provisioning logic where hooks are
+ # initiated.
+ # @return [String]
+ #
+ # @!attribute [rw] hook_failure_mode
+ # Specify the hook failure mode for non-compliant resources in the
+ # followings ways.
+ #
+ # * `FAIL` Stops provisioning resources.
+ #
+ # * `WARN` Allows provisioning to continue with a warning message.
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackEvent AWS API Documentation
#
class StackEvent < Struct.new(
@@ -5586,19 +6695,24 @@ module Aws::CloudFormation
:resource_status,
:resource_status_reason,
:resource_properties,
- :client_request_token)
+ :client_request_token,
+ :hook_type,
+ :hook_status,
+ :hook_status_reason,
+ :hook_invocation_point,
+ :hook_failure_mode)
SENSITIVE = []
include Aws::Structure
end
- # An AWS CloudFormation stack, in a specific account and Region, that's
+ # An CloudFormation stack, in a specific account and Region, that's
# part of a stack set operation. A stack instance is a reference to an
# attempted or actual stack in a given account within a given Region. A
# stack instance can exist without a stack—for example, if the stack
# couldn't be created for some reason. A stack instance is associated
# with only one stack set. Each stack instance contains the ID of its
- # associated stack set, as well as the ID of the actual stack and the
- # stack status.
+ # associated stack set, in addition to the ID of the actual stack and
+ # the stack status.
#
# @!attribute [rw] stack_set_id
# The name or unique ID of the stack set that the stack instance is
@@ -5606,13 +6720,13 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] region
- # The name of the AWS Region that the stack instance is associated
- # with.
+ # The name of the Amazon Web Services Region that the stack instance
+ # is associated with.
# @return [String]
#
# @!attribute [rw] account
- # \[`Self-managed` permissions\] The name of the AWS account that the
- # stack instance is associated with.
+ # \[Self-managed permissions\] The name of the Amazon Web Services
+ # account that the stack instance is associated with.
# @return [String]
#
# @!attribute [rw] stack_id
@@ -5628,14 +6742,14 @@ module Aws::CloudFormation
# The status of the stack instance, in terms of its synchronization
# with its associated stack set.
#
- # * `INOPERABLE`\: A `DeleteStackInstances` operation has failed and
+ # * `INOPERABLE`: A `DeleteStackInstances` operation has failed and
# left the stack in an unstable state. Stacks in this state are
# excluded from further `UpdateStackSet` operations. You might need
# to perform a `DeleteStackInstances` operation, with `RetainStacks`
# set to `true`, to delete the stack instance, and then delete the
# stack manually.
#
- # * `OUTDATED`\: The stack isn't currently up to date with the stack
+ # * `OUTDATED`: The stack isn't currently up to date with the stack
# set because:
#
# * The associated stack failed during a `CreateStackSet` or
@@ -5645,7 +6759,7 @@ module Aws::CloudFormation
# operation that failed or was stopped before the stack was
# created or updated.
#
- # * `CURRENT`\: The stack is currently up to date with the stack set.
+ # * `CURRENT`: The stack is currently up to date with the stack set.
# @return [String]
#
# @!attribute [rw] stack_instance_status
@@ -5653,12 +6767,12 @@ module Aws::CloudFormation
# @return [Types::StackInstanceComprehensiveStatus]
#
# @!attribute [rw] status_reason
- # The explanation for the specific status code that is assigned to
+ # The explanation for the specific status code that's assigned to
# this stack instance.
# @return [String]
#
# @!attribute [rw] organizational_unit_id
- # \[`Service-managed` permissions\] The organization root ID or
+ # \[Service-managed permissions\] The organization root ID or
# organizational unit (OU) IDs that you specified for
# [DeploymentTargets][1].
#
@@ -5672,26 +6786,31 @@ module Aws::CloudFormation
# expected template and parameter configuration of the stack set to
# which it belongs.
#
- # * `DRIFTED`\: The stack differs from the expected template and
+ # * `DRIFTED`: The stack differs from the expected template and
# parameter configuration of the stack set to which it belongs. A
# stack instance is considered to have drifted if one or more of the
# resources in the associated stack have drifted.
#
- # * `NOT_CHECKED`\: AWS CloudFormation has not checked if the stack
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the stack
# instance differs from its expected stack set configuration.
#
- # * `IN_SYNC`\: The stack instance's actual configuration matches its
+ # * `IN_SYNC`: The stack instance's actual configuration matches its
# expected stack set configuration.
#
- # * `UNKNOWN`\: This value is reserved for future use.
+ # * `UNKNOWN`: This value is reserved for future use.
# @return [String]
#
# @!attribute [rw] last_drift_check_timestamp
# Most recent time when CloudFormation performed a drift detection
# operation on the stack instance. This value will be `NULL` for any
- # stack instance on which drift detection has not yet been performed.
+ # stack instance on which drift detection hasn't yet been performed.
# @return [Time]
#
+ # @!attribute [rw] last_operation_id
+ # The last unique ID of a StackSet operation performed on a stack
+ # instance.
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackInstance AWS API Documentation
#
class StackInstance < Struct.new(
@@ -5705,7 +6824,8 @@ module Aws::CloudFormation
:status_reason,
:organizational_unit_id,
:drift_status,
- :last_drift_check_timestamp)
+ :last_drift_check_timestamp,
+ :last_operation_id)
SENSITIVE = []
include Aws::Structure
end
@@ -5713,30 +6833,34 @@ module Aws::CloudFormation
# The detailed status of the stack instance.
#
# @!attribute [rw] detailed_status
- # * `CANCELLED`\: The operation in the specified account and Region
- # has been cancelled. This is either because a user has stopped the
- # stack set operation, or because the failure tolerance of the stack
- # set operation has been exceeded.
+ # * `CANCELLED`: The operation in the specified account and Region has
+ # been canceled. This is either because a user has stopped the stack
+ # set operation, or because the failure tolerance of the stack set
+ # operation has been exceeded.
#
- # * `FAILED`\: The operation in the specified account and Region
+ # * `FAILED`: The operation in the specified account and Region
# failed. If the stack set operation fails in enough accounts within
# a Region, the failure tolerance for the stack set operation as a
# whole might be exceeded.
#
- # * `INOPERABLE`\: A `DeleteStackInstances` operation has failed and
+ # * `INOPERABLE`: A `DeleteStackInstances` operation has failed and
# left the stack in an unstable state. Stacks in this state are
# excluded from further `UpdateStackSet` operations. You might need
# to perform a `DeleteStackInstances` operation, with `RetainStacks`
# set to `true`, to delete the stack instance, and then delete the
# stack manually.
#
- # * `PENDING`\: The operation in the specified account and Region has
+ # * `PENDING`: The operation in the specified account and Region has
# yet to start.
#
- # * `RUNNING`\: The operation in the specified account and Region is
+ # * `RUNNING`: The operation in the specified account and Region is
# currently in progress.
#
- # * `SUCCEEDED`\: The operation in the specified account and Region
+ # * `SKIPPED_SUSPENDED_ACCOUNT`: The operation in the specified
+ # account and Region has been skipped because the account was
+ # suspended at the time of the operation.
+ #
+ # * `SUCCEEDED`: The operation in the specified account and Region
# completed successfully.
# @return [String]
#
@@ -5748,15 +6872,7 @@ module Aws::CloudFormation
include Aws::Structure
end
- # The status that stack instances are filtered by.
- #
- # @note When making an API call, you may pass StackInstanceFilter
- # data as a hash:
- #
- # {
- # name: "DETAILED_STATUS", # accepts DETAILED_STATUS
- # values: "StackInstanceFilterValues",
- # }
+ # The filter to apply to stack instances
#
# @!attribute [rw] name
# The type of filter to apply.
@@ -5790,13 +6906,13 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] region
- # The name of the AWS Region that the stack instance is associated
- # with.
+ # The name of the Amazon Web Services Region that the stack instance
+ # is associated with.
# @return [String]
#
# @!attribute [rw] account
- # \[`Self-managed` permissions\] The name of the AWS account that the
- # stack instance is associated with.
+ # \[Self-managed permissions\] The name of the Amazon Web Services
+ # account that the stack instance is associated with.
# @return [String]
#
# @!attribute [rw] stack_id
@@ -5807,14 +6923,14 @@ module Aws::CloudFormation
# The status of the stack instance, in terms of its synchronization
# with its associated stack set.
#
- # * `INOPERABLE`\: A `DeleteStackInstances` operation has failed and
+ # * `INOPERABLE`: A `DeleteStackInstances` operation has failed and
# left the stack in an unstable state. Stacks in this state are
# excluded from further `UpdateStackSet` operations. You might need
# to perform a `DeleteStackInstances` operation, with `RetainStacks`
# set to `true`, to delete the stack instance, and then delete the
# stack manually.
#
- # * `OUTDATED`\: The stack isn't currently up to date with the stack
+ # * `OUTDATED`: The stack isn't currently up to date with the stack
# set because:
#
# * The associated stack failed during a `CreateStackSet` or
@@ -5824,7 +6940,7 @@ module Aws::CloudFormation
# operation that failed or was stopped before the stack was
# created or updated.
#
- # * `CURRENT`\: The stack is currently up to date with the stack set.
+ # * `CURRENT`: The stack is currently up to date with the stack set.
# @return [String]
#
# @!attribute [rw] status_reason
@@ -5837,7 +6953,7 @@ module Aws::CloudFormation
# @return [Types::StackInstanceComprehensiveStatus]
#
# @!attribute [rw] organizational_unit_id
- # \[`Service-managed` permissions\] The organization root ID or
+ # \[Service-managed permissions\] The organization root ID or
# organizational unit (OU) IDs that you specified for
# [DeploymentTargets][1].
#
@@ -5851,26 +6967,31 @@ module Aws::CloudFormation
# expected template and parameter configuration of the stack set to
# which it belongs.
#
- # * `DRIFTED`\: The stack differs from the expected template and
+ # * `DRIFTED`: The stack differs from the expected template and
# parameter configuration of the stack set to which it belongs. A
# stack instance is considered to have drifted if one or more of the
# resources in the associated stack have drifted.
#
- # * `NOT_CHECKED`\: AWS CloudFormation has not checked if the stack
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the stack
# instance differs from its expected stack set configuration.
#
- # * `IN_SYNC`\: The stack instance's actual configuration matches its
+ # * `IN_SYNC`: The stack instance's actual configuration matches its
# expected stack set configuration.
#
- # * `UNKNOWN`\: This value is reserved for future use.
+ # * `UNKNOWN`: This value is reserved for future use.
# @return [String]
#
# @!attribute [rw] last_drift_check_timestamp
# Most recent time when CloudFormation performed a drift detection
# operation on the stack instance. This value will be `NULL` for any
- # stack instance on which drift detection has not yet been performed.
+ # stack instance on which drift detection hasn't yet been performed.
# @return [Time]
#
+ # @!attribute [rw] last_operation_id
+ # The last unique ID of a StackSet operation performed on a stack
+ # instance.
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackInstanceSummary AWS API Documentation
#
class StackInstanceSummary < Struct.new(
@@ -5883,11 +7004,19 @@ module Aws::CloudFormation
:stack_instance_status,
:organizational_unit_id,
:drift_status,
- :last_drift_check_timestamp)
+ :last_drift_check_timestamp,
+ :last_operation_id)
SENSITIVE = []
include Aws::Structure
end
+ # The specified stack ARN doesn't exist or stack doesn't exist
+ # corresponding to the ARN in input.
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackNotFoundException AWS API Documentation
+ #
+ class StackNotFoundException < Aws::EmptyStructure; end
+
# The StackResource data type.
#
# @!attribute [rw] stack_name
@@ -5904,12 +7033,12 @@ module Aws::CloudFormation
#
# @!attribute [rw] physical_resource_id
# The name or unique identifier that corresponds to a physical
- # instance ID of a resource supported by AWS CloudFormation.
+ # instance ID of a resource supported by CloudFormation.
# @return [String]
#
# @!attribute [rw] resource_type
- # Type of resource. (For more information, go to [ AWS Resource Types
- # Reference][1] in the AWS CloudFormation User Guide.)
+ # Type of resource. For more information, go to [Amazon Web Services
+ # Resource Types Reference][1] in the CloudFormation User Guide.
#
#
#
@@ -5944,6 +7073,12 @@ module Aws::CloudFormation
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
# @return [Types::StackResourceDriftInformation]
#
+ # @!attribute [rw] module_info
+ # Contains information about the module from which the resource was
+ # created, if the resource was created from a module included in the
+ # stack template.
+ # @return [Types::ModuleInfo]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackResource AWS API Documentation
#
class StackResource < Struct.new(
@@ -5956,7 +7091,8 @@ module Aws::CloudFormation
:resource_status,
:resource_status_reason,
:description,
- :drift_information)
+ :drift_information,
+ :module_info)
SENSITIVE = []
include Aws::Structure
end
@@ -5977,12 +7113,12 @@ module Aws::CloudFormation
#
# @!attribute [rw] physical_resource_id
# The name or unique identifier that corresponds to a physical
- # instance ID of a resource supported by AWS CloudFormation.
+ # instance ID of a resource supported by CloudFormation.
# @return [String]
#
# @!attribute [rw] resource_type
- # Type of resource. ((For more information, go to [ AWS Resource Types
- # Reference][1] in the AWS CloudFormation User Guide.)
+ # Type of resource. For more information, go to [Amazon Web Services
+ # Resource Types Reference][1] in the CloudFormation User Guide.
#
#
#
@@ -6007,7 +7143,7 @@ module Aws::CloudFormation
#
# @!attribute [rw] metadata
# The content of the `Metadata` attribute declared for the resource.
- # For more information, see [Metadata Attribute][1] in the AWS
+ # For more information, see [Metadata Attribute][1] in the
# CloudFormation User Guide.
#
#
@@ -6027,6 +7163,12 @@ module Aws::CloudFormation
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
# @return [Types::StackResourceDriftInformation]
#
+ # @!attribute [rw] module_info
+ # Contains information about the module from which the resource was
+ # created, if the resource was created from a module included in the
+ # stack template.
+ # @return [Types::ModuleInfo]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackResourceDetail AWS API Documentation
#
class StackResourceDetail < Struct.new(
@@ -6040,19 +7182,20 @@ module Aws::CloudFormation
:resource_status_reason,
:description,
:metadata,
- :drift_information)
+ :drift_information,
+ :module_info)
SENSITIVE = []
include Aws::Structure
end
# Contains the drift information for a resource that has been checked
# for drift. This includes actual and expected property values for
- # resources in which AWS CloudFormation has detected drift. Only
- # resource properties explicitly defined in the stack template are
- # checked for drift. For more information, see [Detecting Unregulated
- # Configuration Changes to Stacks and Resources][1].
+ # resources in which CloudFormation has detected drift. Only resource
+ # properties explicitly defined in the stack template are checked for
+ # drift. For more information, see [Detecting Unregulated Configuration
+ # Changes to Stacks and Resources][1].
#
- # Resources that do not currently support drift detection cannot be
+ # Resources that don't currently support drift detection can't be
# checked. For a list of resources that support drift detection, see
# [Resources that Support Drift Detection][2].
#
@@ -6075,14 +7218,14 @@ module Aws::CloudFormation
#
# @!attribute [rw] physical_resource_id
# The name or unique identifier that corresponds to a physical
- # instance ID of a resource supported by AWS CloudFormation.
+ # instance ID of a resource supported by CloudFormation.
# @return [String]
#
# @!attribute [rw] physical_resource_id_context
- # Context information that enables AWS CloudFormation to uniquely
- # identify a resource. AWS CloudFormation uses context key-value pairs
- # in cases where a resource's logical and physical IDs are not enough
- # to uniquely identify that resource. Each context key-value pair
+ # Context information that enables CloudFormation to uniquely identify
+ # a resource. CloudFormation uses context key-value pairs in cases
+ # where a resource's logical and physical IDs aren't enough to
+ # uniquely identify that resource. Each context key-value pair
# specifies a unique resource that contains the targeted resource.
# @return [Array<Types::PhysicalResourceIdContextKeyValuePair>]
#
@@ -6115,27 +7258,33 @@ module Aws::CloudFormation
#
# @!attribute [rw] stack_resource_drift_status
# Status of the resource's actual configuration compared to its
- # expected configuration
+ # expected configuration.
#
- # * `DELETED`\: The resource differs from its expected template
+ # * `DELETED`: The resource differs from its expected template
# configuration because the resource has been deleted.
#
- # * `MODIFIED`\: One or more resource properties differ from their
+ # * `MODIFIED`: One or more resource properties differ from their
# expected values (as defined in the stack template and any values
# specified as template parameters).
#
- # * `IN_SYNC`\: The resources's actual configuration matches its
+ # * `IN_SYNC`: The resource's actual configuration matches its
# expected template configuration.
#
- # * `NOT_CHECKED`\: AWS CloudFormation does not currently return this
+ # * `NOT_CHECKED`: CloudFormation does not currently return this
# value.
# @return [String]
#
# @!attribute [rw] timestamp
- # Time at which AWS CloudFormation performed drift detection on the
- # stack resource.
+ # Time at which CloudFormation performed drift detection on the stack
+ # resource.
# @return [Time]
#
+ # @!attribute [rw] module_info
+ # Contains information about the module from which the resource was
+ # created, if the resource was created from a module included in the
+ # stack template.
+ # @return [Types::ModuleInfo]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackResourceDrift AWS API Documentation
#
class StackResourceDrift < Struct.new(
@@ -6148,7 +7297,8 @@ module Aws::CloudFormation
:actual_properties,
:property_differences,
:stack_resource_drift_status,
- :timestamp)
+ :timestamp,
+ :module_info)
SENSITIVE = []
include Aws::Structure
end
@@ -6161,19 +7311,19 @@ module Aws::CloudFormation
# Status of the resource's actual configuration compared to its
# expected configuration
#
- # * `DELETED`\: The resource differs from its expected configuration
- # in that it has been deleted.
+ # * `DELETED`: The resource differs from its expected configuration in
+ # that it has been deleted.
#
- # * `MODIFIED`\: The resource differs from its expected configuration.
+ # * `MODIFIED`: The resource differs from its expected configuration.
#
- # * `NOT_CHECKED`\: AWS CloudFormation has not checked if the resource
+ # * `NOT_CHECKED`: CloudFormation has not checked if the resource
# differs from its expected configuration.
#
# Any resources that do not currently support drift detection have a
# status of `NOT_CHECKED`. For more information, see [Resources that
# Support Drift Detection][1].
#
- # * `IN_SYNC`\: The resources's actual configuration matches its
+ # * `IN_SYNC`: The resource's actual configuration matches its
# expected configuration.
#
#
@@ -6182,8 +7332,8 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] last_check_timestamp
- # When AWS CloudFormation last checked if the resource had drifted
- # from its expected configuration.
+ # When CloudFormation last checked if the resource had drifted from
+ # its expected configuration.
# @return [Time]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackResourceDriftInformation AWS API Documentation
@@ -6201,26 +7351,26 @@ module Aws::CloudFormation
#
# @!attribute [rw] stack_resource_drift_status
# Status of the resource's actual configuration compared to its
- # expected configuration
+ # expected configuration.
#
- # * `DELETED`\: The resource differs from its expected configuration
- # in that it has been deleted.
+ # * `DELETED`: The resource differs from its expected configuration in
+ # that it has been deleted.
#
- # * `MODIFIED`\: The resource differs from its expected configuration.
+ # * `MODIFIED`: The resource differs from its expected configuration.
#
- # * `NOT_CHECKED`\: AWS CloudFormation has not checked if the resource
+ # * `NOT_CHECKED`: CloudFormation hasn't checked if the resource
# differs from its expected configuration.
#
- # Any resources that do not currently support drift detection have a
+ # Any resources that don't currently support drift detection have a
# status of `NOT_CHECKED`. For more information, see [Resources that
# Support Drift Detection][1]. If you performed an
# ContinueUpdateRollback operation on a stack, any resources
# included in `ResourcesToSkip` will also have a status of
- # `NOT_CHECKED`. For more information on skipping resources during
- # rollback operations, see [Continue Rolling Back an Update][2] in
- # the AWS CloudFormation User Guide.
+ # `NOT_CHECKED`. For more information about skipping resources
+ # during rollback operations, see [Continue Rolling Back an
+ # Update][2] in the CloudFormation User Guide.
#
- # * `IN_SYNC`\: The resources's actual configuration matches its
+ # * `IN_SYNC`: The resource's actual configuration matches its
# expected configuration.
#
#
@@ -6230,8 +7380,8 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] last_check_timestamp
- # When AWS CloudFormation last checked if the resource had drifted
- # from its expected configuration.
+ # When CloudFormation last checked if the resource had drifted from
+ # its expected configuration.
# @return [Time]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackResourceDriftInformationSummary AWS API Documentation
@@ -6255,8 +7405,8 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] resource_type
- # Type of resource. (For more information, go to [ AWS Resource Types
- # Reference][1] in the AWS CloudFormation User Guide.)
+ # Type of resource. (For more information, go to [Amazon Web Services
+ # Resource Types Reference][1] in the CloudFormation User Guide.)
#
#
#
@@ -6287,6 +7437,12 @@ module Aws::CloudFormation
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
# @return [Types::StackResourceDriftInformationSummary]
#
+ # @!attribute [rw] module_info
+ # Contains information about the module from which the resource was
+ # created, if the resource was created from a module included in the
+ # stack template.
+ # @return [Types::ModuleInfo]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackResourceSummary AWS API Documentation
#
class StackResourceSummary < Struct.new(
@@ -6296,16 +7452,17 @@ module Aws::CloudFormation
:last_updated_timestamp,
:resource_status,
:resource_status_reason,
- :drift_information)
+ :drift_information,
+ :module_info)
SENSITIVE = []
include Aws::Structure
end
# A structure that contains information about a stack set. A stack set
- # enables you to provision stacks into AWS accounts and across Regions
- # by using a single CloudFormation template. In the stack set, you
- # specify the template to use, as well as any parameters and
- # capabilities that the template requires.
+ # enables you to provision stacks into Amazon Web Services accounts and
+ # across Regions by using a single CloudFormation template. In the stack
+ # set, you specify the template to use, in addition to any parameters
+ # and capabilities that the template requires.
#
# @!attribute [rw] stack_set_name
# The name that's associated with the stack set.
@@ -6336,9 +7493,9 @@ module Aws::CloudFormation
# @!attribute [rw] capabilities
# The capabilities that are allowed in the stack set. Some stack set
# templates might include resources that can affect permissions in
- # your AWS account—for example, by creating new AWS Identity and
- # Access Management (IAM) users. For more information, see
- # [Acknowledging IAM Resources in AWS CloudFormation Templates.][1]
+ # your Amazon Web Services account—for example, by creating new
+ # Identity and Access Management (IAM) users. For more information,
+ # see [Acknowledging IAM Resources in CloudFormation Templates.][1]
#
#
#
@@ -6351,18 +7508,18 @@ module Aws::CloudFormation
# @return [Array<Types::Tag>]
#
# @!attribute [rw] stack_set_arn
- # The Amazon Resource Number (ARN) of the stack set.
+ # The Amazon Resource Name (ARN) of the stack set.
# @return [String]
#
# @!attribute [rw] administration_role_arn
- # The Amazon Resource Number (ARN) of the IAM role used to create or
+ # The Amazon Resource Name (ARN) of the IAM role used to create or
# update the stack set.
#
# Use customized administrator roles to control which users or groups
# can manage specific stack sets within the same administrator
# account. For more information, see [Prerequisites: Granting
- # Permissions for Stack Set Operations][1] in the *AWS CloudFormation
- # User Guide*.
+ # Permissions for Stack Set Operations][1] in the *CloudFormation User
+ # Guide*.
#
#
#
@@ -6382,13 +7539,13 @@ module Aws::CloudFormation
#
# For stack sets, contains information about the last *completed*
# drift operation performed on the stack set. Information about drift
- # operations currently in progress is not included.
+ # operations currently in progress isn't included.
# @return [Types::StackSetDriftDetectionDetails]
#
# @!attribute [rw] auto_deployment
- # \[`Service-managed` permissions\] Describes whether StackSets
- # automatically deploys to AWS Organizations accounts that are added
- # to a target organization or organizational unit (OU).
+ # \[Service-managed permissions\] Describes whether StackSets
+ # automatically deploys to Organizations accounts that are added to a
+ # target organization or organizational unit (OU).
# @return [Types::AutoDeployment]
#
# @!attribute [rw] permission_model
@@ -6402,8 +7559,8 @@ module Aws::CloudFormation
#
# * With `service-managed` permissions, StackSets automatically
# creates the IAM roles required to deploy to accounts managed by
- # AWS Organizations. For more information, see [Grant
- # Service-Managed Stack Set Permissions][2].
+ # Organizations. For more information, see [Grant Service-Managed
+ # Stack Set Permissions][2].
#
#
#
@@ -6412,7 +7569,7 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] organizational_unit_ids
- # \[`Service-managed` permissions\] The organization root ID or
+ # \[Service-managed permissions\] The organization root ID or
# organizational unit (OU) IDs that you specified for
# [DeploymentTargets][1].
#
@@ -6421,6 +7578,17 @@ module Aws::CloudFormation
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html
# @return [Array<String>]
#
+ # @!attribute [rw] managed_execution
+ # Describes whether StackSets performs non-conflicting operations
+ # concurrently and queues conflicting operations.
+ # @return [Types::ManagedExecution]
+ #
+ # @!attribute [rw] regions
+ # Returns a list of all Amazon Web Services Regions the given StackSet
+ # has stack instances deployed in. The Amazon Web Services Regions
+ # list output is in no particular order.
+ # @return [Array<String>]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSet AWS API Documentation
#
class StackSet < Struct.new(
@@ -6438,7 +7606,9 @@ module Aws::CloudFormation
:stack_set_drift_detection_details,
:auto_deployment,
:permission_model,
- :organizational_unit_ids)
+ :organizational_unit_ids,
+ :managed_execution,
+ :regions)
SENSITIVE = []
include Aws::Structure
end
@@ -6447,13 +7617,13 @@ module Aws::CloudFormation
#
# For stack sets, contains information about the last *completed* drift
# operation performed on the stack set. Information about drift
- # operations in-progress is not included.
+ # operations in-progress isn't included.
#
# For stack set operations, includes information about drift operations
# currently being performed on the stack set.
#
- # For more information, see [Detecting Unmanaged Changes in Stack
- # Sets][1] in the *AWS CloudFormation User Guide*.
+ # For more information, see [Detecting unmanaged changes in stack
+ # sets][1] in the *CloudFormation User Guide*.
#
#
#
@@ -6466,15 +7636,15 @@ module Aws::CloudFormation
# have drifted from their expected template and parameter
# configuration.
#
- # * `DRIFTED`\: One or more of the stack instances belonging to the
+ # * `DRIFTED`: One or more of the stack instances belonging to the
# stack set stack differs from the expected template and parameter
# configuration. A stack instance is considered to have drifted if
# one or more of the resources in the associated stack have drifted.
#
- # * `NOT_CHECKED`\: AWS CloudFormation has not checked the stack set
- # for drift.
+ # * `NOT_CHECKED`: CloudFormation hasn't checked the stack set for
+ # drift.
#
- # * `IN_SYNC`\: All of the stack instances belonging to the stack set
+ # * `IN_SYNC`: All of the stack instances belonging to the stack set
# stack match from the expected template and parameter
# configuration.
# @return [String]
@@ -6482,25 +7652,25 @@ module Aws::CloudFormation
# @!attribute [rw] drift_detection_status
# The status of the stack set drift detection operation.
#
- # * `COMPLETED`\: The drift detection operation completed without
+ # * `COMPLETED`: The drift detection operation completed without
# failing on any stack instances.
#
- # * `FAILED`\: The drift detection operation exceeded the specified
+ # * `FAILED`: The drift detection operation exceeded the specified
# failure tolerance.
#
- # * `PARTIAL_SUCCESS`\: The drift detection operation completed
- # without exceeding the failure tolerance for the operation.
+ # * `PARTIAL_SUCCESS`: The drift detection operation completed without
+ # exceeding the failure tolerance for the operation.
#
- # * `IN_PROGRESS`\: The drift detection operation is currently being
+ # * `IN_PROGRESS`: The drift detection operation is currently being
# performed.
#
- # * `STOPPED`\: The user has cancelled the drift detection operation.
+ # * `STOPPED`: The user has canceled the drift detection operation.
# @return [String]
#
# @!attribute [rw] last_drift_check_timestamp
# Most recent time when CloudFormation performed a drift detection
# operation on the stack set. This value will be `NULL` for any stack
- # set on which drift detection has not yet been performed.
+ # set on which drift detection hasn't yet been performed.
# @return [Time]
#
# @!attribute [rw] total_stack_instances_count
@@ -6522,7 +7692,7 @@ module Aws::CloudFormation
# The number of stack instances that have drifted from the expected
# template and parameter configuration of the stack set. A stack
# instance is considered to have drifted if one or more of the
- # resources in the associated stack do not match their expected
+ # resources in the associated stack don't match their expected
# configuration.
# @return [Integer]
#
@@ -6584,36 +7754,35 @@ module Aws::CloudFormation
# The type of stack set operation: `CREATE`, `UPDATE`, or `DELETE`.
# Create and delete operations affect only the specified stack set
# instances that are associated with the specified stack set. Update
- # operations affect both the stack set itself, as well as *all*
+ # operations affect both the stack set itself, in addition to *all*
# associated stack set instances.
# @return [String]
#
# @!attribute [rw] status
# The status of the operation.
#
- # * `FAILED`\: The operation exceeded the specified failure tolerance.
+ # * `FAILED`: The operation exceeded the specified failure tolerance.
# The failure tolerance value that you've set for an operation is
# applied for each Region during stack create and update operations.
# If the number of failed stacks within a Region exceeds the failure
# tolerance, the status of the operation in the Region is set to
# `FAILED`. This in turn sets the status of the operation as a whole
- # to `FAILED`, and AWS CloudFormation cancels the operation in any
+ # to `FAILED`, and CloudFormation cancels the operation in any
# remaining Regions.
#
- # * `QUEUED`\: \[`Service-managed` permissions\] For automatic
+ # * `QUEUED`: \[Service-managed permissions\] For automatic
# deployments that require a sequence of operations, the operation
# is queued to be performed. For more information, see the [stack
- # set operation status codes][1] in the AWS CloudFormation User
- # Guide.
+ # set operation status codes][1] in the CloudFormation User Guide.
#
- # * `RUNNING`\: The operation is currently being performed.
+ # * `RUNNING`: The operation is currently being performed.
#
- # * `STOPPED`\: The user has cancelled the operation.
+ # * `STOPPED`: The user has canceled the operation.
#
- # * `STOPPING`\: The operation is in the process of stopping, at user
+ # * `STOPPING`: The operation is in the process of stopping, at user
# request.
#
- # * `SUCCEEDED`\: The operation completed creating or updating all the
+ # * `SUCCEEDED`: The operation completed creating or updating all the
# specified stacks without exceeding the failure tolerance for the
# operation.
#
@@ -6623,25 +7792,25 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] operation_preferences
- # The preferences for how AWS CloudFormation performs this stack set
+ # The preferences for how CloudFormation performs this stack set
# operation.
# @return [Types::StackSetOperationPreferences]
#
# @!attribute [rw] retain_stacks
# For stack set operations of action type `DELETE`, specifies whether
# to remove the stack instances from the specified stack set, but
- # doesn't delete the stacks. You can't reassociate a retained stack,
- # or add an existing, saved stack to a new stack set.
+ # doesn't delete the stacks. You can't re-associate a retained
+ # stack, or add an existing, saved stack to a new stack set.
# @return [Boolean]
#
# @!attribute [rw] administration_role_arn
- # The Amazon Resource Number (ARN) of the IAM role used to perform
- # this stack set operation.
+ # The Amazon Resource Name (ARN) of the IAM role used to perform this
+ # stack set operation.
#
# Use customized administrator roles to control which users or groups
# can manage specific stack sets within the same administrator
# account. For more information, see [Define Permissions for Multiple
- # Administrators][1] in the *AWS CloudFormation User Guide*.
+ # Administrators][1] in the *CloudFormation User Guide*.
#
#
#
@@ -6660,9 +7829,9 @@ module Aws::CloudFormation
# The time at which the operation was initiated. Note that the
# creation times for the stack set operation might differ from the
# creation time of the individual stacks themselves. This is because
- # AWS CloudFormation needs to perform preparatory work for the
- # operation, such as dispatching the work to the requested Regions,
- # before actually creating the first stacks.
+ # CloudFormation needs to perform preparatory work for the operation,
+ # such as dispatching the work to the requested Regions, before
+ # actually creating the first stacks.
# @return [Time]
#
# @!attribute [rw] end_timestamp
@@ -6673,8 +7842,8 @@ module Aws::CloudFormation
# @return [Time]
#
# @!attribute [rw] deployment_targets
- # \[`Service-managed` permissions\] The AWS Organizations accounts
- # affected by the stack operation.
+ # \[Service-managed permissions\] The Organizations accounts affected
+ # by the stack operation.
# @return [Types::DeploymentTargets]
#
# @!attribute [rw] stack_set_drift_detection_details
@@ -6682,17 +7851,25 @@ module Aws::CloudFormation
# includes information about drift operations currently being
# performed on the stack set.
#
- # this information will only be present for stack set operations whose
+ # This information will only be present for stack set operations whose
# `Action` type is `DETECT_DRIFT`.
#
# For more information, see [Detecting Unmanaged Changes in Stack
- # Sets][1] in the AWS CloudFormation User Guide.
+ # Sets][1] in the CloudFormation User Guide.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html
# @return [Types::StackSetDriftDetectionDetails]
#
+ # @!attribute [rw] status_reason
+ # The status of the operation in details.
+ # @return [String]
+ #
+ # @!attribute [rw] status_details
+ # Detailed information about the StackSet operation.
+ # @return [Types::StackSetOperationStatusDetails]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperation AWS API Documentation
#
class StackSetOperation < Struct.new(
@@ -6707,67 +7884,65 @@ module Aws::CloudFormation
:creation_timestamp,
:end_timestamp,
:deployment_targets,
- :stack_set_drift_detection_details)
+ :stack_set_drift_detection_details,
+ :status_reason,
+ :status_details)
SENSITIVE = []
include Aws::Structure
end
- # The user-specified preferences for how AWS CloudFormation performs a
- # stack set operation.
+ # The user-specified preferences for how CloudFormation performs a stack
+ # set operation.
#
- # For more information on maximum concurrent accounts and failure
+ # For more information about maximum concurrent accounts and failure
# tolerance, see [Stack set operation options][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
#
- # @note When making an API call, you may pass StackSetOperationPreferences
- # data as a hash:
- #
- # {
- # region_order: ["Region"],
- # failure_tolerance_count: 1,
- # failure_tolerance_percentage: 1,
- # max_concurrent_count: 1,
- # max_concurrent_percentage: 1,
- # }
+ # @!attribute [rw] region_concurrency_type
+ # The concurrency type of deploying StackSets operations in Regions,
+ # could be in parallel or one Region at a time.
+ # @return [String]
#
# @!attribute [rw] region_order
- # The order of the Regions in where you want to perform the stack
+ # The order of the Regions where you want to perform the stack
# operation.
# @return [Array<String>]
#
# @!attribute [rw] failure_tolerance_count
# The number of accounts, per Region, for which this operation can
- # fail before AWS CloudFormation stops the operation in that Region.
- # If the operation is stopped in a Region, AWS CloudFormation doesn't
+ # fail before CloudFormation stops the operation in that Region. If
+ # the operation is stopped in a Region, CloudFormation doesn't
# attempt the operation in any subsequent Regions.
#
# Conditional: You must specify either `FailureToleranceCount` or
# `FailureTolerancePercentage` (but not both).
+ #
+ # By default, `0` is specified.
# @return [Integer]
#
# @!attribute [rw] failure_tolerance_percentage
# The percentage of accounts, per Region, for which this stack
- # operation can fail before AWS CloudFormation stops the operation in
- # that Region. If the operation is stopped in a Region, AWS
- # CloudFormation doesn't attempt the operation in any subsequent
- # Regions.
+ # operation can fail before CloudFormation stops the operation in that
+ # Region. If the operation is stopped in a Region, CloudFormation
+ # doesn't attempt the operation in any subsequent Regions.
#
# When calculating the number of accounts based on the specified
- # percentage, AWS CloudFormation rounds *down* to the next whole
- # number.
+ # percentage, CloudFormation rounds *down* to the next whole number.
#
# Conditional: You must specify either `FailureToleranceCount` or
# `FailureTolerancePercentage`, but not both.
+ #
+ # By default, `0` is specified.
# @return [Integer]
#
# @!attribute [rw] max_concurrent_count
# The maximum number of accounts in which to perform this operation at
- # one time. This is dependent on the value of `FailureToleranceCount`.
- # `MaxConcurrentCount` is at most one more than the
- # `FailureToleranceCount`.
+ # one time. This is dependent on the value of
+ # `FailureToleranceCount`.`MaxConcurrentCount` is at most one more
+ # than the `FailureToleranceCount`.
#
# Note that this setting lets you specify the *maximum* for
# operations. For large deployments, under certain circumstances the
@@ -6776,6 +7951,8 @@ module Aws::CloudFormation
#
# Conditional: You must specify either `MaxConcurrentCount` or
# `MaxConcurrentPercentage`, but not both.
+ #
+ # By default, `1` is specified.
# @return [Integer]
#
# @!attribute [rw] max_concurrent_percentage
@@ -6783,7 +7960,7 @@ module Aws::CloudFormation
# operation at one time.
#
# When calculating the number of accounts based on the specified
- # percentage, AWS CloudFormation rounds down to the next whole number.
+ # percentage, CloudFormation rounds down to the next whole number.
# This is true except in cases where rounding down would result is
# zero. In this case, CloudFormation sets the number as one instead.
#
@@ -6794,11 +7971,14 @@ module Aws::CloudFormation
#
# Conditional: You must specify either `MaxConcurrentCount` or
# `MaxConcurrentPercentage`, but not both.
+ #
+ # By default, `1` is specified.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperationPreferences AWS API Documentation
#
class StackSetOperationPreferences < Struct.new(
+ :region_concurrency_type,
:region_order,
:failure_tolerance_count,
:failure_tolerance_percentage,
@@ -6812,37 +7992,38 @@ module Aws::CloudFormation
# results for a given account in a given Region.
#
# @!attribute [rw] account
- # \[`Self-managed` permissions\] The name of the AWS account for this
- # operation result.
+ # \[Self-managed permissions\] The name of the Amazon Web Services
+ # account for this operation result.
# @return [String]
#
# @!attribute [rw] region
- # The name of the AWS Region for this operation result.
+ # The name of the Amazon Web Services Region for this operation
+ # result.
# @return [String]
#
# @!attribute [rw] status
# The result status of the stack set operation for the given account
# in the given Region.
#
- # * `CANCELLED`\: The operation in the specified account and Region
- # has been cancelled. This is either because a user has stopped the
- # stack set operation, or because the failure tolerance of the stack
- # set operation has been exceeded.
+ # * `CANCELLED`: The operation in the specified account and Region has
+ # been canceled. This is either because a user has stopped the stack
+ # set operation, or because the failure tolerance of the stack set
+ # operation has been exceeded.
#
- # * `FAILED`\: The operation in the specified account and Region
+ # * `FAILED`: The operation in the specified account and Region
# failed.
#
# If the stack set operation fails in enough accounts within a
# Region, the failure tolerance for the stack set operation as a
# whole might be exceeded.
#
- # * `RUNNING`\: The operation in the specified account and Region is
+ # * `RUNNING`: The operation in the specified account and Region is
# currently in progress.
#
- # * `PENDING`\: The operation in the specified account and Region has
+ # * `PENDING`: The operation in the specified account and Region has
# yet to start.
#
- # * `SUCCEEDED`\: The operation in the specified account and Region
+ # * `SUCCEEDED`: The operation in the specified account and Region
# completed successfully.
# @return [String]
#
@@ -6851,13 +8032,12 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] account_gate_result
- # The results of the account gate function AWS CloudFormation invokes,
- # if present, before proceeding with stack set operations in an
- # account
+ # The results of the account gate function CloudFormation invokes, if
+ # present, before proceeding with stack set operations in an account.
# @return [Types::AccountGateResult]
#
# @!attribute [rw] organizational_unit_id
- # \[`Service-managed` permissions\] The organization root ID or
+ # \[Service-managed permissions\] The organization root ID or
# organizational unit (OU) IDs that you specified for
# [DeploymentTargets][1].
#
@@ -6879,6 +8059,21 @@ module Aws::CloudFormation
include Aws::Structure
end
+ # Detailed information about the StackSet operation.
+ #
+ # @!attribute [rw] failed_stack_instances_count
+ # The number of stack instances for which the StackSet operation
+ # failed.
+ # @return [Integer]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperationStatusDetails AWS API Documentation
+ #
+ class StackSetOperationStatusDetails < Struct.new(
+ :failed_stack_instances_count)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# The structures that contain summary information about the specified
# operation.
#
@@ -6890,36 +8085,34 @@ module Aws::CloudFormation
# The type of operation: `CREATE`, `UPDATE`, or `DELETE`. Create and
# delete operations affect only the specified stack instances that are
# associated with the specified stack set. Update operations affect
- # both the stack set itself as well as *all* associated stack set
- # instances.
+ # both the stack set itself and *all* associated stack set instances.
# @return [String]
#
# @!attribute [rw] status
# The overall status of the operation.
#
- # * `FAILED`\: The operation exceeded the specified failure tolerance.
+ # * `FAILED`: The operation exceeded the specified failure tolerance.
# The failure tolerance value that you've set for an operation is
# applied for each Region during stack create and update operations.
# If the number of failed stacks within a Region exceeds the failure
# tolerance, the status of the operation in the Region is set to
# `FAILED`. This in turn sets the status of the operation as a whole
- # to `FAILED`, and AWS CloudFormation cancels the operation in any
+ # to `FAILED`, and CloudFormation cancels the operation in any
# remaining Regions.
#
- # * `QUEUED`\: \[`Service-managed` permissions\] For automatic
+ # * `QUEUED`: \[Service-managed permissions\] For automatic
# deployments that require a sequence of operations, the operation
# is queued to be performed. For more information, see the [stack
- # set operation status codes][1] in the AWS CloudFormation User
- # Guide.
+ # set operation status codes][1] in the CloudFormation User Guide.
#
- # * `RUNNING`\: The operation is currently being performed.
+ # * `RUNNING`: The operation is currently being performed.
#
- # * `STOPPED`\: The user has cancelled the operation.
+ # * `STOPPED`: The user has canceled the operation.
#
- # * `STOPPING`\: The operation is in the process of stopping, at user
+ # * `STOPPING`: The operation is in the process of stopping, at user
# request.
#
- # * `SUCCEEDED`\: The operation completed creating or updating all the
+ # * `SUCCEEDED`: The operation completed creating or updating all the
# specified stacks without exceeding the failure tolerance for the
# operation.
#
@@ -6932,9 +8125,9 @@ module Aws::CloudFormation
# The time at which the operation was initiated. Note that the
# creation times for the stack set operation might differ from the
# creation time of the individual stacks themselves. This is because
- # AWS CloudFormation needs to perform preparatory work for the
- # operation, such as dispatching the work to the requested Regions,
- # before actually creating the first stacks.
+ # CloudFormation needs to perform preparatory work for the operation,
+ # such as dispatching the work to the requested Regions, before
+ # actually creating the first stacks.
# @return [Time]
#
# @!attribute [rw] end_timestamp
@@ -6944,6 +8137,26 @@ module Aws::CloudFormation
# account or Region.
# @return [Time]
#
+ # @!attribute [rw] status_reason
+ # The status of the operation in details.
+ # @return [String]
+ #
+ # @!attribute [rw] status_details
+ # Detailed information about the stack set operation.
+ # @return [Types::StackSetOperationStatusDetails]
+ #
+ # @!attribute [rw] operation_preferences
+ # The user-specified preferences for how CloudFormation performs a
+ # stack set operation.
+ #
+ # For more information about maximum concurrent accounts and failure
+ # tolerance, see [Stack set operation options][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
+ # @return [Types::StackSetOperationPreferences]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperationSummary AWS API Documentation
#
class StackSetOperationSummary < Struct.new(
@@ -6951,7 +8164,10 @@ module Aws::CloudFormation
:action,
:status,
:creation_timestamp,
- :end_timestamp)
+ :end_timestamp,
+ :status_reason,
+ :status_details,
+ :operation_preferences)
SENSITIVE = []
include Aws::Structure
end
@@ -6977,9 +8193,9 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] auto_deployment
- # \[`Service-managed` permissions\] Describes whether StackSets
- # automatically deploys to AWS Organizations accounts that are added
- # to a target organizational unit (OU).
+ # \[Service-managed permissions\] Describes whether StackSets
+ # automatically deploys to Organizations accounts that are added to a
+ # target organizational unit (OU).
# @return [Types::AutoDeployment]
#
# @!attribute [rw] permission_model
@@ -6993,8 +8209,8 @@ module Aws::CloudFormation
#
# * With `service-managed` permissions, StackSets automatically
# creates the IAM roles required to deploy to accounts managed by
- # AWS Organizations. For more information, see [Grant
- # Service-Managed Stack Set Permissions][2].
+ # Organizations. For more information, see [Grant Service-Managed
+ # Stack Set Permissions][2].
#
#
#
@@ -7009,27 +8225,32 @@ module Aws::CloudFormation
# have drifted from their expected template and parameter
# configuration.
#
- # * `DRIFTED`\: One or more of the stack instances belonging to the
+ # * `DRIFTED`: One or more of the stack instances belonging to the
# stack set stack differs from the expected template and parameter
# configuration. A stack instance is considered to have drifted if
# one or more of the resources in the associated stack have drifted.
#
- # * `NOT_CHECKED`\: AWS CloudFormation has not checked the stack set
- # for drift.
+ # * `NOT_CHECKED`: CloudFormation hasn't checked the stack set for
+ # drift.
#
- # * `IN_SYNC`\: All of the stack instances belonging to the stack set
+ # * `IN_SYNC`: All the stack instances belonging to the stack set
# stack match from the expected template and parameter
# configuration.
#
- # * `UNKNOWN`\: This value is reserved for future use.
+ # * `UNKNOWN`: This value is reserved for future use.
# @return [String]
#
# @!attribute [rw] last_drift_check_timestamp
# Most recent time when CloudFormation performed a drift detection
# operation on the stack set. This value will be `NULL` for any stack
- # set on which drift detection has not yet been performed.
+ # set on which drift detection hasn't yet been performed.
# @return [Time]
#
+ # @!attribute [rw] managed_execution
+ # Describes whether StackSets performs non-conflicting operations
+ # concurrently and queues conflicting operations.
+ # @return [Types::ManagedExecution]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetSummary AWS API Documentation
#
class StackSetSummary < Struct.new(
@@ -7040,7 +8261,8 @@ module Aws::CloudFormation
:auto_deployment,
:permission_model,
:drift_status,
- :last_drift_check_timestamp)
+ :last_drift_check_timestamp,
+ :managed_execution)
SENSITIVE = []
include Aws::Structure
end
@@ -7087,7 +8309,7 @@ module Aws::CloudFormation
# stack.
#
# For more information, see [Working with Nested Stacks][1] in the
- # *AWS CloudFormation User Guide*.
+ # *CloudFormation User Guide*.
#
#
#
@@ -7100,7 +8322,7 @@ module Aws::CloudFormation
# ultimately belongs.
#
# For more information, see [Working with Nested Stacks][1] in the
- # *AWS CloudFormation User Guide*.
+ # *CloudFormation User Guide*.
#
#
#
@@ -7108,8 +8330,8 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] drift_information
- # Summarizes information on whether a stack's actual configuration
- # differs, or has *drifted*, from it's expected configuration, as
+ # Summarizes information about whether a stack's actual configuration
+ # differs, or has *drifted*, from its expected configuration, as
# defined in the stack template and any values specified as template
# parameters. For more information, see [Detecting Unregulated
# Configuration Changes to Stacks and Resources][1].
@@ -7144,14 +8366,6 @@ module Aws::CloudFormation
#
class StaleRequestException < Aws::EmptyStructure; end
- # @note When making an API call, you may pass StopStackSetOperationInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # operation_id: "ClientRequestToken", # required
- # }
- #
# @!attribute [rw] stack_set_name
# The name or unique ID of the stack set that you want to stop the
# operation for.
@@ -7161,11 +8375,35 @@ module Aws::CloudFormation
# The ID of the stack operation.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StopStackSetOperationInput AWS API Documentation
#
class StopStackSetOperationInput < Struct.new(
:stack_set_name,
- :operation_id)
+ :operation_id,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -7175,20 +8413,12 @@ module Aws::CloudFormation
class StopStackSetOperationOutput < Aws::EmptyStructure; end
# The Tag type enables you to specify a key-value pair that can be used
- # to store information about an AWS CloudFormation stack.
- #
- # @note When making an API call, you may pass Tag
- # data as a hash:
- #
- # {
- # key: "TagKey", # required
- # value: "TagValue", # required
- # }
+ # to store information about an CloudFormation stack.
#
# @!attribute [rw] key
# *Required*. A string used to identify this tag. You can specify a
# maximum of 128 characters for a tag key. Tags owned by Amazon Web
- # Services (AWS) have the reserved prefix: `aws:`.
+ # Services (Amazon Web Services) have the reserved prefix: `aws:`.
# @return [String]
#
# @!attribute [rw] value
@@ -7235,47 +8465,408 @@ module Aws::CloudFormation
include Aws::Structure
end
+ # @!attribute [rw] arn
+ # The Amazon Resource Name (ARN) of the extension.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ # @return [String]
+ #
+ # @!attribute [rw] type
+ # The type of the extension to test.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ # @return [String]
+ #
+ # @!attribute [rw] type_name
+ # The name of the extension to test.
+ #
+ # Conditional: You must specify `Arn`, or `TypeName` and `Type`.
+ # @return [String]
+ #
+ # @!attribute [rw] version_id
+ # The version of the extension to test.
+ #
+ # You can specify the version id with either `Arn`, or with `TypeName`
+ # and `Type`.
+ #
+ # If you don't specify a version, CloudFormation uses the default
+ # version of the extension in this account and Region for testing.
+ # @return [String]
+ #
+ # @!attribute [rw] log_delivery_bucket
+ # The S3 bucket to which CloudFormation delivers the contract test
+ # execution logs.
+ #
+ # CloudFormation delivers the logs by the time contract testing has
+ # completed and the extension has been assigned a test type status of
+ # `PASSED` or `FAILED`.
+ #
+ # The user calling `TestType` must be able to access items in the
+ # specified S3 bucket. Specifically, the user needs the following
+ # permissions:
+ #
+ # * `GetObject`
+ #
+ # * `PutObject`
+ #
+ # For more information, see [Actions, Resources, and Condition Keys
+ # for Amazon S3][1] in the *Amazon Web Services Identity and Access
+ # Management User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TestTypeInput AWS API Documentation
+ #
+ class TestTypeInput < Struct.new(
+ :arn,
+ :type,
+ :type_name,
+ :version_id,
+ :log_delivery_bucket)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # @!attribute [rw] type_version_arn
+ # The Amazon Resource Name (ARN) of the extension.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TestTypeOutput AWS API Documentation
+ #
+ class TestTypeOutput < Struct.new(
+ :type_version_arn)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
# A client request token already exists.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TokenAlreadyExistsException AWS API Documentation
#
class TokenAlreadyExistsException < Aws::EmptyStructure; end
- # The specified type does not exist in the CloudFormation registry.
+ # Detailed information concerning the specification of a CloudFormation
+ # extension in a given account and Region.
+ #
+ # For more information, see [Configuring extensions at the account
+ # level][1] in the *CloudFormation User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration
+ #
+ # @!attribute [rw] arn
+ # The Amazon Resource Name (ARN) for the configuration data, in this
+ # account and Region.
+ # @return [String]
+ #
+ # @!attribute [rw] alias
+ # The alias specified for this configuration, if one was specified
+ # when the configuration was set.
+ # @return [String]
+ #
+ # @!attribute [rw] configuration
+ # A JSON string specifying the configuration data for the extension,
+ # in this account and Region.
+ #
+ # If a configuration hasn't been set for a specified extension,
+ # CloudFormation returns `\{\}`.
+ # @return [String]
+ #
+ # @!attribute [rw] last_updated
+ # When the configuration data was last updated for this extension.
+ #
+ # If a configuration hasn't been set for a specified extension,
+ # CloudFormation returns `null`.
+ # @return [Time]
+ #
+ # @!attribute [rw] type_arn
+ # The Amazon Resource Name (ARN) for the extension, in this account
+ # and Region.
+ #
+ # For public extensions, this will be the ARN assigned when you
+ # [activate the type][1] in this account and Region. For private
+ # extensions, this will be the ARN assigned when you [register the
+ # type][2] in this account and Region.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
+ # @return [String]
+ #
+ # @!attribute [rw] type_name
+ # The name of the extension.
+ # @return [String]
+ #
+ # @!attribute [rw] is_default_configuration
+ # Whether this configuration data is the default configuration for the
+ # extension.
+ # @return [Boolean]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeConfigurationDetails AWS API Documentation
+ #
+ class TypeConfigurationDetails < Struct.new(
+ :arn,
+ :alias,
+ :configuration,
+ :last_updated,
+ :type_arn,
+ :type_name,
+ :is_default_configuration)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # Identifying information for the configuration of a CloudFormation
+ # extension.
+ #
+ # @!attribute [rw] type_arn
+ # The Amazon Resource Name (ARN) for the extension, in this account
+ # and Region.
+ #
+ # For public extensions, this will be the ARN assigned when you
+ # [activate the type][1] in this account and Region. For private
+ # extensions, this will be the ARN assigned when you [register the
+ # type][2] in this account and Region.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
+ # @return [String]
+ #
+ # @!attribute [rw] type_configuration_alias
+ # The alias specified for this configuration, if one was specified
+ # when the configuration was set.
+ # @return [String]
+ #
+ # @!attribute [rw] type_configuration_arn
+ # The Amazon Resource Name (ARN) for the configuration, in this
+ # account and Region.
+ # @return [String]
+ #
+ # @!attribute [rw] type
+ # The type of extension.
+ # @return [String]
+ #
+ # @!attribute [rw] type_name
+ # The name of the extension type to which this configuration applies.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeConfigurationIdentifier AWS API Documentation
+ #
+ class TypeConfigurationIdentifier < Struct.new(
+ :type_arn,
+ :type_configuration_alias,
+ :type_configuration_arn,
+ :type,
+ :type_name)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The specified extension configuration can't be found.
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeConfigurationNotFoundException AWS API Documentation
+ #
+ class TypeConfigurationNotFoundException < Aws::EmptyStructure; end
+
+ # Filter criteria to use in determining which extensions to return.
+ #
+ # @!attribute [rw] category
+ # The category of extensions to return.
+ #
+ # * `REGISTERED`: Private extensions that have been registered for
+ # this account and Region.
+ #
+ # * `ACTIVATED`: Public extensions that have been activated for this
+ # account and Region.
+ #
+ # * `THIRD_PARTY`: Extensions available for use from publishers other
+ # than Amazon. This includes:
+ #
+ # * Private extensions registered in the account.
+ #
+ # * Public extensions from publishers other than Amazon, whether
+ # activated or not.
+ #
+ # * `AWS_TYPES`: Extensions available for use from Amazon.
+ # @return [String]
+ #
+ # @!attribute [rw] publisher_id
+ # The id of the publisher of the extension.
+ #
+ # Extensions published by Amazon aren't assigned a publisher ID. Use
+ # the `AWS_TYPES` category to specify a list of types published by
+ # Amazon.
+ # @return [String]
+ #
+ # @!attribute [rw] type_name_prefix
+ # A prefix to use as a filter for results.
+ # @return [String]
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeFilters AWS API Documentation
+ #
+ class TypeFilters < Struct.new(
+ :category,
+ :publisher_id,
+ :type_name_prefix)
+ SENSITIVE = []
+ include Aws::Structure
+ end
+
+ # The specified extension doesn't exist in the CloudFormation registry.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeNotFoundException AWS API Documentation
#
class TypeNotFoundException < Aws::EmptyStructure; end
- # Contains summary information about the specified CloudFormation type.
+ # Contains summary information about the specified CloudFormation
+ # extension.
#
# @!attribute [rw] type
- # The kind of type.
+ # The kind of extension.
# @return [String]
#
# @!attribute [rw] type_name
- # The name of the type.
+ # The name of the extension.
+ #
+ # If you specified a `TypeNameAlias` when you [activate this
+ # extension][1] in your account and Region, CloudFormation considers
+ # that alias as the type name.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
# @return [String]
#
# @!attribute [rw] default_version_id
- # The ID of the default version of the type. The default version is
- # used when the type version is not specified.
+ # The ID of the default version of the extension. The default version
+ # is used when the extension version isn't specified.
+ #
+ # This applies only to private extensions you have registered in your
+ # account. For public extensions, both those provided by Amazon and
+ # published by third parties, CloudFormation returns `null`. For more
+ # information, see [RegisterType][1].
+ #
+ # To set the default version of an extension, use
+ # SetTypeDefaultVersion.
#
- # To set the default version of a type, use ` SetTypeDefaultVersion `.
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
# @return [String]
#
# @!attribute [rw] type_arn
- # The Amazon Resource Name (ARN) of the type.
+ # The Amazon Resource Name (ARN) of the extension.
# @return [String]
#
# @!attribute [rw] last_updated
- # When the current default version of the type was registered.
+ # When the specified extension version was registered. This applies
+ # only to:
+ #
+ # * Private extensions you have registered in your account. For more
+ # information, see [RegisterType][1].
+ #
+ # * Public extensions you have activated in your account with
+ # auto-update specified. For more information, see
+ # [ActivateType][2].
+ #
+ # For all other extension types, CloudFormation returns `null`.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
+ # [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
# @return [Time]
#
# @!attribute [rw] description
- # The description of the type.
+ # The description of the extension.
+ # @return [String]
+ #
+ # @!attribute [rw] publisher_id
+ # The ID of the extension publisher, if the extension is published by
+ # a third party. Extensions published by Amazon don't return a
+ # publisher ID.
+ # @return [String]
+ #
+ # @!attribute [rw] original_type_name
+ # For public extensions that have been activated for this account and
+ # Region, the type name of the public extension.
+ #
+ # If you specified a `TypeNameAlias` when enabling the extension in
+ # this account and Region, CloudFormation treats that alias as the
+ # extension's type name within the account and Region, not the type
+ # name of the public extension. For more information, see [Specifying
+ # aliases to refer to extensions][1] in the *CloudFormation User
+ # Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
# @return [String]
#
+ # @!attribute [rw] public_version_number
+ # For public extensions that have been activated for this account and
+ # Region, the version of the public extension to be used for
+ # CloudFormation operations in this account and Region.
+ #
+ # How you specified `AutoUpdate` when enabling the extension affects
+ # whether CloudFormation automatically updates the extension in this
+ # account and Region when a new version is released. For more
+ # information, see [Setting CloudFormation to automatically use new
+ # versions of extensions][1] in the *CloudFormation User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
+ # @return [String]
+ #
+ # @!attribute [rw] latest_public_version
+ # For public extensions that have been activated for this account and
+ # Region, the latest version of the public extension *that is
+ # available*. For any extensions other than activated third-arty
+ # extensions, CloudFormation returns `null`.
+ #
+ # How you specified `AutoUpdate` when enabling the extension affects
+ # whether CloudFormation automatically updates the extension in this
+ # account and Region when a new version is released. For more
+ # information, see [Setting CloudFormation to automatically use new
+ # versions of extensions][1] in the *CloudFormation User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
+ # @return [String]
+ #
+ # @!attribute [rw] publisher_identity
+ # The service used to verify the publisher identity.
+ #
+ # For more information, see [Registering your account to publish
+ # CloudFormation extensions][1] in the <i> CFN-CLI User Guide for
+ # Extension Development</i>.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html
+ # @return [String]
+ #
+ # @!attribute [rw] publisher_name
+ # The publisher name, as defined in the public profile for that
+ # publisher in the service used to verify the publisher identity.
+ # @return [String]
+ #
+ # @!attribute [rw] is_activated
+ # Whether the extension is activated for this account and Region.
+ #
+ # This applies only to third-party public extensions. Extensions
+ # published by Amazon are activated by default.
+ # @return [Boolean]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeSummary AWS API Documentation
#
class TypeSummary < Struct.new(
@@ -7284,34 +8875,46 @@ module Aws::CloudFormation
:default_version_id,
:type_arn,
:last_updated,
- :description)
+ :description,
+ :publisher_id,
+ :original_type_name,
+ :public_version_number,
+ :latest_public_version,
+ :publisher_identity,
+ :publisher_name,
+ :is_activated)
SENSITIVE = []
include Aws::Structure
end
# Contains summary information about a specific version of a
- # CloudFormation type.
+ # CloudFormation extension.
#
# @!attribute [rw] type
- # The kind of type.
+ # The kind of extension.
# @return [String]
#
# @!attribute [rw] type_name
- # The name of the type.
+ # The name of the extension.
# @return [String]
#
# @!attribute [rw] version_id
- # The ID of a specific version of the type. The version ID is the
+ # The ID of a specific version of the extension. The version ID is the
# value at the end of the Amazon Resource Name (ARN) assigned to the
- # type version when it is registered.
+ # extension version when it's registered.
# @return [String]
#
# @!attribute [rw] is_default_version
- # Whether the specified type version is set as the default version.
+ # Whether the specified extension version is set as the default
+ # version.
+ #
+ # This applies only to private extensions you have registered in your
+ # account, and extensions published by Amazon. For public third-party
+ # extensions, CloudFormation returns `null`.
# @return [Boolean]
#
# @!attribute [rw] arn
- # The Amazon Resource Name (ARN) of the type version.
+ # The Amazon Resource Name (ARN) of the extension version.
# @return [String]
#
# @!attribute [rw] time_created
@@ -7319,7 +8922,25 @@ module Aws::CloudFormation
# @return [Time]
#
# @!attribute [rw] description
- # The description of the type version.
+ # The description of the extension version.
+ # @return [String]
+ #
+ # @!attribute [rw] public_version_number
+ # For public extensions that have been activated for this account and
+ # Region, the version of the public extension to be used for
+ # CloudFormation operations in this account and Region. For any
+ # extensions other than activated third-arty extensions,
+ # CloudFormation returns `null`.
+ #
+ # How you specified `AutoUpdate` when enabling the extension affects
+ # whether CloudFormation automatically updates the extension in this
+ # account and Region when a new version is released. For more
+ # information, see [Setting CloudFormation to automatically use new
+ # versions of extensions][1] in the *CloudFormation User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TypeVersionSummary AWS API Documentation
@@ -7331,55 +8952,14 @@ module Aws::CloudFormation
:is_default_version,
:arn,
:time_created,
- :description)
+ :description,
+ :public_version_number)
SENSITIVE = []
include Aws::Structure
end
# The input for an UpdateStack action.
#
- # @note When making an API call, you may pass UpdateStackInput
- # data as a hash:
- #
- # {
- # stack_name: "StackName", # required
- # template_body: "TemplateBody",
- # template_url: "TemplateURL",
- # use_previous_template: false,
- # stack_policy_during_update_body: "StackPolicyDuringUpdateBody",
- # stack_policy_during_update_url: "StackPolicyDuringUpdateURL",
- # parameters: [
- # {
- # parameter_key: "ParameterKey",
- # parameter_value: "ParameterValue",
- # use_previous_value: false,
- # resolved_value: "ParameterValue",
- # },
- # ],
- # capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
- # resource_types: ["ResourceType"],
- # role_arn: "RoleARN",
- # rollback_configuration: {
- # rollback_triggers: [
- # {
- # arn: "Arn", # required
- # type: "Type", # required
- # },
- # ],
- # monitoring_time_in_minutes: 1,
- # },
- # stack_policy_body: "StackPolicyBody",
- # stack_policy_url: "StackPolicyURL",
- # notification_arns: ["NotificationARN"],
- # tags: [
- # {
- # key: "TagKey", # required
- # value: "TagValue", # required
- # },
- # ],
- # client_request_token: "ClientRequestToken",
- # }
- #
# @!attribute [rw] stack_name
# The name or unique stack ID of the stack to update.
# @return [String]
@@ -7387,7 +8967,7 @@ module Aws::CloudFormation
# @!attribute [rw] template_body
# Structure containing the template body with a minimum length of 1
# byte and a maximum length of 51,200 bytes. (For more information, go
- # to [Template Anatomy][1] in the AWS CloudFormation User Guide.)
+ # to [Template Anatomy][1] in the CloudFormation User Guide.)
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
@@ -7400,9 +8980,9 @@ module Aws::CloudFormation
#
# @!attribute [rw] template_url
# Location of file containing the template body. The URL must point to
- # a template that is located in an Amazon S3 bucket. For more
- # information, go to [Template Anatomy][1] in the AWS CloudFormation
- # User Guide.
+ # a template that's located in an Amazon S3 bucket or a Systems
+ # Manager document. For more information, go to [Template Anatomy][1]
+ # in the CloudFormation User Guide.
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
@@ -7428,7 +9008,7 @@ module Aws::CloudFormation
# `StackPolicyDuringUpdateURL` parameter, but not both.
#
# If you want to update protected resources, specify a temporary
- # overriding stack policy during this update. If you do not specify a
+ # overriding stack policy during this update. If you don't specify a
# stack policy, the current policy that is associated with the stack
# will be used.
# @return [String]
@@ -7441,7 +9021,7 @@ module Aws::CloudFormation
# parameter, but not both.
#
# If you want to update protected resources, specify a temporary
- # overriding stack policy during this update. If you do not specify a
+ # overriding stack policy during this update. If you don't specify a
# stack policy, the current policy that is associated with the stack
# will be used.
# @return [String]
@@ -7457,16 +9037,16 @@ module Aws::CloudFormation
#
# @!attribute [rw] capabilities
# In some cases, you must explicitly acknowledge that your stack
- # template contains certain capabilities in order for AWS
- # CloudFormation to update the stack.
+ # template contains certain capabilities in order for CloudFormation
+ # to update the stack.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stacks, you
- # must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stacks, you must explicitly acknowledge this by specifying one of
+ # these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -7476,10 +9056,10 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
+ # * If you don't specify either of these capabilities,
# CloudFormation returns an `InsufficientCapabilities` error.
#
- # If your stack template contains these resources, we recommend that
+ # If your stack template contains these resources, we suggest that
# you review all permissions associated with them and edit their
# permissions if necessary.
#
@@ -7487,7 +9067,7 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::Group][2]
#
- # * [ AWS::IAM::InstanceProfile][3]
+ # * [AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
@@ -7495,9 +9075,9 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::User][6]
#
- # * [ AWS::IAM::UserToGroupAddition][7]
+ # * [AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
@@ -7513,23 +9093,22 @@ module Aws::CloudFormation
# reviewing the resulting changes in a change set, you must
# acknowledge this capability. This includes the [AWS::Include][9]
# and [AWS::Serverless][10] transforms, which are macros hosted by
- # AWS CloudFormation.
+ # CloudFormation.
#
- # Change sets do not currently support nested stacks. If you want to
- # update a stack from a stack template that contains macros *and*
- # nested stacks, you must update the stack directly from the
- # template using this capability.
+ # If you want to update a stack from a stack template that contains
+ # macros *and* nested stacks, you must update the stack directly
+ # from the template using this capability.
#
# You should only update stacks directly from a stack template that
# contains macros if you know what processing the macro performs.
#
# Each macro relies on an underlying Lambda service function for
# processing stack templates. Be aware that the Lambda function
- # owner can update the function operation without AWS CloudFormation
+ # owner can update the function operation without CloudFormation
# being notified.
#
- # For more information, see [Using AWS CloudFormation Macros to
- # Perform Custom Processing on Templates][11].
+ # For more information, see [Using CloudFormation Macros to Perform
+ # Custom Processing on Templates][11].
#
#
#
@@ -7552,12 +9131,11 @@ module Aws::CloudFormation
# `AWS::EC2::*`, or `Custom::MyCustomInstance`.
#
# If the list of resource types doesn't include a resource that
- # you're updating, the stack update fails. By default, AWS
- # CloudFormation grants permissions to all resource types. AWS
- # Identity and Access Management (IAM) uses this parameter for AWS
- # CloudFormation-specific condition keys in IAM policies. For more
- # information, see [Controlling Access with AWS Identity and Access
- # Management][1].
+ # you're updating, the stack update fails. By default, CloudFormation
+ # grants permissions to all resource types. Identity and Access
+ # Management (IAM) uses this parameter for CloudFormation-specific
+ # condition keys in IAM policies. For more information, see
+ # [Controlling Access with Identity and Access Management][1].
#
#
#
@@ -7565,23 +9143,23 @@ module Aws::CloudFormation
# @return [Array<String>]
#
# @!attribute [rw] role_arn
- # The Amazon Resource Name (ARN) of an AWS Identity and Access
- # Management (IAM) role that AWS CloudFormation assumes to update the
- # stack. AWS CloudFormation uses the role's credentials to make calls
- # on your behalf. AWS CloudFormation always uses this role for all
- # future operations on the stack. As long as users have permission to
- # operate on the stack, AWS CloudFormation uses this role even if the
+ # The Amazon Resource Name (ARN) of an Identity and Access Management
+ # (IAM) role that CloudFormation assumes to update the stack.
+ # CloudFormation uses the role's credentials to make calls on your
+ # behalf. CloudFormation always uses this role for all future
+ # operations on the stack. Provided that users have permission to
+ # operate on the stack, CloudFormation uses this role even if the
# users don't have permission to pass it. Ensure that the role grants
# least privilege.
#
- # If you don't specify a value, AWS CloudFormation uses the role that
- # was previously associated with the stack. If no role is available,
- # AWS CloudFormation uses a temporary session that is generated from
- # your user credentials.
+ # If you don't specify a value, CloudFormation uses the role that was
+ # previously associated with the stack. If no role is available,
+ # CloudFormation uses a temporary session that is generated from your
+ # user credentials.
# @return [String]
#
# @!attribute [rw] rollback_configuration
- # The rollback triggers for AWS CloudFormation to monitor during stack
+ # The rollback triggers for CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
# @return [Types::RollbackConfiguration]
@@ -7592,7 +9170,7 @@ module Aws::CloudFormation
# both.
#
# You might update the stack policy, for example, in order to protect
- # a new resource that you created during a stack update. If you do not
+ # a new resource that you created during a stack update. If you don't
# specify a stack policy, the current policy that is associated with
# the stack is unchanged.
# @return [String]
@@ -7604,33 +9182,40 @@ module Aws::CloudFormation
# `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.
#
# You might update the stack policy, for example, in order to protect
- # a new resource that you created during a stack update. If you do not
+ # a new resource that you created during a stack update. If you don't
# specify a stack policy, the current policy that is associated with
# the stack is unchanged.
# @return [String]
#
# @!attribute [rw] notification_arns
# Amazon Simple Notification Service topic Amazon Resource Names
- # (ARNs) that AWS CloudFormation associates with the stack. Specify an
+ # (ARNs) that CloudFormation associates with the stack. Specify an
# empty list to remove all notification topics.
# @return [Array<String>]
#
# @!attribute [rw] tags
- # Key-value pairs to associate with this stack. AWS CloudFormation
- # also propagates these tags to supported resources in the stack. You
- # can specify a maximum number of 50 tags.
+ # Key-value pairs to associate with this stack. CloudFormation also
+ # propagates these tags to supported resources in the stack. You can
+ # specify a maximum number of 50 tags.
#
- # If you don't specify this parameter, AWS CloudFormation doesn't
- # modify the stack's tags. If you specify an empty value, AWS
- # CloudFormation removes all associated tags.
+ # If you don't specify this parameter, CloudFormation doesn't modify
+ # the stack's tags. If you specify an empty value, CloudFormation
+ # removes all associated tags.
# @return [Array<Types::Tag>]
#
+ # @!attribute [rw] disable_rollback
+ # Preserve the state of previously provisioned resources when an
+ # operation fails.
+ #
+ # Default: `False`
+ # @return [Boolean]
+ #
# @!attribute [rw] client_request_token
# A unique identifier for this `UpdateStack` request. Specify this
- # token if you plan to retry requests so that AWS CloudFormation knows
+ # token if you plan to retry requests so that CloudFormation knows
# that you're not attempting to update a stack with the same name.
- # You might retry `UpdateStack` requests to ensure that AWS
- # CloudFormation successfully received them.
+ # You might retry `UpdateStack` requests to ensure that CloudFormation
+ # successfully received them.
#
# All events triggered by a given stack operation are assigned the
# same client request token, which you can use to track operations.
@@ -7665,59 +9250,32 @@ module Aws::CloudFormation
:stack_policy_url,
:notification_arns,
:tags,
+ :disable_rollback,
:client_request_token)
SENSITIVE = []
include Aws::Structure
end
- # @note When making an API call, you may pass UpdateStackInstancesInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetNameOrId", # required
- # accounts: ["Account"],
- # deployment_targets: {
- # accounts: ["Account"],
- # organizational_unit_ids: ["OrganizationalUnitId"],
- # },
- # regions: ["Region"], # required
- # parameter_overrides: [
- # {
- # parameter_key: "ParameterKey",
- # parameter_value: "ParameterValue",
- # use_previous_value: false,
- # resolved_value: "ParameterValue",
- # },
- # ],
- # operation_preferences: {
- # region_order: ["Region"],
- # failure_tolerance_count: 1,
- # failure_tolerance_percentage: 1,
- # max_concurrent_count: 1,
- # max_concurrent_percentage: 1,
- # },
- # operation_id: "ClientRequestToken",
- # }
- #
# @!attribute [rw] stack_set_name
# The name or unique ID of the stack set associated with the stack
# instances.
# @return [String]
#
# @!attribute [rw] accounts
- # \[`Self-managed` permissions\] The names of one or more AWS accounts
- # for which you want to update parameter values for stack instances.
- # The overridden parameter values will be applied to all stack
- # instances in the specified accounts and Regions.
+ # \[Self-managed permissions\] The names of one or more Amazon Web
+ # Services accounts for which you want to update parameter values for
+ # stack instances. The overridden parameter values will be applied to
+ # all stack instances in the specified accounts and Amazon Web
+ # Services Regions.
#
# You can specify `Accounts` or `DeploymentTargets`, but not both.
# @return [Array<String>]
#
# @!attribute [rw] deployment_targets
- # \[`Service-managed` permissions\] The AWS Organizations accounts for
- # which you want to update parameter values for stack instances. If
- # your update targets OUs, the overridden parameter values only apply
- # to the accounts that are currently in the target OUs and their child
+ # \[Service-managed permissions\] The Organizations accounts for which
+ # you want to update parameter values for stack instances. If your
+ # update targets OUs, the overridden parameter values only apply to
+ # the accounts that are currently in the target OUs and their child
# OUs. Accounts added to the target OUs and their child OUs in the
# future won't use the overridden values.
#
@@ -7725,10 +9283,10 @@ module Aws::CloudFormation
# @return [Types::DeploymentTargets]
#
# @!attribute [rw] regions
- # The names of one or more Regions in which you want to update
- # parameter values for stack instances. The overridden parameter
- # values will be applied to all stack instances in the specified
- # accounts and Regions.
+ # The names of one or more Amazon Web Services Regions in which you
+ # want to update parameter values for stack instances. The overridden
+ # parameter values will be applied to all stack instances in the
+ # specified accounts and Amazon Web Services Regions.
# @return [Array<String>]
#
# @!attribute [rw] parameter_overrides
@@ -7736,31 +9294,27 @@ module Aws::CloudFormation
# specified stack instances.
#
# Any overridden parameter values will be applied to all stack
- # instances in the specified accounts and Regions. When specifying
- # parameters and their values, be aware of how AWS CloudFormation sets
- # parameter values during stack instance update operations:
+ # instances in the specified accounts and Amazon Web Services Regions.
+ # When specifying parameters and their values, be aware of how
+ # CloudFormation sets parameter values during stack instance update
+ # operations:
#
# * To override the current value for a parameter, include the
# parameter and specify its value.
#
- # * To leave a parameter set to its present value, you can do one of
- # the following:
+ # * To leave an overridden parameter set to its present value, include
+ # the parameter and specify `UsePreviousValue` as `true`. (You
+ # can't specify both a value and set `UsePreviousValue` to `true`.)
#
- # * Do not include the parameter in the list.
+ # * To set an overridden parameter back to the value specified in the
+ # stack set, specify a parameter list but don't include the
+ # parameter in the list.
#
- # * Include the parameter and specify `UsePreviousValue` as `true`.
- # (You cannot specify both a value and set `UsePreviousValue` to
- # `true`.)
- #
- # * To set all overridden parameter back to the values specified in
- # the stack set, specify a parameter list but do not include any
- # parameters.
- #
- # * To leave all parameters set to their present values, do not
+ # * To leave all parameters set to their present values, don't
# specify this property at all.
#
# During stack set updates, any parameter values overridden for a
- # stack instance are not updated, but retain their overridden value.
+ # stack instance aren't updated, but retain their overridden value.
#
# You can only override the parameter *values* that are specified in
# the stack set; to add or delete a parameter itself, use
@@ -7778,7 +9332,7 @@ module Aws::CloudFormation
# @return [Array<Types::Parameter>]
#
# @!attribute [rw] operation_preferences
- # Preferences for how AWS CloudFormation performs this stack set
+ # Preferences for how CloudFormation performs this stack set
# operation.
# @return [Types::StackSetOperationPreferences]
#
@@ -7786,10 +9340,10 @@ module Aws::CloudFormation
# The unique identifier for this stack set operation.
#
# The operation ID also functions as an idempotency token, to ensure
- # that AWS CloudFormation performs the stack set operation only once,
- # even if you retry the request multiple times. You might retry stack
- # set operation requests to ensure that AWS CloudFormation
- # successfully received them.
+ # that CloudFormation performs the stack set operation only once, even
+ # if you retry the request multiple times. You might retry stack set
+ # operation requests to ensure that CloudFormation successfully
+ # received them.
#
# If you don't specify an operation ID, the SDK generates one
# automatically.
@@ -7798,6 +9352,29 @@ module Aws::CloudFormation
# not need to pass this option.
# @return [String]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackInstancesInput AWS API Documentation
#
class UpdateStackInstancesInput < Struct.new(
@@ -7807,7 +9384,8 @@ module Aws::CloudFormation
:regions,
:parameter_overrides,
:operation_preferences,
- :operation_id)
+ :operation_id,
+ :call_as)
SENSITIVE = []
include Aws::Structure
end
@@ -7838,53 +9416,6 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass UpdateStackSetInput
- # data as a hash:
- #
- # {
- # stack_set_name: "StackSetName", # required
- # description: "Description",
- # template_body: "TemplateBody",
- # template_url: "TemplateURL",
- # use_previous_template: false,
- # parameters: [
- # {
- # parameter_key: "ParameterKey",
- # parameter_value: "ParameterValue",
- # use_previous_value: false,
- # resolved_value: "ParameterValue",
- # },
- # ],
- # capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
- # tags: [
- # {
- # key: "TagKey", # required
- # value: "TagValue", # required
- # },
- # ],
- # operation_preferences: {
- # region_order: ["Region"],
- # failure_tolerance_count: 1,
- # failure_tolerance_percentage: 1,
- # max_concurrent_count: 1,
- # max_concurrent_percentage: 1,
- # },
- # administration_role_arn: "RoleARN",
- # execution_role_name: "ExecutionRoleName",
- # deployment_targets: {
- # accounts: ["Account"],
- # organizational_unit_ids: ["OrganizationalUnitId"],
- # },
- # permission_model: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, SELF_MANAGED
- # auto_deployment: {
- # enabled: false,
- # retain_stacks_on_account_removal: false,
- # },
- # operation_id: "ClientRequestToken",
- # accounts: ["Account"],
- # regions: ["Region"],
- # }
- #
# @!attribute [rw] stack_set_name
# The name or unique ID of the stack set that you want to update.
# @return [String]
@@ -7896,8 +9427,8 @@ module Aws::CloudFormation
# @!attribute [rw] template_body
# The structure that contains the template body, with a minimum length
# of 1 byte and a maximum length of 51,200 bytes. For more
- # information, see [Template Anatomy][1] in the AWS CloudFormation
- # User Guide.
+ # information, see [Template Anatomy][1] in the CloudFormation User
+ # Guide.
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to
@@ -7911,8 +9442,9 @@ module Aws::CloudFormation
# @!attribute [rw] template_url
# The location of the file that contains the template body. The URL
# must point to a template (maximum size: 460,800 bytes) that is
- # located in an Amazon S3 bucket. For more information, see [Template
- # Anatomy][1] in the AWS CloudFormation User Guide.
+ # located in an Amazon S3 bucket or a Systems Manager document. For
+ # more information, see [Template Anatomy][1] in the CloudFormation
+ # User Guide.
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to
@@ -7938,17 +9470,16 @@ module Aws::CloudFormation
#
# @!attribute [rw] capabilities
# In some cases, you must explicitly acknowledge that your stack
- # template contains certain capabilities in order for AWS
- # CloudFormation to update the stack set and its associated stack
- # instances.
+ # template contains certain capabilities in order for CloudFormation
+ # to update the stack set and its associated stack instances.
#
# * `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM`
#
# Some stack templates might include resources that can affect
- # permissions in your AWS account; for example, by creating new AWS
- # Identity and Access Management (IAM) users. For those stacks sets,
- # you must explicitly acknowledge this by specifying one of these
- # capabilities.
+ # permissions in your Amazon Web Services account; for example, by
+ # creating new Identity and Access Management (IAM) users. For those
+ # stacks sets, you must explicitly acknowledge this by specifying
+ # one of these capabilities.
#
# The following IAM resources require you to specify either the
# `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
@@ -7958,7 +9489,7 @@ module Aws::CloudFormation
# * If you have IAM resources with custom names, you *must* specify
# `CAPABILITY_NAMED_IAM`.
#
- # * If you don't specify either of these capabilities, AWS
+ # * If you don't specify either of these capabilities,
# CloudFormation returns an `InsufficientCapabilities` error.
#
# If your stack template contains these resources, we recommend that
@@ -7979,23 +9510,26 @@ module Aws::CloudFormation
#
# * [ AWS::IAM::UserToGroupAddition][7]
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][8].
#
# * `CAPABILITY_AUTO_EXPAND`
#
- # Some templates contain macros. If your stack template contains one
- # or more macros, and you choose to update a stack directly from the
- # processed template, without first reviewing the resulting changes
- # in a change set, you must acknowledge this capability. For more
- # information, see [Using AWS CloudFormation Macros to Perform
- # Custom Processing on Templates][9].
+ # Some templates reference macros. If your stack set template
+ # references one or more macros, you must update the stack set
+ # directly from the processed template, without first reviewing the
+ # resulting changes in a change set. To update the stack set
+ # directly, you must acknowledge this capability. For more
+ # information, see [Using CloudFormation Macros to Perform Custom
+ # Processing on Templates][9].
#
- # Stack sets do not currently support macros in stack templates.
- # (This includes the [AWS::Include][10] and [AWS::Serverless][11]
- # transforms, which are macros hosted by AWS CloudFormation.) Even
- # if you specify this capability, if you include a macro in your
- # template the stack set operation will fail.
+ # Stack sets with service-managed permissions do not currently
+ # support the use of macros in templates. (This includes the
+ # [AWS::Include][10] and [AWS::Serverless][11] transforms, which are
+ # macros hosted by CloudFormation.) Even if you specify this
+ # capability for a stack set with service-managed permissions, if
+ # you reference a macro in your template the stack set operation
+ # will fail.
#
#
#
@@ -8014,7 +9548,7 @@ module Aws::CloudFormation
#
# @!attribute [rw] tags
# The key-value pairs to associate with this stack set and the stacks
- # created from it. AWS CloudFormation also propagates these tags to
+ # created from it. CloudFormation also propagates these tags to
# supported resources that are created in the stacks. You can specify
# a maximum number of 50 tags.
#
@@ -8022,45 +9556,45 @@ module Aws::CloudFormation
# of tags that are currently associated with this stack set. This
# means:
#
- # * If you don't specify this parameter, AWS CloudFormation doesn't
+ # * If you don't specify this parameter, CloudFormation doesn't
# modify the stack's tags.
#
# * If you specify *any* tags using this parameter, you must specify
# *all* the tags that you want associated with this stack set, even
- # tags you've specifed before (for example, when creating the stack
- # set or during a previous update of the stack set.). Any tags that
- # you don't include in the updated list of tags are removed from
- # the stack set, and therefore from the stacks and resources as
+ # tags you've specified before (for example, when creating the
+ # stack set or during a previous update of the stack set.). Any tags
+ # that you don't include in the updated list of tags are removed
+ # from the stack set, and therefore from the stacks and resources as
# well.
#
- # * If you specify an empty value, AWS CloudFormation removes all
+ # * If you specify an empty value, CloudFormation removes all
# currently associated tags.
#
- # If you specify new tags as part of an `UpdateStackSet` action, AWS
+ # If you specify new tags as part of an `UpdateStackSet` action,
# CloudFormation checks to see if you have the required IAM permission
# to tag resources. If you omit tags that are currently associated
- # with the stack set from the list of tags you specify, AWS
- # CloudFormation assumes that you want to remove those tags from the
- # stack set, and checks to see if you have permission to untag
- # resources. If you don't have the necessary permission(s), the
- # entire `UpdateStackSet` action fails with an `access denied` error,
- # and the stack set is not updated.
+ # with the stack set from the list of tags you specify, CloudFormation
+ # assumes that you want to remove those tags from the stack set, and
+ # checks to see if you have permission to untag resources. If you
+ # don't have the necessary permission(s), the entire `UpdateStackSet`
+ # action fails with an `access denied` error, and the stack set is not
+ # updated.
# @return [Array<Types::Tag>]
#
# @!attribute [rw] operation_preferences
- # Preferences for how AWS CloudFormation performs this stack set
+ # Preferences for how CloudFormation performs this stack set
# operation.
# @return [Types::StackSetOperationPreferences]
#
# @!attribute [rw] administration_role_arn
- # The Amazon Resource Number (ARN) of the IAM role to use to update
- # this stack set.
+ # The Amazon Resource Name (ARN) of the IAM role to use to update this
+ # stack set.
#
# Specify an IAM role only if you are using customized administrator
# roles to control which users or groups can manage specific stack
# sets within the same administrator account. For more information,
- # see [Granting Permissions for Stack Set Operations][1] in the *AWS
- # CloudFormation User Guide*.
+ # see [Granting Permissions for Stack Set Operations][1] in the
+ # *CloudFormation User Guide*.
#
# If you specified a customized administrator role when you created
# the stack set, you must specify a customized administrator role,
@@ -8074,7 +9608,7 @@ module Aws::CloudFormation
#
# @!attribute [rw] execution_role_name
# The name of the IAM execution role to use to update the stack set.
- # If you do not specify an execution role, AWS CloudFormation uses the
+ # If you do not specify an execution role, CloudFormation uses the
# `AWSCloudFormationStackSetExecutionRole` role for the stack set
# operation.
#
@@ -8082,29 +9616,29 @@ module Aws::CloudFormation
# to control which stack resources users and groups can include in
# their stack sets.
#
- # If you specify a customized execution role, AWS CloudFormation uses
- # that role to update the stack. If you do not specify a customized
- # execution role, AWS CloudFormation performs the update using the
- # role previously associated with the stack set, so long as you have
+ # If you specify a customized execution role, CloudFormation uses that
+ # role to update the stack. If you do not specify a customized
+ # execution role, CloudFormation performs the update using the role
+ # previously associated with the stack set, so long as you have
# permissions to perform operations on the stack set.
# @return [String]
#
# @!attribute [rw] deployment_targets
- # \[`Service-managed` permissions\] The AWS Organizations accounts in
- # which to update associated stack instances.
+ # \[Service-managed permissions\] The Organizations accounts in which
+ # to update associated stack instances.
#
# To update all the stack instances associated with this stack set, do
# not specify `DeploymentTargets` or `Regions`.
#
# If the stack set update includes changes to the template (that is,
# if `TemplateBody` or `TemplateURL` is specified), or the
- # `Parameters`, AWS CloudFormation marks all stack instances with a
- # status of `OUTDATED` prior to updating the stack instances in the
- # specified accounts and Regions. If the stack set update does not
- # include changes to the template or parameters, AWS CloudFormation
- # updates the stack instances in the specified accounts and Regions,
- # while leaving all other stack instances with their existing stack
- # instance status.
+ # `Parameters`, CloudFormation marks all stack instances with a status
+ # of `OUTDATED` prior to updating the stack instances in the specified
+ # accounts and Amazon Web Services Regions. If the stack set update
+ # doesn't include changes to the template or parameters,
+ # CloudFormation updates the stack instances in the specified accounts
+ # and Regions, while leaving all other stack instances with their
+ # existing stack instance status.
# @return [Types::DeploymentTargets]
#
# @!attribute [rw] permission_model
@@ -8119,8 +9653,8 @@ module Aws::CloudFormation
#
# * With `service-managed` permissions, StackSets automatically
# creates the IAM roles required to deploy to accounts managed by
- # AWS Organizations. For more information, see [Grant
- # Service-Managed Stack Set Permissions][2].
+ # Organizations. For more information, see [Grant Service-Managed
+ # Stack Set Permissions][2].
#
#
#
@@ -8129,11 +9663,11 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] auto_deployment
- # \[`Service-managed` permissions\] Describes whether StackSets
- # automatically deploys to AWS Organizations accounts that are added
- # to a target organization or organizational unit (OU).
+ # \[Service-managed permissions\] Describes whether StackSets
+ # automatically deploys to Organizations accounts that are added to a
+ # target organization or organizational unit (OU).
#
- # If you specify `AutoDeployment`, do not specify `DeploymentTargets`
+ # If you specify `AutoDeployment`, don't specify `DeploymentTargets`
# or `Regions`.
# @return [Types::AutoDeployment]
#
@@ -8141,13 +9675,13 @@ module Aws::CloudFormation
# The unique ID for this stack set operation.
#
# The operation ID also functions as an idempotency token, to ensure
- # that AWS CloudFormation performs the stack set operation only once,
- # even if you retry the request multiple times. You might retry stack
- # set operation requests to ensure that AWS CloudFormation
- # successfully received them.
+ # that CloudFormation performs the stack set operation only once, even
+ # if you retry the request multiple times. You might retry stack set
+ # operation requests to ensure that CloudFormation successfully
+ # received them.
#
- # If you don't specify an operation ID, AWS CloudFormation generates
- # one automatically.
+ # If you don't specify an operation ID, CloudFormation generates one
+ # automatically.
#
# Repeating this stack set operation with a new operation ID retries
# all stack instances whose status is `OUTDATED`.
@@ -8157,43 +9691,72 @@ module Aws::CloudFormation
# @return [String]
#
# @!attribute [rw] accounts
- # \[`Self-managed` permissions\] The accounts in which to update
+ # \[Self-managed permissions\] The accounts in which to update
# associated stack instances. If you specify accounts, you must also
- # specify the Regions in which to update stack set instances.
+ # specify the Amazon Web Services Regions in which to update stack set
+ # instances.
#
# To update *all* the stack instances associated with this stack set,
- # do not specify the `Accounts` or `Regions` properties.
+ # don't specify the `Accounts` or `Regions` properties.
#
# If the stack set update includes changes to the template (that is,
# if the `TemplateBody` or `TemplateURL` properties are specified), or
- # the `Parameters` property, AWS CloudFormation marks all stack
- # instances with a status of `OUTDATED` prior to updating the stack
- # instances in the specified accounts and Regions. If the stack set
- # update does not include changes to the template or parameters, AWS
+ # the `Parameters` property, CloudFormation marks all stack instances
+ # with a status of `OUTDATED` prior to updating the stack instances in
+ # the specified accounts and Amazon Web Services Regions. If the stack
+ # set update does not include changes to the template or parameters,
# CloudFormation updates the stack instances in the specified accounts
- # and Regions, while leaving all other stack instances with their
- # existing stack instance status.
+ # and Amazon Web Services Regions, while leaving all other stack
+ # instances with their existing stack instance status.
# @return [Array<String>]
#
# @!attribute [rw] regions
- # The Regions in which to update associated stack instances. If you
- # specify Regions, you must also specify accounts in which to update
- # stack set instances.
+ # The Amazon Web Services Regions in which to update associated stack
+ # instances. If you specify Regions, you must also specify accounts in
+ # which to update stack set instances.
#
# To update *all* the stack instances associated with this stack set,
# do not specify the `Accounts` or `Regions` properties.
#
# If the stack set update includes changes to the template (that is,
# if the `TemplateBody` or `TemplateURL` properties are specified), or
- # the `Parameters` property, AWS CloudFormation marks all stack
- # instances with a status of `OUTDATED` prior to updating the stack
- # instances in the specified accounts and Regions. If the stack set
- # update does not include changes to the template or parameters, AWS
- # CloudFormation updates the stack instances in the specified accounts
- # and Regions, while leaving all other stack instances with their
- # existing stack instance status.
+ # the `Parameters` property, CloudFormation marks all stack instances
+ # with a status of `OUTDATED` prior to updating the stack instances in
+ # the specified accounts and Regions. If the stack set update does not
+ # include changes to the template or parameters, CloudFormation
+ # updates the stack instances in the specified accounts and Regions,
+ # while leaving all other stack instances with their existing stack
+ # instance status.
# @return [Array<String>]
#
+ # @!attribute [rw] call_as
+ # \[Service-managed permissions\] Specifies whether you are acting as
+ # an account administrator in the organization's management account
+ # or as a delegated administrator in a member account.
+ #
+ # By default, `SELF` is specified. Use `SELF` for stack sets with
+ # self-managed permissions.
+ #
+ # * If you are signed in to the management account, specify `SELF`.
+ #
+ # * If you are signed in to a delegated administrator account, specify
+ # `DELEGATED_ADMIN`.
+ #
+ # Your Amazon Web Services account must be registered as a delegated
+ # administrator in the management account. For more information, see
+ # [Register a delegated administrator][1] in the *CloudFormation
+ # User Guide*.
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html
+ # @return [String]
+ #
+ # @!attribute [rw] managed_execution
+ # Describes whether StackSets performs non-conflicting operations
+ # concurrently and queues conflicting operations.
+ # @return [Types::ManagedExecution]
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackSetInput AWS API Documentation
#
class UpdateStackSetInput < Struct.new(
@@ -8213,7 +9776,9 @@ module Aws::CloudFormation
:auto_deployment,
:operation_id,
:accounts,
- :regions)
+ :regions,
+ :call_as,
+ :managed_execution)
SENSITIVE = []
include Aws::Structure
end
@@ -8230,14 +9795,6 @@ module Aws::CloudFormation
include Aws::Structure
end
- # @note When making an API call, you may pass UpdateTerminationProtectionInput
- # data as a hash:
- #
- # {
- # enable_termination_protection: false, # required
- # stack_name: "StackNameOrId", # required
- # }
- #
# @!attribute [rw] enable_termination_protection
# Whether to enable termination protection on the specified stack.
# @return [Boolean]
@@ -8270,18 +9827,10 @@ module Aws::CloudFormation
# The input for ValidateTemplate action.
#
- # @note When making an API call, you may pass ValidateTemplateInput
- # data as a hash:
- #
- # {
- # template_body: "TemplateBody",
- # template_url: "TemplateURL",
- # }
- #
# @!attribute [rw] template_body
# Structure containing the template body with a minimum length of 1
# byte and a maximum length of 51,200 bytes. For more information, go
- # to [Template Anatomy][1] in the AWS CloudFormation User Guide.
+ # to [Template Anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
# are passed, only `TemplateBody` is used.
@@ -8294,8 +9843,8 @@ module Aws::CloudFormation
# @!attribute [rw] template_url
# Location of file containing the template body. The URL must point to
# a template (max size: 460,800 bytes) that is located in an Amazon S3
- # bucket. For more information, go to [Template Anatomy][1] in the AWS
- # CloudFormation User Guide.
+ # bucket or a Systems Manager document. For more information, go to
+ # [Template Anatomy][1] in the CloudFormation User Guide.
#
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
# are passed, only `TemplateBody` is used.
@@ -8331,7 +9880,7 @@ module Aws::CloudFormation
# CreateStack or UpdateStack actions with your template; otherwise,
# those actions return an InsufficientCapabilities error.
#
- # For more information, see [Acknowledging IAM Resources in AWS
+ # For more information, see [Acknowledging IAM Resources in
# CloudFormation Templates][1].
#
#
diff --git a/lib/aws-sdk-cloudformation/waiters.rb b/lib/aws-sdk-cloudformation/waiters.rb
index 7217b18..bce472b 100644
--- a/lib/aws-sdk-cloudformation/waiters.rb
+++ b/lib/aws-sdk-cloudformation/waiters.rb
@@ -3,7 +3,7 @@
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
@@ -267,6 +267,12 @@ module Aws::CloudFormation
"expected" => "UPDATE_ROLLBACK_COMPLETE",
"matcher" => "pathAny",
"state" => "failure"
+ },
+ {
+ "argument" => "stacks[].stack_status",
+ "expected" => "UPDATE_COMPLETE",
+ "matcher" => "pathAny",
+ "state" => "failure"
}
]
)