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.
*/ public deleteStackSet( args: DeleteStackSetCommandInput, @@ -920,7 +920,7 @@ export class CloudFormation extends CloudFormationClient { *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 on registering as a publisher, see:
+ *For more information about registering as a publisher, see:
*@@ -969,7 +969,7 @@ export class CloudFormation extends CloudFormationClient { * 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 + * 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.
*Use DetectStackDrift to initiate a stack drift detection operation. @@ -1511,7 +1511,7 @@ export class CloudFormation extends CloudFormationClient { * drift time checked.
*For more information on performing a drift detection operation on a stack set, see + *
For more information about performing a drift detection operation on a stack set, see * Detecting unmanaged * changes in stack sets.
*You can only run a single drift detection operation on a given stack set at one @@ -2168,7 +2168,7 @@ export class CloudFormation extends CloudFormationClient { /** *
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 on publishing extensions, see Publishing extensions to make them available for public use in the + * 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 in the * CloudFormation CLI User Guide.
*To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
*/ @@ -2231,7 +2231,7 @@ export class CloudFormation extends CloudFormationClient { /** *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 on requirements for registering as a public extension publisher, see + *
For information about requirements for registering as a public extension publisher, see * Registering your account to publish CloudFormation * extensions in the CloudFormation CLI User * Guide.
@@ -2280,8 +2280,8 @@ export class CloudFormation extends CloudFormationClient { *Making the extension available for use in your account.
* * - *For more information on how to develop extensions and ready them for registration, see
- * Creating Resource
+ * For more information about how to develop extensions and ready them for registration,
+ * see Creating Resource
* Providers in the CloudFormation CLI User
* Guide. You can have a maximum of 50 resource extension versions registered at a time. This
diff --git a/clients/client-cloudformation/src/commands/DeleteStackSetCommand.ts b/clients/client-cloudformation/src/commands/DeleteStackSetCommand.ts
index 224cb803ac16..d8d13aa69e5d 100644
--- a/clients/client-cloudformation/src/commands/DeleteStackSetCommand.ts
+++ b/clients/client-cloudformation/src/commands/DeleteStackSetCommand.ts
@@ -23,8 +23,8 @@ export interface DeleteStackSetCommandInput extends DeleteStackSetInput {}
export interface DeleteStackSetCommandOutput extends DeleteStackSetOutput, __MetadataBearer {}
/**
- * 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. If you don't supply a For more information on registering as a publisher, see: For more information about registering as a publisher, see:
diff --git a/clients/client-cloudformation/src/commands/DescribeStackDriftDetectionStatusCommand.ts b/clients/client-cloudformation/src/commands/DescribeStackDriftDetectionStatusCommand.ts
index f1994ad3bb29..aa8abfc6d8ab 100644
--- a/clients/client-cloudformation/src/commands/DescribeStackDriftDetectionStatusCommand.ts
+++ b/clients/client-cloudformation/src/commands/DescribeStackDriftDetectionStatusCommand.ts
@@ -29,7 +29,7 @@ export interface DescribeStackDriftDetectionStatusCommandOutput
* 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
+ * 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. Use DetectStackDrift to initiate a stack drift detection operation.
diff --git a/clients/client-cloudformation/src/commands/DetectStackSetDriftCommand.ts b/clients/client-cloudformation/src/commands/DetectStackSetDriftCommand.ts
index 1a30dac5077e..46d9ef3fde2d 100644
--- a/clients/client-cloudformation/src/commands/DetectStackSetDriftCommand.ts
+++ b/clients/client-cloudformation/src/commands/DetectStackSetDriftCommand.ts
@@ -60,7 +60,7 @@ export interface DetectStackSetDriftCommandOutput extends DetectStackSetDriftOut
* drift time checked. For more information on performing a drift detection operation on a stack set, see
+ * For more information about performing a drift detection operation on a stack set, see
* Detecting unmanaged
* changes in stack sets. You can only run a single drift detection operation on a given stack set at one
diff --git a/clients/client-cloudformation/src/commands/PublishTypeCommand.ts b/clients/client-cloudformation/src/commands/PublishTypeCommand.ts
index 78ecba90dd88..e720ba9dd1f9 100644
--- a/clients/client-cloudformation/src/commands/PublishTypeCommand.ts
+++ b/clients/client-cloudformation/src/commands/PublishTypeCommand.ts
@@ -21,7 +21,7 @@ export interface PublishTypeCommandOutput extends PublishTypeOutput, __MetadataB
/**
* 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 on publishing extensions, see Publishing extensions to make them available for public use in the
+ * 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 in the
* CloudFormation CLI User Guide. To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher. 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 on requirements for registering as a public extension publisher, see
+ * For information about requirements for registering as a public extension publisher, see
* Registering your account to publish CloudFormation
* extensions in the CloudFormation CLI User
* Guide. Making the extension available for use in your account. For more information on how to develop extensions and ready them for registration, see
- * Creating Resource
+ * For more information about how to develop extensions and ready them for registration,
+ * see Creating Resource
* Providers in the CloudFormation CLI User
* Guide. You can have a maximum of 50 resource extension versions registered at a time. This
diff --git a/clients/client-cloudformation/src/models/models_0.ts b/clients/client-cloudformation/src/models/models_0.ts
index ff127887cb14..03717da2c7ab 100644
--- a/clients/client-cloudformation/src/models/models_0.ts
+++ b/clients/client-cloudformation/src/models/models_0.ts
@@ -165,7 +165,7 @@ export interface ActivateTypeInput {
Type?: ThirdPartyType | string;
/**
- * The Amazon Resource Number (ARN) of the public extension. The Amazon Resource Name (ARN) of the public extension. Conditional: You must specify The Amazon Resource Number (ARN) of the activated extension, in this account and
+ * The Amazon Resource Name (ARN) of the activated extension, in this account and
* region. Whether or not this configuration data is the default configuration for the
- * extension. Whether this configuration data is the default configuration for the extension. 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 on modules, see Using modules to encapsulate and
+ * For more information about modules, see Using modules to encapsulate and
* reuse resource configurations in the
* CloudFormation User Guide. If your stack template contains these resources, we recommend that you review all
+ * If your stack template contains these resources, we suggest that you review all
* permissions associated with them and edit their permissions if necessary. For more information on macros, see Using CloudFormation macros to
+ * For more information about macros, see Using CloudFormation macros to
* perform custom processing on templates. The quota for the resource has already been reached. For information on resource and stack limitations, see CloudFormation
+ * For information about resource and stack limitations, see CloudFormation
* quotas in the CloudFormation User Guide. The user-specified preferences for how CloudFormation performs a stack set
* operation. For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options. For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options. The stack ID you are importing into a new stack set. Specify the Amazon Resource Number
+ * The stack ID you are importing into a new stack set. Specify the Amazon Resource Name
* (ARN) of the stack. 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
@@ -4679,8 +4678,8 @@ export interface DescribeStackResourceDriftsOutput {
StackResourceDrifts: StackResourceDrift[] | undefined;
/**
- * If the request doesn't return all of the remaining results, If the request doesn't return all the remaining results, Whether termination protection is enabled for the stack. For nested stacks,
- * termination protection is set on the root stack and cannot be changed directly on the
- * nested stack. For more information, see Protecting a Stack From Being
- * Deleted in the CloudFormation User Guide. Information on whether a stack's actual configuration differs, or has
+ * Information about 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 Stacks and Resources. The Amazon Resource Number (ARN) of the stack set. The Amazon Resource Name (ARN) of the stack set. The Amazon Resource Number (ARN) of the IAM role used to create or update
+ * 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
@@ -5617,7 +5616,7 @@ export interface StackSetOperation {
RetainStacks?: boolean;
/**
- * The Amazon Resource Number (ARN) of the IAM role used to perform this
+ * 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
@@ -5664,6 +5663,11 @@ export interface StackSetOperation {
* Changes in Stack Sets in the CloudFormation User Guide. The status of the operation in details. The publisher ID of the extension publisher. Extensions provided by Amazon are not assigned a publisher ID. Extensions provided by Amazon Web Services are not assigned a publisher ID. 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 To set the default version of an extension, use 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, whether or not they are
- * activated in your account, CloudFormation returns PublisherId, and you have registered as an extension
* publisher, DescribePublisher returns information about your own publisher
* account.
*
- * PublicTypeArn, or TypeName,
* Type, and PublisherId.InsufficientCapabilities error.
*
NextToken is
- * set to a token. To retrieve the next set of results, call
+ * 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 all results,
* NextToken is set to null.null. For more information, see RegisterType.null. For more information, see RegisterType.
* SetTypeDefaultVersion
* .null.null.VersionId.
This applies only to registered private extension versions. CloudFormation - * doesn't return this information for public extensions, whether or not they are activated in - * your account.
+ * doesn't return this information for public extensions, whether they are activated in your + * account. *@@ -5899,8 +5903,8 @@ export interface DescribeTypeOutput { *
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 or not they are activated in - * your account.
+ * doesn't return this information for public extensions, whether they are activated in your + * account. */ TypeTestsStatusDescription?: string; @@ -5911,7 +5915,7 @@ export interface DescribeTypeOutput { /** *The schema that defines the extension.
- *For more information on extension schemas, see Resource Provider
+ * For more information about extension schemas, see Resource Provider
* Schema in the CloudFormation CLI User
* Guide. 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 and published by third parties, CloudFormation returns
+ * provided by Amazon Web Services and published by third parties, CloudFormation returns
* The Amazon Resource Name (ARN) of the IAM execution role used to register
* the extension. This applies only to private extensions you have registered in your account.
* For more information, see RegisterType. If the registered extension calls any Amazon Web Services APIs, you must create an
*
* IAM execution role
@@ -6018,7 +6021,7 @@ export interface DescribeTypeOutput {
*
* null. For more information, see RegisterType.PUBLIC: The extension is publicly visible and usable within any
- * Amazon account.
Whether or not the extension is activated in the account and region.
+ *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.
The user-specified preferences for how CloudFormation performs a stack set * operation.
- *For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.
+ *For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
*/ OperationPreferences?: StackSetOperationPreferences; @@ -6846,7 +6849,7 @@ export interface ImportStacksToStackSetInput { /** *The user-specified preferences for how CloudFormation performs a stack set * operation.
- *For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.
+ *For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
*/ OperationPreferences?: StackSetOperationPreferences; @@ -7121,7 +7124,7 @@ export interface ListStackInstancesInput { StackSetName: string | undefined; /** - *If the previous request didn't return all of the remaining results, the response's + *
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
@@ -7397,7 +7400,7 @@ export interface StackResourceDriftInformationSummary {
*
Any resources that don't currently support drift detection have a status of
* NOT_CHECKED. For more information, see Resources that Support Drift Detection. 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 in the CloudFormation User Guide.
@@ -7646,7 +7649,7 @@ export interface StackSummary { RootId?: string; /** - *
Summarizes information on whether a stack's actual configuration differs, or has + *
Summarizes information about 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 Stacks and Resources.
@@ -7702,11 +7705,11 @@ export interface ListStackSetOperationResultsInput { OperationId: string | undefined; /** - *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
+ *
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.
The status of the operation in details.
+ */ + StatusReason?: string; } export namespace StackSetOperationSummary { @@ -8269,8 +8277,8 @@ export interface ListTypeRegistrationsOutput { RegistrationTokenList?: string[]; /** - *If the request doesn't return all of the remaining results, NextToken is
- * set to a token. To retrieve the next set of results, call this action again and assign that
+ *
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, NextToken is set to null.
* PUBLIC: Extensions that are publicly visible and available to be
- * activated within any Amazon account. This includes extensions from Amazon, as well as
- * third-party publishers.
The default is PRIVATE.
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
+ *
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.
Whether or not the extension is activated for this account and region.
+ *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.
*/ @@ -8789,7 +8797,7 @@ export interface PublishTypeInput { Type?: ThirdPartyType | string; /** - *The Amazon Resource Number (ARN) of the extension.
+ *The Amazon Resource Name (ARN) of the extension.
*Conditional: You must specify Arn, or TypeName and
* Type.
The Amazon Resource Number (ARN) assigned to the public extension upon + *
The Amazon Resource Name (ARN) assigned to the public extension upon * publication.
*/ PublicTypeArn?: string; @@ -9027,7 +9035,7 @@ export interface RegisterTypeInput { /** *The name of the extension being registered.
- *We recommend that extension names adhere to the following patterns:
+ *We suggest that extension names adhere to the following patterns:
*For resource types, @@ -9037,6 +9045,9 @@ export interface RegisterTypeInput { *
For modules, * company_or_organization::service::type::MODULE.
*For hooks, MyCompany::Testing::MyTestHook.
+ *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 extension you want to + *
For information about generating a schema handler package for the extension you want to * register, see submit * in the CloudFormation CLI User Guide.
*The Amazon Resource Name (ARN) of the IAM role for CloudFormation to 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 on adding
+ * (resources.cloudformation.amazonaws.com). For more information about adding
* trust relationships, see Modifying a role trust policy in the Identity and Access Management User
* Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create
@@ -9577,7 +9588,7 @@ export interface UpdateStackInput {
* the StackPolicyDuringUpdateBody or the 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 stack policy, the current policy that is + * during this update. If you don't specify a stack policy, the current policy that is * associated with the stack will be used.
*/ StackPolicyDuringUpdateBody?: string; @@ -9588,7 +9599,7 @@ export interface UpdateStackInput { * can specify either theStackPolicyDuringUpdateBody or the
* 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 stack policy, the current policy that is + * during this update. If you don't specify a stack policy, the current policy that is * associated with the stack will be used.
*/ StackPolicyDuringUpdateURL?: string; @@ -9629,7 +9640,7 @@ export interface UpdateStackInput { *InsufficientCapabilities error.
*
*
- * If your stack template contains these resources, we recommend that you review all + *
If your stack template contains these resources, we suggest that you review all * permissions associated with them and edit their permissions if necessary.
*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 diff --git a/clients/client-cloudformation/src/protocols/Aws_query.ts b/clients/client-cloudformation/src/protocols/Aws_query.ts index 7ce9431ecf0d..0c13872259e6 100644 --- a/clients/client-cloudformation/src/protocols/Aws_query.ts +++ b/clients/client-cloudformation/src/protocols/Aws_query.ts @@ -9820,6 +9820,7 @@ const deserializeAws_queryStackSetOperation = (output: any, context: __SerdeCont EndTimestamp: undefined, DeploymentTargets: undefined, StackSetDriftDetectionDetails: undefined, + StatusReason: undefined, }; if (output["OperationId"] !== undefined) { contents.OperationId = __expectString(output["OperationId"]); @@ -9863,6 +9864,9 @@ const deserializeAws_queryStackSetOperation = (output: any, context: __SerdeCont context ); } + if (output["StatusReason"] !== undefined) { + contents.StatusReason = __expectString(output["StatusReason"]); + } return contents; }; @@ -9976,6 +9980,7 @@ const deserializeAws_queryStackSetOperationSummary = ( Status: undefined, CreationTimestamp: undefined, EndTimestamp: undefined, + StatusReason: undefined, }; if (output["OperationId"] !== undefined) { contents.OperationId = __expectString(output["OperationId"]); @@ -9992,6 +9997,9 @@ const deserializeAws_queryStackSetOperationSummary = ( if (output["EndTimestamp"] !== undefined) { contents.EndTimestamp = __expectNonNull(__parseRfc3339DateTime(output["EndTimestamp"])); } + if (output["StatusReason"] !== undefined) { + contents.StatusReason = __expectString(output["StatusReason"]); + } return contents; }; diff --git a/codegen/sdk-codegen/aws-models/cloudformation.json b/codegen/sdk-codegen/aws-models/cloudformation.json index b8c5c5e0e09c..1b0d4583fa14 100644 --- a/codegen/sdk-codegen/aws-models/cloudformation.json +++ b/codegen/sdk-codegen/aws-models/cloudformation.json @@ -158,7 +158,7 @@ "PublicTypeArn": { "target": "com.amazonaws.cloudformation#ThirdPartyTypeArn", "traits": { - "smithy.api#documentation": "
The Amazon Resource Number (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
The Amazon Resource Number (ARN) of the activated extension, in this account and\n region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the activated extension, in this account and\n region.
" } } } @@ -417,6 +417,9 @@ "input": { "target": "com.amazonaws.cloudformation#CancelUpdateStackInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" @@ -1284,7 +1287,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this\n by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation\n returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or\n more macros, and you choose to create a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when\n creating change sets has no effect.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create or update the stack\n directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
\nFor more information on macros, see Using CloudFormation macros to\n perform custom processing on templates.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this\n by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation\n returns an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or\n more macros, and you choose to create a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when\n creating change sets has no effect.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create or update the stack\n directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
\nFor more information about macros, see Using CloudFormation macros to\n perform custom processing on templates.
\nThe stack ID you are importing into a new stack set. Specify the Amazon Resource Number\n (ARN) of the stack.
" + "smithy.api#documentation": "The stack ID you are importing into a new stack set. Specify the Amazon Resource Name\n (ARN) of the stack.
" } }, "Parameters": { @@ -1707,7 +1710,7 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the IAM role to use to create this\n stack set.
\nSpecify an IAM role only if you are using customized administrator roles\n to control which users or groups can manage specific stack sets within the same\n administrator account. For more information, see Prerequisites: Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to create this\n stack set.
\nSpecify an IAM role only if you are using customized administrator roles\n to control which users or groups can manage specific stack sets within the same\n administrator account. For more information, see Prerequisites: Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { @@ -1878,6 +1881,9 @@ "input": { "target": "com.amazonaws.cloudformation#DeleteStackInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" @@ -2034,7 +2040,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a stack set. Before you can delete a stack set, all of its member stack\n instances must be deleted. For more information about how to do this, see DeleteStackInstances.
" + "smithy.api#documentation": "Deletes a stack set. Before you can delete a stack set, all its member stack instances\n must be deleted. For more information about how to complete this, see DeleteStackInstances.
" } }, "com.amazonaws.cloudformation#DeleteStackSetInput": { @@ -2517,7 +2523,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension\n publisher, DescribePublisher returns information about your own publisher\n account.
For more information on registering as a publisher, see:
\n\n RegisterPublisher\n
\n\n Publishing\n extensions to make them available for public use in the CloudFormation CLI User Guide\n
\nReturns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension\n publisher, DescribePublisher returns information about your own publisher\n account.
For more information about registering as a publisher, see:
\n\n RegisterPublisher\n
\n\n Publishing\n extensions to make them available for public use in the CloudFormation CLI User Guide\n
\nReturns information about a stack drift detection operation. A stack drift detection\n operation detects whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. A stack is considered to have\n drifted if one or more of its resources have drifted. For more information on stack and\n resource drift, see Detecting\n Unregulated Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use\n to monitor the progress of the operation using\n DescribeStackDriftDetectionStatus. Once the drift detection operation has\n completed, use DescribeStackResourceDrifts to return drift information\n about the stack and its resources.
Returns information about a stack drift detection operation. A stack drift detection\n operation detects whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. A stack is considered to have\n drifted if one or more of its resources have drifted. For more information about stack and\n resource drift, see Detecting\n Unregulated Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use\n to monitor the progress of the operation using\n DescribeStackDriftDetectionStatus. Once the drift detection operation has\n completed, use DescribeStackResourceDrifts to return drift information\n about the stack and its resources.
If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call\n DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
If the request doesn't return all the remaining results, NextToken is set\n to a token. To retrieve the next set of results, call\n DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
The publisher ID of the extension publisher.
\nExtensions provided by Amazon are not assigned a publisher ID.
" + "smithy.api#documentation": "The publisher ID of the extension publisher.
\nExtensions provided by Amazon Web Services are not assigned a publisher ID.
" } }, "PublicVersionNumber": { @@ -3516,25 +3522,25 @@ "DefaultVersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "The ID of the default version of the extension. The default version is used when the\n extension version isn't specified.
\nThis applies only to private extensions you have registered in your account. For public\n extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.
To set the default version of an extension, use \n SetTypeDefaultVersion\n .
The ID of the default version of the extension. The default version is used when the\n extension version isn't specified.
\nThis applies only to private extensions you have registered in your account. For public\n extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.
To set the default version of an extension, use \n SetTypeDefaultVersion\n .
Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and\n extensions published by Amazon. For public third-party extensions, whether or not they are\n activated in your account, CloudFormation returns null.
Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and\n extensions published by Amazon Web Services. For public third-party extensions, whether they\n are activated in your account, CloudFormation returns null.
The contract test status of the registered extension version. To return the extension\n test status of a specific extension version, you must specify\n VersionId.
This applies only to registered private extension versions. CloudFormation\n doesn't return this information for public extensions, whether or not they are activated in\n your account.
\n\n PASSED: The extension has passed all its contract tests.
An extension must have a test status of PASSED before it can be\n published. For more information, see Publishing extensions to make them available for public\n use in the CloudFormation Command Line Interface User\n Guide.
\n FAILED: The extension has failed one or more contract tests.
\n IN_PROGRESS: Contract tests are currently being performed on the\n extension.
\n NOT_TESTED: Contract tests haven't been performed on the\n extension.
The contract test status of the registered extension version. To return the extension\n test status of a specific extension version, you must specify\n VersionId.
This applies only to registered private extension versions. CloudFormation\n doesn't return this information for public extensions, whether they are activated in your\n account.
\n\n PASSED: The extension has passed all its contract tests.
An extension must have a test status of PASSED before it can be\n published. For more information, see Publishing extensions to make them available for public\n use in the CloudFormation Command Line Interface User\n Guide.
\n FAILED: The extension has failed one or more contract tests.
\n IN_PROGRESS: Contract tests are currently being performed on the\n extension.
\n NOT_TESTED: Contract tests haven't been performed on the\n extension.
The description of the test status. To return the extension test status of a specific\n extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation\n doesn't return this information for public extensions, whether or not they are activated in\n your account.
" + "smithy.api#documentation": "The description of the test status. To return the extension test status of a specific\n extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation\n doesn't return this information for public extensions, whether they are activated in your\n account.
" } }, "Description": { @@ -3546,7 +3552,7 @@ "Schema": { "target": "com.amazonaws.cloudformation#TypeSchema", "traits": { - "smithy.api#documentation": "The schema that defines the extension.
\nFor more information on extension schemas, see Resource Provider\n Schema in the CloudFormation CLI User\n Guide.
" + "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource Provider\n Schema in the CloudFormation CLI User\n Guide.
" } }, "ProvisioningType": { @@ -3564,7 +3570,7 @@ "LoggingConfig": { "target": "com.amazonaws.cloudformation#LoggingConfig", "traits": { - "smithy.api#documentation": "Contains logging configuration information for private extensions. This applies only to\n private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns\n null. For more information, see RegisterType.
Contains logging configuration information for private extensions. This applies only to\n private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns\n null. For more information, see RegisterType.
The Amazon Resource Name (ARN) of the IAM execution role used to register\n the extension. This applies only to private extensions you have registered in your account.\n For more information, see RegisterType.
\n \nIf the registered extension calls any Amazon Web Services APIs, you must create an\n \n IAM execution role\n that includes the necessary\n permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. CloudFormation then assumes that execution role to provide your\n extension with the appropriate credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to register\n the extension. This applies only to private extensions you have registered in your account.\n For more information, see RegisterType.
\nIf the registered extension calls any Amazon Web Services APIs, you must create an\n \n IAM execution role\n that includes the necessary\n permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. CloudFormation then assumes that execution role to provide your\n extension with the appropriate credentials.
" } }, "Visibility": { "target": "com.amazonaws.cloudformation#Visibility", "traits": { - "smithy.api#documentation": "The scope at which the extension is visible and usable in CloudFormation\n operations.
\nValid values include:
\n\n PRIVATE: The extension is only visible and usable within the account\n in which it is registered. CloudFormation marks any extensions you register as\n PRIVATE.
\n PUBLIC: The extension is publicly visible and usable within any\n Amazon account.
The scope at which the extension is visible and usable in CloudFormation\n operations.
\nValid values include:
\n\n PRIVATE: The extension is only visible and usable within the account\n in which it is registered. CloudFormation marks any extensions you register as\n PRIVATE.
\n PUBLIC: The extension is publicly visible and usable within any\n Amazon Web Services account.
Whether or not the extension is activated in the account and region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns null.
Whether the extension is activated in the account and region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns null.
Detect drift on a stack set. When CloudFormation performs drift detection on a\n stack set, it performs drift detection on the stack associated with each stack instance in\n the stack set. For more information, see How CloudFormation performs drift detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set\n drift detection operation. Use this operation id with \n DescribeStackSetOperation\n to monitor the progress of the drift\n detection operation. The drift detection operation may take some time, depending on the\n number of stack instances included in the stack set, in addition to the number of resources\n included in each stack.
Once the operation has completed, use the following actions to return drift\n information:
\nUse \n DescribeStackSet\n to return detailed information\n about the stack set, including detailed information about the last\n completed drift operation performed on the stack set.\n (Information about drift operations that are in progress isn't included.)
Use \n ListStackInstances\n to return a list of stack\n instances belonging to the stack set, including the drift status and last drift time\n checked of each instance.
Use \n DescribeStackInstance\n to return detailed\n information about a specific stack instance, including its drift status and last\n drift time checked.
For more information on performing a drift detection operation on a stack set, see\n Detecting unmanaged\n changes in stack sets.
\nYou can only run a single drift detection operation on a given stack set at one\n time.
\nTo stop a drift detection stack set operation, use \n StopStackSetOperation\n .
Detect drift on a stack set. When CloudFormation performs drift detection on a\n stack set, it performs drift detection on the stack associated with each stack instance in\n the stack set. For more information, see How CloudFormation performs drift detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set\n drift detection operation. Use this operation id with \n DescribeStackSetOperation\n to monitor the progress of the drift\n detection operation. The drift detection operation may take some time, depending on the\n number of stack instances included in the stack set, in addition to the number of resources\n included in each stack.
Once the operation has completed, use the following actions to return drift\n information:
\nUse \n DescribeStackSet\n to return detailed information\n about the stack set, including detailed information about the last\n completed drift operation performed on the stack set.\n (Information about drift operations that are in progress isn't included.)
Use \n ListStackInstances\n to return a list of stack\n instances belonging to the stack set, including the drift status and last drift time\n checked of each instance.
Use \n DescribeStackInstance\n to return detailed\n information about a specific stack instance, including its drift status and last\n drift time checked.
For more information about performing a drift detection operation on a stack set, see\n Detecting unmanaged\n changes in stack sets.
\nYou can only run a single drift detection operation on a given stack set at one\n time.
\nTo stop a drift detection stack set operation, use \n StopStackSetOperation\n .
The quota for the resource has already been reached.
\nFor information on resource and stack limitations, see CloudFormation\n quotas in the CloudFormation User Guide.
", + "smithy.api#documentation": "The quota for the resource has already been reached.
\nFor information about resource and stack limitations, see CloudFormation\n quotas in the CloudFormation User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -5076,7 +5082,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the previous request didn't return all of the remaining results, the response's\n NextToken parameter value is set to a token. To retrieve the next set of\n results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
If the previous request didn't return all the remaining results, the response's\n NextToken parameter value is set to a token. To retrieve the next set of\n results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
If the previous request didn't return all of the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set\n of results, call ListStackSetOperationResults again and assign that token to\n the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to\n null.
If the previous request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of\n results, call ListStackSetOperationResults again and assign that token to the\n request object's NextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to\n null.
If the request doesn't return all of the remaining results, NextToken is\n set to a token. To retrieve the next set of results, call this action again and assign that\n token to the request object's NextToken parameter. If the request returns all\n results, NextToken is set to null.
If the request doesn't return all the remaining results, NextToken is set\n to a token. To retrieve the next set of results, call this action again and assign that\n token to the request object's NextToken parameter. If the request returns all\n results, NextToken is set to null.
The scope at which the extensions are visible and usable in CloudFormation\n operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account\n and region. This includes:
Private extensions you have registered in this account and region.
\nPublic extensions that you have activated in this account and region.
\n\n PUBLIC: Extensions that are publicly visible and available to be\n activated within any Amazon account. This includes extensions from Amazon, as well as\n third-party publishers.
The default is PRIVATE.
The scope at which the extensions are visible and usable in CloudFormation\n operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account\n and region. This includes:
Private extensions you have registered in this account and region.
\nPublic extensions that you have activated in this account and region.
\n\n PUBLIC: Extensions that are publicly visible and available to be\n activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in\n addition to third-party publishers.
The default is PRIVATE.
If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
If the previous paginated request didn't return all the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set\n of results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
Contains information about the module from which the resource was created, if the\n resource was created from a module included in the stack template.
\nFor more information on modules, see Using modules to encapsulate and\n reuse resource configurations in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the\n resource was created from a module included in the stack template.
\nFor more information about modules, see Using modules to encapsulate and\n reuse resource configurations in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#MonitoringTimeInMinutes": { @@ -6349,7 +6355,7 @@ } ], "traits": { - "smithy.api#documentation": "Publishes the specified extension to the CloudFormation registry as a public\n extension in this region. Public extensions are available for use by all CloudFormation users. For more information on publishing extensions, see Publishing extensions to make them available for public use in the\n CloudFormation CLI User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
", + "smithy.api#documentation": "Publishes the specified extension to the CloudFormation registry as a public\n 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 in the\n CloudFormation CLI User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
", "smithy.api#idempotent": {} } }, @@ -6365,7 +6371,7 @@ "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The Amazon Resource Number (ARN) assigned to the public extension upon\n publication.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the public extension upon\n publication.
" } } } @@ -6556,7 +6562,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users.\n This publisher ID applies to your account in all Amazon Web Services Regions.
\nFor information on requirements for registering as a public extension publisher, see\n Registering your account to publish CloudFormation\n extensions in the CloudFormation CLI User\n Guide.
\n ", + "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users.\n This publisher ID applies to your account in all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see\n Registering your account to publish CloudFormation\n extensions in the CloudFormation CLI User\n Guide.
\n ", "smithy.api#idempotent": {} } }, @@ -6602,7 +6608,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an\n extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information on how to develop extensions and ready them for registration, see\n Creating Resource\n Providers in the CloudFormation CLI User\n Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This\n maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using \n RegisterType\n , you can use \n DescribeTypeRegistration\n to\n monitor the progress of the registration request.
Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", + "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an\n extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information about how to develop extensions and ready them for registration,\n see Creating Resource\n Providers in the CloudFormation CLI User\n Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This\n maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using \n RegisterType\n , you can use \n DescribeTypeRegistration\n to\n monitor the progress of the registration request.
Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", "smithy.api#idempotent": {} } }, @@ -6618,14 +6624,14 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The name of the extension being registered.
\nWe recommend that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nThe following organization namespaces are reserved and can't be used in your\n extension names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n AWS\n
\n Custom\n
\n Dev\n
The name of the extension being registered.
\nWe suggest that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nFor hooks, MyCompany::Testing::MyTestHook.
\nThe following organization namespaces are reserved and can't be used in your\n extension names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n AWS\n
\n Custom\n
\n Dev\n
A URL to the S3 bucket containing the extension project package that contains the\n necessary files for the extension you want to register.
\nFor information on generating a schema handler package for the extension you want to\n register, see submit\n in the CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3\n bucket. That's, the user needs to have GetObject permissions for the\n schema handler package. For more information, see Actions, Resources, and Condition Keys\n for Amazon S3 in the Identity and Access Management User\n Guide.
\nA URL to the S3 bucket containing the extension project package that contains the\n necessary files for the extension you want to register.
\nFor information about generating a schema handler package for the extension you want to\n register, see submit\n in the CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3\n bucket. That's, the user needs to have GetObject permissions for the\n schema handler package. For more information, see Actions, Resources, and Condition Keys\n for Amazon S3 in the Identity and Access Management User\n Guide.
\nThe Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must\n contain a trust relationship with the CloudFormation service principle\n (resources.cloudformation.amazonaws.com). For more information on adding\n trust relationships, see Modifying a role trust policy in the Identity and Access Management User\n Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create\n an \n IAM execution role\n that includes the necessary\n permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. When CloudFormation needs to invoke the resource type handler,\n CloudFormation assumes this execution role to create a temporary session token,\n which it then passes to the resource type handler, thereby supplying your resource type\n with the appropriate credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must\n contain a trust relationship with the CloudFormation service principle\n (resources.cloudformation.amazonaws.com). For more information about adding\n trust relationships, see Modifying a role trust policy in the Identity and Access Management User\n Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create\n an \n IAM execution role\n that includes the necessary\n permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. When CloudFormation needs to invoke the resource type handler,\n CloudFormation assumes this execution role to create a temporary session token,\n which it then passes to the resource type handler, thereby supplying your resource type\n with the appropriate credentials.
" } }, "ClientRequestToken": { @@ -7406,6 +7412,9 @@ "input": { "target": "com.amazonaws.cloudformation#SetStackPolicyInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "Sets a stack policy for a specified stack.
" } @@ -7563,6 +7572,9 @@ "input": { "target": "com.amazonaws.cloudformation#SignalResourceInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "Sends a signal to the specified resource with a success or failure status. You can use\n 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\n the required number of signals or the timeout period is exceeded. The SignalResource operation is\n useful in cases where you want to send signals from anywhere other than an Amazon EC2\n instance.
Whether termination protection is enabled for the stack.
\nFor nested stacks,\n termination protection is set on the root stack and cannot be changed directly on the\n nested stack. For more information, see Protecting a Stack From Being\n Deleted in the CloudFormation User Guide.
" + "smithy.api#documentation": "Whether termination protection is enabled for the stack.
\nFor nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack. For more information, see Protecting a Stack From Being Deleted in the\n CloudFormation User Guide.
" } }, "ParentId": { @@ -7738,7 +7750,7 @@ "DriftInformation": { "target": "com.amazonaws.cloudformation#StackDriftInformation", "traits": { - "smithy.api#documentation": "Information on whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.
" + "smithy.api#documentation": "Information about whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.
" } } }, @@ -8589,7 +8601,7 @@ "StackResourceDriftStatus": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected\n configuration.
\n\n DELETED: The resource differs from its expected configuration in that\n it has been deleted.
\n MODIFIED: The resource differs from its expected\n configuration.
\n NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its\n expected configuration.
Any resources that don't currently support drift detection have a status of\n NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in\n ResourcesToSkip will also have a status of NOT_CHECKED.\n For more information on skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.
\n IN_SYNC: The resource's actual configuration matches its expected\n configuration.
Status of the resource's actual configuration compared to its expected\n configuration.
\n\n DELETED: The resource differs from its expected configuration in that\n it has been deleted.
\n MODIFIED: The resource differs from its expected\n configuration.
\n NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its\n expected configuration.
Any resources that don't currently support drift detection have a status of\n NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in\n ResourcesToSkip will also have a status of NOT_CHECKED.\n For more information about skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.
\n IN_SYNC: The resource's actual configuration matches its expected\n configuration.
The Amazon Resource Number (ARN) of the stack set.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stack set.
" } }, "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the IAM role used to create or update\n the stack set.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to create or update\n the stack set.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { @@ -9014,7 +9026,7 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the IAM role used to perform this\n stack set operation.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Define Permissions for Multiple\n Administrators in the CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to perform this\n stack set operation.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Define Permissions for Multiple\n Administrators in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { @@ -9046,6 +9058,12 @@ "traits": { "smithy.api#documentation": "Detailed information about the drift status of the stack set. This includes information\n about drift operations currently being performed on the stack set.
\nThis information will only be present for stack set operations whose Action\n type is DETECT_DRIFT.
For more information, see Detecting Unmanaged\n Changes in Stack Sets in the CloudFormation User Guide.
" } + }, + "StatusReason": { + "target": "com.amazonaws.cloudformation#StackSetOperationStatusReason", + "traits": { + "smithy.api#documentation": "The status of the operation in details.
" + } } }, "traits": { @@ -9116,7 +9134,7 @@ } }, "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set\n operation.
\nFor more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set\n operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" } }, "com.amazonaws.cloudformation#StackSetOperationResultStatus": { @@ -9227,6 +9245,9 @@ ] } }, + "com.amazonaws.cloudformation#StackSetOperationStatusReason": { + "type": "string" + }, "com.amazonaws.cloudformation#StackSetOperationSummaries": { "type": "list", "member": { @@ -9265,6 +9286,12 @@ "traits": { "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions\n specified. Note that this doesn't necessarily mean that the stack set operation was\n successful, or even attempted, in each account or Region.
" } + }, + "StatusReason": { + "target": "com.amazonaws.cloudformation#StackSetOperationStatusReason", + "traits": { + "smithy.api#documentation": "The status of the operation in details.
" + } } }, "traits": { @@ -9537,7 +9564,7 @@ "DriftInformation": { "target": "com.amazonaws.cloudformation#StackDriftInformationSummary", "traits": { - "smithy.api#documentation": "Summarizes information on whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.
" + "smithy.api#documentation": "Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.
" } } }, @@ -10003,7 +10030,7 @@ "IsDefaultConfiguration": { "target": "com.amazonaws.cloudformation#IsDefaultConfiguration", "traits": { - "smithy.api#documentation": "Whether or not this configuration data is the default configuration for the\n extension.
" + "smithy.api#documentation": "Whether this configuration data is the default configuration for the extension.
" } } }, @@ -10242,7 +10269,7 @@ "IsActivated": { "target": "com.amazonaws.cloudformation#IsActivated", "traits": { - "smithy.api#documentation": "Whether or not the extension is activated for this account and region.
\nThis applies only to third-party public extensions. Extensions published by Amazon are\n activated by default.
" + "smithy.api#documentation": "Whether the extension is activated for this account and region.
\nThis applies only to third-party public extensions. Extensions published by Amazon are\n activated by default.
" } } }, @@ -10412,13 +10439,13 @@ "StackPolicyDuringUpdateBody": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateBody", "traits": { - "smithy.api#documentation": "Structure containing the temporary overriding stack policy body. You can specify either\n the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL\n parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.
" + "smithy.api#documentation": "Structure containing the temporary overriding stack policy body. You can specify either\n the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL\n parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you don't specify a stack policy, the current policy that is\n associated with the stack will be used.
" } }, "StackPolicyDuringUpdateURL": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", "traits": { - "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point\n to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You\n can specify either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.
" + "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point\n to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You\n can specify either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you don't specify a stack policy, the current policy that is\n associated with the stack will be used.
" } }, "Parameters": { @@ -10430,7 +10457,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this\n by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or\n more macros, and you choose to update a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros\n and nested stacks, you must update the stack directly from\n the template using this capability.
\nYou should only update stacks directly from a stack template that contains\n macros if you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for\n processing stack templates. Be aware that the Lambda function owner can update the\n function operation without CloudFormation being notified.
\nFor more information, see Using\n CloudFormation Macros to Perform Custom Processing on\n Templates.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this\n by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM\n capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or\n more macros, and you choose to update a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros\n and nested stacks, you must update the stack directly from\n the template using this capability.
\nYou should only update stacks directly from a stack template that contains\n macros if you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for\n processing stack templates. Be aware that the Lambda function owner can update the\n function operation without CloudFormation being notified.
\nFor more information, see Using\n CloudFormation Macros to Perform Custom Processing on\n Templates.
\nThe Amazon Resource Number (ARN) of the IAM role to use to update this\n stack set.
\nSpecify an IAM role only if you are using customized administrator roles\n to control which users or groups can manage specific stack sets within the same\n administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you\n must specify a customized administrator role, even if it is the same customized\n administrator role used with this stack set previously.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to update this\n stack set.
\nSpecify an IAM role only if you are using customized administrator roles\n to control which users or groups can manage specific stack sets within the same\n administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you\n must specify a customized administrator role, even if it is the same customized\n administrator role used with this stack set previously.
" } }, "ExecutionRoleName": {