CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and -repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly +repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, +Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a
diff --git a/clients/client-cloudformation/src/CloudFormation.ts b/clients/client-cloudformation/src/CloudFormation.ts
index ec5d233e6d76..51066787a5ce 100644
--- a/clients/client-cloudformation/src/CloudFormation.ts
+++ b/clients/client-cloudformation/src/CloudFormation.ts
@@ -1761,7 +1761,8 @@ export interface CloudFormation {
/**
*
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and - * repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly + * repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, + * Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly * scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services * infrastructure.
*With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a
diff --git a/clients/client-cloudformation/src/CloudFormationClient.ts b/clients/client-cloudformation/src/CloudFormationClient.ts
index ceae031c1d38..687dd0941e73 100644
--- a/clients/client-cloudformation/src/CloudFormationClient.ts
+++ b/clients/client-cloudformation/src/CloudFormationClient.ts
@@ -617,7 +617,8 @@ export interface CloudFormationClientResolvedConfig extends CloudFormationClient
/**
*
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and - * repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly + * repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, + * Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly * scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services * infrastructure.
*With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a diff --git a/clients/client-cloudformation/src/commands/ActivateOrganizationsAccessCommand.ts b/clients/client-cloudformation/src/commands/ActivateOrganizationsAccessCommand.ts index c43f20d7961e..378fbbfc7e5b 100644 --- a/clients/client-cloudformation/src/commands/ActivateOrganizationsAccessCommand.ts +++ b/clients/client-cloudformation/src/commands/ActivateOrganizationsAccessCommand.ts @@ -28,9 +28,9 @@ export interface ActivateOrganizationsAccessCommandInput extends ActivateOrganiz export interface ActivateOrganizationsAccessCommandOutput extends ActivateOrganizationsAccessOutput, __MetadataBearer {} /** - *
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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ActivateTypeCommand.ts b/clients/client-cloudformation/src/commands/ActivateTypeCommand.ts index 32a15513c0d7..d3e0807fe67b 100644 --- a/clients/client-cloudformation/src/commands/ActivateTypeCommand.ts +++ b/clients/client-cloudformation/src/commands/ActivateTypeCommand.ts @@ -28,12 +28,10 @@ export interface ActivateTypeCommandInput extends ActivateTypeInput {} export interface ActivateTypeCommandOutput extends ActivateTypeOutput, __MetadataBearer {} /** - *Activates a public third-party extension, making it available for use in stack templates. For more information, - * see Using public - * extensions in the CloudFormation User Guide.
- *Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see - * Configuring extensions at - * the account level in the CloudFormation User Guide.
+ *Activates a public third-party extension, making it available for use in stack templates. + * Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For + * more information, see Using public + * extensions in the CloudFormation User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/BatchDescribeTypeConfigurationsCommand.ts b/clients/client-cloudformation/src/commands/BatchDescribeTypeConfigurationsCommand.ts index db047b7a853d..69426f59690e 100644 --- a/clients/client-cloudformation/src/commands/BatchDescribeTypeConfigurationsCommand.ts +++ b/clients/client-cloudformation/src/commands/BatchDescribeTypeConfigurationsCommand.ts @@ -33,10 +33,11 @@ export interface BatchDescribeTypeConfigurationsCommandOutput __MetadataBearer {} /** - *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 in the CloudFormation User Guide.
+ *Returns configuration data for the specified CloudFormation extensions, from the CloudFormation + * registry for the account and Region.
+ *For more information, see Edit configuration + * data for extensions in your account in the + * CloudFormation User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/CancelUpdateStackCommand.ts b/clients/client-cloudformation/src/commands/CancelUpdateStackCommand.ts index fb2a768c921d..1baff102ebe3 100644 --- a/clients/client-cloudformation/src/commands/CancelUpdateStackCommand.ts +++ b/clients/client-cloudformation/src/commands/CancelUpdateStackCommand.ts @@ -28,8 +28,8 @@ export interface CancelUpdateStackCommandInput extends CancelUpdateStackInput {} export interface CancelUpdateStackCommandOutput extends __MetadataBearer {} /** - *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.
+ *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.
*You can cancel only stacks that are in the UPDATE_IN_PROGRESS 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 and continue the rollback. By continuing the rollback, you can return your stack to a working state
- * (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
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.
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 and continue the rollback. By continuing the rollback, you can
+ * return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and
+ * then try to update the stack again.
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.
Creates a list of changes that will be applied to a stack so that you 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 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 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, 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. 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.
Creates a list of changes that will be applied to a stack so that you 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 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 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, 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. 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.
Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of
- * the template generation using the DescribeGeneratedTemplate API action.
Creates a template from existing resources that are not already managed with CloudFormation.
+ * You can check the status of the template generation using the
+ * DescribeGeneratedTemplate API action.
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 through the DescribeStacks operation.
+ *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 through the DescribeStacks operation.
+ *For more information about creating a stack and monitoring stack progress, see Managing Amazon Web Services + * resources as a single unit with CloudFormation stacks in the + * CloudFormation User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/CreateStackInstancesCommand.ts b/clients/client-cloudformation/src/commands/CreateStackInstancesCommand.ts index 33f8ef935486..99ab8ee9e0fc 100644 --- a/clients/client-cloudformation/src/commands/CreateStackInstancesCommand.ts +++ b/clients/client-cloudformation/src/commands/CreateStackInstancesCommand.ts @@ -28,10 +28,10 @@ export interface CreateStackInstancesCommandInput extends CreateStackInstancesIn export interface CreateStackInstancesCommandOutput extends CreateStackInstancesOutput, __MetadataBearer {} /** - *Creates stack instances for the specified accounts, within the 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.
Creates stack instances for the specified accounts, within the 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.
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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/DeactivateTypeCommand.ts b/clients/client-cloudformation/src/commands/DeactivateTypeCommand.ts index 680cef312299..4c523966d757 100644 --- a/clients/client-cloudformation/src/commands/DeactivateTypeCommand.ts +++ b/clients/client-cloudformation/src/commands/DeactivateTypeCommand.ts @@ -28,10 +28,12 @@ export interface DeactivateTypeCommandInput extends DeactivateTypeInput {} export interface DeactivateTypeCommandOutput extends DeactivateTypeOutput, __MetadataBearer {} /** - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/DeleteChangeSetCommand.ts b/clients/client-cloudformation/src/commands/DeleteChangeSetCommand.ts index 49143df4a583..02021c038037 100644 --- a/clients/client-cloudformation/src/commands/DeleteChangeSetCommand.ts +++ b/clients/client-cloudformation/src/commands/DeleteChangeSetCommand.ts @@ -28,11 +28,13 @@ export interface DeleteChangeSetCommandInput extends DeleteChangeSetInput {} export interface DeleteChangeSetCommandOutput extends DeleteChangeSetOutput, __MetadataBearer {} /** - *Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
+ *Deletes the specified change set. Deleting change sets ensures that no one executes the + * wrong change set.
*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.
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.
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't - * show up in the DescribeStacks operation if the deletion has been completed successfully.
+ *Deletes a specified stack. Once the call completes successfully, stack deletion starts. + * Deleted stacks don't show up in the DescribeStacks operation if the deletion + * has been completed successfully.
+ *For more information about deleting a stack, see Delete a stack from + * the CloudFormation console in the CloudFormation User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/DeleteStackSetCommand.ts b/clients/client-cloudformation/src/commands/DeleteStackSetCommand.ts index 2edb136a371d..c6a4311f80f7 100644 --- a/clients/client-cloudformation/src/commands/DeleteStackSetCommand.ts +++ b/clients/client-cloudformation/src/commands/DeleteStackSetCommand.ts @@ -28,8 +28,8 @@ export interface DeleteStackSetCommandInput extends DeleteStackSetInput {} export interface DeleteStackSetCommandOutput extends DeleteStackSetOutput, __MetadataBearer {} /** - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/DeregisterTypeCommand.ts b/clients/client-cloudformation/src/commands/DeregisterTypeCommand.ts index 124432a2d6d4..f79ef93e7829 100644 --- a/clients/client-cloudformation/src/commands/DeregisterTypeCommand.ts +++ b/clients/client-cloudformation/src/commands/DeregisterTypeCommand.ts @@ -28,14 +28,16 @@ export interface DeregisterTypeCommandInput extends DeregisterTypeInput {} export interface DeregisterTypeCommandOutput extends DeregisterTypeOutput, __MetadataBearer {} /** - *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.
+ *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 view the deprecation status of an extension or extension version, use DescribeType.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-cloudformation/src/commands/DescribeAccountLimitsCommand.ts b/clients/client-cloudformation/src/commands/DescribeAccountLimitsCommand.ts index f3c6beb7abf9..69339a6dbfba 100644 --- a/clients/client-cloudformation/src/commands/DescribeAccountLimitsCommand.ts +++ b/clients/client-cloudformation/src/commands/DescribeAccountLimitsCommand.ts @@ -28,9 +28,8 @@ export interface DescribeAccountLimitsCommandInput extends DescribeAccountLimits export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimitsOutput, __MetadataBearer {} /** - *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 in the - * 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 Understand CloudFormation quotas in the CloudFormation User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/DescribeChangeSetCommand.ts b/clients/client-cloudformation/src/commands/DescribeChangeSetCommand.ts index c28404579166..d4de02616e6d 100644 --- a/clients/client-cloudformation/src/commands/DescribeChangeSetCommand.ts +++ b/clients/client-cloudformation/src/commands/DescribeChangeSetCommand.ts @@ -28,9 +28,10 @@ export interface DescribeChangeSetCommandInput extends DescribeChangeSetInput {} export interface DescribeChangeSetCommandOutput extends DescribeChangeSetOutput, __MetadataBearer {} /** - *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 in the CloudFormation User Guide.
+ *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 Update + * CloudFormation stacks using change sets in the + * CloudFormation User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/DescribeChangeSetHooksCommand.ts b/clients/client-cloudformation/src/commands/DescribeChangeSetHooksCommand.ts index 95e7bbbcef99..25e9ca33fdae 100644 --- a/clients/client-cloudformation/src/commands/DescribeChangeSetHooksCommand.ts +++ b/clients/client-cloudformation/src/commands/DescribeChangeSetHooksCommand.ts @@ -28,8 +28,8 @@ export interface DescribeChangeSetHooksCommandInput extends DescribeChangeSetHoo export interface DescribeChangeSetHooksCommandOutput extends DescribeChangeSetHooksOutput, __MetadataBearer {} /** - *Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the - * change set.
+ *Returns hook-related information for the change set and a list of changes that CloudFormation + * makes when you run the change set.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/DescribeGeneratedTemplateCommand.ts b/clients/client-cloudformation/src/commands/DescribeGeneratedTemplateCommand.ts index 75f0df747a5e..ce23988c443d 100644 --- a/clients/client-cloudformation/src/commands/DescribeGeneratedTemplateCommand.ts +++ b/clients/client-cloudformation/src/commands/DescribeGeneratedTemplateCommand.ts @@ -28,9 +28,10 @@ export interface DescribeGeneratedTemplateCommandInput extends DescribeGenerated export interface DescribeGeneratedTemplateCommandOutput extends DescribeGeneratedTemplateOutput, __MetadataBearer {} /** - *Describes a generated template. The output includes details about the progress of the creation of a generated
- * template started by a CreateGeneratedTemplate API action or the update of a generated template started
- * with an UpdateGeneratedTemplate API action.
Describes a generated template. The output includes details about the progress of the
+ * creation of a generated template started by a CreateGeneratedTemplate API action
+ * or the update of a generated template started with an UpdateGeneratedTemplate API
+ * action.
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.
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.
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.
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:
*- * Publishing - * extensions to make them available for public use in the CloudFormation CLI User - * Guide + * Publishing extensions + * to make them available for public use in the + * CloudFormation Command Line Interface (CLI) User Guide *
*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.
+ *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 Detect unmanaged + * configuration changes to stacks and resources with drift detection.
*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.
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.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
diff --git a/clients/client-cloudformation/src/commands/DescribeStackEventsCommand.ts b/clients/client-cloudformation/src/commands/DescribeStackEventsCommand.ts
index d3c8d297251a..10ec35e8cc45 100644
--- a/clients/client-cloudformation/src/commands/DescribeStackEventsCommand.ts
+++ b/clients/client-cloudformation/src/commands/DescribeStackEventsCommand.ts
@@ -28,12 +28,12 @@ export interface DescribeStackEventsCommandInput extends DescribeStackEventsInpu
export interface DescribeStackEventsCommandOutput extends DescribeStackEventsOutput, __MetadataBearer {}
/**
- * Returns all stack related events for a specified stack in reverse chronological order. For more information - * about a stack's event history, see CloudFormation stack creation - * events in the CloudFormation User Guide.
+ *Returns all stack related events for a specified stack in reverse chronological order. For + * more information about a stack's event history, see Understand CloudFormation stack creation events in the + * CloudFormation User Guide.
*You can list events for stacks that have failed to create or have been deleted by specifying the unique stack - * identifier (stack ID).
+ *You can list events for stacks that have failed to create or have been deleted by + * specifying the unique stack identifier (stack ID).
*Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and - * Amazon Web Services 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 StackSet, use ListStackInstances.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-cloudformation/src/commands/DescribeStackResourceCommand.ts b/clients/client-cloudformation/src/commands/DescribeStackResourceCommand.ts index 1976e641cba5..dcbd402d27ba 100644 --- a/clients/client-cloudformation/src/commands/DescribeStackResourceCommand.ts +++ b/clients/client-cloudformation/src/commands/DescribeStackResourceCommand.ts @@ -29,8 +29,8 @@ export interface DescribeStackResourceCommandOutput extends DescribeStackResourc /** *Returns a description of the specified resource in the specified stack.
- *For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has - * been deleted.
+ *For deleted stacks, DescribeStackResource returns resource information for up to 90 days + * after the stack has been deleted.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/DescribeStackResourceDriftsCommand.ts b/clients/client-cloudformation/src/commands/DescribeStackResourceDriftsCommand.ts index 5d1729383f01..48a1b7f253b3 100644 --- a/clients/client-cloudformation/src/commands/DescribeStackResourceDriftsCommand.ts +++ b/clients/client-cloudformation/src/commands/DescribeStackResourceDriftsCommand.ts @@ -28,13 +28,17 @@ export interface DescribeStackResourceDriftsCommandInput extends DescribeStackRe export interface DescribeStackResourceDriftsCommandOutput extends DescribeStackResourceDriftsOutput, __MetadataBearer {} /** - *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 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 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.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
+ *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 + * 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 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 Resource
+ * type support for imports and drift detection.
Use DetectStackResourceDrift to detect drift on individual resources, or + * DetectStackDrift to detect drift on all supported resources for a given + * stack.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/DescribeStackResourcesCommand.ts b/clients/client-cloudformation/src/commands/DescribeStackResourcesCommand.ts index 07aeeee4f16c..839bf8f0b167 100644 --- a/clients/client-cloudformation/src/commands/DescribeStackResourcesCommand.ts +++ b/clients/client-cloudformation/src/commands/DescribeStackResourcesCommand.ts @@ -28,21 +28,23 @@ export interface DescribeStackResourcesCommandInput extends DescribeStackResourc export interface DescribeStackResourcesCommandOutput extends DescribeStackResourcesOutput, __MetadataBearer {} /** - *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.
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.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use
- * ListStackResources instead.
Only the first 100 resources will be returned. If your stack has more resources than
+ * this, you should use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the
- * stack has been deleted.
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 CloudFormation User Guide.
For deleted stacks, DescribeStackResources returns resource information for
+ * up to 90 days after the stack has been deleted.
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, see the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and
- * PhysicalResourceId in the same request.
A ValidationError is returned if you specify both StackName
+ * and PhysicalResourceId in the same request.
Returns the description for the specified stack; if no stack name was specified, then it returns the description - * for all the stacks created. For more information about a stack's event history, see CloudFormation stack creation - * events in the CloudFormation User Guide.
+ *Returns the description for the specified stack; if no stack name was specified, then it + * returns the description for all the stacks created. For more information about a stack's event + * history, see Understand CloudFormation stack creation events in the + * CloudFormation User Guide.
*If the stack doesn't exist, a ValidationError is returned.
Returns detailed information about an extension that has been registered.
- *If you specify a VersionId, DescribeType returns information about that specific
- * extension version. Otherwise, it returns information about the default extension version.
If you specify a VersionId, DescribeType returns information
+ * about that specific extension version. Otherwise, it returns information about the default
+ * extension version.
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.
- *Once the registration request has completed, use DescribeType to return detailed information - * about an extension.
+ *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.
+ *Once the registration request has completed, use DescribeType to return + * detailed information about an extension.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/DetectStackDriftCommand.ts b/clients/client-cloudformation/src/commands/DetectStackDriftCommand.ts index d93ab0f2a5f0..40d5c51afd15 100644 --- a/clients/client-cloudformation/src/commands/DetectStackDriftCommand.ts +++ b/clients/client-cloudformation/src/commands/DetectStackDriftCommand.ts @@ -28,23 +28,28 @@ export interface DetectStackDriftCommandInput extends DetectStackDriftInput {} export interface DetectStackDriftCommandOutput extends DetectStackDriftOutput, __MetadataBearer {} /** - *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. For each 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.
- *Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift - * Detection.
+ *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. For each 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 Detect unmanaged configuration changes to stacks and resources with drift + * detection.
+ *Use DetectStackDrift to detect drift on all supported resources for a given
+ * stack, or DetectStackResourceDrift to detect drift on individual
+ * resources.
For a list of stack resources that currently support drift detection, see Resource + * type support for imports and drift detection.
*
- * DetectStackDrift can take up to several minutes, depending on the number of resources contained
- * within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack
- * drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts
- * to return drift information about the stack and its resources.
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.
DetectStackDrift can take up to several minutes, depending on the number of
+ * resources contained within the stack. Use DescribeStackDriftDetectionStatus
+ * to monitor the progress of a detect stack drift operation. Once the drift detection operation
+ * has completed, use DescribeStackResourceDrifts to return drift information
+ * about the stack and its resources.
+ * 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.
Returns information about whether a resource's actual configuration 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.
- *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 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.
+ * 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 Detect unmanaged + * configuration changes to stacks and resources with drift detection. + *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 don't currently support drift detection can't be checked. For a list of + * resources that support drift detection, see Resource + * type support for imports and drift detection.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/DetectStackSetDriftCommand.ts b/clients/client-cloudformation/src/commands/DetectStackSetDriftCommand.ts index 89cee8cea170..9e2bc30c29ff 100644 --- a/clients/client-cloudformation/src/commands/DetectStackSetDriftCommand.ts +++ b/clients/client-cloudformation/src/commands/DetectStackSetDriftCommand.ts @@ -28,33 +28,39 @@ export interface DetectStackSetDriftCommandInput extends DetectStackSetDriftInpu export interface DetectStackSetDriftCommandOutput extends DetectStackSetDriftOutput, __MetadataBearer {} /** - *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.
+ *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.
*
- * 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. The drift detection operation may take some time, depending on the number of stack
- * instances included in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
+ *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. The drift detection operation may take some time, depending on the number of stack
+ * instances included in the stack set, 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 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 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 specific stack instance, - * including its drift status and last drift time checked.
+ *Use DescribeStackInstance to return detailed information about a + * specific stack instance, including its drift status and last drift time checked.
*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 time.
+ *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 + * time.
*To stop a drift detection stack set operation, use StopStackSetOperation.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-cloudformation/src/commands/EstimateTemplateCostCommand.ts b/clients/client-cloudformation/src/commands/EstimateTemplateCostCommand.ts index fda5777ecc68..2758b32ac107 100644 --- a/clients/client-cloudformation/src/commands/EstimateTemplateCostCommand.ts +++ b/clients/client-cloudformation/src/commands/EstimateTemplateCostCommand.ts @@ -28,8 +28,9 @@ export interface EstimateTemplateCostCommandInput extends EstimateTemplateCostIn export interface EstimateTemplateCostCommandOutput extends EstimateTemplateCostOutput, __MetadataBearer {} /** - *Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly - * Calculator URL with a query string that describes the resources required to run the template.
+ *Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple + * Monthly Calculator URL with a query string that describes the resources required to run the + * template.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ExecuteChangeSetCommand.ts b/clients/client-cloudformation/src/commands/ExecuteChangeSetCommand.ts index 72b662981646..fffdc177406d 100644 --- a/clients/client-cloudformation/src/commands/ExecuteChangeSetCommand.ts +++ b/clients/client-cloudformation/src/commands/ExecuteChangeSetCommand.ts @@ -28,15 +28,15 @@ export interface ExecuteChangeSetCommandInput extends ExecuteChangeSetInput {} export interface ExecuteChangeSetCommandOutput extends ExecuteChangeSetOutput, __MetadataBearer {} /** - *Updates a stack using the input information that was provided when the specified change set was created. After - * the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to - * view the status of the update.
- *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, 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.
Updates a stack using the input information that was provided when the specified change + * set was created. After the call successfully completes, CloudFormation starts updating the stack. + * Use the DescribeStacks action to view the status of the update.
+ *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, 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.
Retrieves a generated template. If the template is in an InProgress or Pending status
- * then the template returned will be the template when the template was last in a Complete status. If the
- * template has not yet been in a Complete status then an empty template will be returned.
Retrieves a generated template. If the template is in an InProgress or
+ * Pending status then the template returned will be the template when the
+ * template was last in a Complete status. If the template has not yet been in a
+ * Complete status then an empty template will be returned.
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is - * returned.
+ *Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null + * value is returned.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/GetTemplateCommand.ts b/clients/client-cloudformation/src/commands/GetTemplateCommand.ts index 7eaa36a22aaf..a7fa67e17b24 100644 --- a/clients/client-cloudformation/src/commands/GetTemplateCommand.ts +++ b/clients/client-cloudformation/src/commands/GetTemplateCommand.ts @@ -28,9 +28,10 @@ export interface GetTemplateCommandInput extends GetTemplateInput {} export interface GetTemplateCommandOutput extends GetTemplateOutput, __MetadataBearer {} /** - *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.
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.
If the template doesn't exist, a ValidationError is returned.
Returns information about a new or existing template. The GetTemplateSummary action is useful for
- * viewing parameter information, such as default parameter values and parameter types, before you create or update a
- * stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you can get template
- * information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the
- * stack has been deleted. If the template doesn't exist, a ValidationError is returned.
Returns information about a new or existing template. The GetTemplateSummary
+ * action is useful for viewing parameter information, such as default parameter values and
+ * parameter types, before you create or update a stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you
+ * can get template information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for
+ * up to 90 days after the stack has been deleted. If the template doesn't exist, a
+ * ValidationError is returned.
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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ListChangeSetsCommand.ts b/clients/client-cloudformation/src/commands/ListChangeSetsCommand.ts index 7a522c1109a5..fffdb85ad9a8 100644 --- a/clients/client-cloudformation/src/commands/ListChangeSetsCommand.ts +++ b/clients/client-cloudformation/src/commands/ListChangeSetsCommand.ts @@ -28,8 +28,9 @@ export interface ListChangeSetsCommandInput extends ListChangeSetsInput {} export interface ListChangeSetsCommandOutput extends ListChangeSetsOutput, __MetadataBearer {} /** - *Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are
- * in the CREATE_IN_PROGRESS or CREATE_PENDING state.
Returns the ID and status of each active change set for a stack. For example, CloudFormation
+ * lists change sets that are in the CREATE_IN_PROGRESS or
+ * CREATE_PENDING state.
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 function.
- *For more information, see CloudFormation export stack output - * values.
+ *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 function.
+ *For more information, see Get exported outputs from a deployed CloudFormation stack.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ListImportsCommand.ts b/clients/client-cloudformation/src/commands/ListImportsCommand.ts index fad7e1e263fb..973873f7448e 100644 --- a/clients/client-cloudformation/src/commands/ListImportsCommand.ts +++ b/clients/client-cloudformation/src/commands/ListImportsCommand.ts @@ -28,10 +28,10 @@ export interface ListImportsCommandInput extends ListImportsInput {} export interface ListImportsCommandOutput extends ListImportsOutput, __MetadataBearer {} /** - *Lists all stacks that are importing an exported output value. To modify or remove an exported output value, - * first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
- *For more information about importing an exported output value, see the Fn::ImportValue - * function.
+ *Lists all stacks that are importing an exported output value. To modify or remove an + * exported output value, first use this action to see which stacks are using it. To see the + * exported output values in your account, see ListExports.
+ *For more information about importing an exported output value, see the Fn::ImportValue function.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ListResourceScanRelatedResourcesCommand.ts b/clients/client-cloudformation/src/commands/ListResourceScanRelatedResourcesCommand.ts index 2e2aca6de56c..26d9c1167640 100644 --- a/clients/client-cloudformation/src/commands/ListResourceScanRelatedResourcesCommand.ts +++ b/clients/client-cloudformation/src/commands/ListResourceScanRelatedResourcesCommand.ts @@ -33,8 +33,8 @@ export interface ListResourceScanRelatedResourcesCommandOutput __MetadataBearer {} /** - *Lists the related resources for a list of resources from a resource scan. The response indicates whether each - * returned resource is already managed by CloudFormation.
+ *Lists the related resources for a list of resources from a resource scan. The response + * indicates whether each returned resource is already managed by CloudFormation.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ListResourceScanResourcesCommand.ts b/clients/client-cloudformation/src/commands/ListResourceScanResourcesCommand.ts index f5b9d7554c7e..f2144392cccf 100644 --- a/clients/client-cloudformation/src/commands/ListResourceScanResourcesCommand.ts +++ b/clients/client-cloudformation/src/commands/ListResourceScanResourcesCommand.ts @@ -28,9 +28,10 @@ export interface ListResourceScanResourcesCommandInput extends ListResourceScanR export interface ListResourceScanResourcesCommandOutput extends ListResourceScanResourcesOutput, __MetadataBearer {} /** - *Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type - * prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates - * whether each returned resource is already managed by CloudFormation.
+ *Lists the resources from a resource scan. The results can be filtered by resource + * identifier, resource type prefix, tag key, and tag value. Only resources that match all + * specified filters are returned. The response indicates whether each returned resource is + * already managed by CloudFormation.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ListResourceScansCommand.ts b/clients/client-cloudformation/src/commands/ListResourceScansCommand.ts index 49947721f9ab..142e9ef72351 100644 --- a/clients/client-cloudformation/src/commands/ListResourceScansCommand.ts +++ b/clients/client-cloudformation/src/commands/ListResourceScansCommand.ts @@ -28,7 +28,8 @@ export interface ListResourceScansCommandInput extends ListResourceScansInput {} export interface ListResourceScansCommandOutput extends ListResourceScansOutput, __MetadataBearer {} /** - *List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
+ *List the resource scans from newest to oldest. By default it will return up to 10 resource + * scans.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ListStackInstanceResourceDriftsCommand.ts b/clients/client-cloudformation/src/commands/ListStackInstanceResourceDriftsCommand.ts index 20f856e91cef..9cc3c8803a36 100644 --- a/clients/client-cloudformation/src/commands/ListStackInstanceResourceDriftsCommand.ts +++ b/clients/client-cloudformation/src/commands/ListStackInstanceResourceDriftsCommand.ts @@ -36,8 +36,9 @@ export interface ListStackInstanceResourceDriftsCommandOutput *Returns drift information for resources in a stack instance.
*
- * ListStackInstanceResourceDrifts returns drift information for the most recent drift detection
- * operation. If an operation is in progress, it may only return partial results.
ListStackInstanceResourceDrifts returns drift information for the most
+ * recent drift detection operation. If an operation is in progress, it may only return partial
+ * results.
* 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 Amazon Web Services account name or Region, or that - * have a specific status.
+ *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 + * Amazon Web Services account name or Region, or that have a specific status.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ListStackResourcesCommand.ts b/clients/client-cloudformation/src/commands/ListStackResourcesCommand.ts index de9f2a804930..ea516db0e07c 100644 --- a/clients/client-cloudformation/src/commands/ListStackResourcesCommand.ts +++ b/clients/client-cloudformation/src/commands/ListStackResourcesCommand.ts @@ -29,8 +29,8 @@ export interface ListStackResourcesCommandOutput extends ListStackResourcesOutpu /** *Returns descriptions of all resources of the specified stack.
- *For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been - * deleted.
+ *For deleted stacks, ListStackResources returns resource information for up to 90 days + * after the stack has been deleted.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ListStackSetsCommand.ts b/clients/client-cloudformation/src/commands/ListStackSetsCommand.ts index 9f0e87e0f2ba..a66699eb78c3 100644 --- a/clients/client-cloudformation/src/commands/ListStackSetsCommand.ts +++ b/clients/client-cloudformation/src/commands/ListStackSetsCommand.ts @@ -31,18 +31,20 @@ export interface ListStackSetsCommandOutput extends ListStackSetsOutput, __Metad *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.
[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
+ * 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.
[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.
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary - * information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter - * is specified, summary information for all stacks is returned (including existing stacks and stacks that have been - * deleted).
+ *Returns the summary information for stacks whose status matches the specified + * StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days + * after the stack is deleted. If no StackStatusFilter is specified, summary information for all + * stacks is returned (including existing stacks and stacks that have been deleted).
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ListTypesCommand.ts b/clients/client-cloudformation/src/commands/ListTypesCommand.ts index e6c944d8d1b1..ac5f5345e61e 100644 --- a/clients/client-cloudformation/src/commands/ListTypesCommand.ts +++ b/clients/client-cloudformation/src/commands/ListTypesCommand.ts @@ -28,7 +28,8 @@ export interface ListTypesCommandInput extends ListTypesInput {} export interface ListTypesCommandOutput extends ListTypesOutput, __MetadataBearer {} /** - *Returns summary information about extension that have been registered with CloudFormation.
+ *Returns summary information about extension that have been registered with + * CloudFormation.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/PublishTypeCommand.ts b/clients/client-cloudformation/src/commands/PublishTypeCommand.ts index 333daec8ac18..1e72e6b95b47 100644 --- a/clients/client-cloudformation/src/commands/PublishTypeCommand.ts +++ b/clients/client-cloudformation/src/commands/PublishTypeCommand.ts @@ -28,11 +28,13 @@ export interface PublishTypeCommandInput extends PublishTypeInput {} export interface PublishTypeCommandOutput extends PublishTypeOutput, __MetadataBearer {} /** - *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 in the CloudFormation CLI User Guide.
- *To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
+ *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 in the + * CloudFormation Command Line Interface (CLI) User Guide.
+ *To publish an extension, you must be registered as a publisher with CloudFormation. For more + * information, see RegisterPublisher.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/RecordHandlerProgressCommand.ts b/clients/client-cloudformation/src/commands/RecordHandlerProgressCommand.ts index 8e794679a8ab..7378bf221e8b 100644 --- a/clients/client-cloudformation/src/commands/RecordHandlerProgressCommand.ts +++ b/clients/client-cloudformation/src/commands/RecordHandlerProgressCommand.ts @@ -29,8 +29,8 @@ export interface RecordHandlerProgressCommandOutput extends RecordHandlerProgres /** *Reports progress of a resource handler to CloudFormation.
- *Reserved for use by the CloudFormation CLI. Don't use this API - * in your code.
+ *Reserved for use by the CloudFormation + * CLI. Don't use this API in your code.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/RegisterPublisherCommand.ts b/clients/client-cloudformation/src/commands/RegisterPublisherCommand.ts index a0734fe621b1..c0c93eeb57fa 100644 --- a/clients/client-cloudformation/src/commands/RegisterPublisherCommand.ts +++ b/clients/client-cloudformation/src/commands/RegisterPublisherCommand.ts @@ -28,10 +28,12 @@ export interface RegisterPublisherCommandInput extends RegisterPublisherInput {} export interface RegisterPublisherCommandOutput extends RegisterPublisherOutput, __MetadataBearer {} /** - *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 in the CloudFormation CLI User - * Guide.
+ *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 + * Prerequisite: Registering your account to publish CloudFormation extensions in the + * CloudFormation Command Line Interface (CLI) User Guide.
* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-cloudformation/src/commands/RegisterTypeCommand.ts b/clients/client-cloudformation/src/commands/RegisterTypeCommand.ts index e52cc42f4c81..dab9ddc73891 100644 --- a/clients/client-cloudformation/src/commands/RegisterTypeCommand.ts +++ b/clients/client-cloudformation/src/commands/RegisterTypeCommand.ts @@ -28,8 +28,8 @@ export interface RegisterTypeCommandInput extends RegisterTypeInput {} export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __MetadataBearer {} /** - *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:
+ *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.
@@ -41,14 +41,19 @@ export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __Metadat *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 in the CloudFormation CLI User Guide.
- *You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and - * per Region. Use DeregisterType 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 registered a private extension in your account and Region, use SetTypeConfiguration to specify - * configuration properties for the extension. For more information, see Configuring extensions at - * the account level in the CloudFormation User Guide.
+ *For more information about how to develop extensions and ready them for registration, see + * Creating resource types using the CloudFormation CLI in the + * CloudFormation Command Line Interface (CLI) User Guide.
+ *You can have a maximum of 50 resource extension versions registered at a time. This + * maximum is per account and per Region. Use DeregisterType + * 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 registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For + * more information, see Edit configuration + * data for extensions in your account in the + * CloudFormation User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/RollbackStackCommand.ts b/clients/client-cloudformation/src/commands/RollbackStackCommand.ts index c7546acdcb67..42e9b22f12a4 100644 --- a/clients/client-cloudformation/src/commands/RollbackStackCommand.ts +++ b/clients/client-cloudformation/src/commands/RollbackStackCommand.ts @@ -28,12 +28,14 @@ export interface RollbackStackCommandInput extends RollbackStackInput {} export interface RollbackStackCommandOutput extends RollbackStackOutput, __MetadataBearer {} /** - *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.
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.
diff --git a/clients/client-cloudformation/src/commands/SetTypeConfigurationCommand.ts b/clients/client-cloudformation/src/commands/SetTypeConfigurationCommand.ts index ebe45e75a7fe..28e3aa5450b3 100644 --- a/clients/client-cloudformation/src/commands/SetTypeConfigurationCommand.ts +++ b/clients/client-cloudformation/src/commands/SetTypeConfigurationCommand.ts @@ -28,14 +28,19 @@ export interface SetTypeConfigurationCommandInput extends SetTypeConfigurationIn export interface SetTypeConfigurationCommandOutput extends SetTypeConfigurationOutput, __MetadataBearer {} /** - *
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. For more information, see Configuring extensions at
- * the account level in the CloudFormation User Guide.
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. For
+ * more information, see Edit configuration
+ * data for extensions in your account 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 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 Specify values stored in + * other services using dynamic references in the + * CloudFormation User Guide.
*Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
+ *Specify the default version of an extension. The default version of an extension will be + * used in CloudFormation operations.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/SignalResourceCommand.ts b/clients/client-cloudformation/src/commands/SignalResourceCommand.ts index 57755fab161f..2ea27cb84fb5 100644 --- a/clients/client-cloudformation/src/commands/SignalResourceCommand.ts +++ b/clients/client-cloudformation/src/commands/SignalResourceCommand.ts @@ -29,10 +29,11 @@ export interface SignalResourceCommandOutput extends __MetadataBearer {} /** *Sends a signal to the specified resource with a success or failure 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 operation is useful in cases where you want to send signals from
- * anywhere other than an Amazon EC2 instance.
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
+ * operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2
+ * instance.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
diff --git a/clients/client-cloudformation/src/commands/StartResourceScanCommand.ts b/clients/client-cloudformation/src/commands/StartResourceScanCommand.ts
index bd100f2a5580..32170dddaaac 100644
--- a/clients/client-cloudformation/src/commands/StartResourceScanCommand.ts
+++ b/clients/client-cloudformation/src/commands/StartResourceScanCommand.ts
@@ -28,8 +28,8 @@ export interface StartResourceScanCommandInput extends StartResourceScanInput {}
export interface StartResourceScanCommandOutput extends StartResourceScanOutput, __MetadataBearer {}
/**
- * Starts a scan of the resources in this account in this Region. You can the status of a scan using the
- * ListResourceScans API action.
Starts a scan of the resources in this account in this Region. You can the status of a
+ * scan using the ListResourceScans API action.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
+ *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 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 modules, this includes determining if the module's model meets all necessary + * requirements.
*For more information, see Testing your public - * extension prior to publishing 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.
- *Once you've initiated testing on an extension using TestType, you can pass the returned
- * TypeVersionArn into DescribeType 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 in the CloudFormation CLI User
- * Guide.
For more information, see Testing your public extension before publishing in the + * CloudFormation Command Line Interface (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.
+ *Once you've initiated testing on an extension using TestType, you can pass
+ * the returned TypeVersionArn into DescribeType 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 in the
+ * CloudFormation Command Line Interface (CLI) User Guide.
Updates a generated template. This can be used to change the name, add and remove resources, refresh resources,
- * and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of
- * the update to the generated template using the DescribeGeneratedTemplate API action.
Updates a generated template. This can be used to change the name, add and remove
+ * resources, refresh resources, and change the DeletionPolicy and
+ * UpdateReplacePolicy settings. You can check the status of the update to the
+ * generated template using the DescribeGeneratedTemplate API action.
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 through the DescribeStacks action.
- *To get a copy of the template for an existing stack, you can use the GetTemplate - * action.
- *For more information about creating an update template, updating a stack, and monitoring the progress of the - * update, see Updating a Stack.
+ *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 through the DescribeStacks action.
+ *To get a copy of the template for an existing stack, you can use the GetTemplate action.
+ *For more information about updating a stack and monitoring the progress of the update, see + * Managing + * Amazon Web Services resources as a single unit with CloudFormation stacks in the + * CloudFormation User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/UpdateStackInstancesCommand.ts b/clients/client-cloudformation/src/commands/UpdateStackInstancesCommand.ts index 6773786ee06a..97cbd3c2ab66 100644 --- a/clients/client-cloudformation/src/commands/UpdateStackInstancesCommand.ts +++ b/clients/client-cloudformation/src/commands/UpdateStackInstancesCommand.ts @@ -28,18 +28,20 @@ export interface UpdateStackInstancesCommandInput extends UpdateStackInstancesIn export interface UpdateStackInstancesCommandOutput extends UpdateStackInstancesOutput, __MetadataBearer {} /** - *Updates the parameter values for stack instances for the specified 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 Amazon Web Services Regions and accounts where they already exist; to - * create additional stack instances, use CreateStackInstances.
- *During stack set updates, any parameters overridden for a stack 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 UpdateStackSet to update the stack set
- * template. If you add a parameter to a template, before you can override the parameter value specified in the stack
- * set you must first use UpdateStackSet to update all stack
- * instances with the updated template and parameter value specified in the stack set. Once a stack instance has been
- * updated with the new parameter, you can then override the parameter value using
- * UpdateStackInstances.
Updates the parameter values for stack instances for the specified 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 Amazon Web Services Regions and accounts where they already + * exist; to create additional stack instances, use CreateStackInstances.
+ *During stack set updates, any parameters overridden for a stack 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 UpdateStackSet
+ * to update the stack set template. If you add a parameter to a template, before you can
+ * override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and
+ * parameter value specified in the stack set. Once a stack instance has been updated with the
+ * new parameter, you can then override the parameter value using
+ * UpdateStackInstances.
Updates the stack set, and associated stack instances in the specified 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 tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
+ *Updates the stack set, and associated stack instances in the specified 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 tolerance), the stack set is updated with your + * changes. Subsequent CreateStackInstances calls on the specified stack set + * use the updated stack set.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/UpdateTerminationProtectionCommand.ts b/clients/client-cloudformation/src/commands/UpdateTerminationProtectionCommand.ts index bbfc29f6ab85..8bd7c7f3a54f 100644 --- a/clients/client-cloudformation/src/commands/UpdateTerminationProtectionCommand.ts +++ b/clients/client-cloudformation/src/commands/UpdateTerminationProtectionCommand.ts @@ -28,12 +28,13 @@ export interface UpdateTerminationProtectionCommandInput extends UpdateTerminati export interface UpdateTerminationProtectionCommandOutput extends UpdateTerminationProtectionOutput, __MetadataBearer {} /** - *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 in the CloudFormation User Guide.
- *For nested - * stacks, termination protection is set on the root stack and can't be changed directly on the nested - * stack.
+ *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 Protect a CloudFormation + * stack from being deleted in the CloudFormation User Guide.
+ *For nested stacks, + * termination protection is set on the root stack and can't be changed directly on the nested + * stack.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/commands/ValidateTemplateCommand.ts b/clients/client-cloudformation/src/commands/ValidateTemplateCommand.ts index 0407ae5ed484..d310ffb858cc 100644 --- a/clients/client-cloudformation/src/commands/ValidateTemplateCommand.ts +++ b/clients/client-cloudformation/src/commands/ValidateTemplateCommand.ts @@ -28,9 +28,9 @@ export interface ValidateTemplateCommandInput extends ValidateTemplateInput {} export interface ValidateTemplateCommandOutput extends ValidateTemplateOutput, __MetadataBearer {} /** - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cloudformation/src/index.ts b/clients/client-cloudformation/src/index.ts index c4a04c604681..881a6e7b1d06 100644 --- a/clients/client-cloudformation/src/index.ts +++ b/clients/client-cloudformation/src/index.ts @@ -3,7 +3,8 @@ /** *CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and - * repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly + * repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, + * Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly * scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services * infrastructure.
*With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a diff --git a/clients/client-cloudformation/src/models/models_0.ts b/clients/client-cloudformation/src/models/models_0.ts index 926b1fbfd772..77f35c415a5b 100644 --- a/clients/client-cloudformation/src/models/models_0.ts +++ b/clients/client-cloudformation/src/models/models_0.ts @@ -108,14 +108,14 @@ export interface AccountGateResult { *
Number of stack outputs
*For more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the - * CloudFormation User Guide.
+ *For more information about these account limits, and other CloudFormation limits, see Understand CloudFormation quotas in the CloudFormation User Guide.
* @public */ export interface AccountLimit { /** *The name of the account limit.
- *Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit
+ *
Values: ConcurrentResourcesLimit | StackLimit |
+ * StackOutputsLimit
*
The Amazon Resource Name (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.
* @public */ LogRoleArn: string | undefined; @@ -236,50 +237,52 @@ export type VersionBump = (typeof VersionBump)[keyof typeof VersionBump]; export interface ActivateTypeInput { /** *The extension type.
- *Conditional: You must specify PublicTypeArn, or TypeName, Type, and
- * PublisherId.
Conditional: You must specify PublicTypeArn, or TypeName,
+ * Type, and PublisherId.
The Amazon Resource Name (ARN) of the public extension.
- *Conditional: You must specify PublicTypeArn, or TypeName, Type, and
- * PublisherId.
Conditional: You must specify PublicTypeArn, or TypeName,
+ * Type, and PublisherId.
The ID of the extension publisher.
- *Conditional: You must specify PublicTypeArn, or TypeName, Type, and
- * PublisherId.
Conditional: You must specify PublicTypeArn, or TypeName,
+ * Type, and PublisherId.
The name of the extension.
- *Conditional: You must specify PublicTypeArn, or TypeName, Type, and
- * PublisherId.
Conditional: You must specify PublicTypeArn, or TypeName,
+ * Type, and PublisherId.
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.
+ *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.
* @public */ TypeNameAlias?: string; /** - *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.
+ *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.
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.
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.
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.
MINOR: CloudFormation updates the extension to the newest minor version, if
+ * one is available.
* 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.
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.
The Amazon Resource Name (ARN) of the activated extension, in this account and Region.
+ *The Amazon Resource Name (ARN) of the activated extension, in this account and + * Region.
* @public */ Arn?: string; @@ -343,7 +351,7 @@ export class CFNRegistryException extends __BaseException { readonly name: "CFNRegistryException" = "CFNRegistryException"; readonly $fault: "client" = "client"; /** - *An message with details about the error that occurred.
+ *A message with details about the error that occurred.
* @public */ Message?: string; @@ -369,7 +377,7 @@ export class TypeNotFoundException extends __BaseException { readonly name: "TypeNotFoundException" = "TypeNotFoundException"; readonly $fault: "client" = "client"; /** - *An message with details about the error that occurred.
+ *A message with details about the error that occurred.
* @public */ Message?: string; @@ -455,15 +463,16 @@ export interface AutoDeployment { export interface TypeConfigurationIdentifier { /** *The Amazon Resource Name (ARN) for the extension, in this account and Region.
- *For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account - * and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account - * and Region.
+ *For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this + * will be the ARN assigned when you call the RegisterType API + * operation in this account and Region.
* @public */ TypeArn?: string; /** - *The alias specified for this configuration, if one was specified when the configuration was set.
+ *The alias specified for this configuration, if one was specified when the configuration was + * set.
* @public */ TypeConfigurationAlias?: string; @@ -499,7 +508,8 @@ export interface BatchDescribeTypeConfigurationsInput { } /** - *Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.
+ *Detailed information concerning an error generated during the setting of configuration data + * for a CloudFormation extension.
* @public */ export interface BatchDescribeTypeConfigurationsError { @@ -523,44 +533,49 @@ export interface BatchDescribeTypeConfigurationsError { } /** - *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 in the CloudFormation User Guide.
+ *Detailed information concerning the specification of a CloudFormation extension in a given + * account and Region.
+ *For more information, see Edit configuration data + * for extensions in your account in the CloudFormation User Guide.
* @public */ export interface TypeConfigurationDetails { /** - *The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
+ *The Amazon Resource Name (ARN) for the configuration data, in this account and + * Region.
* @public */ Arn?: string; /** - *The alias specified for this configuration, if one was specified when the configuration was set.
+ *The alias specified for this configuration, if one was specified when the configuration was + * set.
* @public */ Alias?: string; /** - *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 \{\}.
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
+ * \{\}.
When the configuration data was last updated for this extension.
- *If a configuration hasn't been set for a specified extension, CloudFormation returns null.
If a configuration hasn't been set for a specified extension, CloudFormation returns
+ * null.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
- *For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account - * and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account - * and Region.
+ *For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this + * will be the ARN assigned when you call the RegisterType API + * operation in this account and Region.
* @public */ TypeArn?: string; @@ -583,19 +598,22 @@ export interface TypeConfigurationDetails { */ export interface BatchDescribeTypeConfigurationsOutput { /** - *A list of information concerning any errors generated during the setting of the specified configurations.
+ *A list of information concerning any errors generated during the setting of the specified + * configurations.
* @public */ Errors?: BatchDescribeTypeConfigurationsError[]; /** - *A list of any of the specified extension configurations that CloudFormation could not process for any reason.
+ *A list of any of the specified extension configurations that CloudFormation could not process + * for any reason.
* @public */ UnprocessedTypeConfigurations?: TypeConfigurationIdentifier[]; /** - *A list of any of the specified extension configurations from the CloudFormation registry.
+ *A list of any of the specified extension configurations from the CloudFormation + * registry.
* @public */ TypeConfigurations?: TypeConfigurationDetails[]; @@ -609,7 +627,7 @@ export class TypeConfigurationNotFoundException extends __BaseException { readonly name: "TypeConfigurationNotFoundException" = "TypeConfigurationNotFoundException"; readonly $fault: "client" = "client"; /** - *An message with details about the error that occurred.
+ *A message with details about the error that occurred.
* @public */ Message?: string; @@ -648,13 +666,15 @@ export type CallAs = (typeof CallAs)[keyof typeof CallAs]; export interface CancelUpdateStackInput { /** *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:
+ *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/*\/*" \}] \}
+ * \{ "Version": "2012-10-17", "Statement": [\{ "Effect": "Deny", "Action":
+ * "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*\/*" \}]
+ * \}
*
The name or the unique stack ID that's associated with the stack.
@@ -663,9 +683,10 @@ export interface CancelUpdateStackInput { StackName: string | undefined; /** - *A unique identifier for this CancelUpdateStack request. Specify 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 CloudFormation successfully received them.
A unique identifier for this CancelUpdateStack request. Specify 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 CloudFormation successfully received them.
The field that CloudFormation will change, such as the name of a resource's property, and whether the resource will be - * recreated.
+ *The field that CloudFormation will change, such as the name of a resource's property, and + * whether the resource will be recreated.
* @public */ export interface ResourceTargetDefinition { /** - *Indicates which resource attribute is triggering this update, such as a change in the resource attribute's
- * Metadata, Properties, or Tags.
Indicates which resource attribute is triggering this update, such as a change in the
+ * resource attribute's Metadata, Properties, or Tags.
If the Attribute value is Properties, the name of the property. For all other
- * attributes, the value is null.
If the Attribute value is Properties, the name of the property.
+ * For all other attributes, the value is null.
If the Attribute value is Properties, indicates whether a change 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 in the
- * CloudFormation User Guide.
If the Attribute value is Properties, indicates whether a change
+ * 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 in the Amazon Web Services resource and
+ * property types reference in the CloudFormation User Guide.
The value of the property before the change is executed. Large values can be truncated.
+ *The value of the property before the change is executed. Large values can be + * truncated.
* @public */ BeforeValue?: string; /** - *The value of the property after the change is executed. Large values can be truncated.
+ *The value of the property after the change is executed. Large values can be + * truncated.
* @public */ AfterValue?: string; @@ -876,62 +899,68 @@ export interface ResourceTargetDefinition { } /** - *For a resource with Modify as the action, the ResourceChange structure describes the
- * changes CloudFormation will make to that resource.
For a resource with Modify as the action, the ResourceChange
+ * structure describes the changes CloudFormation will make to that resource.
A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether
- * the resource will be recreated.
A ResourceTargetDefinition structure that describes the field that CloudFormation
+ * will change and whether the resource will be recreated.
Indicates whether CloudFormation can determine the target value, and whether the target value will change before you - * execute a change set.
- *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, CloudFormation knows
- * that this property value will change, and its value, so this is a Static evaluation.
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'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 ID, so all references to that resource will also be
- * updated.
Indicates whether CloudFormation can determine the target value, and whether the target value + * will change before you execute a change set.
+ *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, CloudFormation knows that this property value will change, and its value, so this
+ * is a Static evaluation.
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'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 ID, so all references to that resource will also be updated.
The group to which the CausingEntity value belongs. There are five entity groups:
The group to which the CausingEntity value belongs. There are five entity
+ * groups:
- * ResourceReference entities are Ref intrinsic functions that refer to resources in
- * the template, such as \{ "Ref" : "MyEC2InstanceResource" \}.
ResourceReference entities are Ref intrinsic functions that refer to
+ * resources in the template, such as \{ "Ref" : "MyEC2InstanceResource" \}.
*
- * ParameterReference entities are Ref intrinsic functions that get template parameter
- * values, such as \{ "Ref" : "MyPasswordParameter" \}.
ParameterReference entities are Ref intrinsic functions that get
+ * template parameter values, such as \{ "Ref" : "MyPasswordParameter" \}.
*
- * ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource
- * attribute values, such as \{ "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] \}.
ResourceAttribute entities are Fn::GetAtt intrinsic functions that
+ * get resource attribute values, such as \{ "Fn::GetAtt" : [ "MyEC2InstanceResource",
+ * "PublicDnsName" ] \}.
*
- * DirectModification entities are changes that are made directly to the template.
DirectModification entities are changes that are made directly to the
+ * template.
*
- * 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, 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 CloudFormation until you run an update on the parent
- * stack.
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, 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 CloudFormation until you run
+ * an update on the parent stack.
* The identity of the entity that triggered this change. This entity 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).
If the ChangeSource value is DirectModification, no value is given for
- * CausingEntity.
The identity of the entity that triggered this change. This entity 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).
If the ChangeSource value is DirectModification, no value is given
+ * for CausingEntity.
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 in the CloudFormation User Guide.
+ *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 Create reusable resource configurations + * that can be included across templates with CloudFormation modules in the + * CloudFormation User Guide.
* @public */ export interface ModuleInfo { /** - *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 /.
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, that's nested inside a parent module of type
+ * AWS::Second::Example::MODULE.
*
* AWS::First::Example::MODULE/AWS::Second::Example::MODULE
*
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.
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 - * in the CloudFormation User Guide.
+ *For more information, see Reference module resources in + * CloudFormation templates in the CloudFormation User Guide.
* @public */ LogicalIdHierarchy?: string; @@ -1019,13 +1051,14 @@ export const Replacement = { export type Replacement = (typeof Replacement)[keyof typeof Replacement]; /** - *The ResourceChange structure describes the resource and the action that CloudFormation will perform on it if
- * you execute this change set.
The ResourceChange structure describes the resource and the action that
+ * CloudFormation will perform on it if you execute this change set.
The action that will be taken on the physical resource when the change set is executed.
+ *The action that will be taken on the physical resource when the change set is + * executed.
*@@ -1049,7 +1082,8 @@ export interface ResourceChange { *
- * ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.
ReplaceAndSnapshot The resource will be replaced and then have a snapshot
+ * taken.
* 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).
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).
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they - * haven't been created.
+ *The resource's physical ID (resource name). Resources that you are adding don't have + * physical IDs because they haven't been created.
* @public */ PhysicalResourceId?: string; @@ -1084,29 +1119,33 @@ export interface ResourceChange { ResourceType?: string; /** - *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 RequiresRecreation field is
- * Always and the Evaluation field is Static, Replacement is
- * True. If the RequiresRecreation field is Always and the
- * Evaluation field is Dynamic, Replacement is Conditionally.
If you have multiple changes with different RequiresRecreation values, the Replacement
- * value depends on the change with the most impact. A RequiresRecreation value of Always has
- * the most impact, followed by Conditionally, and then Never.
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 RequiresRecreation field is Always and the
+ * Evaluation field is Static, Replacement is
+ * True. If the RequiresRecreation field is Always and the
+ * Evaluation field is Dynamic, Replacement is
+ * Conditional.
If you have multiple changes with different RequiresRecreation values, the
+ * Replacement value depends on the change with the most impact. A
+ * RequiresRecreation value of Always has the most impact, followed by
+ * Conditional, and then Never.
For the Modify action, indicates which resource attribute is triggering this update, such as a
- * change in the resource attribute's Metadata, Properties, or Tags.
For the Modify action, indicates which resource attribute is triggering this
+ * update, such as a change in the resource attribute's Metadata,
+ * Properties, or Tags.
For the Modify action, a list of ResourceChangeDetail structures that describes the
- * changes that CloudFormation will make to the resource.
For the Modify action, a list of ResourceChangeDetail structures
+ * that describes the changes that CloudFormation will make to the resource.
Contains information about the module from which the resource was created, if the resource was created from a - * module included in the stack template.
+ *Contains information about the module from which the resource was created, if the resource + * was created from a module included in the stack template.
* @public */ ModuleInfo?: ModuleInfo; /** - *An encoded JSON string containing the context of the resource before the change is executed.
+ *An encoded JSON string containing the context of the resource before the change is + * executed.
* @public */ BeforeContext?: string; /** - *An encoded JSON string containing the context of the resource after the change is executed.
+ *An encoded JSON string containing the context of the resource after the change is + * executed.
* @public */ AfterContext?: string; @@ -1151,7 +1192,8 @@ export const ChangeType = { export type ChangeType = (typeof ChangeType)[keyof typeof ChangeType]; /** - *The Change structure describes the changes CloudFormation will perform if you execute the change set.
The Change structure describes the changes CloudFormation will perform if you
+ * execute the change set.
Is either null, if no hooks invoke for the resource, or contains the number of hooks that will
- * invoke for the resource.
Is either null, if no hooks invoke for the resource, or contains the number of
+ * hooks that will invoke for the resource.
A ResourceChange structure that describes the resource and action that CloudFormation will perform.
A ResourceChange structure that describes the resource and action that
+ * CloudFormation will perform.
The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of
- * Organization::Service::Hook.
The unique name for your hook. Specifies a three-part namespace for your hook, with a
+ * recommended pattern of Organization::Service::Hook.
The following organization namespaces are reserved and can't be used in your hook type names:
+ *The following organization namespaces are reserved and can't be used in your hook type + * names:
*@@ -1433,8 +1477,8 @@ export const ExecutionStatus = { export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionStatus]; /** - *
The ChangeSetSummary structure describes a change set, its status, and the stack with which it's
- * associated.
The ChangeSetSummary structure describes a change set, its status, and the
+ * stack with which it's associated.
If the change set execution status is AVAILABLE, you can execute 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 CloudFormation is still creating it or in an OBSOLETE state because the stack was already
- * updated.
If the change set execution status is AVAILABLE, you can execute 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 CloudFormation is still creating it or in an
+ * OBSOLETE state because the stack was already updated.
The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
- * FAILED.
The state of the change set, such as CREATE_IN_PROGRESS,
+ * CREATE_COMPLETE, or FAILED.
A description of the change set's status. For example, if your change set is in the FAILED state,
- * CloudFormation shows the error message.
A description of the change set's status. For example, if your change set is in the
+ * FAILED state, CloudFormation shows the error message.
The name or the unique ID of the stack that you want to continue rolling back.
*Don't specify the name of a nested stack (a stack that was created by using the
- * AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that
- * contains the AWS::CloudFormation::Stack resource).
AWS::CloudFormation::Stack resource). Instead, use this operation on the
+ * parent stack (the stack that contains the AWS::CloudFormation::Stack
+ * resource).
* 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.
+ *The Amazon Resource Name (ARN) of an 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.
* @public */ RoleARN?: string; /** - *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.
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 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 this property to skip rolling back resources that CloudFormation can't successfully
+ * roll back. We recommend that you troubleshoot 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 cause dependent resources to fail. In this case, it might not be necessary to skip the - * dependent resources.
+ *Specify the minimum number of resources required to successfully roll back your stack. For + * example, a failed resource update might cause dependent resources to fail. In this case, it + * might not be necessary to skip the dependent resources.
*To skip resources that are part of nested stacks, use the following format:
- * NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource
- * (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding
- * embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE,
- * or DELETE_FAILED.
NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a
+ * stack resource (Type: AWS::CloudFormation::Stack) in the
+ * ResourcesToSkip list, then its corresponding embedded stack must be in one of
+ * the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or
+ * DELETE_FAILED.
* Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an - * example of a continue update rollback operation with nested stacks, see Using - * ResourcesToSkip to recover a nested stacks hierarchy.
+ *Don't confuse a child stack's name with its corresponding logical ID defined in the + * parent stack. For an example of a continue update rollback operation with nested stacks, see + * Continue rolling back from failed nested stack updates.
*A unique identifier for this ContinueUpdateRollback request. 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 CloudFormation successfully received
- * them.
A unique identifier for this ContinueUpdateRollback request. 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 CloudFormation successfully received
+ * them.
The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.
+ *The key associated with the parameter. If you don't specify a key and value for a particular + * parameter, CloudFormation uses the default value that's specified in your template.
* @public */ ParameterKey?: string; @@ -1646,16 +1695,16 @@ export interface Parameter { ParameterValue?: string; /** - *During a stack update, use the existing parameter value that the stack is using for a given parameter key. If
- * you specify true, do not specify a parameter value.
During a stack update, use the existing parameter value that the stack is using for a given
+ * parameter key. If you specify true, do not specify a parameter value.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for - * SSM - * parameter types in the template.
+ *Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only + * for Systems Manager parameter types in the template. For more information, see Use + * CloudFormation-supplied parameter types in the CloudFormation User Guide.
* @public */ ResolvedValue?: string; @@ -1667,9 +1716,10 @@ export interface Parameter { */ export interface ResourceToImport { /** - *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 in the CloudFormation User Guide.
The type of resource to import into your stack, such as AWS::S3::Bucket. For a
+ * list of supported resource types, see Resource type
+ * support for imports and drift detection in the
+ * CloudFormation User Guide.
A key-value pair that identifies the target resource. The key is an identifier property (for example,
- * BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for
- * example, MyS3Bucket).
A key-value pair that identifies the target resource. The key is an identifier property (for
+ * example, BucketName for AWS::S3::Bucket resources) and the value is the
+ * actual property value (for example, MyS3Bucket).
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.
+ *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.
* @public */ export interface RollbackTrigger { /** *The Amazon Resource Name (ARN) of the rollback trigger.
- *If a specified trigger is missing, the entire stack operation fails and is rolled back.
+ *If a specified trigger is missing, the entire stack operation fails and is rolled + * back.
* @public */ Arn: string | undefined; /** - *The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
+ *The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
* @public */ Type: string | undefined; } /** - *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 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.
+ *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 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 Roll back your CloudFormation stack on alarm breach with rollback triggers.
* @public */ export interface RollbackConfiguration { /** *The triggers to monitor during stack creation or update actions.
- *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:
+ *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:
*To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.
+ *To use the rollback triggers previously specified for this stack, if any, don't specify + * this parameter.
*To specify new or updated rollback triggers, you must specify all the triggers that you - * want used for this stack, even 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.
+ *To specify new or updated rollback triggers, you must specify all the + * triggers that you want used for this stack, even 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.
*To remove all currently specified triggers, specify an empty list for this parameter.
+ *To remove all currently specified triggers, specify an empty list for this + * parameter.
*If a specified trigger is missing, the entire stack operation fails and is rolled back.
+ *If a specified trigger is missing, the entire stack operation fails and is rolled + * back.
* @public */ RollbackTriggers?: RollbackTrigger[]; /** - *The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack - * creation or update operation deploys all necessary resources.
+ *The amount of time, in minutes, during which CloudFormation should monitor all the rollback + * triggers after the stack creation or update operation deploys all necessary resources.
*The default is 0 minutes.
- *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 desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
- *If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack - * creation and update operations. Then, for update operations, it begins disposing of old resources immediately once - * the operation completes.
+ *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 desired, and manually + * cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
+ *If you specify 0 for this parameter, CloudFormation still monitors the specified rollback + * triggers during stack creation and update operations. Then, for update operations, it begins + * disposing of old resources immediately once the operation completes.
* @public */ MonitoringTimeInMinutes?: number; } /** - *The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
+ *The Tag type enables you to specify a key-value pair that can be used to store information + * about an CloudFormation stack.
* @public */ export interface Tag { /** *
- * 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 (Amazon Web Services) have the reserved prefix:
+ * 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 have the reserved prefix:
* aws:.
- * Required. A string containing the value for this tag. You can specify a maximum of 256 - * characters for a tag value.
+ * Required. A string containing the value for this tag. You can specify a + * maximum of 256 characters for a tag value. * @public */ Value: string | undefined; @@ -1787,84 +1844,87 @@ export interface Tag { */ export interface CreateChangeSetInput { /** - *The name or the unique ID of the stack for which you are creating a 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.
+ *The name or the unique ID of the stack for which you are creating a 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.
* @public */ StackName: string | undefined; /** - *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. CloudFormation generates the change set by comparing this template with the template of the stack that you - * specified.
- *Conditional: You must specify only TemplateBody or TemplateURL.
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. CloudFormation generates the change set by comparing + * this template with the template of the stack that you specified.
+ *Conditional: You must specify only TemplateBody or
+ * TemplateURL.
The location of the file that contains the revised template. The URL 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. The location for an Amazon S3 bucket must start with
- * https://.
Conditional: You must specify only TemplateBody or TemplateURL.
The location of the file that contains the revised template. The URL 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. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only TemplateBody or
+ * TemplateURL.
Whether to reuse the template that's associated with the stack to create the change set.
+ *Whether to reuse the template that's associated with the stack to create the change + * set.
* @public */ UsePreviousTemplate?: boolean; /** - *A list of Parameter structures that specify input parameters for the change set. For more
- * information, see the Parameter data type.
A list of Parameter structures that specify input parameters for the change
+ * set. For more information, see the Parameter data type.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order - * for CloudFormation to create the stack.
+ *In some cases, you must explicitly acknowledge that your 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 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.
Some stack templates might include resources that can affect permissions in your + * Amazon Web Services account; for example, by creating new 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.
If you have IAM resources, you can specify either capability.
*If you have IAM resources with custom names, you must specify
- * CAPABILITY_NAMED_IAM.
If you have IAM resources with custom names, you must
+ * specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
- * InsufficientCapabilities error.
InsufficientCapabilities error.
* If your stack template contains these resources, we suggest that you review all permissions associated with - * them and edit their permissions if necessary.
+ *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::Group + * + * AWS::IAM::Group *
*- * - * AWS::IAM::Policy + * + * AWS::IAM::Policy *
** - * AWS::IAM::Role + * AWS::IAM::Role *
*- * - * AWS::IAM::User + * + * AWS::IAM::User *
*- * AWS::IAM::UserToGroupAddition + * AWS::IAM::UserToGroupAddition *
*For more information, see Acknowledging IAM resources in - * CloudFormation templates.
+ *For more information, see Acknowledging IAM resources in CloudFormation templates.
*
* CAPABILITY_AUTO_EXPAND
*
Some template contain macros. Macros perform custom processing on templates; this can include simple actions - * like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, - * users typically create a change set from the processed template, so that they can review the changes resulting from - * the macros before actually creating the stack. 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. This includes the AWS::Include and AWS::Serverless transforms, which - * are macros hosted by CloudFormation.
+ *Some template contain macros. Macros perform custom processing on templates; this can + * include simple actions like find-and-replace operations, all the way to extensive + * transformations of entire templates. Because of this, users typically create a change set + * from the processed template, so that they can review the changes resulting from the macros + * before actually creating the stack. 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. + * This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
*This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no - * effect.
- *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.
+ *This capacity doesn't apply to creating change sets, and specifying it when creating + * change sets has no effect.
+ *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.
*For more information about macros, see Using CloudFormation macros to perform custom processing on - * templates.
+ *For more information about macros, see Perform custom processing + * on CloudFormation templates with template macros.
*Only one of the Capabilities and ResourceType parameters can be specified.
Only one of the Capabilities and ResourceType parameters can
+ * be specified.
The template resource types that you have permissions to work with if you execute this change set, such as
- * AWS::EC2::Instance, 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, 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 in the CloudFormation User Guide.
+ *The template resource types that you have permissions to work with if you execute this
+ * change set, such as AWS::EC2::Instance, 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, CloudFormation grants permissions to all resource types. IAM + * uses this parameter for condition keys in IAM policies for CloudFormation. For more information, + * see Control access with + * Identity and Access Management in the CloudFormation User Guide.
*Only one of the Capabilities and ResourceType parameters can be specified.
Only one of the Capabilities and ResourceType parameters can
+ * be specified.
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.
+ *The Amazon Resource Name (ARN) of an 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.
* @public */ RoleARN?: string; /** - *The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified - * monitoring period afterwards.
+ *The rollback triggers for CloudFormation to monitor during stack creation and updating + * operations, and for the specified monitoring period afterwards.
* @public */ RollbackConfiguration?: RollbackConfiguration; /** - *The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates - * with the stack. To remove all associated notification topics, specify an empty list.
+ *The Amazon Resource Names (ARNs) of Amazon SNS topics that CloudFormation associates with the + * stack. To remove all associated notification topics, specify an empty list.
* @public */ NotificationARNs?: string[]; /** - *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.
+ *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.
* @public */ Tags?: Tag[]; /** - *The name of the change set. The name must be unique among all change 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 - * alphabetical character and can't exceed 128 characters.
+ *The name of the change set. The name must be unique among all change 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 alphabetical character and can't exceed 128 characters.
* @public */ ChangeSetName: string | undefined; /** - *A unique identifier for this CreateChangeSet request. Specify this 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.
A unique identifier for this CreateChangeSet request. Specify this 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.
The type of change set operation. To create a change set for a new stack, specify CREATE. To create
- * a change set for an existing stack, specify UPDATE. To create a change set for an import operation,
- * specify IMPORT.
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 state - * until you execute the change set.
- *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.
The type of change set operation. To create a change set for a new stack, specify
+ * CREATE. To create a change set for an existing stack, specify
+ * UPDATE. To create a change set for an import operation, specify
+ * IMPORT.
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
+ * state until you execute the change set.
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.
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.
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.
Determines what action will be taken if stack creation fails. If this parameter is specified, the
- * DisableRollback parameter to the ExecuteChangeSet API operation must
- * not be specified. This must be one of these values:
Determines what action will be taken if stack creation fails. If this parameter is
+ * specified, the DisableRollback parameter to the ExecuteChangeSet 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.
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 API
- * operation.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent
+ * to specifying true for the DisableRollback parameter to the
+ * ExecuteChangeSet 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 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 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.
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.
Indicates if the change set imports resources that already exist.
*This parameter can only import resources that have custom names in templates. For more information, see name type in the - * CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, - * use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation - * management in the CloudFormation User Guide.
+ *This parameter can only import resources that have custom names in templates. For more + * information, see name type in the + * CloudFormation User Guide. To import resources that do not accept custom + * names, such as EC2 instances, use the resource import feature instead. For more information, + * see Import Amazon Web Services resources into + * a CloudFormation stack with a resource import in the + * CloudFormation User Guide.
*A resource included in a generated template. This data type is used with the
- * CreateGeneratedTemplate and UpdateGeneratedTemplate API actions.
CreateGeneratedTemplate and UpdateGeneratedTemplate API
+ * actions.
* @public
*/
export interface ResourceDefinition {
/**
- * The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see
- * IaC
- * generator supported resource types in the CloudFormation User Guide
+ *
The type of the resource, such as AWS::DynamoDB::Table. For the list of
+ * supported resources, see Resource type
+ * support for imports and drift detection in the
+ * CloudFormation User Guide
*
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the
- * primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list
- * in the resource schema.) The value is the value of that primary identifier. For example, for a
- * AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair
- * could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension
- * development.
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the
+ * name of one of the primary identifiers for the resource. (Primary identifiers are specified in
+ * the primaryIdentifier list in the resource schema.) The value is the value of that
+ * primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary
+ * identifiers is TableName so the key-value pair could be "TableName":
+ * "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
The DeletionPolicy assigned to resources in the generated template. Supported values are:
The DeletionPolicy assigned to resources in the generated template. Supported
+ * values are:
@@ -2234,27 +2311,28 @@ export interface TemplateConfiguration {
* RETAIN - retain all resources when the stack is deleted.
For more information, see DeletionPolicy attribute in the - * CloudFormation User Guide.
+ *For more information, see DeletionPolicy + * attribute in the CloudFormation User Guide.
* @public */ DeletionPolicy?: GeneratedTemplateDeletionPolicy; /** - *The UpdateReplacePolicy assigned to resources in the generated template. Supported values
- * are:
The UpdateReplacePolicy assigned to resources in the generated template.
+ * Supported values are:
- * DELETE - delete all resources when the resource is replaced during an update operation.
DELETE - delete all resources when the resource is replaced during an update
+ * operation.
*
- * RETAIN - retain all resources when the resource is replaced during an update operation.
RETAIN - retain all resources when the resource is replaced during an update
+ * operation.
* For more information, see UpdateReplacePolicy - * attribute in the CloudFormation User Guide.
+ *For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.
* @public */ UpdateReplacePolicy?: GeneratedTemplateUpdateReplacePolicy; @@ -2266,8 +2344,9 @@ export interface TemplateConfiguration { export interface CreateGeneratedTemplateInput { /** *An optional list of resources to be included in the generated template.
- * If no resources are specified,the template will be created without any resources. Resources can be added to the
- * template using the UpdateGeneratedTemplate API action.
If no resources are specified,the template will be created without any resources.
+ * Resources can be added to the template using the UpdateGeneratedTemplate API
+ * action.
An optional name or ARN of a stack to use as the base stack for the generated template.
+ *An optional name or ARN of a stack to use as the base stack for the generated + * template.
* @public */ StackName?: string; /** - *The configuration details of the generated template, including the DeletionPolicy and
- * UpdateReplacePolicy.
The configuration details of the generated template, including the
+ * DeletionPolicy and UpdateReplacePolicy.
The name that's associated with the stack. The name must be unique in the Region in which you are creating the - * stack.
+ *The name that's associated with the stack. The name must be unique in the Region in which + * you are creating the stack.
*A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an - * alphabetical character and can't be longer than 128 characters.
+ *A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It + * must start with an alphabetical character and can't be longer than 128 characters.
*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 in the CloudFormation User Guide.
- *Conditional: You must specify either the TemplateBody or the TemplateURL parameter,
- * but not both.
Structure containing the template body with a minimum length of 1 byte and a maximum + * length of 51,200 bytes.
+ *Conditional: You must specify either the TemplateBody or the
+ * TemplateURL parameter, but not both.
Location of file containing the template body. The URL must point to 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 in the
- * CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter,
- * but not both.
Location of file containing the template body. The URL must point to a template (max size:
+ * 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location
+ * for an Amazon S3 bucket must start with https://.
Conditional: You must specify either the TemplateBody or the
+ * TemplateURL parameter, but not both.
A list of Parameter structures that specify input parameters for the stack. For more information,
- * see the Parameter
- * data type.
A list of Parameter structures that specify input parameters for the stack.
+ * For more information, see the Parameter data
+ * type.
Set to true to disable rollback of the stack if stack creation failed. You can specify either
- * DisableRollback or OnFailure, but not both.
Set to true to disable rollback of the stack if stack creation failed. You
+ * can specify either DisableRollback or OnFailure, but not
+ * both.
Default: false
*
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the - * specified monitoring period afterwards.
+ *The rollback triggers for CloudFormation to monitor during stack creation and updating + * operations, and for the specified monitoring period afterwards.
* @public */ RollbackConfiguration?: RollbackConfiguration; /** - *The amount of time that can pass before the stack status becomes CREATE_FAILED; if
- * DisableRollback is not set or is set to false, the stack will be rolled back.
The amount of time that can pass before the stack status becomes
+ * CREATE_FAILED; if DisableRollback is not set or is set to
+ * false, the stack will be rolled back.
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).
+ *The 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).
* @public */ NotificationARNs?: string[]; /** - *In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order - * for CloudFormation to create the stack.
+ *In some cases, you must explicitly acknowledge that your 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 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.
Some stack templates might include resources that can affect permissions in your + * Amazon Web Services account; for example, by creating new 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.
If you have IAM resources, you can specify either capability.
*If you have IAM resources with custom names, you must specify
- * CAPABILITY_NAMED_IAM.
If you have IAM resources with custom names, you must
+ * specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
- * InsufficientCapabilities error.
InsufficientCapabilities error.
* If your stack template contains these resources, we recommend that you review all permissions associated with - * them and edit their permissions if necessary.
+ *If your stack template contains these resources, we recommend that you review all + * permissions associated with them and edit their permissions if necessary.
*- * AWS::IAM::AccessKey + * AWS::IAM::AccessKey *
*- * AWS::IAM::Group + * AWS::IAM::Group *
*- * AWS::IAM::Policy + * AWS::IAM::Policy *
*- * AWS::IAM::User + * AWS::IAM::User *
*- * AWS::IAM::UserToGroupAddition + * AWS::IAM::UserToGroupAddition *
*For more information, see Acknowledging IAM Resources in - * CloudFormation Templates.
+ *For more information, see Acknowledging IAM resources in CloudFormation templates.
*
* CAPABILITY_AUTO_EXPAND
*
Some template contain macros. Macros perform custom processing on templates; this can include simple actions - * like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, - * users typically create a change set from the processed template, so that they can review the changes resulting from - * the macros before actually creating the stack. 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. This includes the AWS::Include and AWS::Serverless transforms, which - * are macros hosted by CloudFormation.
- *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.
+ *Some template contain macros. Macros perform custom processing on templates; this can + * include simple actions like find-and-replace operations, all the way to extensive + * transformations of entire templates. Because of this, users typically create a change set + * from the processed template, so that they can review the changes resulting from the macros + * before actually creating the stack. 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. + * This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
+ *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 CloudFormation being - * notified.
+ *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 CloudFormation being notified.
*For more information, see Using CloudFormation macros to perform custom processing - * on templates.
+ *For more information, see Perform custom processing + * on CloudFormation templates with template macros.
*Only one of the Capabilities and ResourceType parameters can be specified.
Only one of the Capabilities and ResourceType parameters can
+ * be specified.
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 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, 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.
+ *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 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, CloudFormation grants permissions to all resource types. IAM uses + * this parameter for CloudFormation-specific condition keys in IAM policies. For more information, + * see Control access with + * Identity and Access Management.
*Only one of the Capabilities and ResourceType parameters can be specified.
Only one of the Capabilities and ResourceType parameters can
+ * be specified.
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.
+ *The Amazon Resource Name (ARN) of an 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.
* @public */ RoleARN?: string; /** - *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.
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.
Default: ROLLBACK
*
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in
- * the CloudFormation User Guide. You can specify either the StackPolicyBody or the
- * StackPolicyURL parameter, but not both.
Structure containing the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide.
+ * You can specify either the StackPolicyBody or the StackPolicyURL
+ * parameter, but not both.
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. The location for an Amazon S3 bucket must start with https://.
- * You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not
- * both.
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. The location for an Amazon S3
+ * bucket must start with https://. You can specify either the
+ * StackPolicyBody or the StackPolicyURL parameter, but not
+ * both.
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.
+ *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.
* @public */ Tags?: Tag[]; /** - *A unique identifier for this CreateStack request. Specify this 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 CloudFormation successfully received them.
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 have
- * ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are
- * initiated from the console use the token format Console-StackOperation-ID, which helps you
- * easily identify the stack operation . For example, if you create a stack using the console, each stack event would be
- * assigned the same token in the following format:
- * Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this CreateStack request. Specify this 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
+ * CloudFormation successfully received them.
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 have
+ * ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack
+ * operations that are initiated from the console use the token format
+ * Console-StackOperation-ID, which helps you easily identify the stack
+ * operation . For example, if you create a stack using the console, each stack event would be
+ * assigned the same token in the following format:
+ * Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Whether to enable termination protection on 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 in the CloudFormation User Guide. Termination protection is deactivated on stacks - * by default.
- *For nested - * stacks, termination protection is set on the root stack and can't be changed directly on the nested - * stack.
+ *Whether to enable termination protection on 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 Protect CloudFormation + * stacks from being deleted in the CloudFormation User Guide. Termination + * protection is deactivated on stacks by default.
+ *For nested stacks, + * termination protection is set on the root stack and can't be changed directly on the nested + * stack.
* @public */ EnableTerminationProtection?: boolean; /** - *When set to true, newly created resources are deleted when the operation rolls back. This includes
- * newly created resources marked with a deletion policy of Retain.
When set to true, newly created resources are deleted when the operation
+ * rolls back. This includes newly created resources marked with a deletion policy of
+ * Retain.
Default: false
*
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
+ * For more information about maximum concurrent accounts and failure tolerance, see Stack set operation
* options. The name or unique ID of the stack set that you want to create stack instances from. The name or unique ID of the stack set that you want to create stack instances
+ * from. [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 [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 [Service-managed permissions] The Organizations accounts for which to create stack instances in the
- * specified Amazon Web Services Regions. You can specify [Service-managed permissions] The Organizations accounts for which to create stack
+ * instances in the specified Amazon Web Services Regions. You can specify The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified
- * Amazon Web Services accounts. The names of one or more Amazon Web Services Regions where you want to create stack instances using the
+ * specified Amazon Web Services accounts. 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 Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values
- * during stack instance operations: 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 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 override the current value for a parameter, include the parameter and specify its
+ * value. To leave an overridden parameter set to its present value, include the parameter and specify
- * To leave an overridden parameter set to its present value, include the parameter and
+ * specify 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 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, don't specify this property at all. 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 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 to update the stack set
- * template. During stack set updates, any parameter values overridden for a 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 UpdateStackSet
+ * to update the stack set template. The unique identifier for this stack set operation. The operation ID also functions as an idempotency token, to ensure 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. Repeating this stack set operation with a new operation ID retries all stack instances whose status is
- * The operation ID also functions as an idempotency token, to ensure 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. Repeating this stack set operation with a new operation ID retries all stack instances
+ * whose status is [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, [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, If you are signed in to the management account, specify If you are signed in to the management account, specify
+ * If you are signed in to a delegated administrator account, specify Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated
- * administrator in the CloudFormation User Guide. If you are signed in to a delegated administrator account, specify
+ * Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a
+ * delegated administrator in the CloudFormation User Guide. The name to associate with the stack set. The name must be unique in the Region where you create your stack
- * set. The name to associate with the stack set. The name must be unique in the Region where you
+ * create your stack set. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an
- * alphabetic character and can't be longer than 128 characters. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It
+ * must start with an alphabetic character and can't be longer than 128 characters. A description of the stack set. You can use the description to identify the stack set's purpose or other
- * important information. A description of the stack set. You can use the description to identify the stack set's
+ * purpose or other important information. 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 in the
- * CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both. The structure that contains the template body, with a minimum length of 1 byte and a
+ * maximum length of 51,200 bytes. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
+ * not both. 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 or a Systems Manager document. For more information, see
- * Template Anatomy
- * in the CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both. 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 or a Systems Manager
+ * document. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
+ * not both. The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack. The stack ID you are importing into a new stack set. Specify the Amazon Resource Name
+ * (ARN) of the stack. In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in
- * order for CloudFormation to create the stack set and related stack instances. In some cases, you must explicitly acknowledge that your stack set template contains
+ * certain capabilities in order for CloudFormation to create the stack set and related stack
+ * instances.
* Some stack templates might include resources that can affect 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 Some stack templates might include resources that can affect permissions in your
+ * Amazon Web Services account; for example, by creating new 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
+ * If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify
- * If you have IAM resources with custom names, you must
+ * specify If you don't specify either of these capabilities, CloudFormation returns an
- * Accounts or DeploymentTargets, but not both.Accounts or DeploymentTargets, but not
+ * both.Accounts or DeploymentTargets, but not both.Accounts or DeploymentTargets, but not
+ * both.
*
- * UsePreviousValue as true. (You can't specify both a value and set
- * UsePreviousValue to true.)UsePreviousValue as true. (You can't specify both a
+ * value and set UsePreviousValue to true.)OUTDATED.OUTDATED.SELF is specified. Use SELF for stack sets with self-managed
- * permissions.SELF is specified. Use SELF for stack sets with
+ * self-managed permissions.
*
* @public
@@ -3057,44 +3164,45 @@ export type PermissionModels = (typeof PermissionModels)[keyof typeof Permission
*/
export interface CreateStackSetInput {
/**
- * SELF.SELF.DELEGATED_ADMIN.DELEGATED_ADMIN.
*
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
* CAPABILITY_IAM or
- * CAPABILITY_NAMED_IAM capability.CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
*
CAPABILITY_NAMED_IAM.CAPABILITY_NAMED_IAM.InsufficientCapabilities error.InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with - * them and edit their permissions if necessary.
+ *If your stack template contains these resources, we recommend that you review all + * permissions associated with them and edit their permissions if necessary.
*- * AWS::IAM::AccessKey + * AWS::IAM::AccessKey *
*- * AWS::IAM::Group + * AWS::IAM::Group *
*- * AWS::IAM::Policy + * AWS::IAM::Policy *
*- * AWS::IAM::User + * AWS::IAM::User *
*- * AWS::IAM::UserToGroupAddition + * AWS::IAM::UserToGroupAddition *
*For more information, see Acknowledging IAM Resources in - * CloudFormation Templates.
+ *For more information, see Acknowledging IAM resources in CloudFormation templates.
* *
* CAPABILITY_AUTO_EXPAND
*
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.
+ *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.
*Stack sets with service-managed permissions don't currently support the use of macros in templates. (This - * includes the AWS::Include and AWS::Serverless 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.
+ *Stack sets with service-managed permissions don't currently support the use of + * macros in templates. (This includes the AWS::Include and AWS::Serverless 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.
*The key-value pairs to associate with this stack set and the stacks 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, 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.
The key-value pairs to associate with this stack set and the stacks 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, 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.
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 in the CloudFormation User Guide.
+ *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 in the + * CloudFormation User Guide.
* @public */ AdministrationRoleARN?: string; /** - *The name of the IAM execution role to use to create the stack set. If you do not specify an execution role,
- * CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which stack resources users - * and groups can include in their stack sets.
+ *The name of the IAM execution role to use to create the stack set. If you do not specify
+ * an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole
+ * role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which + * stack resources users and groups can include in their stack sets.
* @public */ ExecutionRoleName?: string; /** *Describes how the IAM roles required for stack set operations are created. By default,
- * SELF-MANAGED is specified.
SELF-MANAGED is specified.
* With self-managed permissions, you must create the administrator and execution roles required to
- * deploy to target accounts. For more information, see Grant Self-Managed Stack Set
- * Permissions.
With self-managed permissions, you must create the administrator and
+ * execution roles required to deploy to target accounts. For more information, see Grant
+ * Self-Managed Stack Set Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to
- * deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set
- * Permissions.
With service-managed permissions, StackSets automatically creates the
+ * IAM roles required to deploy to accounts managed by Organizations. For more
+ * information, see Grant
+ * Service-Managed Stack Set Permissions.
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.
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.
[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.
[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 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 in the CloudFormation User Guide.
+ *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 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.
+ *Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated + * administrators.
* @public */ CallAs?: CallAs; /** - *A unique identifier for this CreateStackSet request. Specify this 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 automatically.
+ *A unique identifier for this CreateStackSet request. Specify this 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 + * automatically.
* @public */ ClientRequestToken?: string; /** - *Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting - * operations.
+ *Describes whether StackSets performs non-conflicting operations concurrently and queues + * conflicting operations.
* @public */ ManagedExecution?: ManagedExecution; @@ -3338,23 +3453,26 @@ export interface DeactivateOrganizationsAccessOutput {} */ export interface DeactivateTypeInput { /** - *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.
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.
The extension type.
- *Conditional: You must specify either Arn, or TypeName and Type.
Conditional: You must specify either Arn, or TypeName and
+ * Type.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
- *Conditional: You must specify either Arn, or TypeName and Type.
Conditional: You must specify either Arn, or TypeName and
+ * Type.
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.
+ *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.
* @public */ StackName?: string; @@ -3472,37 +3590,41 @@ export interface DeleteStackInput { StackName: string | undefined; /** - *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, CloudFormation deletes the stack but doesn't delete the retained
- * resources.
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.
+ *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, CloudFormation deletes the
+ * stack but doesn't delete the retained resources.
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.
* @public */ RetainResources?: string[]; /** - *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.
+ *The Amazon Resource Name (ARN) of an 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.
* @public */ RoleARN?: string; /** - *A unique identifier for this DeleteStack request. Specify this 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 CloudFormation successfully received them.
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 have
- * ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are
- * initiated from the console use the token format Console-StackOperation-ID, which helps you
- * easily identify the stack operation . For example, if you create a stack using the console, each stack event would be
- * assigned the same token in the following format:
- * Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this DeleteStack request. Specify this 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
+ * CloudFormation successfully received them.
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 have
+ * ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack
+ * operations that are initiated from the console use the token format
+ * Console-StackOperation-ID, which helps you easily identify the stack
+ * operation . For example, if you create a stack using the console, each stack event would be
+ * assigned the same token in the following format:
+ * Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
- * STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this
- * parameter.
STANDARD - Use the standard behavior. Specifying this value is the same
+ * as not specifying this parameter.
*
- * FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to
- * resource deletion failure.
FORCE_DELETE_STACK - Delete the stack if it's stuck in a
+ * DELETE_FAILED state due to resource deletion failure.
* [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.
[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.
[Service-managed permissions] The Organizations accounts from which to delete stack instances.
- *You can specify Accounts or DeploymentTargets, but not both.
[Service-managed permissions] The Organizations accounts from which to delete + * stack instances.
+ *You can specify Accounts or DeploymentTargets, but not
+ * both.
Removes 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.
- *For more information, see Stack set operation - * options.
+ *Removes 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.
+ *For more information, see Stack set operation options.
* @public */ RetainStacks: boolean | undefined; /** *The unique identifier for this stack set operation.
- *If you don't specify an operation ID, the SDK generates one automatically.
- *The operation ID also functions as an idempotency token, to ensure 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.
If you don't specify an operation ID, the SDK generates one + * automatically.
+ *The operation ID also functions as an idempotency token, to ensure 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.
[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.
+ *The name or unique ID of the stack set that you're deleting. You can obtain this value by + * running ListStackSets.
* @public */ StackSetName: string | undefined; /** - *[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*The Amazon Resource Name (ARN) of the extension.
- *Conditional: You must specify either TypeName and Type, or Arn.
Conditional: You must specify either TypeName and Type, or
+ * Arn.
The kind of extension.
- *Conditional: You must specify either TypeName and Type, or Arn.
Conditional: You must specify either TypeName and Type, or
+ * Arn.
The name of the extension.
- *Conditional: You must specify either TypeName and Type, or Arn.
Conditional: You must specify either TypeName and Type, or
+ * Arn.
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.
+ *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.
* @public */ VersionId?: string; @@ -3744,14 +3881,15 @@ export interface DescribeAccountLimitsInput { */ export interface DescribeAccountLimitsOutput { /** - *An account limit structure that contain a list of CloudFormation account limits and their values.
+ *An account limit structure that contain a list of CloudFormation account limits and their + * values.
* @public */ AccountLimits?: AccountLimit[]; /** - *If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page - * exists, this value is null.
+ *If the output exceeds 1 MB in size, a string that identifies the next page of limits. If + * no additional page exists, this value is null.
* @public */ NextToken?: string; @@ -3769,21 +3907,22 @@ export interface DescribeChangeSetInput { ChangeSetName: string | undefined; /** - *If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to - * describe.
+ *If you specified the name of a change set, specify the stack name or ID (ARN) of the + * change set you want to describe.
* @public */ StackName?: string; /** - *A string (provided by the DescribeChangeSet response output) that identifies the next page of - * information that you want to retrieve.
+ *A string (provided by the DescribeChangeSet response output) that + * identifies the next page of information that you want to retrieve.
* @public */ NextToken?: string; /** - *If true, the returned changes include detailed changes in the property values.
If true, the returned changes include detailed changes in the property
+ * values.
A list of Parameter structures that describes the input parameters and their values used to create
- * the change set. For more information, see the Parameter data type.
A list of Parameter structures that describes the input parameters and their
+ * values used to create the change set. For more information, see the Parameter data type.
If the change set execution status is AVAILABLE, you can execute 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 CloudFormation is still creating it or in an OBSOLETE state because the stack was already
- * updated.
If the change set execution status is AVAILABLE, you can execute 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 CloudFormation is still creating it or in an
+ * OBSOLETE state because the stack was already updated.
The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
- * FAILED.
The current status of the change set, such as CREATE_IN_PROGRESS,
+ * CREATE_COMPLETE, or FAILED.
A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
+ *A description of the change set's status. For example, if your attempt to create a change + * set failed, CloudFormation shows the error message.
* @public */ StatusReason?: string; /** - *The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you - * execute the change set.
+ *The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the + * change set.
* @public */ NotificationARNs?: string[]; /** - *The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified - * monitoring period afterwards.
+ *The rollback triggers for CloudFormation to monitor during stack creation and updating + * operations, and for the specified monitoring period afterwards.
* @public */ RollbackConfiguration?: RollbackConfiguration; /** - *If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set - * was created.
+ *If you execute the change set, the list of capabilities that were explicitly acknowledged + * when the change set was created.
* @public */ Capabilities?: Capability[]; @@ -3887,15 +4027,15 @@ export interface DescribeChangeSetOutput { Tags?: Tag[]; /** - *A list of Change structures that describes the resources CloudFormation changes if you execute the change
- * set.
A list of Change structures that describes the resources CloudFormation changes
+ * if you execute the change set.
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, - * this value is null.
+ *If the output exceeds 1 MB, a string that identifies the next page of changes. If there is + * no additional page, this value is null.
* @public */ NextToken?: string; @@ -3907,39 +4047,41 @@ export interface DescribeChangeSetOutput { IncludeNestedStacks?: boolean; /** - *Specifies the change set ID of the parent change set in the current nested change set hierarchy.
+ *Specifies the change set ID of the parent change set in the current nested change set + * hierarchy.
* @public */ ParentChangeSetId?: string; /** - *Specifies the change set ID of the root change set in the current nested change set hierarchy.
+ *Specifies the change set ID of the root change set in the current nested change set + * hierarchy.
* @public */ RootChangeSetId?: string; /** - *Determines what action will be taken if stack creation fails. When this parameter is specified, the
- * DisableRollback parameter to the ExecuteChangeSet API operation must
- * not be specified. This must be one of these values:
Determines what action will be taken if stack creation fails. When this parameter is
+ * specified, the DisableRollback parameter to the ExecuteChangeSet 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.
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 API
- * operation.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent
+ * to specifying true for the DisableRollback parameter to the
+ * ExecuteChangeSet 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 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 API operation.
* Indicates if the change set imports resources that already exist.
*This parameter can only import resources that have custom names in templates. To import - * resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.
+ *This parameter can only import resources that have custom names in + * templates. To import resources that do not accept custom names, such as EC2 instances, use + * the resource import + * feature instead.
*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.
+ *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.
* @public */ StackName?: string; /** - *A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of
- * information that you want to retrieve.
A string, provided by the DescribeChangeSetHooks response output, that
+ * identifies the next page of information that you want to retrieve.
If specified, lists only the hooks related to the specified LogicalResourceId.
If specified, lists only the hooks related to the specified
+ * LogicalResourceId.
The path of the property. For example, if this is for the S3Bucket member of the Code
- * property, the property path would be Code/S3Bucket.
The path of the property. For example, if this is for the S3Bucket member of
+ * the Code property, the property path would be Code/S3Bucket.
The type of this warning. For more information, see IaC generator and write-only - * properties in the CloudFormation User Guide.
+ *The type of this warning. For more information, see Resolve + * write-only properties in the CloudFormation User Guide.
*
- * MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive write-only properties.
- * The IaC generator selects one set of mutually exclusive properties and converts the included properties into
- * parameters. The parameter names have a suffix OneOf and the parameter descriptions indicate that the
- * corresponding property can be replaced with other exclusive properties.
MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive
+ * write-only properties. The IaC generator selects one set of mutually exclusive properties and
+ * converts the included properties into parameters. The parameter names have a suffix
+ * OneOf and the parameter descriptions indicate that the corresponding property can
+ * be replaced with other exclusive properties.
*
- * UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource. One example of
- * unsupported properties would be a required write-only property that is an array, because a parameter cannot be an
- * array. Another example is an optional write-only property.
UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource.
+ * One example of unsupported properties would be a required write-only property that is an array,
+ * because a parameter cannot be an array. Another example is an optional write-only
+ * property.
*
- * MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are found in the resource,
- * and the type of that property can be any of several types.
MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are
+ * found in the resource, and the type of that property can be any of several types.
* Currently the resource and property reference documentation does not indicate if a property uses a type of
- * oneOf or anyOf. You need to look at the resource provider schema.
Currently the resource and property reference documentation does not indicate if a property
+ * uses a type of oneOf or anyOf. You need to look at the resource
+ * provider schema.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see
- * IaC
- * generator supported resource types In the CloudFormation User Guide
+ *
The type of the resource, such as AWS::DynamoDB::Table. For the list of
+ * supported resources, see Resource type
+ * support for imports and drift detection In the
+ * CloudFormation User Guide
*
A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name
- * of one of the primary identifiers for the resource. (Primary identifiers are specified in the
- * primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For
- * example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the
- * key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension
- * development.
A list of up to 256 key-value pairs that identifies the resource in the generated template.
+ * The key is the name of one of the primary identifiers for the resource. (Primary identifiers are
+ * specified in the primaryIdentifier list in the resource schema.) The value is the
+ * value of that primary identifier. For example, for a AWS::DynamoDB::Table resource,
+ * the primary identifiers is TableName so the key-value pair could be
+ * "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
Status of the processing of a resource in a generated template.
*The resource processing is still in progress.
*The resource processing is complete.
*The resource processing is pending.
*The resource processing has failed.
*The Amazon Resource Name (ARN) of the generated template. The format is
- * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}. For example,
- * arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
+ * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}.
+ * For example,
+ * arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
* .
A list of objects describing the details of the resources in the template generation.
+ *A list of objects describing the details of the resources in the template + * generation.
* @public */ Resources?: ResourceDetail[]; @@ -4330,8 +4497,8 @@ export interface DescribeGeneratedTemplateOutput { Status?: GeneratedTemplateStatus; /** - *The reason for the current template generation status. This will provide more details if a failure - * happened.
+ *The reason for the current template generation status. This will provide more details if a + * failure happened.
* @public */ StatusReason?: string; @@ -4355,21 +4522,22 @@ export interface DescribeGeneratedTemplateOutput { Progress?: TemplateProgress; /** - *The stack ARN of the base stack if a base stack was provided when generating the template.
+ *The stack ARN of the base stack if a base stack was provided when generating the + * template.
* @public */ StackId?: string; /** - *The configuration details of the generated template, including the DeletionPolicy and
- * UpdateReplacePolicy.
The configuration details of the generated template, including the
+ * DeletionPolicy and UpdateReplacePolicy.
The number of warnings generated for this template. The warnings are found in the details of each of the - * resources in the template.
+ *The number of warnings generated for this template. The warnings are found in the details + * of each of the resources in the template.
* @public */ TotalWarnings?: number; @@ -4380,17 +4548,20 @@ export interface DescribeGeneratedTemplateOutput { */ export interface DescribeOrganizationsAccessInput { /** - *[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.
+ *[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*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.
If you don't supply a PublisherId, and you have registered as an extension
+ * publisher, DescribePublisher returns information about your own publisher
+ * account.
Whether the publisher is verified. Currently, all registered publishers are verified.
+ *Whether the publisher is verified. Currently, all registered publishers are + * verified.
* @public */ PublisherStatus?: PublisherStatus; /** - *The type of account used as the identity provider when registering this publisher with CloudFormation.
+ *The type of account used as the identity provider when registering this publisher with + * CloudFormation.
* @public */ IdentityProvider?: IdentityProvider; @@ -4528,8 +4702,9 @@ export type ResourceScanStatus = (typeof ResourceScanStatus)[keyof typeof Resour export interface DescribeResourceScanOutput { /** *The Amazon Resource Name (ARN) of the resource scan. The format is
- * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}. An example is
- * arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772
+ * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}. An
+ * example is
+ * arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772
* .
Status of the resource scan.
*The resource scan is still in progress.
*The resource scan is complete.
*The resource scan has expired.
*The resource scan has failed.
*The reason for the resource scan status, providing more information if a failure happened.
+ *The reason for the resource scan status, providing more information if a failure + * happened.
* @public */ StatusReason?: string; @@ -4584,24 +4776,27 @@ export interface DescribeResourceScanOutput { PercentageCompleted?: number; /** - *The list of resource types for the specified scan. Resource types are only available for scans with a
- * Status set to COMPLETE or FAILED .
The list of resource types for the specified scan. Resource types are only available for
+ * scans with a Status set to COMPLETE or FAILED .
The number of resources that were listed. This is only available for scans with a Status set to
- * COMPLETE, EXPIRED, or FAILED .
The number of resources that were listed. This is only available for scans with a
+ * Status set to COMPLETE, EXPIRED, or FAILED
+ * .
The number of resources that were read. This is only available for scans with a Status set to
- * COMPLETE, EXPIRED, or FAILED .
The number of resources that were read. This is only available for scans with a
+ * Status set to COMPLETE, EXPIRED, or FAILED
+ * .
This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.
This field may be 0 if the resource scan failed with a
+ * ResourceScanLimitExceededException.
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.
+ *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.
* @public */ StackDriftDetectionId: string | undefined; @@ -4686,8 +4882,9 @@ export interface DescribeStackDriftDetectionStatusOutput { /** *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 reports 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.
* @public */ StackDriftDetectionId: string | undefined; @@ -4697,17 +4894,18 @@ export interface DescribeStackDriftDetectionStatusOutput { *
- * 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.
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: CloudFormation hasn't 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 template configuration.
IN_SYNC: The stack's actual configuration matches its expected template
+ * configuration.
* @@ -4723,20 +4921,23 @@ export interface DescribeStackDriftDetectionStatusOutput { *
- * DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all
- * resources in the stack that support drift detection. (Resources that don't currently support stack detection remain
- * unchecked.)
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_COMPLETE: The stack drift detection operation has successfully
+ * completed for all resources in the stack that support drift detection. (Resources that
+ * don't currently support stack detection remain unchecked.)
+ * 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 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 currently in progress.
DETECTION_IN_PROGRESS: The stack drift detection operation is currently
+ * in progress.
* Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a
- * status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is
- * IN_SYNC.
Total number of stack resources that have drifted. This is NULL until the drift detection
+ * operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks
+ * whose drift status is IN_SYNC.
The name or the unique stack ID that's associated with the stack, which aren't 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.
@@ -4891,8 +5093,8 @@ export interface StackEvent { PhysicalResourceId?: string; /** - *Type of resource. (For more information, go to Amazon Web Services Resource Types - * Reference in the CloudFormation User Guide.)
+ *Type of resource. For more information, see Amazon Web Services resource and + * property types reference in the CloudFormation User Guide.
* @public */ ResourceType?: string; @@ -4923,15 +5125,16 @@ export interface StackEvent { /** *The token passed to the operation that generated this event.
- *All events triggered 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 have
- * ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are - * initiated from the console use the token format Console-StackOperation-ID, which helps you - * easily identify the stack operation . For example, if you create a stack using the console, each stack event would be + *
All events triggered 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 have ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack
+ * operations that are initiated from the console use the token format
+ * Console-StackOperation-ID, which helps you easily identify the stack
+ * operation . For example, if you create a stack using the console, each stack event would be
* assigned the same token in the following format:
- * Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
* @public
*/
ClientRequestToken?: string;
@@ -4977,20 +5180,22 @@ export interface StackEvent {
HookFailureMode?: HookFailureMode;
/**
- * An optional field containing information about the detailed status of the stack event.
+ *An optional field containing information about the detailed status of the stack + * event.
*
- * CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more
- * information, see CloudFormation stack deployment
- * in the CloudFormation User Guide.
CONFIGURATION_COMPLETE - all of the resources in the stack have reached that
+ * event. For more information, see Understand
+ * CloudFormation stack creation events in the CloudFormation User Guide.
*
- * VALIDATION_FAILED - template validation failed because of invalid properties in the template. The
- * ResourceStatusReason field shows what properties are defined incorrectly.
VALIDATION_FAILED - template validation failed because of invalid properties
+ * in the template. The ResourceStatusReason field shows what properties are defined
+ * incorrectly.
* If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page - * exists, this value is null.
+ *If the output exceeds 1 MB in size, a string that identifies the next page of events. If + * no additional page exists, this value is null.
* @public */ NextToken?: string; @@ -5022,7 +5227,8 @@ export interface DescribeStackEventsOutput { */ export interface DescribeStackInstanceInput { /** - *The name or the unique stack ID of the stack set that you want to get stack instance information for.
+ *The name or the unique stack ID of the stack set that you want to get stack instance + * information for.
* @public */ StackSetName: string | undefined; @@ -5040,18 +5246,21 @@ export interface DescribeStackInstanceInput { StackInstanceRegion: string | undefined; /** - *[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a + *
A 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, in addition to the ID of the @@ -5330,7 +5539,8 @@ export class StackInstanceNotFoundException extends __BaseException { */ export interface DescribeStackResourceInput { /** - *
The name or the unique stack ID that's associated with the stack, which aren't 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.
@@ -5370,7 +5580,7 @@ export type StackResourceDriftStatus = (typeof StackResourceDriftStatus)[keyof t /** *Contains information about whether the resource's actual configuration differs, or has - * drifted, from its expected configuration.
+ * drifted, from its expected configuration. * @public */ export interface StackResourceDriftInformation { @@ -5379,7 +5589,8 @@ export interface StackResourceDriftInformation { *
- * 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.
* @@ -5387,15 +5598,16 @@ export interface StackResourceDriftInformation { *
- * 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.
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 Resource
+ * type support for imports and drift detection.
- * IN_SYNC: The resource's actual configuration matches its expected configuration.
IN_SYNC: The resource's actual configuration matches its expected
+ * configuration.
* When 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.
* @public */ LastCheckTimestamp?: Date; @@ -5433,14 +5646,15 @@ export interface StackResourceDetail { LogicalResourceId: string | undefined; /** - *The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
+ *The name or unique identifier that corresponds to a physical instance ID of a resource + * supported by CloudFormation.
* @public */ PhysicalResourceId?: string; /** - *Type of resource. For more information, go to Amazon Web Services Resource Types - * Reference in the CloudFormation User Guide.
+ *Type of resource. For more information, see Amazon Web Services resource and + * property types reference in the CloudFormation User Guide.
* @public */ ResourceType: string | undefined; @@ -5470,23 +5684,25 @@ export interface StackResourceDetail { Description?: string; /** - *The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute
+ *
The content of the Metadata attribute declared for the resource. For more
+ * information, see Metadata attribute
* in the CloudFormation User Guide.
Information about whether the resource'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.
+ *Information about whether the resource'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 Detect + * unmanaged configuration changes to stacks and resources with drift detection.
* @public */ DriftInformation?: StackResourceDriftInformation; /** - *Contains information about the module from which the resource was created, if the resource was created from a - * module included in the stack template.
+ *Contains information about the module from which the resource was created, if the resource + * was created from a module included in the stack template.
* @public */ ModuleInfo?: ModuleInfo; @@ -5498,8 +5714,8 @@ export interface StackResourceDetail { */ export interface DescribeStackResourceOutput { /** - *A StackResourceDetail structure containing the description of the specified resource in the
- * specified stack.
A StackResourceDetail structure containing the description of the specified
+ * resource in the specified stack.
The resource drift status values to use as filters for the resource drift results returned.
+ *The resource drift status values to use as filters for the resource drift results + * returned.
*
- * DELETED: The resource differs from its expected template configuration in that the resource has
- * been deleted.
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 expected template values.
MODIFIED: One or more resource properties differ from their expected
+ * template values.
*
- * IN_SYNC: The resource's actual configuration matches its expected template configuration.
IN_SYNC: The resource's actual configuration matches its expected
+ * template configuration.
* @@ -5547,18 +5766,20 @@ export interface DescribeStackResourceDriftsInput { NextToken?: string; /** - *
The maximum number of results to be returned with a single call. If the number of available results exceeds this
- * maximum, the response includes a NextToken value that you can assign to the NextToken
- * request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of
+ * available results exceeds this maximum, the response includes a NextToken value
+ * that you can assign to the NextToken request parameter to get the next set of
+ * results.
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.
+ *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.
* @public */ export interface PhysicalResourceIdContextKeyValuePair { @@ -5591,10 +5812,11 @@ export const DifferenceType = { export type DifferenceType = (typeof DifferenceType)[keyof typeof DifferenceType]; /** - *Information about a resource property whose actual value differs from its expected value, as defined in the
- * stack template and any values specified as template parameters. These will be present only for resources whose
- * StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to
- * Stacks and Resources.
Information about a resource property whose actual value differs from its expected value, as
+ * defined in the stack template and any values specified as template parameters. These will be
+ * present only for resources whose StackResourceDriftStatus is MODIFIED.
+ * For more information, see Detect unmanaged
+ * configuration changes to stacks and resources with drift detection.
The expected property value of the resource property, as defined in the stack template and any values specified - * as template parameters.
+ *The expected property value of the resource property, as defined in the stack template and + * any values specified as template parameters.
* @public */ ExpectedValue: string | undefined; @@ -5622,16 +5844,18 @@ export interface PropertyDifference { *
- * ADD: A value has been added to a resource property that's an array or list data type.
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 configuration.
REMOVE: The property has been removed from the current resource
+ * configuration.
*
- * NOT_EQUAL: The current property value differs from its expected value (as defined in the stack
- * template and any values specified as template parameters).
NOT_EQUAL: The current property value differs from its expected value (as
+ * defined in the stack template and any values specified as template parameters).
* Contains the drift information for a resource that has been checked for drift. This includes actual and expected - * property values for 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.
- *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.
- *Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
+ *Contains the drift information for a resource that has been checked for drift. This includes + * actual and expected property values for resources in which CloudFormation has detected drift. Only + * resource properties explicitly defined in the stack template are checked for drift. For more + * information, see Detect unmanaged + * configuration changes to stacks and resources with drift detection.
+ *Resources that don't currently support drift detection can't be checked. For a list of + * resources that support drift detection, see Resource type + * support for imports and drift detection.
+ *Use DetectStackResourceDrift to detect drift on individual resources, or + * DetectStackDrift to detect drift on all resources in a given stack that + * support drift detection.
* @public */ export interface StackResourceDrift { @@ -5664,16 +5891,17 @@ export interface StackResourceDrift { LogicalResourceId: string | undefined; /** - *The name or unique identifier that corresponds to a physical instance ID of a resource supported by - * CloudFormation.
+ *The name or unique identifier that corresponds to a physical instance ID of a resource + * supported by CloudFormation.
* @public */ PhysicalResourceId?: string; /** - *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.
+ *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.
* @public */ PhysicalResourceIdContext?: PhysicalResourceIdContextKeyValuePair[]; @@ -5685,26 +5913,26 @@ export interface StackResourceDrift { ResourceType: string | undefined; /** - *A JSON structure containing the expected property values of the stack resource, as defined in the stack template - * and any values specified as template parameters.
- *For resources whose StackResourceDriftStatus is DELETED, this structure will not be
- * present.
A JSON structure containing the expected property values of the stack resource, as defined + * in the stack template and any values specified as template parameters.
+ *For resources whose StackResourceDriftStatus is DELETED, this
+ * structure will not be present.
A JSON structure containing the actual property values of the stack resource.
- *For resources whose StackResourceDriftStatus is DELETED, this structure will not be
- * present.
For resources whose StackResourceDriftStatus is DELETED, this
+ * structure will not be present.
A collection of the resource properties whose actual values differ from their expected values. These will be
- * present only for resources whose StackResourceDriftStatus is
- * MODIFIED.
A collection of the resource properties whose actual values differ from their expected
+ * values. These will be present only for resources whose StackResourceDriftStatus is
+ * MODIFIED.
- * DELETED: The resource differs from its expected template configuration because the resource has
- * been deleted.
DELETED: The resource differs from its expected template configuration
+ * because the resource has been deleted.
*
- * MODIFIED: One or more resource properties differ from their expected values (as defined in the
- * stack template and any values specified as template parameters).
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 resource's actual configuration matches its expected template configuration.
IN_SYNC: The resource's actual configuration matches its expected template
+ * configuration.
* @@ -5742,8 +5971,8 @@ export interface StackResourceDrift { Timestamp: Date | undefined; /** - *
Contains information about the module from which the resource was created, if the resource was created from a - * module included in the stack template.
+ *Contains information about the module from which the resource was created, if the resource + * was created from a module included in the stack template.
* @public */ ModuleInfo?: ModuleInfo; @@ -5754,21 +5983,23 @@ export interface StackResourceDrift { */ export interface DescribeStackResourceDriftsOutput { /** - *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 CloudFormation detects drift.
- *For a given stack, there will be one StackResourceDrift for each 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.
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 CloudFormation + * detects drift.
+ *For a given stack, there will be one StackResourceDrift for each 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 Resource
+ * type support for imports and drift detection.
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 all results, NextToken is set to
- * null.
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 all results, NextToken is set to null.
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
+ *The name or the unique stack ID that is associated with the stack, which aren't always + * interchangeable:
*Running stacks: You can specify either the stack's name or its unique stack ID.
@@ -5791,7 +6023,7 @@ export interface DescribeStackResourcesInput { *Default: There is no default value.
*Required: Conditional. If you don't specify StackName, you must specify
- * PhysicalResourceId.
PhysicalResourceId.
* @public
*/
StackName?: string;
@@ -5804,12 +6036,14 @@ export interface DescribeStackResourcesInput {
LogicalResourceId?: string;
/**
- * The name or unique identifier that corresponds to a physical 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 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 don't specify PhysicalResourceId, you must specify
- * StackName.
The name or unique identifier that corresponds to a physical 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 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 don't specify PhysicalResourceId, you must
+ * specify StackName.
Default: There is no default value.
* @public */ @@ -5840,14 +6074,15 @@ export interface StackResource { LogicalResourceId: string | undefined; /** - *The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
+ *The name or unique identifier that corresponds to a physical instance ID of a resource + * supported by CloudFormation.
* @public */ PhysicalResourceId?: string; /** - *Type of resource. For more information, go to Amazon Web Services Resource Types - * Reference in the CloudFormation User Guide.
+ *Type of resource. For more information, see Amazon Web Services resource and + * property types reference in the CloudFormation User Guide.
* @public */ ResourceType: string | undefined; @@ -5877,16 +6112,17 @@ export interface StackResource { Description?: string; /** - *Information about whether the resource'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.
+ *Information about whether the resource'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 Detect + * unmanaged configuration changes to stacks and resources with drift detection.
* @public */ DriftInformation?: StackResourceDriftInformation; /** - *Contains information about the module from which the resource was created, if the resource was created from a - * module included in the stack template.
+ *Contains information about the module from which the resource was created, if the resource + * was created from a module included in the stack template.
* @public */ ModuleInfo?: ModuleInfo; @@ -5911,17 +6147,20 @@ export interface DescribeStackResourcesOutput { export interface DescribeStacksInput { /** *If you don't pass a parameter to StackName, the API returns a response that describes all
- * resources in the account, which can impact performance. This requires ListStacks and
- * DescribeStacks permissions.
If you don't pass a parameter to StackName, the API returns a response
+ * that describes all resources in the account, which can impact performance. This requires
+ * ListStacks and DescribeStacks permissions.
Consider using the ListStacks API if you're not passing a parameter to
- * StackName.
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/*\/*" \}] \}
+ *StackName.
+ * 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/*\/*" \}] + * \}
*The name or the unique stack ID that's associated with the stack, which aren't 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.
@@ -5944,28 +6183,30 @@ export interface DescribeStacksInput { /** *Contains information about whether the 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.
+ * 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. * @public */ export interface StackDriftInformation { /** - *Status of the stack's actual configuration compared to its expected template configuration.
+ *Status of the stack's actual configuration compared to its expected template + * configuration.
*
- * 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.
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: CloudFormation hasn't 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 template configuration.
IN_SYNC: The stack's actual configuration matches its expected template
+ * configuration.
* @@ -5977,8 +6218,8 @@ export interface StackDriftInformation { StackDriftStatus: StackDriftStatus | undefined; /** - *
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources - * that support drift detection.
+ *Most recent time when a drift detection operation was initiated on the stack, or any of its + * individual resources that support drift detection.
* @public */ LastCheckTimestamp?: Date; @@ -6097,15 +6338,15 @@ export interface Stack { DeletionTime?: Date; /** - *The time the stack was last updated. This field will only be returned if the stack has been updated at least - * once.
+ *The time the stack was last updated. This field will only be returned if the stack has been + * updated at least once.
* @public */ LastUpdatedTime?: Date; /** - *The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified - * monitoring period afterwards.
+ *The rollback triggers for CloudFormation to monitor during stack creation and updating + * operations, and for the specified monitoring period afterwards.
* @public */ RollbackConfiguration?: RollbackConfiguration; @@ -6163,8 +6404,8 @@ export interface Stack { Outputs?: Output[]; /** - *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.
+ *The Amazon Resource Name (ARN) of an IAM role that's associated with the stack. During a + * stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
* @public */ RoleARN?: string; @@ -6177,43 +6418,46 @@ export interface Stack { /** *Whether termination protection is enabled for the stack.
- *For nested - * stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. - * For more information, see Protecting a Stack From Being Deleted - * in the CloudFormation User Guide.
+ *For nested stacks, + * termination protection is set on the root stack and can't be changed directly on the nested + * stack. For more information, see Protect a CloudFormation + * stack from being deleted in the CloudFormation User Guide.
* @public */ EnableTerminationProtection?: boolean; /** - *For nested stacks--stacks created as resources for another stack--the 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 in the - * CloudFormation User Guide.
+ *For nested stacks--stacks created as resources for another stack--the 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 Embed stacks within other + * stacks using nested stacks in the CloudFormation User Guide.
* @public */ ParentId?: string; /** - *For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which - * the nested stack ultimately belongs.
- *For more information, see Working with Nested Stacks in the - * CloudFormation User Guide.
+ *For nested stacks--stacks created as resources for another stack--the stack ID of the + * top-level stack to which the nested stack ultimately belongs.
+ *For more information, see Embed stacks within other + * stacks using nested stacks in the CloudFormation User Guide.
* @public */ RootId?: string; /** - *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.
+ *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 Detect + * unmanaged configuration changes to stacks and resources with drift detection.
* @public */ DriftInformation?: StackDriftInformation; /** - *When set to true, newly created resources are deleted when the operation rolls back. This includes
- * newly created resources marked with a deletion policy of Retain.
When set to true, newly created resources are deleted when the operation rolls
+ * back. This includes newly created resources marked with a deletion policy of
+ * Retain.
Default: false
*
- * STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this
- * parameter.
STANDARD - Use the standard behavior. Specifying this value is the same as
+ * not specifying this parameter.
*
- * FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to
- * resource deletion failure.
FORCE_DELETE_STACK - Delete the stack if it's stuck in a
+ * DELETE_FAILED state due to resource deletion failure.
* The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or
- * resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets
- * CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more
- * information, see CloudFormation stack deployment in
- * the CloudFormation User Guide.
The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is
+ * present, the resource or resource configuration phase has completed and the stabilization of the
+ * resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the
+ * resources in the stack have reached that event. For more information, see Understand
+ * CloudFormation stack creation events in the CloudFormation User Guide.
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page - * exists, this value is null.
+ *If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If + * no additional page exists, this value is null.
* @public */ NextToken?: string; @@ -6279,18 +6523,21 @@ export interface DescribeStackSetInput { StackSetName: string | undefined; /** - *[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*The capabilities that are allowed in the stack set. Some stack set templates might include resources that can - * affect permissions in 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. - *
+ * affect permissions in 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. * @public */ Capabilities?: Capability[]; @@ -6630,18 +6876,21 @@ export interface DescribeStackSetOperationInput { OperationId: string | undefined; /** - *[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*
* 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
+ * operations, the operation is queued to be performed. For more information, see the stack set operation status
* codes in the CloudFormation User Guide.
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 in + *
For more information, see Detect stack set drift in * the CloudFormation User Guide.
* @public */ @@ -6854,30 +7103,34 @@ export interface DescribeStackSetOperationOutput { export interface DescribeTypeInput { /** *The kind of extension.
- *Conditional: You must specify either TypeName and Type, or Arn.
Conditional: You must specify either TypeName and Type, or
+ * Arn.
The name of the extension.
- *Conditional: You must specify either TypeName and Type, or Arn.
Conditional: You must specify either TypeName and Type, or
+ * Arn.
The Amazon Resource Name (ARN) of the extension.
- *Conditional: You must specify either TypeName and Type, or Arn.
Conditional: You must specify either TypeName and Type, or
+ * Arn.
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
- * extension version. Otherwise, it returns information about the default extension version.
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 extension version. Otherwise, it returns information about the default
+ * extension version.
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 in the CloudFormation User Guide.
+ *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 Requirements for activating third-party public modules in the + * CloudFormation User Guide.
* @public */ export interface RequiredActivatedType { /** - *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.
+ *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.
* @public */ TypeNameAlias?: string; /** *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 in the CloudFormation User Guide.
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 Use
+ * aliases to refer to extensions in the CloudFormation User Guide.
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.
+ *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.
* @public */ TypeName?: string; /** - *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.
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.
To set the default version of an extension, use SetTypeDefaultVersion.
* @public */ @@ -7030,25 +7285,26 @@ export interface DescribeTypeOutput { /** *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.
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.
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.
+ *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 in the CloudFormation Command Line Interface User
- * Guide.
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 in the
+ * CloudFormation Command Line Interface (CLI) User Guide.
@@ -7056,11 +7312,13 @@ export interface DescribeTypeOutput { *
- * IN_PROGRESS: Contract tests are currently being performed on the extension.
IN_PROGRESS: Contract tests are currently being performed on the
+ * extension.
*
- * NOT_TESTED: Contract tests haven't been performed on the extension.
NOT_TESTED: Contract tests haven't been performed on the
+ * extension.
* 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.
+ *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.
* @public */ TypeTestsStatusDescription?: string; @@ -7084,31 +7342,32 @@ export interface DescribeTypeOutput { /** *The schema that defines the extension.
- *For more information about extension schemas, see Resource Provider Schema in the - * CloudFormation CLI User Guide.
+ *For more information about extension schemas, see Resource type + * schema in the CloudFormation Command Line Interface (CLI) User Guide.
* @public */ Schema?: string; /** - *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.
+ *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 resource 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 resource type doesn't include an update handler, so the type can't 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 resource type doesn't include all the following handlers, and therefore
- * can't actually be provisioned.
NON_PROVISIONABLE: The resource type doesn't include all the following
+ * handlers, and therefore can't actually be provisioned.
* create
@@ -7132,13 +7391,13 @@ export interface DescribeTypeOutput { *
- * LIVE: The extension is activated or 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 extension has been deactivated or deregistered and can no
+ * longer be used in CloudFormation operations.
* For public third-party extensions, CloudFormation returns null.
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.
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.
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.
+ *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.
* @public */ RequiredActivatedTypes?: RequiredActivatedType[]; /** - *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.
+ *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 - * that includes - * the necessary permissions to 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.
+ * IAM execution + * role + * that includes the necessary permissions to 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. * @public */ ExecutionRoleArn?: string; @@ -7179,13 +7441,14 @@ export interface DescribeTypeOutput { *
- * PRIVATE: The extension is only visible and usable within the account in which it is registered.
- * CloudFormation marks any extensions 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 extension is publicly visible and usable within any Amazon Web Services
- * account.
When the specified extension version was registered. This applies only to:
*Private extensions you have registered in your account. For more information, see RegisterType.
+ *Private extensions you have registered in your account. For more information, see + * RegisterType.
*Public extensions you have activated in your account with auto-update specified. For more information, see - * ActivateType.
+ *Public extensions you have activated in your account with auto-update specified. For + * more information, see ActivateType.
*When the specified private extension version was registered or activated in your account.
+ *When the specified private extension version was registered or activated in your + * account.
* @public */ TimeCreated?: Date; /** - *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. For more - * information, see Configuring extensions at - * the account level in the CloudFormation User Guide.
+ *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. For more information, see Edit configuration + * data for extensions in your account in the + * CloudFormation User Guide.
* @public */ ConfigurationSchema?: string; /** *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.
This applies only to public third-party extensions. For private registered extensions, and
+ * extensions provided by Amazon Web Services, CloudFormation returns null.
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 in the CloudFormation User Guide.
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 Use aliases to refer to extensions in the
+ * CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of - * the public extension.
+ *For public extensions that have been activated for this account and Region, the Amazon + * Resource Name (ARN) of the public extension.
* @public */ OriginalTypeArn?: string; /** *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.
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.
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.
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.
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.
This only applies to public third-party extensions. For all other extensions, CloudFormation
+ * returns null.
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 in the CloudFormation User Guide.
+ *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 Automatically use new versions of extensions in the + * CloudFormation User Guide.
* @public */ AutoUpdate?: boolean; @@ -7299,7 +7568,8 @@ export interface DescribeTypeOutput { export interface DescribeTypeRegistrationInput { /** *The identifier for this registration request.
- *This registration token is generated by CloudFormation when you initiate a registration request using RegisterType.
+ *This registration token is generated by CloudFormation when you initiate a registration + * request using RegisterType.
* @public */ RegistrationToken: string | undefined; @@ -7338,16 +7608,17 @@ export interface DescribeTypeRegistrationOutput { /** *The Amazon Resource Name (ARN) of the extension being registered.
- *For registration requests with a ProgressStatus of other than COMPLETE, this will be
- * null.
For registration requests with a ProgressStatus of other than
+ * COMPLETE, this will be null.
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.
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.
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.
+ *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.
* @public */ StackDriftDetectionId: string | undefined; @@ -7405,8 +7677,9 @@ export interface DetectStackResourceDriftInput { */ export interface DetectStackResourceDriftOutput { /** - *Information about whether the resource's actual configuration has drifted from its expected template - * configuration, including actual and expected property values and any differences detected.
+ *Information about whether the resource's actual configuration has drifted from its + * expected template configuration, including actual and expected property values and any + * differences detected.
* @public */ StackResourceDrift: StackResourceDrift | undefined; @@ -7424,8 +7697,7 @@ export interface DetectStackSetDriftInput { /** *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.
+ *For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
* @public */ OperationPreferences?: StackSetOperationPreferences; @@ -7439,18 +7711,21 @@ export interface DetectStackSetDriftInput { OperationId?: string; /** - *[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*The ID of the drift detection stack set operation.
- *You can use this operation ID with DescribeStackSetOperation to monitor the progress of the - * drift detection operation.
+ *You can use this operation ID with DescribeStackSetOperation to monitor + * the progress of the drift detection operation.
* @public */ OperationId?: string; @@ -7477,20 +7752,20 @@ export interface DetectStackSetDriftOutput { */ export interface EstimateTemplateCostInput { /** - *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 in the - * CloudFormation User Guide.)
- *Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only
- * TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum + * length of 51,200 bytes.
+ *Conditional: You must pass TemplateBody or TemplateURL. If both
+ * are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the
- * CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only
- * TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's
+ * located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must
+ * start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both
+ * are passed, only TemplateBody is used.
An Amazon Web Services 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.
* @public */ Url?: string; @@ -7521,40 +7796,43 @@ export interface EstimateTemplateCostOutput { */ export interface ExecuteChangeSetInput { /** - *The name or Amazon Resource Name (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.
* @public */ ChangeSetName: string | undefined; /** - *If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's - * associated with the change set you want to execute.
+ *If you specified the name of a change set, specify the stack name or Amazon Resource Name + * (ARN) that's associated with the change set you want to execute.
* @public */ StackName?: string; /** - *A unique identifier for this ExecuteChangeSet request. Specify 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 CloudFormation successfully received them.
A unique identifier for this ExecuteChangeSet request. Specify 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 CloudFormation successfully received them.
Preserves the state of previously provisioned resources when an operation fails. This parameter can't be
- * specified when the OnStackFailure parameter to the CreateChangeSet API operation was
- * specified.
Preserves the state of previously provisioned resources when an operation fails. This
+ * parameter can't be specified when the OnStackFailure parameter to the CreateChangeSet 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 API operation.
True - if the stack creation fails, do nothing. This is equivalent to
+ * specifying DO_NOTHING for the OnStackFailure parameter to the
+ * CreateChangeSet 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 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 API operation.
* Default: True
@@ -7564,8 +7842,9 @@ export interface ExecuteChangeSetInput {
DisableRollback?: boolean;
/**
- *
When set to true, newly created resources are deleted when the operation rolls back. This includes
- * newly created resources marked with a deletion policy of Retain.
When set to true, newly created resources are deleted when the operation
+ * rolls back. This includes newly created resources marked with a deletion policy of
+ * Retain.
Default: false
*
The name or Amazon Resource Name (ARN) of the generated template. The format is
- * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}. For example,
- * arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
+ * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}.
+ * For example,
+ * arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
* .
The template body of the generated template, in the language specified by the Language
- * parameter.
The template body of the generated template, in the language specified by the
+ * Language parameter.
The name or unique stack ID that's associated with the stack whose policy you want to get.
+ *The name or unique stack ID that's associated with the stack whose policy you want to + * get.
* @public */ StackName: string | undefined; @@ -7695,8 +7976,8 @@ export interface GetStackPolicyInput { */ export interface GetStackPolicyOutput { /** - *Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in - * the CloudFormation User Guide.)
+ *Structure containing the stack policy body. (For more information, see Prevent updates to stack resources in the + * CloudFormation User Guide.)
* @public */ StackPolicyBody?: string; @@ -7722,7 +8003,8 @@ export type TemplateStage = (typeof TemplateStage)[keyof typeof TemplateStage]; */ export interface GetTemplateInput { /** - *The name or the unique stack ID that's associated with the stack, which aren't 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.
@@ -7737,18 +8019,20 @@ export interface GetTemplateInput { StackName?: string; /** - *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.
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.
For templates that include transforms, the stage of the template 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, CloudFormation specifies Processed.
For templates that include transforms, the stage of the template 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, CloudFormation specifies
+ * Processed.
Structure containing the template body. (For more information, go to Template Anatomy in the - * CloudFormation User Guide.)
+ *Structure containing the template body.
*CloudFormation returns the same template that was used when the stack was created.
* @public */ @@ -7769,9 +8052,9 @@ export interface GetTemplateOutput { /** *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 CloudFormation finishes creating the change set, the Processed template becomes
- * available.
Processed templates are always available. For change sets, the
+ * Original template is always available. After CloudFormation finishes creating the
+ * change set, the Processed template becomes available.
* @public
*/
StagesAvailable?: TemplateStage[];
@@ -7783,8 +8066,9 @@ export interface GetTemplateOutput {
*/
export interface TemplateSummaryConfig {
/**
- * If set to True, any unrecognized resource types generate warnings and not an error. Any
- * unrecognized resource types are returned in the Warnings output parameter.
If set to True, any unrecognized resource types generate warnings and not an
+ * error. Any unrecognized resource types are returned in the Warnings output
+ * parameter.
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 in the - * CloudFormation User Guide.
- *Conditional: You must specify only one of the following parameters: StackName,
- * StackSetName, TemplateBody, or TemplateURL.
Structure containing the template body with a minimum length of 1 byte and a maximum + * length of 51,200 bytes.
+ *Conditional: You must specify only one of the following parameters:
+ * StackName, StackSetName, TemplateBody, or
+ * TemplateURL.
Location of file containing the template body. The URL must point to 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
- * in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with
- * https://.
Conditional: You must specify only one of the following parameters: StackName,
- * StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size:
+ * 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location
+ * for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters:
+ * StackName, StackSetName, TemplateBody, or
+ * TemplateURL.
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.
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.
The name or unique ID of the stack set from which the stack was created.
- *Conditional: You must specify only one of the following parameters: StackName,
- * StackSetName, TemplateBody, or TemplateURL.
Conditional: You must specify only one of the following parameters:
+ * StackName, StackSetName, TemplateBody, or
+ * TemplateURL.
[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be defined in
- * the stack template, CloudFormation returns only the AllowedValues property.
A set of criteria that CloudFormation uses to validate parameter values. Although other
+ * constraints might be defined in the stack template, CloudFormation returns only the
+ * AllowedValues property.
Flag that indicates whether the parameter value is shown as plain text in logs and in the Amazon Web Services Management Console.
+ *Flag that indicates whether the parameter value is shown as plain text in logs and in the + * Amazon Web Services Management Console.
* @public */ NoEcho?: boolean; @@ -7917,28 +8207,30 @@ export interface ParameterDeclaration { } /** - *Describes the target resources of a specific type in your import template (for example, all
- * AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources of
- * that type.
Describes the target resources of a specific type in your import template (for example,
+ * all AWS::S3::Bucket resources) and the properties you can provide during the
+ * import to identify resources of that type.
The template resource type of the target resources, such as AWS::S3::Bucket.
The template resource type of the target resources, such as
+ * AWS::S3::Bucket.
The logical IDs of the target resources of the specified ResourceType, as defined in the import
- * template.
The logical IDs of the target resources of the specified ResourceType, as
+ * defined in the import template.
The resource properties you can provide during the import to identify your target resources. For example,
- * BucketName is a possible identifier property for AWS::S3::Bucket resources.
The resource properties you can provide during the import to identify your target
+ * resources. For example, BucketName is a possible identifier property for
+ * AWS::S3::Bucket resources.
A list of all of the unrecognized resource types. This is only returned if the
- * TemplateSummaryConfig parameter has the TreatUnrecognizedResourceTypesAsWarning
- * configuration set to True.
TemplateSummaryConfig parameter has the
+ * TreatUnrecognizedResourceTypesAsWarning configuration set to
+ * True.
* @public
*/
UnrecognizedResourceTypes?: string[];
@@ -7964,7 +8257,8 @@ export interface Warnings {
*/
export interface GetTemplateSummaryOutput {
/**
- * A list of parameter declarations that describe various properties for each parameter.
+ *A list of parameter declarations that describe various properties for each + * parameter.
* @public */ Parameters?: ParameterDeclaration[]; @@ -7976,30 +8270,34 @@ export interface GetTemplateSummaryOutput { Description?: string; /** - *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 CreateStack or UpdateStack actions with your template; otherwise, those actions return
- * an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in - * CloudFormation Templates.
+ *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 CreateStack or UpdateStack
+ * actions with your template; otherwise, those actions return an
+ * InsufficientCapabilities error.
For more information, see Acknowledging IAM resources in CloudFormation templates.
* @public */ Capabilities?: Capability[]; /** - *The list of resources that generated the values in the Capabilities response element.
The list of resources that generated the values in the Capabilities response
+ * element.
A list of all the template resource types that are defined in the template, such as
- * AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
AWS::EC2::Instance, AWS::Dynamo::Table, and
+ * Custom::MyCustomInstance.
* @public
*/
ResourceTypes?: string[];
/**
- * The Amazon Web Services template format version, which identifies the capabilities of the template.
+ *The Amazon Web Services template format version, which identifies the capabilities of the + * template.
* @public */ Version?: string; @@ -8017,9 +8315,10 @@ export interface GetTemplateSummaryOutput { DeclaredTransforms?: string[]; /** - *A list of resource identifier summaries that describe the target resources of an import operation and the
- * properties you can provide during the import to identify the target resources. For example, BucketName
- * is a possible identifier property for an AWS::S3::Bucket resource.
A list of resource identifier summaries that describe the target resources of an import
+ * operation and the properties you can provide during the import to identify the target
+ * resources. For example, BucketName is a possible identifier property for an
+ * AWS::S3::Bucket resource.
The name of the stack set. The name must be unique in the Region where you create your stack set.
+ *The name of the stack set. The name must be unique in the Region where you create your + * stack set.
* @public */ StackSetName: string | undefined; /** - *The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a - * time.
+ *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.
The list of OU ID's to which the stacks being imported has to be mapped as deployment target.
+ *The list of OU ID's to which the stacks being imported has to be mapped as deployment + * target.
* @public */ OrganizationalUnitIds?: string[]; /** *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.
+ *For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
* @public */ OperationPreferences?: StackSetOperationPreferences; @@ -8077,11 +8377,12 @@ export interface ImportStacksToStackSetInput { OperationId?: string; /** - *By default, SELF is specified. Use SELF for stack sets with self-managed
- * permissions.
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 the management account, specify
+ * SELF.
For service managed stack sets, specify DELEGATED_ADMIN.
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
+ *The name or the Amazon Resource Name (ARN) of the stack for which you want to list change + * sets.
* @public */ StackName: string | undefined; /** - *A string (provided by the ListChangeSets response output) that identifies the next page of - * change sets that you want to retrieve.
+ *A string (provided by the ListChangeSets response output) that + * identifies the next page of change sets that you want to retrieve.
* @public */ NextToken?: string; @@ -8150,15 +8452,15 @@ export interface ListChangeSetsInput { */ export interface ListChangeSetsOutput { /** - *A list of ChangeSetSummary structures that provides the ID and status of each change set for the
- * specified stack.
A list of ChangeSetSummary structures that provides the ID and status of each
+ * change set for the specified stack.
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.
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.
A string (provided by the ListExports response output) that identifies the next page of - * exported output values that you asked to retrieve.
+ *A string (provided by the ListExports response output) that identifies + * the next page of exported output values that you asked to retrieve.
* @public */ NextToken?: string; @@ -8188,16 +8490,16 @@ export interface Export { ExportingStackId?: string; /** - *The name of exported output value. Use this name and the Fn::ImportValue function to import the
- * associated value into other stacks. The name is defined in the Export field in the associated stack's
- * Outputs section.
The name of exported output value. Use this name and the Fn::ImportValue
+ * function to import the associated value into other stacks. The name is defined in the
+ * Export field in the associated stack's Outputs section.
The value of the exported output, such as a resource physical ID. This value is defined in the
- * Export field in the associated stack's Outputs section.
The value of the exported output, such as a resource physical ID. This value is defined in
+ * the Export field in the associated stack's Outputs section.
If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is - * no additional page, this value is null.
+ *If the output exceeds 100 exported output values, a string that identifies the next page + * of exports. If there is no additional page, this value is null.
* @public */ NextToken?: string; @@ -8232,10 +8534,10 @@ export interface ListGeneratedTemplatesInput { NextToken?: string; /** - * If the number of available results exceeds this maximum, the response includes a NextToken value
- * that you can use for the NextToken parameter to get the next set of results. By default the
- * ListGeneratedTemplates API action will return at most 50 results in each response. The maximum value is
- * 100.
If the number of available results exceeds this maximum, the response includes a
+ * NextToken value that you can use for the NextToken parameter to
+ * get the next set of results. By default the ListGeneratedTemplates API action
+ * will return at most 50 results in each response. The maximum value is 100.
The Amazon Resource Name (ARN) of the generated template. The format is
- * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}. For example,
- * arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
+ * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}. For
+ * example,
+ * arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
* .
The reason for the current template generation status. This will provide more details if a failure - * happened.
+ *The reason for the current template generation status. This will provide more details if a + * failure happened.
* @public */ StatusReason?: string; @@ -8321,8 +8624,8 @@ export interface TemplateSummary { LastUpdatedTime?: Date; /** - *The number of resources in the generated template. This is a total of resources in pending, in-progress, - * completed, and failed states.
+ *The number of resources in the generated template. This is a total of resources in pending, + * in-progress, completed, and failed states.
* @public */ NumberOfResources?: number; @@ -8339,10 +8642,10 @@ export interface ListGeneratedTemplatesOutput { Summaries?: TemplateSummary[]; /** - *If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve
- * the next set of results, call ListGeneratedTemplates again and use that value for the
- * NextToken parameter. If the request returns all results, NextToken is set to an empty
- * string.
If the request doesn't return all the remaining results, NextToken is set to
+ * a token. To retrieve the next set of results, call ListGeneratedTemplates again
+ * and use that value for the NextToken parameter. If the request returns all
+ * results, NextToken is set to an empty string.
The name of the exported output value. 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.
* @public */ ExportName: string | undefined; /** - *A string (provided by the ListImports response output) that identifies the next page of stacks - * that are importing the specified exported output value.
+ *A string (provided by the ListImports response output) that identifies + * the next page of stacks that are importing the specified exported output value.
* @public */ NextToken?: string; @@ -8377,33 +8681,35 @@ export interface ListImportsOutput { Imports?: string[]; /** - *A string that identifies the next page of exports. If there is no additional page, this value is null.
+ *A string that identifies the next page of exports. If there is no additional page, this + * value is null.
* @public */ NextToken?: string; } /** - *Identifies a scanned resource. This is used with the ListResourceScanRelatedResources API
- * action.
Identifies a scanned resource. This is used with the
+ * ListResourceScanRelatedResources API action.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see
- * IaC
- * generator supported resource types In the CloudFormation User Guide.
The type of the resource, such as AWS::DynamoDB::Table. For the list of
+ * supported resources, see Resource type
+ * support for imports and drift detection In the
+ * CloudFormation User Guide.
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the
- * primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list
- * in the resource schema.) The value is the value of that primary identifier. For example, for a
- * AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair
- * could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension
- * development.
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the
+ * name of one of the primary identifiers for the resource. (Primary identifiers are specified in
+ * the primaryIdentifier list in the resource schema.) The value is the value of that
+ * primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary
+ * identifiers is TableName so the key-value pair could be "TableName":
+ * "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
The list of resources for which you want to get the related resources. Up to 100 resources can be - * provided.
+ *The list of resources for which you want to get the related resources. Up to 100 resources + * can be provided.
* @public */ Resources: ScannedResourceIdentifier[] | undefined; @@ -8433,10 +8739,10 @@ export interface ListResourceScanRelatedResourcesInput { NextToken?: string; /** - * If the number of available results exceeds this maximum, the response includes a NextToken value
- * that you can use for the NextToken parameter to get the next set of results. By default the
- * ListResourceScanRelatedResources API action will return up to 100 results in each response. The maximum
- * value is 100.
If the number of available results exceeds this maximum, the response includes a
+ * NextToken value that you can use for the NextToken parameter to
+ * get the next set of results. By default the ListResourceScanRelatedResources API
+ * action will return up to 100 results in each response. The maximum value is 100.
A scanned resource returned by ListResourceScanResources or
- * ListResourceScanRelatedResources.
ListResourceScanRelatedResources.
* @public
*/
export interface ScannedResource {
/**
- * The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see
- * Resource type support In the CloudFormation User Guide
+ *
The type of the resource, such as AWS::DynamoDB::Table. For the list of
+ * supported resources, see Resource type
+ * support for imports and drift detection In the
+ * CloudFormation User Guide
*
A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the name of one of the
- * primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list
- * in the resource schema.) The value is the value of that primary identifier. For example, for a
- * AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair
- * could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension
- * development.
A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the
+ * name of one of the primary identifiers for the resource. (Primary identifiers are specified in
+ * the primaryIdentifier list in the resource schema.) The value is the value of that
+ * primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary
+ * identifiers is TableName so the key-value pair could be "TableName":
+ * "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
List of up to MaxResults resources in the specified resource scan related to the specified
- * resources.
List of up to MaxResults resources in the specified resource scan related to
+ * the specified resources.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve
- * the next set of results, call ListResourceScanRelatedResources again and use that value for the
- * NextToken parameter. If the request returns all results, NextToken is set to an empty
- * string.
If the request doesn't return all the remaining results, NextToken is set to
+ * a token. To retrieve the next set of results, call
+ * ListResourceScanRelatedResources again and use that value for the
+ * NextToken parameter. If the request returns all results, NextToken
+ * is set to an empty string.
If specified, the returned resources will have the specified resource identifier (or one of them in the case - * where the resource has multiple identifiers).
+ *If specified, the returned resources will have the specified resource identifier (or one + * of them in the case where the resource has multiple identifiers).
* @public */ ResourceIdentifier?: string; /** - *If specified, the returned resources will be of any of the resource types with the specified prefix.
+ *If specified, the returned resources will be of any of the resource types with the + * specified prefix.
* @public */ ResourceTypePrefix?: string; @@ -8559,10 +8869,10 @@ export interface ListResourceScanResourcesInput { NextToken?: string; /** - * If the number of available results exceeds this maximum, the response includes a NextToken value
- * that you can use for the NextToken parameter to get the next set of results. By default the
- * ListResourceScanResources API action will return at most 100 results in each response. The maximum value
- * is 100.
If the number of available results exceeds this maximum, the response includes a
+ * NextToken value that you can use for the NextToken parameter to
+ * get the next set of results. By default the ListResourceScanResources API action
+ * will return at most 100 results in each response. The maximum value is 100.
List of up to MaxResults resources in the specified resource scan that match all of the specified
- * filters.
List of up to MaxResults resources in the specified resource scan that match
+ * all of the specified filters.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve
- * the next set of results, call ListResourceScanResources again and use that value for the
- * NextToken parameter. If the request returns all results, NextToken is set to an empty
- * string.
If the request doesn't return all the remaining results, NextToken is set to
+ * a token. To retrieve the next set of results, call ListResourceScanResources
+ * again and use that value for the NextToken parameter. If the request returns all
+ * results, NextToken is set to an empty string.
If the number of available results exceeds this maximum, the response includes a NextToken value
- * that you can use for the NextToken parameter to get the next set of results. The default value is 10.
- * The maximum value is 100.
If the number of available results exceeds this maximum, the response includes a
+ * NextToken value that you can use for the NextToken parameter to
+ * get the next set of results. The default value is 10. The maximum value is 100.
A summary of the resource scan. This is returned by the ListResourceScan API action.
A summary of the resource scan. This is returned by the ListResourceScan API
+ * action.
Status of the resource scan.
*The resource scan is still in progress.
*The resource scan is complete.
*The resource scan has expired.
*The resource scan has failed.
*The reason for the resource scan status, providing more information if a failure happened.
+ *The reason for the resource scan status, providing more information if a failure + * happened.
* @public */ StatusReason?: string; @@ -8679,9 +9007,10 @@ export interface ListResourceScansOutput { ResourceScanSummaries?: ResourceScanSummary[]; /** - *If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve
- * the next set of results, call ListResourceScans again and use that value for the NextToken
- * parameter. If the request returns all results, NextToken is set to an empty string.
If the request doesn't return all the remaining results, NextToken is set to
+ * a token. To retrieve the next set of results, call ListResourceScans again and
+ * use that value for the NextToken parameter. If the request returns all results,
+ * NextToken is set to an empty string.
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 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.
The maximum number of results to be returned with a single call. If the number of available results exceeds this
- * maximum, the response includes a NextToken value that you can assign to the NextToken
- * request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of
+ * available results exceeds this maximum, the response includes a NextToken value
+ * that you can assign to the NextToken request parameter to get the next set of
+ * results.
- * DELETED: The resource differs from its expected template configuration in that the resource has
- * been deleted.
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 expected template values.
MODIFIED: One or more resource properties differ from their expected
+ * template values.
*
- * IN_SYNC: The resource's actual configuration matches its expected template configuration.
IN_SYNC: The resource's actual configuration matches its expected
+ * template configuration.
* @@ -8758,18 +9091,21 @@ export interface ListStackInstanceResourceDriftsInput { OperationId: string | undefined; /** - *
[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*Type of resource. For more information, go to Amazon Web Services Resource Types - * Reference in the CloudFormation User Guide.
+ *Type of resource. For more information, see Amazon Web Services resource and + * property types reference in the CloudFormation User Guide.
* @public */ ResourceType: string | undefined; @@ -8859,17 +9195,18 @@ export interface StackInstanceResourceDriftsSummary { */ export interface ListStackInstanceResourceDriftsOutput { /** - *A list of StackInstanceResourceDriftsSummary structures that contain information about the
- * specified stack instances.
A list of StackInstanceResourceDriftsSummary structures that contain
+ * information about the specified stack instances.
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 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 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.
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.
The maximum number of results to be returned with a single call. If the number of available results exceeds this
- * maximum, the response includes a NextToken value that you can assign to the NextToken
- * request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of
+ * available results exceeds this maximum, the response includes a NextToken value
+ * that you can assign to the NextToken request parameter to get the next set of
+ * results.
[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*A list of StackInstanceSummary structures that contain information about the specified stack
- * instances.
A list of StackInstanceSummary structures that contain information about the
+ * specified stack instances.
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, NextToken is set to
- * null.
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, NextToken is set to null.
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
+ *The name or the unique stack ID that is associated with the stack, which aren't always + * interchangeable:
*Running stacks: You can specify either the stack's name or its unique stack ID.
@@ -9143,7 +9486,8 @@ export interface ListStackResourcesInput { StackName: string | undefined; /** - *A string that identifies the next page of stack resources that you want to retrieve.
+ *A string that identifies the next page of stack resources that you want to + * retrieve.
* @public */ NextToken?: string; @@ -9151,7 +9495,7 @@ export interface ListStackResourcesInput { /** *Summarizes information about whether the resource's actual configuration differs, or has - * drifted, from its expected configuration.
+ * drifted, from its expected configuration. * @public */ export interface StackResourceDriftInformationSummary { @@ -9160,7 +9504,8 @@ export interface StackResourceDriftInformationSummary { *
- * 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.
* @@ -9168,17 +9513,18 @@ export interface StackResourceDriftInformationSummary { *
- * NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.
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
- * about skipping resources during rollback operations, see Continue Rolling
- * Back an Update in the CloudFormation User Guide.
NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its
+ * expected configuration.
+ * Any resources that don't currently support drift detection have a status of
+ * NOT_CHECKED. For more information, see Resource
+ * type support for imports and 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 about skipping resources during rollback operations, see Continue rolling back an update in the CloudFormation User Guide.
- * IN_SYNC: The resource's actual configuration matches its expected configuration.
IN_SYNC: The resource's actual configuration matches its expected
+ * configuration.
* When 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.
* @public */ LastCheckTimestamp?: Date; @@ -9204,14 +9551,15 @@ export interface StackResourceSummary { LogicalResourceId: string | undefined; /** - *The name or unique identifier that corresponds to a physical instance ID of the resource.
+ *The name or unique identifier that corresponds to a physical instance ID of the + * resource.
* @public */ PhysicalResourceId?: string; /** - *Type of resource. (For more information, go to Amazon Web Services Resource Types - * Reference in the CloudFormation User Guide.)
+ *Type of resource. (For more information, see Amazon Web Services resource and + * property types reference in the CloudFormation User Guide.)
* @public */ ResourceType: string | undefined; @@ -9235,16 +9583,17 @@ export interface StackResourceSummary { ResourceStatusReason?: string; /** - *Information about whether the resource'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.
+ *Information about whether the resource'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 Detect + * unmanaged configuration changes to stacks and resources with drift detection.
* @public */ DriftInformation?: StackResourceDriftInformationSummary; /** - *Contains information about the module from which the resource was created, if the resource was created from a - * module included in the stack template.
+ *Contains information about the module from which the resource was created, if the resource + * was created from a module included in the stack template.
* @public */ ModuleInfo?: ModuleInfo; @@ -9262,8 +9611,8 @@ export interface ListStackResourcesOutput { StackResourceSummaries?: StackResourceSummary[]; /** - *If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page - * exists, this value is null.
+ *If the output exceeds 1 MB, a string that identifies the next page of stack resources. If + * no additional page exists, this value is null.
* @public */ NextToken?: string; @@ -9281,8 +9630,9 @@ export interface ListStacksInput { NextToken?: string; /** - *Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified
- * status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.
Stack status to use as a filter. Specify one or more stack status codes to list only
+ * stacks with the specified status codes. For a complete list of stack status codes, see the
+ * StackStatus parameter of the Stack data type.
Contains information about whether the 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.
+ * 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. * @public */ export interface StackDriftInformationSummary { /** - *Status of the stack's actual configuration compared to its expected template configuration.
+ *Status of the stack's actual configuration compared to its expected template + * configuration.
*
- * 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.
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: CloudFormation hasn't 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 template configuration.
IN_SYNC: The stack's actual configuration matches its expected template
+ * configuration.
* @@ -9323,8 +9675,8 @@ export interface StackDriftInformationSummary { StackDriftStatus: StackDriftStatus | undefined; /** - *
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources - * that support drift detection.
+ *Most recent time when a drift detection operation was initiated on the stack, or any of its + * individual resources that support drift detection.
* @public */ LastCheckTimestamp?: Date; @@ -9360,8 +9712,8 @@ export interface StackSummary { CreationTime: Date | undefined; /** - *The time the stack was last updated. This field will only be returned if the stack has been updated at least - * once.
+ *The time the stack was last updated. This field will only be returned if the stack has been + * updated at least once.
* @public */ LastUpdatedTime?: Date; @@ -9385,28 +9737,29 @@ export interface StackSummary { StackStatusReason?: string; /** - *For nested stacks--stacks created as resources for another stack--the 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 in the - * CloudFormation User Guide.
+ *For nested stacks--stacks created as resources for another stack--the 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 Embed stacks within other + * stacks using nested stacks in the CloudFormation User Guide.
* @public */ ParentId?: string; /** - *For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which - * the nested stack ultimately belongs.
- *For more information, see Working with Nested Stacks in the - * CloudFormation User Guide.
+ *For nested stacks--stacks created as resources for another stack--the stack ID of the + * top-level stack to which the nested stack ultimately belongs.
+ *For more information, see Embed stacks within other + * stacks using nested stacks in the CloudFormation User Guide.
* @public */ RootId?: string; /** *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.
+ * drifted, from its expected configuration, as defined in the stack template + * and any values specified as template parameters. For more information, see Detect + * unmanaged configuration changes to stacks and resources with drift detection. * @public */ DriftInformation?: StackDriftInformationSummary; @@ -9418,14 +9771,15 @@ export interface StackSummary { */ export interface ListStacksOutput { /** - *A list of StackSummary structures containing information about the specified stacks.
A list of StackSummary structures containing information about the specified
+ * stacks.
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page - * exists, this value is null.
+ *If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If + * no additional page exists, this value is null.
* @public */ NextToken?: string; @@ -9436,37 +9790,42 @@ export interface ListStacksOutput { */ export interface ListStackSetAutoDeploymentTargetsInput { /** - *The name or unique ID of the stack set that you want to get automatic deployment targets for.
+ *The name or unique ID of the stack set that you want to get automatic deployment targets + * for.
* @public */ StackSetName: string | undefined; /** - *A string that identifies the next page of stack set deployment targets that you want to retrieve.
+ *A string that identifies the next page of stack set deployment targets that you want to + * retrieve.
* @public */ NextToken?: string; /** - *The maximum number of results to be returned with a single call. If the number of available results exceeds this
- * maximum, the response includes a NextToken value that you can assign to the NextToken
- * request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of
+ * available results exceeds this maximum, the response includes a NextToken value
+ * that you can assign to the NextToken request parameter to get the next set of
+ * results.
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 StackSets with self-managed
- * permissions.
By default, SELF is specified. Use SELF for StackSets with
+ * self-managed permissions.
If you are signed in to the management account, specify SELF.
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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve
- * the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the NextToken parameter. If the
- * request returns all results, NextToken is set to an empty string.
If the request doesn't return all the remaining results, NextToken is set to
+ * a token. To retrieve the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the
+ * NextToken parameter. If the request returns all results, NextToken
+ * is set to an empty string.
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.
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 maximum number of results to be returned with a single call. If the number of available results exceeds this
- * maximum, the response includes a NextToken value that you can assign to the NextToken
- * request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of
+ * available results exceeds this maximum, the response includes a NextToken value
+ * that you can assign to the NextToken request parameter to get the next set of
+ * results.
[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*A list of StackSetOperationResultSummary structures that contain information about the specified
- * operation results, for accounts and Amazon Web Services Regions that are included in the operation.
A list of StackSetOperationResultSummary structures that contain information
+ * about the specified operation results, for accounts and Amazon Web Services Regions that are included in the
+ * operation.
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of
- * results, call ListOperationResults again and assign that token to the request object's
- * NextToken parameter. If there are no remaining results, NextToken is set to
- * null.
If the request doesn't return all results, NextToken is set to a token. To
+ * retrieve the next set of results, call ListOperationResults again and assign that
+ * token to the request object's NextToken parameter. If there are no remaining
+ * results, NextToken is set to null.
The name or unique ID of the stack set that you want to get operation summaries for.
+ *The name or unique ID of the stack set that you want to get operation summaries + * for.
* @public */ StackSetName: string | undefined; /** - *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
- * ListStackSetOperations 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 of the remaining results, the response
+ * object's NextToken parameter value is set to a token. To retrieve the next set of
+ * results, call ListStackSetOperations 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 maximum number of results to be returned with a single call. If the number of available results exceeds this
- * maximum, the response includes a NextToken value that you can assign to the NextToken
- * request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of
+ * available results exceeds this maximum, the response includes a NextToken value
+ * that you can assign to the NextToken request parameter to get the next set of
+ * results.
[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*
* 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
+ * operations, the operation is queued to be performed. For more information, see the stack set operation status
* codes in the CloudFormation User Guide.
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
+ * For more information about maximum concurrent accounts and failure tolerance, see Stack set operation
* options. A list of A list of If the request doesn't return all results, If the request doesn't return all results, If the previous paginated request didn't return all the remaining results, the response object's
- * If the previous paginated request didn't return all the remaining results, the response
+ * object's The maximum number of results to be returned with a single call. If the number of available results exceeds this
- * maximum, the response includes a The maximum number of results to be returned with a single call. If the number of
+ * available results exceeds this maximum, the response includes a [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, [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, If you are signed in to the management account, specify If you are signed in to the management account, specify
+ * If you are signed in to a delegated administrator account, specify Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated
- * administrator in the CloudFormation User Guide. If you are signed in to a delegated administrator account, specify
+ * Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a
+ * delegated administrator in the CloudFormation User Guide. A list of A list of If the request doesn't return all of the remaining results, If the request doesn't return all of the remaining results, The kind of extension. Conditional: You must specify either Conditional: You must specify either The name of the extension. Conditional: You must specify either Conditional: You must specify either The Amazon Resource Name (ARN) of the extension. Conditional: You must specify either Conditional: You must specify either The maximum number of results to be returned with a single call. If the number of available results exceeds this
- * maximum, the response includes a The maximum number of results to be returned with a single call. If the number of
+ * available results exceeds this maximum, the response includes a If the previous paginated request didn't return all the remaining results, the response object's
- * If the previous paginated request didn't return all the remaining results, the response
+ * object's 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. If the request doesn't return all the remaining results, If the request doesn't return all the remaining results,
- * StackSetOperationSummary structures that contain summary information about operations for
- * the specified stack set.StackSetOperationSummary structures that contain summary
+ * information about operations for the specified stack set.NextToken is set to a token. To retrieve the next set of
- * results, call ListOperationResults again and assign that token to the request object's
- * NextToken parameter. If there are no remaining results, NextToken is set to
- * null.NextToken is set to a token. To
+ * retrieve the next set of results, call ListOperationResults again and assign that
+ * token to the request object's NextToken parameter. If there are no remaining
+ * results, NextToken is set to null.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.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.NextToken value that you can assign to the NextToken
- * request parameter to get the next set of results.NextToken value
+ * that you can assign to the NextToken request parameter to get the next set of
+ * results.SELF is specified. Use SELF for stack sets with self-managed
- * permissions.SELF is specified. Use SELF for stack sets with
+ * self-managed permissions.
*
* @public
@@ -10026,16 +10402,17 @@ export interface StackSetSummary {
*/
export interface ListStackSetsOutput {
/**
- * SELF.SELF.DELEGATED_ADMIN.DELEGATED_ADMIN.StackSetSummary structures that contain information about the user's stack sets.StackSetSummary structures that contain information about the
+ * user's stack sets.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, NextToken is set to
- * null.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, NextToken is set to null.TypeName and Type, or Arn.TypeName and Type, or
+ * Arn.TypeName and Type, or Arn.TypeName and Type, or
+ * Arn.TypeName and Type, or Arn.TypeName and Type, or
+ * Arn.NextToken value that you can assign to the NextToken
- * request parameter to get the next set of results.NextToken value
+ * that you can assign to the NextToken request parameter to get the next set of
+ * results.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.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.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.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.
*
REGISTERED: Private extensions that have been registered for this account and Region.REGISTERED: Private extensions that have been registered for this account and
+ * Region.
- * ACTIVATED: Public extensions that have been activated 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:
THIRD_PARTY: Extensions available for use from publishers other than Amazon.
+ * This includes:
* Private extensions registered in the account.
@@ -10152,8 +10537,8 @@ export interface TypeFilters { /** *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.
Extensions published by Amazon aren't assigned a publisher ID. Use the
+ * AWS_TYPES category to specify a list of types published by Amazon.
- * PRIVATE: Extensions that are visible and usable within this account and Region. This
- * includes:
PRIVATE: Extensions that are visible and usable within this account and
+ * Region. This includes:
* Private extensions you have registered in this account and Region.
@@ -10188,7 +10573,9 @@ export interface ListTypesInput { *
- * 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.
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.
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.
+ *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 resource 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 resource type doesn't include an update handler, so the type can't 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 resource type doesn't include create, read, and delete handlers, and
- * therefore can't 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.
The deprecation status of the extension that you want to get summary information about.
+ *The deprecation status of the extension that you want to get summary information + * about.
*Valid values include:
*
- * LIVE: The extension is registered for use in CloudFormation operations.
LIVE: The extension is registered for use in CloudFormation
+ * operations.
*
- * DEPRECATED: The extension 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.
* 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.
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.
The maximum number of results to be returned with a single call. If the number of available results exceeds this
- * maximum, the response includes a NextToken value that you can assign to the NextToken
- * request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of
+ * available results exceeds this maximum, the response includes a NextToken value
+ * that you can assign to the NextToken request parameter to get the next set of
+ * results.
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.
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.
The name of the extension.
- *If you specified a TypeNameAlias when you call the ActivateType API operation in your account
- * and Region, CloudFormation considers that alias as the type name.
If you specified a TypeNameAlias when you call the ActivateType API
+ * operation in your account and Region, CloudFormation considers that alias as the type name.
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.
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.
To set the default version of an extension, use SetTypeDefaultVersion.
* @public */ @@ -10315,8 +10709,8 @@ export interface TypeSummary { *Private extensions you have registered in your account. For more information, see RegisterType.
*Public extensions you have activated in your account with auto-update specified. For more information, see - * ActivateType.
+ *Public extensions you have activated in your account with auto-update specified. For more + * information, see ActivateType.
*For all other extension types, CloudFormation returns null.
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.
+ *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.
* @public */ PublisherId?: string; /** - *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 in the CloudFormation User Guide.
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 Use
+ * aliases to refer to extensions in the CloudFormation User Guide.
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 in the
- * CloudFormation User Guide.
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 Automatically use new versions of extensions in the
+ * CloudFormation User Guide.
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 in the
- * CloudFormation User Guide.
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-party 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 Automatically use new versions of extensions in the
+ * CloudFormation User Guide.
The service used to verify the publisher identity.
- *For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.
+ *For more information, see Publishing extensions to make + * them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
* @public */ PublisherIdentity?: IdentityProvider; /** - *The publisher name, as defined in the public profile for that publisher in the service used to verify the - * publisher identity.
+ *The publisher name, as defined in the public profile for that publisher in the service used + * to verify the publisher identity.
* @public */ PublisherName?: string; /** *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.
+ *This applies only to third-party public extensions. Extensions published by Amazon are + * activated by default.
* @public */ IsActivated?: boolean; @@ -10396,15 +10794,17 @@ export interface TypeSummary { */ export interface ListTypesOutput { /** - *A list of TypeSummary structures that contain information about the specified extensions.
A list of TypeSummary structures that contain information about the specified
+ * extensions.
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.
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.
The kind of the extension.
- *Conditional: You must specify either TypeName and Type, or Arn.
Conditional: You must specify either TypeName and Type, or
+ * Arn.
The name of the extension for which you want version summary information.
- *Conditional: You must specify either TypeName and Type, or Arn.
Conditional: You must specify either TypeName and Type, or
+ * 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.
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.
The maximum number of results to be returned with a single call. If the number of available results exceeds this
- * maximum, the response includes a NextToken value that you can assign to the NextToken
- * request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of
+ * available results exceeds this maximum, the response includes a NextToken value
+ * that you can assign to the NextToken request parameter to get the next set of
+ * results.
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 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.
The deprecation status of the extension 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 extension version is registered and can be used in CloudFormation operations, dependent on
- * its provisioning behavior and visibility scope.
LIVE: The extension version is registered and can be used in CloudFormation
+ * operations, dependent on its provisioning behavior and visibility scope.
*
- * DEPRECATED: The extension 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.
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's 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's registered.
* @public */ VersionId?: string; /** *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.
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.
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 in the
- * CloudFormation User Guide.
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-party 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 Automatically use new versions of extensions in the
+ * CloudFormation User Guide.
A list of TypeVersionSummary structures that contain information about the specified extension's
- * versions.
A list of TypeVersionSummary structures that contain information about the
+ * specified extension's versions.
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 token to the request object's
- * NextToken parameter. If the request returns all results, NextToken is set to
- * null.
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 token
+ * to the request object's NextToken parameter. If the request returns all results,
+ * NextToken is set to null.
The type of the extension.
- *Conditional: You must specify Arn, or TypeName and Type.
Conditional: You must specify Arn, or TypeName and
+ * Type.
The Amazon Resource Name (ARN) of the extension.
- *Conditional: You must specify Arn, or TypeName and Type.
Conditional: You must specify Arn, or TypeName and
+ * Type.
The name of the extension.
- *Conditional: You must specify Arn, or TypeName and Type.
Conditional: You must specify Arn, or TypeName and
+ * Type.
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:
+ *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.
- *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.
For more information, see Semantic Versioning + * 2.0.0.
+ *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.
Reserved for use by the CloudFormation CLI.
+ *Reserved for use by the CloudFormation + * CLI.
* @public */ BearerToken: string | undefined; /** - *Reserved for use by the CloudFormation CLI.
+ *Reserved for use by the CloudFormation + * CLI.
* @public */ OperationStatus: OperationStatus | undefined; /** - *Reserved for use by the CloudFormation CLI.
+ *Reserved for use by the CloudFormation + * CLI.
* @public */ CurrentOperationStatus?: OperationStatus; /** - *Reserved for use by the CloudFormation CLI.
+ *Reserved for use by the CloudFormation + * CLI.
* @public */ StatusMessage?: string; /** - *Reserved for use by the CloudFormation CLI.
+ *Reserved for use by the CloudFormation + * CLI.
* @public */ ErrorCode?: HandlerErrorCode; /** - *Reserved for use by the CloudFormation CLI.
+ *Reserved for use by the CloudFormation + * CLI.
* @public */ ResourceModel?: string; /** - *Reserved for use by the CloudFormation CLI.
+ *Reserved for use by the CloudFormation + * CLI.
* @public */ ClientRequestToken?: string; @@ -10765,18 +11187,19 @@ export interface RecordHandlerProgressOutput {} */ export interface RegisterPublisherInput { /** - *Whether you accept the Terms and Conditions 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.
+ *Whether you accept the Terms and Conditions 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.
*The default is false.
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 in the CloudFormation CLI User Guide.
+ *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 Prerequisite: Registering your account to publish CloudFormation extensions in the + * CloudFormation Command Line Interface (CLI) User Guide.
* @public */ ConnectionArn?: string; @@ -10808,20 +11231,18 @@ export interface RegisterTypeInput { *We suggest that extension names adhere to the following patterns:
*For resource types, - * company_or_organization::service::type.
+ *For resource types, company_or_organization::service::type.
For modules, - * company_or_organization::service::type::MODULE.
+ *For modules, company_or_organization::service::type::MODULE.
For hooks, - * MyCompany::Testing::MyTestHook.
+ *For hooks, MyCompany::Testing::MyTestHook.
The following organization namespaces are reserved and can't be used in your extension names:
+ *The following organization namespaces are reserved and can't be used in your extension + * names:
*@@ -10860,15 +11281,16 @@ export interface RegisterTypeInput { TypeName: string | undefined; /** - *
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 about generating a schema handler package for the extension you want to register, see submit in the - * CloudFormation CLI User Guide.
+ *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 about generating a schema handler package for the extension you want to + * register, see submit in + * the CloudFormation Command Line Interface (CLI) User Guide.
*The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs - * to have GetObject permissions for - * the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 - * in the Identity and Access Management User Guide.
+ *The user registering the extension must be able to access the package in the S3 bucket. + * That's, the user needs to have GetObject permissions for the schema + * handler package. For more information, see Actions, Resources, and Condition Keys for + * Amazon S3 in the Identity and Access Management 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 principal (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 an - * IAM execution role - * that includes - * the necessary permissions to 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.
+ *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 principal
+ * (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 an + * + * IAM + * execution role + * that includes the necessary permissions to 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.
* @public */ ExecutionRoleArn?: string; /** - *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 an extension from the same registration request, - * even if the request is submitted multiple times.
+ *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 + * an extension from the same registration request, even if the request is submitted multiple + * times.
* @public */ ClientRequestToken?: string; @@ -10912,8 +11339,8 @@ export interface RegisterTypeInput { export interface RegisterTypeOutput { /** *The identifier for this registration request.
- *Use this registration token when calling DescribeTypeRegistration, which returns information - * about the status and IDs of the extension registration.
+ *Use this registration token when calling DescribeTypeRegistration, which + * returns information about the status and IDs of the extension registration.
* @public */ RegistrationToken?: string; @@ -10930,8 +11357,8 @@ export interface RollbackStackInput { StackName: string | undefined; /** - *The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the - * stack.
+ *The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the + * stack.
* @public */ RoleARN?: string; @@ -10943,8 +11370,9 @@ export interface RollbackStackInput { ClientRequestToken?: string; /** - *When set to true, newly created resources are deleted when the operation rolls back. This includes
- * newly created resources marked with a deletion policy of Retain.
When set to true, newly created resources are deleted when the operation
+ * rolls back. This includes newly created resources marked with a deletion policy of
+ * Retain.
Default: false
*
Structure containing the stack policy body. For more information, go to Prevent updates to stack resources in
- * the CloudFormation User Guide. You can specify either the StackPolicyBody or the
- * StackPolicyURL parameter, but not both.
Structure containing the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide.
+ * You can specify either the StackPolicyBody or the StackPolicyURL
+ * parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
- * an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for an Amazon S3 bucket must
- * start with https://. You can specify either the StackPolicyBody or the
- * StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum
+ * size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for
+ * an Amazon S3 bucket must start with https://. You can specify either the
+ * StackPolicyBody or the StackPolicyURL parameter, but not
+ * both.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
- *For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account - * and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation 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.
+ *For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this + * will be the ARN assigned when you call the RegisterType API + * operation 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.
* @public */ TypeArn?: string; /** *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. For more information, see
- * Defining
- * account-level configuration data for an extension in the CloudFormation CLI User
- * Guide.
The configuration data must be formatted as JSON, and validate against the schema returned
+ * in the ConfigurationSchema response element of DescribeType. For
+ * more information, see Defining the account-level configuration of an extension in the
+ * CloudFormation Command Line Interface (CLI) User Guide.
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.
+ *Conditional: Specifying a configuration alias is required when setting a configuration for + * a resource type extension.
* @public */ ConfigurationAlias?: string; @@ -57,7 +56,7 @@ export interface SetTypeConfigurationInput { /** *The name of the extension.
*Conditional: You must specify ConfigurationArn, or Type and
- * TypeName.
TypeName.
* @public
*/
TypeName?: string;
@@ -65,7 +64,7 @@ export interface SetTypeConfigurationInput {
/**
* The type of extension.
*Conditional: You must specify ConfigurationArn, or Type and
- * TypeName.
TypeName.
* @public
*/
Type?: ThirdPartyType;
@@ -76,9 +75,10 @@ export interface SetTypeConfigurationInput {
*/
export interface SetTypeConfigurationOutput {
/**
- * The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
+ *The Amazon Resource Name (ARN) for the configuration data, in this account and + * Region.
*Conditional: You must specify ConfigurationArn, or Type and
- * TypeName.
TypeName.
* @public
*/
ConfigurationArn?: string;
@@ -89,29 +89,33 @@ export interface SetTypeConfigurationOutput {
*/
export interface SetTypeDefaultVersionInput {
/**
- * 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.
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.
The kind of extension.
- *Conditional: You must specify either TypeName and Type, or Arn.
Conditional: You must specify either TypeName and Type, or
+ * Arn.
The name of the extension.
- *Conditional: You must specify either TypeName and Type, or Arn.
Conditional: You must specify either TypeName and Type, or
+ * Arn.
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.
+ *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.
* @public */ VersionId?: string; @@ -142,29 +146,31 @@ export type ResourceSignalStatus = (typeof ResourceSignalStatus)[keyof typeof Re */ export interface SignalResourceInput { /** - *The stack name or unique stack ID that includes the resource that you want to signal.
+ *The stack name or unique stack ID that includes the resource that you want to + * signal.
* @public */ StackName: string | undefined; /** - *The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in - * the template.
+ *The logical ID of the resource that you want to signal. The logical ID is the name of the + * resource that given in the template.
* @public */ LogicalResourceId: string | undefined; /** *A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the - * instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as - * signaling a wait condition), each signal requires a different unique ID.
+ * instance ID that you are signaling as the unique ID. If you send multiple signals to a single + * resource (such as signaling a wait condition), each signal requires a different unique + * ID. * @public */ UniqueId: string | undefined; /** - *The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately - * fail the stack creation or update.
+ *The status of the signal, which is either success or failure. A failure signal causes + * CloudFormation to immediately fail the stack creation or update.
* @public */ Status: ResourceSignalStatus | undefined; @@ -209,8 +215,9 @@ export class ResourceScanLimitExceededException extends __BaseException { */ export interface StartResourceScanInput { /** - *A unique identifier for this StartResourceScan request. Specify this token if you plan to retry
- * requests so that CloudFormation knows that you're not attempting to start a new resource scan.
A unique identifier for this StartResourceScan request. Specify this token if
+ * you plan to retry requests so that CloudFormation knows that you're not attempting to start a new
+ * resource scan.
The Amazon Resource Name (ARN) of the resource scan. The format is
- * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}. An example is
- * arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772
+ * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:resourceScan/$\{Id\}. An
+ * example is
+ * arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772
* .
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 in the CloudFormation User Guide.
+ * administrator in the CloudFormation User Guide. *The Amazon Resource Name (ARN) of the extension.
- *Conditional: You must specify Arn, or TypeName and Type.
Conditional: You must specify Arn, or TypeName and
+ * Type.
The type of the extension to test.
- *Conditional: You must specify Arn, or TypeName and Type.
Conditional: You must specify Arn, or TypeName and
+ * Type.
The name of the extension to test.
- *Conditional: You must specify Arn, or TypeName and Type.
Conditional: You must specify Arn, or TypeName and
+ * Type.
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.
+ *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.
* @public */ VersionId?: string; /** *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:
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:
@@ -324,7 +335,8 @@ export interface TestTypeInput { *
*For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
+ *For more information, see Actions, Resources, and + * Condition Keys for Amazon S3 in the Identity and Access Management User Guide.
* @public */ LogDeliveryBucket?: string; @@ -370,16 +382,17 @@ export interface UpdateGeneratedTemplateInput { RemoveResources?: string[]; /** - *If true, update the resource properties in the generated template with their current live state.
- * This feature is useful when the resource properties in your generated a template does not reflect the live state of
- * the resource properties. This happens when a user update the resource properties after generating a template.
If true, update the resource properties in the generated template with their
+ * current live state. This feature is useful when the resource properties in your generated a
+ * template does not reflect the live state of the resource properties. This happens when a user
+ * update the resource properties after generating a template.
The configuration details of the generated template, including the DeletionPolicy and
- * UpdateReplacePolicy.
The configuration details of the generated template, including the
+ * DeletionPolicy and UpdateReplacePolicy.
The Amazon Resource Name (ARN) of the generated template. The format is
- * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}. For example,
- * arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
+ * arn:$\{Partition\}:cloudformation:$\{Region\}:$\{Account\}:generatedtemplate/$\{Id\}.
+ * For example,
+ * arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
* .
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 in the - * CloudFormation User Guide.)
- *Conditional: You must specify only one of the following parameters: TemplateBody,
- * TemplateURL, or set the UsePreviousTemplate to true.
Structure containing the template body with a minimum length of 1 byte and a maximum + * length of 51,200 bytes.
+ *Conditional: You must specify only one of the following parameters:
+ * TemplateBody, TemplateURL, or set the
+ * UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the
- * CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters: TemplateBody,
- * TemplateURL, or set the UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's
+ * located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must
+ * start with https://.
Conditional: You must specify only one of the following parameters:
+ * TemplateBody, TemplateURL, or set the
+ * UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are updating.
- *Conditional: You must specify only one of the following parameters: TemplateBody,
- * TemplateURL, or set the UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are + * updating.
+ *Conditional: You must specify only one of the following parameters:
+ * TemplateBody, TemplateURL, or set the
+ * UsePreviousTemplate to true.
Structure containing the temporary overriding stack policy body. You can specify either 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 don't specify a stack policy, the current policy that is associated with the stack will be used.
+ *Structure containing the temporary overriding stack policy body. You can specify either
+ * 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 don't specify a stack policy, the current policy that is associated + * with the stack will be used.
* @public */ StackPolicyDuringUpdateBody?: string; /** - *Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:
- * 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with
- * https://. You can specify either 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 don't specify a stack policy, the current policy that is associated with the stack will be used.
+ *Location of a file containing the temporary overriding stack policy. The URL must point to
+ * a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The
+ * location for an Amazon S3 bucket must start with https://. You can specify either 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 don't specify a stack policy, the current policy that is associated + * with the stack will be used.
* @public */ StackPolicyDuringUpdateURL?: string; /** - *A list of Parameter structures that specify input parameters for the stack. For more information,
- * see the Parameter
- * data type.
A list of Parameter structures that specify input parameters for the stack.
+ * For more information, see the Parameter data
+ * type.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order - * for CloudFormation to update the stack.
+ *In some cases, you must explicitly acknowledge that your 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 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.
Some stack templates might include resources that can affect permissions in your + * Amazon Web Services account, for example, by creating new 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.
If you have IAM resources, you can specify either capability.
*If you have IAM resources with custom names, you must specify
- * CAPABILITY_NAMED_IAM.
If you have IAM resources with custom names, you must
+ * specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
- * InsufficientCapabilities error.
InsufficientCapabilities error.
* If your stack template contains these resources, we suggest that you review all permissions associated with - * them and edit their permissions if necessary.
+ *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::Group + * + * AWS::IAM::Group *
*- * AWS::IAM::Policy + * AWS::IAM::Policy *
** - * AWS::IAM::Role + * AWS::IAM::Role *
*- * - * AWS::IAM::User + * + * AWS::IAM::User *
*- * AWS::IAM::UserToGroupAddition + * AWS::IAM::UserToGroupAddition *
*For more information, see Acknowledging IAM Resources in - * CloudFormation Templates.
+ *For more information, see Acknowledging IAM resources in CloudFormation templates.
*
* CAPABILITY_AUTO_EXPAND
*
Some template contain macros. Macros perform custom processing on templates; this can include simple actions - * like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, - * users typically create a change set from the processed template, so that they can review the changes resulting from - * the macros before actually updating the stack. 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. This includes the AWS::Include and AWS::Serverless transforms, which - * are macros hosted by CloudFormation.
- *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.
+ *Some template contain macros. Macros perform custom processing on templates; this can + * include simple actions like find-and-replace operations, all the way to extensive + * transformations of entire templates. Because of this, users typically create a change set + * from the processed template, so that they can review the changes resulting from the macros + * before actually updating the stack. 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. + * This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
+ *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 CloudFormation being - * notified.
+ *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 CloudFormation being notified.
*For more information, see Using CloudFormation Macros to Perform Custom Processing - * on Templates.
+ *For more information, see Perform custom processing + * on CloudFormation templates with template macros.
*Only one of the Capabilities and ResourceType parameters can be specified.
Only one of the Capabilities and ResourceType parameters can
+ * be specified.
The template resource types that you have permissions to work with for this update stack action, such as
- * AWS::EC2::Instance, 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, 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.
+ *The template resource types that you have permissions to work with for this update stack
+ * action, such as AWS::EC2::Instance, 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, CloudFormation grants permissions to all resource types. IAM uses this + * parameter for CloudFormation-specific condition keys in IAM policies. For more information, see + * Control access with Identity and Access Management.
*Only one of the Capabilities and ResourceType parameters can be specified.
Only one of the Capabilities and ResourceType parameters can
+ * be specified.
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.
+ *The Amazon Resource Name (ARN) of an 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.
* @public */ RoleARN?: string; /** - *The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the - * specified monitoring period afterwards.
+ *The rollback triggers for CloudFormation to monitor during stack creation and updating + * operations, and for the specified monitoring period afterwards.
* @public */ RollbackConfiguration?: RollbackConfiguration; /** - *Structure containing a new stack policy body. You can specify either 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 don't specify a stack policy, the current policy that is associated with the stack is - * unchanged.
+ *Structure containing a new stack policy body. You can specify either 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 don't specify a stack policy, the current policy + * that is associated with the stack is unchanged.
* @public */ StackPolicyBody?: string; /** - *Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located
- * in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with
- * https://. You can specify either 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 don't specify a stack policy, the current policy that is associated with the stack is - * unchanged.
+ *Location of a file containing the updated stack policy. The URL must point to a policy
+ * (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an
+ * Amazon S3 bucket must start with https://. You can specify either 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 don't specify a stack policy, the current policy + * that is associated with the stack is unchanged.
* @public */ StackPolicyURL?: string; /** - *Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. - * Specify an empty list to remove all notification topics.
+ *Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation + * associates with the stack. Specify an empty list to remove all notification topics.
* @public */ NotificationARNs?: string[]; /** - *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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, - * CloudFormation removes all associated 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, CloudFormation doesn't modify the stack's tags. If you + * specify an empty value, CloudFormation removes all associated tags.
* @public */ Tags?: Tag[]; @@ -647,25 +677,29 @@ export interface UpdateStackInput { DisableRollback?: boolean; /** - *A unique identifier for this UpdateStack request. Specify this 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 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. For example, if you execute a CreateStack operation with the token
- * token1, then all the StackEvents generated by that operation will have
- * ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are
- * initiated from the console use the token format Console-StackOperation-ID, which helps you
- * easily identify the stack operation . For example, if you create a stack using the console, each stack event would be
- * assigned the same token in the following format:
- * Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this UpdateStack request. Specify this 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
+ * 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. For example, if you execute a
+ * CreateStack operation with the token token1, then all the
+ * StackEvents generated by that operation will have
+ * ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack
+ * operations that are initiated from the console use the token format
+ * Console-StackOperation-ID, which helps you easily identify the stack
+ * operation . For example, if you create a stack using the console, each stack event would be
+ * assigned the same token in the following format:
+ * Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
When set to true, newly created resources are deleted when the operation rolls back. This includes
- * newly created resources marked with a deletion policy of Retain.
When set to true, newly created resources are deleted when the operation
+ * rolls back. This includes newly created resources marked with a deletion policy of
+ * Retain.
Default: false
*
[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.
[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.
[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.
- *You can specify Accounts or DeploymentTargets, but not both.
[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.
+ *You can specify Accounts or DeploymentTargets, but not
+ * both.
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.
+ *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.
* @public */ Regions: string[] | undefined; /** - *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 Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values - * during stack instance update operations:
+ *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 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 override the current value for a parameter, include the parameter and specify its + * value.
*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 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 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 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, don't specify this property at all.
+ *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 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 to update the stack set template. If you add a parameter
- * to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to
- * update all stack instances with the updated template and parameter value specified in the stack set. Once a stack
- * instance has been updated with the new parameter, you can then override the parameter value using
- * UpdateStackInstances.
During stack set updates, any parameter values overridden for a 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 UpdateStackSet to update the
+ * stack set template. If you add a parameter to a template, before you can override the
+ * parameter value specified in the stack set you must first use UpdateStackSet
+ * to update all stack instances with the updated template and parameter value specified in the
+ * stack set. Once a stack instance has been updated with the new parameter, you can then
+ * override the parameter value using UpdateStackInstances.
The unique identifier for this stack set operation.
- *The operation ID also functions as an idempotency token, to ensure 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.
+ *The operation ID also functions as an idempotency token, to ensure 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.
* @public */ OperationId?: string; /** - *[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*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 in the - * CloudFormation User Guide.
- *Conditional: You must specify only one of the following parameters: TemplateBody or
- * TemplateURL—or set UsePreviousTemplate to true.
The structure that contains the template body, with a minimum length of 1 byte and a + * maximum length of 51,200 bytes.
+ *Conditional: You must specify only one of the following parameters:
+ * TemplateBody or TemplateURL—or set
+ * UsePreviousTemplate to true.
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 or a Systems Manager document. For more information, - * see Template - * Anatomy in the CloudFormation User Guide.
- *Conditional: You must specify only one of the following parameters: TemplateBody or
- * TemplateURL—or set UsePreviousTemplate to true.
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 or a Systems Manager + * document.
+ *Conditional: You must specify only one of the following parameters:
+ * TemplateBody or TemplateURL—or set
+ * UsePreviousTemplate to true.
Use the existing template that's associated with the stack set that you're updating.
- *Conditional: You must specify only one of the following parameters: TemplateBody or
- * TemplateURL—or set UsePreviousTemplate to true.
Use the existing template that's associated with the stack set that you're + * updating.
+ *Conditional: You must specify only one of the following parameters:
+ * TemplateBody or TemplateURL—or set
+ * UsePreviousTemplate to true.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order - * for CloudFormation to update the stack set and its associated stack instances.
+ *In some cases, you must explicitly acknowledge that your stack 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 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.
Some stack templates might include resources that can affect permissions in your + * Amazon Web Services account, for example, by creating new 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.
If you have IAM resources, you can specify either capability.
*If you have IAM resources with custom names, you must specify
- * CAPABILITY_NAMED_IAM.
If you have IAM resources with custom names, you must
+ * specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an
- * InsufficientCapabilities error.
InsufficientCapabilities error.
* If your stack template contains these resources, we recommend that you review all permissions associated with - * them and edit their permissions if necessary.
+ *If your stack template contains these resources, we recommend that you review all + * permissions associated with them and edit their permissions if necessary.
*- * AWS::IAM::AccessKey + * AWS::IAM::AccessKey *
*- * AWS::IAM::Group + * AWS::IAM::Group *
*- * AWS::IAM::Policy + * AWS::IAM::Policy *
*- * AWS::IAM::User + * AWS::IAM::User *
*- * AWS::IAM::UserToGroupAddition + * AWS::IAM::UserToGroupAddition *
*For more information, see Acknowledging IAM Resources in - * CloudFormation Templates.
+ *For more information, see Acknowledging IAM resources in CloudFormation templates.
*
* CAPABILITY_AUTO_EXPAND
*
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.
+ *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.
*Stack sets with service-managed permissions do not currently support the use of macros in templates. (This - * includes the AWS::Include and AWS::Serverless 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.
+ *Stack sets with service-managed permissions do not currently support the use of + * macros in templates. (This includes the AWS::Include and AWS::Serverless 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.
*The key-value pairs to associate with this stack set and the stacks 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:
+ *The key-value pairs to associate with this stack set and the stacks 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, 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 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 any tags using this parameter, you must specify + * all the tags that you want associated with this stack set, even + * 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, 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, 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, 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.
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, 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.
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 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 it is the same customized administrator role used with this stack set previously.
+ *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 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 it is the same customized administrator role + * used with this stack set previously.
* @public */ AdministrationRoleARN?: string; /** - *The name of the IAM execution role to use to update the stack set. If you do not specify an execution role,
- * CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which stack resources users - * and groups can include in their stack sets.
- *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.
+ *The name of the IAM execution role to use to update the stack set. If you do not specify
+ * an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole
+ * role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which + * stack resources users and groups can include in their stack sets.
+ *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.
* @public */ ExecutionRoleName?: string; /** - *[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, 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.
[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, 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.
Describes how the IAM roles required for stack set operations are created. You cannot modify
- * PermissionModel if there are stack instances associated with your stack set.
Describes how the IAM roles required for stack set operations are created. You cannot
+ * modify PermissionModel if there are stack instances associated with your stack
+ * set.
With self-managed permissions, you must create the administrator and execution roles required to
- * deploy to target accounts. For more information, see Grant Self-Managed Stack Set
- * Permissions.
With self-managed permissions, you must create the administrator and
+ * execution roles required to deploy to target accounts. For more information, see Grant
+ * Self-Managed Stack Set Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to
- * deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set
- * Permissions.
With service-managed permissions, StackSets automatically creates the
+ * IAM roles required to deploy to accounts managed by Organizations. For more
+ * information, see Grant
+ * Service-Managed Stack Set Permissions.
[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, don't specify DeploymentTargets or
- * Regions.
[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, don't specify DeploymentTargets
+ * or Regions.
The unique ID for this stack set operation.
- *The operation ID also functions as an idempotency token, to ensure 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, CloudFormation generates one automatically.
- *Repeating this stack set operation with a new operation ID retries all stack instances whose status is
- * OUTDATED.
The operation ID also functions as an idempotency token, to ensure 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, CloudFormation generates one + * automatically.
+ *Repeating this stack set operation with a new operation ID retries all stack instances
+ * whose status is OUTDATED.
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, - * you must also specify the Amazon Web Services Regions in which to update stack set instances.
- *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, 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.
[Self-managed permissions] The accounts in which to update associated stack instances. If + * you specify accounts, you must also specify the Amazon Web Services Regions in which to update stack set + * instances.
+ *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, 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.
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, 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.
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, 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.
[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.
[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 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 in the CloudFormation User Guide.
+ *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 in the CloudFormation User Guide.
*Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting - * operations.
+ *Describes whether StackSets performs non-conflicting operations concurrently and queues + * conflicting operations.
* @public */ ManagedExecution?: ManagedExecution; @@ -1132,7 +1204,8 @@ export interface UpdateTerminationProtectionInput { EnableTerminationProtection: boolean | undefined; /** - *The name or unique ID of the stack for which you want to set termination protection.
+ *The name or unique ID of the stack for which you want to set termination + * protection.
* @public */ StackName: string | undefined; @@ -1155,20 +1228,20 @@ export interface UpdateTerminationProtectionOutput { */ export interface ValidateTemplateInput { /** - *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 in the CloudFormation User Guide.
- *Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only
- * TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum + * length of 51,200 bytes.
+ *Conditional: You must pass TemplateURL or TemplateBody. If both
+ * are passed, only TemplateBody is used.
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 or a Systems Manager document. For more information, go to Template Anatomy in the
- * CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only
- * TemplateBody is used.
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 or a Systems Manager document. The location
+ * for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both
+ * are passed, only TemplateBody is used.
Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
+ *Flag indicating whether the parameter should be displayed as plain text in logs and + * UIs.
* @public */ NoEcho?: boolean; @@ -1222,18 +1296,18 @@ export interface ValidateTemplateOutput { Description?: string; /** - *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 CreateStack or - * UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities - * error.
- *For more information, see Acknowledging IAM Resources in - * CloudFormation Templates.
+ *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 CreateStack or UpdateStack actions with your template; + * otherwise, those actions return an InsufficientCapabilities error.
+ *For more information, see Acknowledging IAM resources in CloudFormation templates.
* @public */ Capabilities?: Capability[]; /** - *The list of resources that generated the values in the Capabilities response element.
The list of resources that generated the values in the Capabilities response
+ * element.
The name of the account limit.
\nValues: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit\n
The name of the account limit.
\nValues: ConcurrentResourcesLimit | StackLimit |\n StackOutputsLimit\n
The AccountLimit data type.
\nCloudFormation has the following limits per account:
\nNumber of concurrent resources
\nNumber of stacks
\nNumber of stack outputs
\nFor more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "The AccountLimit data type.
\nCloudFormation has the following limits per account:
\nNumber of concurrent resources
\nNumber of stacks
\nNumber of stack outputs
\nFor more information about these account limits, and other CloudFormation limits, see Understand CloudFormation quotas in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#AccountLimitList": { @@ -172,7 +172,7 @@ } ], "traits": { - "smithy.api#documentation": "Activate trusted access with Organizations. With trusted access between StackSets and Organizations\n activated, the management account has permissions to create and manage StackSets for your\n organization.
" + "smithy.api#documentation": "Activate trusted access with Organizations. With trusted access between StackSets\n and Organizations activated, the management account has permissions to create\n and manage StackSets for your organization.
" } }, "com.amazonaws.cloudformation#ActivateOrganizationsAccessInput": { @@ -206,7 +206,7 @@ } ], "traits": { - "smithy.api#documentation": "Activates a public third-party extension, making it available for use in stack templates. For more information,\n see Using public\n extensions in the CloudFormation User Guide.
\nOnce you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see\n Configuring extensions at\n the account level in the CloudFormation User Guide.
", + "smithy.api#documentation": "Activates a public third-party extension, making it available for use in stack templates.\n Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Using public\n extensions in the CloudFormation User Guide.
", "smithy.api#idempotent": {} } }, @@ -216,37 +216,37 @@ "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { - "smithy.api#documentation": "The extension type.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The extension type.
\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, Type, and\n PublisherId.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
The ID of the extension publisher.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The ID of the extension publisher.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
The name of the extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The name of the extension.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
An alias to assign to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the\n alias to refer to the extension in your templates, API calls, and CloudFormation console.
\nAn extension alias must be unique within a given account and Region. You can activate the same public resource\n multiple times in the same account and Region, using different type name aliases.
" + "smithy.api#documentation": "An alias to assign to the public extension, in this account and Region. If you specify an\n alias for the extension, CloudFormation treats the alias as the extension type name within this\n account and Region. You must use the alias to refer to the extension in your templates, API\n calls, and CloudFormation console.
\nAn extension alias must be unique within a given account and Region. You can activate the\n same public resource multiple times in the same account and Region, using different type name\n aliases.
" } }, "AutoUpdate": { "target": "com.amazonaws.cloudformation#AutoUpdate", "traits": { - "smithy.api#documentation": "Whether to automatically update the extension in this account and Region when a new minor\n version is published by the extension publisher. Major versions released by the publisher must be manually\n updated.
\nThe default is true.
Whether to automatically update the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions\n released by the publisher must be manually updated.
\nThe default is true.
Manually updates a previously-activated type to a new major or minor version, if available. You can also use\n this parameter to update the value of AutoUpdate.
\n MAJOR: CloudFormation updates the extension to the newest major version, if one is available.
\n MINOR: CloudFormation updates the extension to the newest minor version, if one is available.
Manually updates a previously-activated type to a new major or minor version, if\n available. You can also use this parameter to update the value of\n AutoUpdate.
\n MAJOR: CloudFormation updates the extension to the newest major version, if\n one is available.
\n MINOR: CloudFormation updates the extension to the newest minor version, if\n one is available.
The major version of this extension you want to activate, if multiple major versions are available. The default\n is the latest major version. CloudFormation uses the latest available minor version of the major\n version selected.
\nYou can specify MajorVersion or VersionBump, but not both.
The major version of this extension you want to activate, if multiple major versions are\n available. The default is the latest major version. CloudFormation uses the latest available\n minor version of the major version selected.
\nYou can specify MajorVersion or VersionBump, but not\n both.
The Amazon Resource Name (ARN) of the activated extension, in this account and Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the activated extension, in this account and\n Region.
" } } }, @@ -393,7 +393,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry\n for the account and Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + "smithy.api#documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation\n registry for the account and Region.
\nFor more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError": { @@ -419,7 +419,7 @@ } }, "traits": { - "smithy.api#documentation": "Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.
" + "smithy.api#documentation": "Detailed information concerning an error generated during the setting of configuration data\n for a CloudFormation extension.
" } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors": { @@ -450,19 +450,19 @@ "Errors": { "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors", "traits": { - "smithy.api#documentation": "A list of information concerning any errors generated during the setting of the specified configurations.
" + "smithy.api#documentation": "A list of information concerning any errors generated during the setting of the specified\n configurations.
" } }, "UnprocessedTypeConfigurations": { "target": "com.amazonaws.cloudformation#UnprocessedTypeConfigurations", "traits": { - "smithy.api#documentation": "A list of any of the specified extension configurations that CloudFormation could not process for any reason.
" + "smithy.api#documentation": "A list of any of the specified extension configurations that CloudFormation could not process\n for any reason.
" } }, "TypeConfigurations": { "target": "com.amazonaws.cloudformation#TypeConfigurationDetailsList", "traits": { - "smithy.api#documentation": "A list of any of the specified extension configurations from the CloudFormation registry.
" + "smithy.api#documentation": "A list of any of the specified extension configurations from the CloudFormation\n registry.
" } } }, @@ -494,7 +494,7 @@ "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage", "traits": { - "smithy.api#documentation": "An message with details about the error that occurred.
" + "smithy.api#documentation": "A message with details about the error that occurred.
" } } }, @@ -539,7 +539,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update\n and reverts to the previous stack configuration.
\nYou can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
Cancels an update on the specified stack. If the call completes successfully, the stack\n rolls back the update and reverts to the previous stack configuration.
\nYou can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account.
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:
\n\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }\n
The name or the unique stack ID that's associated with the stack.
", + "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response that\n describes all resources in the account.
The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the\n request:
\n\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }]\n }\n
The name or the unique stack ID that's associated with the stack.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might\n retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.
A unique identifier for this CancelUpdateStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an\n update on a stack with the same name. You might retry CancelUpdateStack requests\n to ensure that CloudFormation successfully received them.
Is either null, if no hooks invoke for the resource, or contains the number of hooks that will\n invoke for the resource.
Is either null, if no hooks invoke for the resource, or contains the number of\n hooks that will invoke for the resource.
A ResourceChange structure that describes the resource and action that CloudFormation will perform.
A ResourceChange structure that describes the resource and action that\n CloudFormation will perform.
The Change structure describes the changes CloudFormation will perform if you execute the change set.
The Change structure describes the changes CloudFormation will perform if you\n execute the change set.
The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of\n Organization::Service::Hook.
The following organization namespaces are reserved and can't be used in your hook type names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n ASK\n
\n AWS\n
\n Custom\n
\n Dev\n
The unique name for your hook. Specifies a three-part namespace for your hook, with a\n recommended pattern of Organization::Service::Hook.
The following organization namespaces are reserved and can't be used in your hook type\n names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n ASK\n
\n AWS\n
\n Custom\n
\n Dev\n
If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already\n updated.
If the change set execution status is AVAILABLE, you can execute the change\n set. If you can't execute the change set, the status indicates why. For example, a change set\n might be in an UNAVAILABLE state because CloudFormation is still creating it or in an\n OBSOLETE state because the stack was already updated.
The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
The state of the change set, such as CREATE_IN_PROGRESS,\n CREATE_COMPLETE, or FAILED.
A description of the change set's status. For example, if your change set is in the FAILED state,\n CloudFormation shows the error message.
A description of the change set's status. For example, if your change set is in the\n FAILED state, CloudFormation shows the error message.
The ChangeSetSummary structure describes a change set, its status, and the stack with which it's\n associated.
The ChangeSetSummary structure describes a change set, its status, and the\n stack with which it's associated.
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and\n repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly\n scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services\n infrastructure.
\nWith CloudFormation, you declare all your resources and dependencies in a template file. The template defines a\n collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack\n together and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation\n product page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a\n specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
", + "smithy.api#documentation": "CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and\n repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service,\n Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly\n scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services\n infrastructure.
\nWith CloudFormation, you declare all your resources and dependencies in a template file. The template defines a\n collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack\n together and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation\n product page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a\n specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
", "smithy.api#title": "AWS CloudFormation", "smithy.api#xmlNamespace": { "uri": "http://cloudformation.amazonaws.com/doc/2010-05-15/" @@ -2452,7 +2452,7 @@ } ], "traits": { - "smithy.api#documentation": "For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the\n UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the\n error and continue the rollback. By continuing the rollback, you can return your stack to a working state\n (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after\n a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was\n deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance\n still exists and attempts to roll back to it, causing the update rollback to fail.
For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues\n rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of\n the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can\n return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and\n then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll\n back all changes after a failed stack update. For example, you might have a stack that's\n rolling back to an old database instance that was deleted outside of CloudFormation. Because\n CloudFormation doesn't know the database was deleted, it assumes that the database instance still\n exists and attempts to roll back to it, causing the update rollback to fail.
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that\n contains the AWS::CloudFormation::Stack resource).
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the\n parent stack (the stack that contains the AWS::CloudFormation::Stack\n resource).
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this\n role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation\n uses this role even if the users don't have permission to pass it. Ensure that the role grants least\n permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to roll back the\n stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that's generated from\n your user credentials.
" } }, "ResourcesToSkip": { "target": "com.amazonaws.cloudformation#ResourcesToSkip", "traits": { - "smithy.api#documentation": "A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation.\n You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't\n specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update\n was canceled. To check why a resource update failed, use the DescribeStackResources action, and\n view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend\n that you \n troubleshoot resources before skipping them. CloudFormation sets the status of the specified resources to\n UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the\n skipped resources will be inconsistent with the state of the resources in the stack template. Before performing\n another stack update, you must update the stack or resources to be consistent with each other. If you don't,\n 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\n resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the\n dependent resources.
\nTo skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource\n (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding\n embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE,\n or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an\n example of a continue update rollback operation with nested stacks, see Using\n ResourcesToSkip to recover a nested stacks hierarchy.
\nA list of the logical IDs of the resources that CloudFormation skips during the continue\n update rollback operation. You can specify only resources that are in the\n UPDATE_FAILED state because a rollback failed. You can't specify resources that\n are in the UPDATE_FAILED state for other reasons, for example, because an update\n 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\n roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets the status of the\n specified resources to UPDATE_COMPLETE and continues to roll back the stack.\n After the rollback is complete, the state of the skipped resources will be inconsistent with\n the state of the resources in the stack template. Before performing another stack update,\n you must update the stack or resources to be consistent with each other. If you don't,\n 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\n example, a failed resource update might cause dependent resources to fail. In this case, it\n might not be necessary to skip the dependent resources.
\nTo skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a\n stack resource (Type: AWS::CloudFormation::Stack) in the\n ResourcesToSkip list, then its corresponding embedded stack must be in one of\n the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or\n DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the\n parent stack. For an example of a continue update rollback operation with nested stacks, see\n Continue rolling back from failed nested stack updates.
\nA unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to\n retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name.\n You might retry ContinueUpdateRollback requests to ensure that CloudFormation successfully received\n them.
A unique identifier for this ContinueUpdateRollback request. Specify this\n token if you plan to retry requests so that CloudFormation knows that you're not attempting to\n continue the rollback to a stack with the same name. You might retry\n ContinueUpdateRollback requests to ensure that CloudFormation successfully received\n them.
Creates a list of changes that will be applied to a stack so that you can review the changes before executing\n 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\n a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change\n set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change\n set and lists the differences. Use change sets to understand which resources CloudFormation will create or\n change, and how it will change resources in an existing stack, before you create or update a stack.
\nTo create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify\n CREATE. To create a change set for an existing stack, specify UPDATE for the\n ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for\n the ChangeSetType parameter. After the 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. CloudFormation doesn't make changes until you execute the change set.
\nTo create a change set for the entire stack hierarchy, set IncludeNestedStacks to\n True.
Creates a list of changes that will be applied to a stack so that you can review the\n changes before executing them. You can create a change set for a stack that doesn't exist or\n an existing stack. If you create a change set for a stack that doesn't exist, the change set\n shows all of the resources that CloudFormation will create. If you create a change set for an\n existing stack, CloudFormation compares the stack's information with the information that you\n submit in the change set and lists the differences. Use change sets to understand which\n resources CloudFormation will create or change, and how it will change resources in an existing\n stack, before you create or update a stack.
\nTo create a change set for a stack that doesn't exist, for the ChangeSetType\n parameter, specify CREATE. To create a change set for an existing stack, specify\n UPDATE for the ChangeSetType parameter. To create a change set for\n an import operation, specify IMPORT for the ChangeSetType parameter.\n After the CreateChangeSet call successfully completes, CloudFormation starts creating\n 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\n by using the ExecuteChangeSet action. CloudFormation doesn't make changes until\n you execute the change set.
\nTo create a change set for the entire stack hierarchy, set\n IncludeNestedStacks to True.
The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set\n by comparing this stack's information with the information that you submit, such as a modified template or different\n parameter input values.
", + "smithy.api#documentation": "The name or the unique ID of the stack for which you are creating a change set. CloudFormation\n generates the change set by comparing this stack's information with the information that you\n submit, such as a modified template or different parameter input values.
", "smithy.api#required": {} } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length\n of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you\n specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
A structure that contains the body of the revised template, with a minimum length of 1\n byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing\n this template with the template of the stack that you specified.
\nConditional: You must specify only TemplateBody or\n TemplateURL.
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800\n bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by\n comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with\n https://.
Conditional: You must specify only TemplateBody or TemplateURL.
The location of the file that contains the revised template. The URL must point to a\n template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager\n document. CloudFormation generates the change set by comparing this template with the stack that\n you specified. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only TemplateBody or\n TemplateURL.
Whether to reuse the template that's associated with the stack to create the change set.
" + "smithy.api#documentation": "Whether to reuse the template that's associated with the stack to create the change\n set.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the change set. For more\n information, see the Parameter data type.
A list of Parameter structures that specify input parameters for the change\n set. For more information, see the Parameter data type.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n 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 Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n 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 permissions associated with\n 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\n CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change 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 more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when creating change sets has no\n effect.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create or update the stack directly from the template using the CreateStack or\n UpdateStack action, and specifying this capability.
\nFor more information about macros, see Using CloudFormation macros to perform custom processing on\n templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
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 IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n 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 can\n 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 set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n 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 creating\n 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 directly\n from the template using the CreateStack or UpdateStack action, and specifying this capability.
\nFor more information about macros, see Perform custom processing\n on CloudFormation templates with template macros.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
The template resource types that you have permissions to work with if you execute this change set, such as\n AWS::EC2::Instance, 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\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with if you execute this\n change set, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the\n stack update fails. By default, CloudFormation grants permissions to all resource types. IAM\n uses this parameter for condition keys in IAM policies for CloudFormation. For more information,\n see Control access with\n Identity and Access Management in the CloudFormation User Guide.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the\n change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future\n operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if\n the users don't have permission to pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is\n available, CloudFormation uses a temporary session that is generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes when executing the\n change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that is generated from\n your user credentials.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates\n with the stack. To remove all associated notification topics, specify an empty list.
" + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Amazon SNS topics that CloudFormation associates with the\n stack. To remove all associated notification topics, specify an empty list.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You\n can specify a maximum of 50 tags.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to\n resources in the stack. You can specify a maximum of 50 tags.
" } }, "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the change set. The name must be unique among all change sets that are associated with the specified\n stack.
\nA change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an\n alphabetical character and can't exceed 128 characters.
", + "smithy.api#documentation": "The name of the change set. The name must be unique among all change sets that are\n associated with the specified stack.
\nA change set name can contain only alphanumeric, case sensitive characters, and hyphens.\n It must start with an alphabetical character and can't exceed 128 characters.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.cloudformation#ClientToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might\n retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
A unique identifier for this CreateChangeSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to create\n another change set with the same name. You might retry CreateChangeSet requests\n to ensure that CloudFormation successfully received them.
The type of change set operation. To create a change set for a new stack, specify CREATE. To create\n a change set for an existing stack, specify UPDATE. To create a change set for an import operation,\n specify IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or\n resources. The stack will be in the REVIEW_IN_PROGRESS state\n until you execute the change set.
\nBy default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change\n set for a new stack or the CREATE type to create a change set for an existing stack.
The type of change set operation. To create a change set for a new stack, specify\n CREATE. To create a change set for an existing stack, specify\n UPDATE. To create a change set for an import operation, specify\n IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack\n ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS\n state until you execute the change set.
By default, CloudFormation specifies UPDATE. You can't use the\n UPDATE type to create a change set for a new stack or the CREATE\n type to create a change set for an existing stack.
Creates a change set for the all nested stacks specified in the template. The default behavior of this action is\n set to False. To include nested sets in a change set, specify True.
Creates a change set for the all nested stacks specified in the template. The default\n behavior of this action is set to False. To include nested sets in a change set,\n specify True.
Determines what action will be taken if stack creation fails. If this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must\n not be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change\n set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to\n be deleted.
Determines what action will be taken if stack creation fails. If this parameter is\n specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these\n values:
\n DELETE - Deletes the change set if the stack creation fails. This is only\n valid when the ChangeSetType parameter is set to CREATE. If the\n deletion of the stack fails, the status of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent\n to specifying true for the DisableRollback parameter to the\n ExecuteChangeSet API operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is\n equivalent to specifying false for the DisableRollback parameter\n to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to\n DELETE for the change set for the parent stack, any failure in a child stack\n will cause the parent stack creation to fail and all stacks to be deleted.
Indicates if the change set imports resources that already exist.
\nThis parameter can only import resources that have custom names in templates. For more information, see name type in the\n CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances,\n use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation\n management in the CloudFormation User Guide.
\nIndicates if the change set imports resources that already exist.
\nThis parameter can only import resources that have custom names in templates. For more\n information, see name type in the\n CloudFormation User Guide. To import resources that do not accept custom\n names, such as EC2 instances, use the resource import feature instead. For more information,\n see Import Amazon Web Services resources into\n a CloudFormation stack with a resource import in the\n CloudFormation User Guide.
\nCreates a template from existing resources that are not already managed with CloudFormation. You can check the status of\n the template generation using the DescribeGeneratedTemplate API action.
Creates a template from existing resources that are not already managed with CloudFormation.\n You can check the status of the template generation using the\n DescribeGeneratedTemplate API action.
An optional list of resources to be included in the generated template.
\n If no resources are specified,the template will be created without any resources. Resources can be added to the\n template using the UpdateGeneratedTemplate API action.
An optional list of resources to be included in the generated template.
\n If no resources are specified,the template will be created without any resources.\n Resources can be added to the template using the UpdateGeneratedTemplate API\n action.
An optional name or ARN of a stack to use as the base stack for the generated template.
" + "smithy.api#documentation": "An optional name or ARN of a stack to use as the base stack for the generated\n template.
" } }, "TemplateConfiguration": { "target": "com.amazonaws.cloudformation#TemplateConfiguration", "traits": { - "smithy.api#documentation": "The configuration details of the generated template, including the DeletionPolicy and\n UpdateReplacePolicy.
The configuration details of the generated template, including the\n DeletionPolicy and UpdateReplacePolicy.
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts.\n You can check the status of the stack through the DescribeStacks operation.
" + "smithy.api#documentation": "Creates a stack as specified in the template. After the call completes successfully, the\n stack creation starts. You can check the status of the stack through the DescribeStacks operation.
\nFor more information about creating a stack and monitoring stack progress, see Managing Amazon Web Services\n resources as a single unit with CloudFormation stacks in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#CreateStackInput": { @@ -2799,110 +2799,110 @@ "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name that's associated with the stack. The name must be unique in the Region in which you are creating the\n stack.
\nA stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an\n alphabetical character and can't be longer than 128 characters.
\nThe name that's associated with the stack. The name must be unique in the Region in which\n you are creating the stack.
\nA stack name can contain only alphanumeric characters (case sensitive) and hyphens. It\n must start with an alphabetical character and can't be longer than 128 characters.
\nStructure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template anatomy in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.
\nConditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
Location of file containing the template body. The URL must point to a template (max size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location\n for an Amazon S3 bucket must start with https://.
Conditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.
A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
A list of Parameter structures that specify input parameters for the stack.\n For more information, see the Parameter data\n type.
Set to true to disable rollback of the stack if stack creation failed. You can specify either\n DisableRollback or OnFailure, but not both.
Default: false\n
Set to true to disable rollback of the stack if stack creation failed. You\n can specify either DisableRollback or OnFailure, but not\n both.
Default: false\n
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the\n specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" } }, "TimeoutInMinutes": { "target": "com.amazonaws.cloudformation#TimeoutMinutes", "traits": { - "smithy.api#documentation": "The amount of time that can pass before the stack status becomes CREATE_FAILED; if\n DisableRollback is not set or is set to false, the stack will be rolled back.
The amount of time that can pass before the stack status becomes\n CREATE_FAILED; if DisableRollback is not set or is set to\n false, the stack will be rolled back.
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your\n Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
" + "smithy.api#documentation": "The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs\n using the Amazon SNS console or your Command Line Interface (CLI).
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n 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 Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n 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 permissions associated with\n them and edit their permissions if necessary.
\n\n AWS::IAM::AccessKey\n
\n\n AWS::IAM::Group\n
\n\n AWS::IAM::Policy\n
\n\n AWS::IAM::Role\n
\n\n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change 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 more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create the stack directly from the template using this capability.
\nYou should only create stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation macros to perform custom processing\n on templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
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 IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n 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 AWS::IAM::AccessKey\n
\n\n AWS::IAM::Group\n
\n\n AWS::IAM::Policy\n
\n\n AWS::IAM::Role\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 can\n 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 set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create the stack directly from the\n template using this capability.
\nYou should only create stacks directly from a stack template that contains macros if\n you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function operation\n without CloudFormation being notified.
\nFor more information, see Perform custom processing\n on CloudFormation templates with template macros.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
The template resource types that you have permissions to work with for this create stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the\n following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources), Custom::logical_ID\n (for a\n specific custom resource), AWS::service_name::* (for all resources of a particular\n Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific\n Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this create stack\n action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance. Use the following syntax to describe template\n resource types: AWS::* (for all Amazon Web Services resources), Custom::* (for all\n custom resources), Custom::logical_ID\n (for a specific custom resource),\n AWS::service_name::* (for all resources of a particular\n Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack\n creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses\n this parameter for CloudFormation-specific condition keys in IAM policies. For more information,\n see Control access with\n Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role\n for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses\n this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to create the\n stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that's generated from\n your user credentials.
" } }, "OnFailure": { "target": "com.amazonaws.cloudformation#OnFailure", "traits": { - "smithy.api#documentation": "Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING,\n ROLLBACK, or DELETE. You can specify either OnFailure or\n DisableRollback, but not both.
Default: ROLLBACK\n
Determines what action will be taken if stack creation fails. This must be one of:\n DO_NOTHING, ROLLBACK, or DELETE. You can specify\n either OnFailure or DisableRollback, but not both.
Default: ROLLBACK\n
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Structure containing the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://.\n You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not\n both.
Location of a file containing the stack policy. The URL must point to a policy (maximum\n size: 16 KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3\n bucket must start with https://. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in\n the stack. A maximum number of 50 tags can be specified.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the\n resources created in the stack. A maximum number of 50 tags can be specified.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry\n CreateStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this CreateStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to create a stack\n with the same name. You might retry CreateStack requests to ensure that\n CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with\n termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks\n by default.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" + "smithy.api#documentation": "Whether to enable termination protection on the specified stack. If a user attempts to\n delete a stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protect CloudFormation\n stacks from being deleted in the CloudFormation User Guide. Termination\n protection is deactivated on stacks by default.
\nFor nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" } }, "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.
Default: false\n
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack\n instance refers to a stack in a specific account and Region. You must specify at least one value for either\n Accounts or DeploymentTargets, and you must specify at least one value for\n Regions.
Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A\n stack instance refers to a stack in a specific account and Region. You must specify at least\n one value for either Accounts or DeploymentTargets, and you must\n specify at least one value for Regions.
The name or unique ID of the stack set that you want to create stack instances from.
", + "smithy.api#documentation": "The name or unique ID of the stack set that you want to create stack instances\n from.
", "smithy.api#required": {} } }, "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack\n instances in the specified Region(s) for.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create\n stack instances in the specified Region(s) for.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
[Service-managed permissions] The Organizations accounts for which to create stack instances in the\n specified Amazon Web Services Regions.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Service-managed permissions] The Organizations accounts for which to create stack\n instances in the specified Amazon Web Services Regions.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified\n Amazon Web Services accounts.
", + "smithy.api#documentation": "The names of one or more Amazon Web Services Regions where you want to create stack instances using the\n specified Amazon Web Services accounts.
", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of stack set parameters whose values you want to override in the selected stack instances.
\nAny overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values\n during stack instance operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template.
" + "smithy.api#documentation": "A list of stack set parameters whose values you want to override in the selected stack\n instances.
\nAny overridden parameter values will be applied to all stack instances in the specified\n accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how\n CloudFormation sets parameter values during stack instance operations:
\nTo override the current value for a parameter, include the parameter and specify its\n value.
\nTo leave an overridden parameter set to its present value, include the parameter and\n specify UsePreviousValue as true. (You can't specify both a\n value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a\n parameter list but don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at\n all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't\n updated, but retain their overridden value.
\nYou can only override the parameter values that are specified in the\n stack set; to add or delete a parameter itself, use UpdateStackSet\n to update the stack set template.
" } }, "OperationPreferences": { @@ -2989,14 +2989,14 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n might retry stack set operation requests to ensure that CloudFormation successfully received\n them.
\nIf you don't specify an operation ID, the SDK generates one\n automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nThe name to associate with the stack set. The name must be unique in the Region where you create your stack\n set.
\nA stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an\n alphabetic character and can't be longer than 128 characters.
\nThe name to associate with the stack set. The name must be unique in the Region where you\n create your stack set.
\nA stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It\n must start with an alphabetic character and can't be longer than 128 characters.
\nA description of the stack set. You can use the description to identify the stack set's purpose or other\n important information.
" + "smithy.api#documentation": "A description of the stack set. You can use the description to identify the stack set's\n purpose or other important information.
" } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" + "smithy.api#documentation": "The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but\n not both.
" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see\n Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" + "smithy.api#documentation": "The location of the file that contains the template body. The URL must point to a template\n (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager\n document.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but\n not both.
" } }, "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (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": { @@ -3100,56 +3100,56 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n 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 permissions associated with\n them and edit their permissions if necessary.
\n\n AWS::IAM::AccessKey\n
\n\n AWS::IAM::Group\n
\n\n AWS::IAM::Policy\n
\n\n AWS::IAM::Role\n
\n\n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must create the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions don't currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions,\n if you reference a macro in your template the stack set operation will fail.
\nIn some cases, you must explicitly acknowledge that your stack set template contains\n certain capabilities in order for CloudFormation to create the stack set and related stack\n instances.
\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 IAM users. For those stack sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n 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 AWS::IAM::AccessKey\n
\n\n AWS::IAM::Group\n
\n\n AWS::IAM::Policy\n
\n\n AWS::IAM::Role\n
\n\n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more\n macros, you must create the stack set directly from the processed template, without first\n reviewing the resulting changes in a change set. To create the stack set directly, you\n must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions don't currently support the use of\n macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if\n you specify this capability for a stack set with service-managed permissions, if you\n reference a macro in your template the stack set operation will fail.
\nThe key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates\n these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be\n specified.
\nIf you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the\n required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an\n access denied error, and the stack set is not created.
The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in the stacks. A\n maximum number of 50 tags can be specified.
\nIf you specify tags as part of a CreateStackSet action, CloudFormation checks to\n see if you have the required IAM permission to tag resources. If you don't, the entire\n CreateStackSet action fails with an access denied error, and the\n stack set is not created.
The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users or groups can\n manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting\n Permissions for Stack Set Operations in the CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific stack sets within the same administrator account.\n For more information, see Prerequisites: Granting\n Permissions for Stack Set Operations in the\n CloudFormation User Guide.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "The name of the IAM execution role to use to create the stack set. If you do not specify an execution role,\n CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which stack resources users\n and groups can include in their stack sets.
" + "smithy.api#documentation": "The name of the IAM execution role to use to create the stack set. If you do not specify\n an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole\n role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their stack sets.
" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are created. By default,\n SELF-MANAGED is specified.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to\n deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set\n Permissions.
Describes how the IAM roles required for stack set operations are created. By default,\n SELF-MANAGED is specified.
With self-managed permissions, you must create the administrator and\n execution roles required to deploy to target accounts. For more information, see Grant\n Self-Managed Stack Set Permissions.
With service-managed permissions, StackSets automatically creates the\n IAM roles required to deploy to accounts managed by Organizations. For more\n information, see Grant\n Service-Managed Stack Set Permissions.
Describes whether StackSets automatically deploys to Organizations accounts that are added to the target\n organization or organizational unit (OU). Specify only if PermissionModel is\n SERVICE_MANAGED.
Describes whether StackSets automatically deploys to Organizations accounts that\n are added to the target organization or organizational unit (OU). Specify only if\n PermissionModel is SERVICE_MANAGED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
To create a stack set with service-managed permissions while signed in to the management account,\n specify SELF.
To create a stack set with service-managed permissions while signed in to a delegated administrator account,\n specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated admin in the management account.\n For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nStack sets with service-managed permissions are created in the management account, including stack\n sets that are created by delegated administrators.
" + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n 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\n 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\n delegated administrator in the CloudFormation User Guide.
\nStack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated\n administrators.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateStackSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might\n retry CreateStackSet requests to ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one automatically.
", + "smithy.api#documentation": "A unique identifier for this CreateStackSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to create\n another stack set with the same name. You might retry CreateStackSet requests to\n ensure that CloudFormation successfully received them.
If you don't specify an operation ID, the SDK generates one\n automatically.
", "smithy.api#idempotencyToken": {} } }, "ManagedExecution": { "target": "com.amazonaws.cloudformation#ManagedExecution", "traits": { - "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" } } }, @@ -3208,7 +3208,7 @@ } ], "traits": { - "smithy.api#documentation": "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\n organization.
" + "smithy.api#documentation": "Deactivates trusted access with Organizations. If trusted access is deactivated,\n the management account does not have permissions to create and manage\n service-managed StackSets for your organization.
" } }, "com.amazonaws.cloudformation#DeactivateOrganizationsAccessInput": { @@ -3242,7 +3242,7 @@ } ], "traits": { - "smithy.api#documentation": "Deactivates a public extension that was previously activated in this account and Region.
\nOnce deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations\n where the stack template includes the extension, even if no updates are being made to the extension. In addition,\n deactivated extensions aren't automatically updated if a new version of the extension is released.
", + "smithy.api#documentation": "Deactivates a public extension that was previously activated in this account and\n Region.
\nOnce deactivated, an extension can't be used in any CloudFormation operation. This includes\n stack update operations where the stack template includes the extension, even if no updates\n are being made to the extension. In addition, deactivated extensions aren't automatically\n updated if a new version of the extension is released.
", "smithy.api#idempotent": {} } }, @@ -3252,19 +3252,19 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The type name of the extension, in this account and Region. If you specified a type name alias when enabling the\n extension, use the type name alias.
\nConditional: You must specify either Arn, or TypeName and Type.
The type name of the extension, in this account and Region. If you specified a type name\n alias when enabling the extension, use the type name alias.
\nConditional: You must specify either Arn, or TypeName and\n Type.
The extension type.
\nConditional: You must specify either Arn, or TypeName and Type.
The extension type.
\nConditional: You must specify either Arn, or TypeName and\n Type.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nConditional: You must specify either Arn, or TypeName and Type.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nConditional: You must specify either Arn, or TypeName and\n Type.
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
\nIf the call successfully completes, CloudFormation successfully deleted the change set.
\nIf IncludeNestedStacks specifies True during the creation of the nested change set,\n then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also\n delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
Deletes the specified change set. Deleting change sets ensures that no one executes the\n wrong change set.
\nIf the call successfully completes, CloudFormation successfully deleted the change set.
\nIf IncludeNestedStacks specifies True during the creation of the\n nested change set, then DeleteChangeSet will delete all change sets that belong\n to the stacks hierarchy and will also delete all change sets for nested stacks with the status\n of REVIEW_IN_PROGRESS.
If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's\n associated with it.
" + "smithy.api#documentation": "If you specified the name of a change set to delete, specify the stack name or Amazon\n Resource Name (ARN) that's associated with it.
" } } }, @@ -3386,7 +3386,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't\n show up in the DescribeStacks operation if the deletion has been completed successfully.
" + "smithy.api#documentation": "Deletes a specified stack. Once the call completes successfully, stack deletion starts.\n Deleted stacks don't show up in the DescribeStacks operation if the deletion\n has been completed successfully.
\nFor more information about deleting a stack, see Delete a stack from\n the CloudFormation console in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#DeleteStackInput": { @@ -3403,25 +3403,25 @@ "RetainResources": { "target": "com.amazonaws.cloudformation#RetainResources", "traits": { - "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the\n resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained\n resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to\n delete the stack.
" + "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that\n are associated with the resources you want to retain. During deletion, CloudFormation deletes the\n stack but doesn't delete the retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3\n bucket, but you want to delete the stack.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to delete the\n stack. CloudFormation uses the role's credentials to make calls on your behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that's generated from\n your user credentials.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry\n DeleteStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this DeleteStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to delete a stack\n with the same name. You might retry DeleteStack requests to ensure that\n CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Specifies the deletion mode for the stack. Possible values are:
\n\n STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this\n parameter.
\n FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to\n resource deletion failure.
Specifies the deletion mode for the stack. Possible values are:
\n\n STANDARD - Use the standard behavior. Specifying this value is the same\n as not specifying this parameter.
\n FORCE_DELETE_STACK - Delete the stack if it's stuck in a\n DELETE_FAILED state due to resource deletion failure.
[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances\n for.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack\n instances for.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
[Service-managed permissions] The Organizations accounts from which to delete stack instances.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Service-managed permissions] The Organizations accounts from which to delete\n stack instances.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a\n retained stack or add an existing, saved stack to a new stack set.
\nFor more information, see Stack set operation\n options.
", + "smithy.api#documentation": "Removes the stack instances from the specified stack set, but doesn't delete the stacks.\n You can't reassociate a retained stack or add an existing, saved stack to a new stack\n set.
\nFor more information, see Stack set operation options.
", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "The unique identifier for this stack set operation.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You can retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
The unique identifier for this stack set operation.
\nIf you don't specify an operation ID, the SDK generates one\n automatically.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n can retry stack set operation requests to ensure that CloudFormation successfully received\n them.
\nRepeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nDeletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more\n information about how to complete 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": { @@ -3563,14 +3563,14 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.
", + "smithy.api#documentation": "The name or unique ID of the stack set that you're deleting. You can obtain this value by\n running ListStackSets.
", "smithy.api#required": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nMarks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from\n 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\n extension has only a single active version, deregistering that version results in the extension itself being\n deregistered and marked as deprecated in the registry.
\nYou can't deregister the default version of an extension if there are other active version of that extension. If\n you do deregister the default version of an extension, the extension type itself is deregistered as well and marked\n as deprecated.
\nTo view the deprecation status of an extension or extension version, use DescribeType.
", + "smithy.api#documentation": "Marks an extension or extension version as DEPRECATED in the CloudFormation\n registry, removing it from active use. Deprecated extensions or extension versions cannot be\n used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of\n that extension. If an extension has only a single active version, deregistering that version\n results in the extension itself being deregistered and marked as deprecated in the\n registry.
\nYou can't deregister the default version of an extension if there are other active version\n of that extension. If you do deregister the default version of an extension, the extension\n type itself is deregistered as well and marked as deprecated.
\nTo view the deprecation status of an extension or extension version, use DescribeType.
", "smithy.api#idempotent": {} } }, @@ -3681,25 +3681,25 @@ "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
" + "smithy.api#documentation": "The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
" } } }, @@ -3723,7 +3723,7 @@ "target": "com.amazonaws.cloudformation#DescribeAccountLimitsOutput" }, "traits": { - "smithy.api#documentation": "Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.\n For more information about account limits, see CloudFormation Quotas in the\n CloudFormation User Guide.
", + "smithy.api#documentation": "Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you\n can create in your account. For more information about account limits, see Understand CloudFormation quotas in the CloudFormation User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3752,13 +3752,13 @@ "AccountLimits": { "target": "com.amazonaws.cloudformation#AccountLimitList", "traits": { - "smithy.api#documentation": "An account limit structure that contain a list of CloudFormation account limits and their values.
" + "smithy.api#documentation": "An account limit structure that contain a list of CloudFormation account limits and their\n values.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page\n exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of limits. If\n no additional page exists, this value is null.
" } } }, @@ -3781,7 +3781,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set.\n For more information, see Updating Stacks Using Change\n Sets in the CloudFormation User Guide.
", + "smithy.api#documentation": "Returns the inputs for the change set and a list of changes that CloudFormation will make if\n you execute the change set. For more information, see Update\n CloudFormation stacks using change sets in the\n CloudFormation User Guide.
", "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], "smithy.waiters#waitable": { "ChangeSetCreateComplete": { @@ -3833,7 +3833,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the\n change set.
" + "smithy.api#documentation": "Returns hook-related information for the change set and a list of changes that CloudFormation\n makes when you run the change set.
" } }, "com.amazonaws.cloudformation#DescribeChangeSetHooksInput": { @@ -3850,19 +3850,19 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want\n to describe.
" + "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or stack ID (ARN) of the\n change set you want to describe.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of\n information that you want to retrieve.
A string, provided by the DescribeChangeSetHooks response output, that\n identifies the next page of information that you want to retrieve.
If specified, lists only the hooks related to the specified LogicalResourceId.
If specified, lists only the hooks related to the specified\n LogicalResourceId.
If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to\n describe.
" + "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or ID (ARN) of the\n change set you want to describe.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string (provided by the DescribeChangeSet response output) that identifies the next page of\n information that you want to retrieve.
" + "smithy.api#documentation": "A string (provided by the DescribeChangeSet response output) that\n identifies the next page of information that you want to retrieve.
" } }, "IncludePropertyValues": { "target": "com.amazonaws.cloudformation#IncludePropertyValues", "traits": { - "smithy.api#documentation": "If true, the returned changes include detailed changes in the property values.
If true, the returned changes include detailed changes in the property\n values.
A list of Parameter structures that describes the input parameters and their values used to create\n the change set. For more information, see the Parameter data type.
A list of Parameter structures that describes the input parameters and their\n values used to create the change set. For more information, see the Parameter data type.
If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already\n updated.
If the change set execution status is AVAILABLE, you can execute the change\n set. If you can't execute the change set, the status indicates why. For example, a change set\n might be in an UNAVAILABLE state because CloudFormation is still creating it or in an\n OBSOLETE state because the stack was already updated.
The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
The current status of the change set, such as CREATE_IN_PROGRESS,\n CREATE_COMPLETE, or FAILED.
A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
" + "smithy.api#documentation": "A description of the change set's status. For example, if your attempt to create a change\n set failed, CloudFormation shows the error message.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you\n execute the change set.
" + "smithy.api#documentation": "The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the\n change set.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set\n was created.
" + "smithy.api#documentation": "If you execute the change set, the list of capabilities that were explicitly acknowledged\n when the change set was created.
" } }, "Tags": { @@ -4045,13 +4045,13 @@ "Changes": { "target": "com.amazonaws.cloudformation#Changes", "traits": { - "smithy.api#documentation": "A list of Change structures that describes the resources CloudFormation changes if you execute the change\n set.
A list of Change structures that describes the resources CloudFormation changes\n if you execute the change set.
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page,\n this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB, a string that identifies the next page of changes. If there is\n no additional page, this value is null.
" } }, "IncludeNestedStacks": { @@ -4063,25 +4063,25 @@ "ParentChangeSetId": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { - "smithy.api#documentation": "Specifies the change set ID of the parent change set in the current nested change set hierarchy.
" + "smithy.api#documentation": "Specifies the change set ID of the parent change set in the current nested change set\n hierarchy.
" } }, "RootChangeSetId": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { - "smithy.api#documentation": "Specifies the change set ID of the root change set in the current nested change set hierarchy.
" + "smithy.api#documentation": "Specifies the change set ID of the root change set in the current nested change set\n hierarchy.
" } }, "OnStackFailure": { "target": "com.amazonaws.cloudformation#OnStackFailure", "traits": { - "smithy.api#documentation": "Determines what action will be taken if stack creation fails. When this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must\n not be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
Determines what action will be taken if stack creation fails. When this parameter is\n specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these\n values:
\n DELETE - Deletes the change set if the stack creation fails. This is only\n valid when the ChangeSetType parameter is set to CREATE. If the\n deletion of the stack fails, the status of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent\n to specifying true for the DisableRollback parameter to the\n ExecuteChangeSet API operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is\n equivalent to specifying false for the DisableRollback parameter\n to the ExecuteChangeSet API operation.
Indicates if the change set imports resources that already exist.
\nThis parameter can only import resources that have custom names in templates. To import\n resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.
\nIndicates if the change set imports resources that already exist.
\nThis parameter can only import resources that have custom names in\n templates. To import resources that do not accept custom names, such as EC2 instances, use\n the resource import\n feature instead.
\nDescribes a generated template. The output includes details about the progress of the creation of a generated\n template started by a CreateGeneratedTemplate API action or the update of a generated template started\n with an UpdateGeneratedTemplate API action.
Describes a generated template. The output includes details about the progress of the\n creation of a generated template started by a CreateGeneratedTemplate API action\n or the update of a generated template started with an UpdateGeneratedTemplate API\n action.
The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}.\n For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
A list of objects describing the details of the resources in the template generation.
" + "smithy.api#documentation": "A list of objects describing the details of the resources in the template\n generation.
" } }, "Status": { @@ -4153,7 +4153,7 @@ "StatusReason": { "target": "com.amazonaws.cloudformation#TemplateStatusReason", "traits": { - "smithy.api#documentation": "The reason for the current template generation status. This will provide more details if a failure\n happened.
" + "smithy.api#documentation": "The reason for the current template generation status. This will provide more details if a\n failure happened.
" } }, "CreationTime": { @@ -4177,19 +4177,19 @@ "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "The stack ARN of the base stack if a base stack was provided when generating the template.
" + "smithy.api#documentation": "The stack ARN of the base stack if a base stack was provided when generating the\n template.
" } }, "TemplateConfiguration": { "target": "com.amazonaws.cloudformation#TemplateConfiguration", "traits": { - "smithy.api#documentation": "The configuration details of the generated template, including the DeletionPolicy and\n UpdateReplacePolicy.
The configuration details of the generated template, including the\n DeletionPolicy and UpdateReplacePolicy.
The number of warnings generated for this template. The warnings are found in the details of each of the\n resources in the template.
" + "smithy.api#documentation": "The number of warnings generated for this template. The warnings are found in the details\n of each of the resources in the template.
" } } }, @@ -4214,7 +4214,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information about the account's OrganizationAccess status. This API can be called either\n by the management account or the delegated administrator by using the CallAs parameter. This API can\n also be called without the CallAs parameter by the management account.
Retrieves information about the account's OrganizationAccess status. This API\n can be called either by the management account or the delegated administrator by using the\n CallAs parameter. This API can also be called without the CallAs\n parameter by the management account.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nReturns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher 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\n 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 extensions\n to make them available for public use in the\n CloudFormation Command Line Interface (CLI) User Guide\n
\nThe ID of the extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
The ID of the 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.
Whether the publisher is verified. Currently, all registered publishers are verified.
" + "smithy.api#documentation": "Whether the publisher is verified. Currently, all registered publishers are\n verified.
" } }, "IdentityProvider": { "target": "com.amazonaws.cloudformation#IdentityProvider", "traits": { - "smithy.api#documentation": "The type of account used as the identity provider when registering this publisher with CloudFormation.
" + "smithy.api#documentation": "The type of account used as the identity provider when registering this publisher with\n CloudFormation.
" } }, "PublisherProfile": { @@ -4348,19 +4348,19 @@ "ResourceScanId": { "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .
The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An\n example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .
Status of the resource scan.
\nThe resource scan is still in progress.
\nThe resource scan is complete.
\nThe resource scan has expired.
\nThe resource scan has failed.
\nStatus of the resource scan.
\nThe resource scan is still in progress.
\nThe resource scan is complete.
\nThe resource scan has expired.
\nThe resource scan has failed.
\nThe reason for the resource scan status, providing more information if a failure happened.
" + "smithy.api#documentation": "The reason for the resource scan status, providing more information if a failure\n happened.
" } }, "StartTime": { @@ -4384,19 +4384,19 @@ "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "The list of resource types for the specified scan. Resource types are only available for scans with a\n Status set to COMPLETE or FAILED .
The list of resource types for the specified scan. Resource types are only available for\n scans with a Status set to COMPLETE or FAILED .
The number of resources that were listed. This is only available for scans with a Status set to\n COMPLETE, EXPIRED, or FAILED .
The number of resources that were listed. This is only available for scans with a\n Status set to COMPLETE, EXPIRED, or FAILED\n .
The number of resources that were read. This is only available for scans with a Status set to\n COMPLETE, EXPIRED, or FAILED .
This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.
The number of resources that were read. This is only available for scans with a\n Status set to COMPLETE, EXPIRED, or FAILED\n .
This field may be 0 if the resource scan failed with a\n ResourceScanLimitExceededException.
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the\n operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use\n DescribeStackResourceDrifts to return drift information 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 its 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 Detect unmanaged\n configuration changes to stacks and resources with drift detection.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to\n monitor the progress of the operation using DescribeStackDriftDetectionStatus.\n Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.
The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.
", + "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of drift results CloudFormation retains for any given stack, and for\n how long, may vary.
", "smithy.api#required": {} } } @@ -4447,21 +4447,21 @@ "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of reports CloudFormation retains for any given stack, and for how long, may vary.
", + "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of reports CloudFormation retains for any given stack, and for how\n long, may vary.
", "smithy.api#required": {} } }, "StackDriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack's actual configuration compared to its expected configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A\n stack is considered to have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its\n expected template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.
\n UNKNOWN: This value is reserved for future use.
The status of the stack drift detection operation.
\n\n DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all\n resources in the stack that support drift detection. (Resources that don't currently support stack detection remain\n unchecked.)
If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation,\n only the resources with those logical IDs are checked for drift.
\n\n DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the\n stack. Results will be available for resources on which CloudFormation successfully completed drift detection.
\n DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
The status of the stack drift detection operation.
\n\n DETECTION_COMPLETE: The stack drift detection operation has successfully\n completed for all resources in the stack that support drift detection. (Resources that\n don't currently support stack detection remain unchecked.)
If you specified logical resource IDs for CloudFormation to use as a filter for the stack\n drift detection operation, only the resources with those logical IDs are checked for\n drift.
\n\n DETECTION_FAILED: The stack drift detection operation has failed for at\n least one resource in the stack. Results will be available for resources on which\n CloudFormation successfully completed drift detection.
\n DETECTION_IN_PROGRESS: The stack drift detection operation is currently\n in progress.
Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a\n status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is\n IN_SYNC.
Total number of stack resources that have drifted. This is NULL until the drift detection\n operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks\n whose drift status is IN_SYNC.
Returns all stack related events for a specified stack in reverse chronological order. For more information\n about a stack's event history, see CloudFormation stack creation\n events in the CloudFormation User Guide.
\nYou can list events for stacks that have failed to create or have been deleted by specifying the unique stack\n identifier (stack ID).
\nReturns all stack related events for a specified stack in reverse chronological order. For\n more information about a stack's event history, see Understand CloudFormation stack creation events in the\n CloudFormation User Guide.
\nYou can list events for stacks that have failed to create or have been deleted by\n specifying the unique stack identifier (stack ID).
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "The name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "NextToken": { @@ -4540,7 +4540,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page\n exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of events. If\n no additional page exists, this value is null.
" } } }, @@ -4566,7 +4566,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and\n Amazon Web Services Region.
\nFor a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
" + "smithy.api#documentation": "Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account,\n and Amazon Web Services Region.
\nFor a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
" } }, "com.amazonaws.cloudformation#DescribeStackInstanceInput": { @@ -4576,7 +4576,7 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or the unique stack ID of the stack set that you want to get stack instance information for.
", + "smithy.api#documentation": "The name or the unique stack ID of the stack set that you want to get stack instance\n information for.
", "smithy.api#required": {} } }, @@ -4599,7 +4599,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nReturns a description of the specified resource in the specified stack.
\nFor deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has\n been deleted.
" + "smithy.api#documentation": "Returns a description of the specified resource in the specified stack.
\nFor deleted stacks, DescribeStackResource returns resource information for up to 90 days\n after the stack has been deleted.
" } }, "com.amazonaws.cloudformation#DescribeStackResourceDrifts": { @@ -4642,7 +4642,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackResourceDriftsOutput" }, "traits": { - "smithy.api#documentation": "Returns drift information for the resources that have been checked for drift in the specified stack. This\n includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
\nFor a given stack, there will be one StackResourceDrift for each stack resource that has been\n checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently\n support drift detection aren't checked, and so not included. For a list of resources that support drift detection,\n see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
", + "smithy.api#documentation": "Returns drift information for the resources that have been checked for drift in the\n specified stack. This includes actual and expected configuration values for resources where\n CloudFormation detects configuration drift.
\nFor a given stack, there will be one StackResourceDrift for each stack\n resource that has been checked for drift. Resources that haven't yet been checked for drift\n aren't included. Resources that don't currently support drift detection aren't checked, and so\n not included. For a list of resources that support drift detection, see Resource\n type support for imports and drift detection.
Use DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all supported resources for a given\n stack.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4664,7 +4664,7 @@ "StackResourceDriftStatusFilters": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatusFilters", "traits": { - "smithy.api#documentation": "The resource drift status values to use as filters for the resource drift results returned.
\n\n DELETED: The resource differs from its expected template configuration in that the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected template values.
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The resource drift status values to use as filters for the resource drift results\n returned.
\n\n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
Drift information for the resources that have been checked for drift in the specified stack. This includes\n actual and expected configuration values for resources where CloudFormation detects drift.
\nFor a given stack, there will be one StackResourceDrift for each stack resource that has been\n checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently\n support drift detection aren't checked, and so not included. For a list of resources that support drift detection,\n see Resources that Support Drift Detection.
Drift information for the resources that have been checked for drift in the specified\n stack. This includes actual and expected configuration values for resources where CloudFormation\n detects drift.
\nFor a given stack, there will be one StackResourceDrift for each stack\n resource that has been checked for drift. Resources that haven't yet been checked for drift\n aren't included. Resources that do not currently support drift detection aren't checked, and\n so not included. For a list of resources that support drift detection, see Resource\n type support for imports and drift detection.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call DescribeStackResourceDrifts\n again and assign that token to the request object's NextToken parameter. If the\n request returns all results, NextToken is set to null.
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", + "smithy.api#documentation": "The name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", "smithy.api#required": {} } }, @@ -4737,7 +4737,7 @@ "StackResourceDetail": { "target": "com.amazonaws.cloudformation#StackResourceDetail", "traits": { - "smithy.api#documentation": "A StackResourceDetail structure containing the description of the specified resource in the\n specified stack.
A StackResourceDetail structure containing the description of the specified\n resource in the specified stack.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is\n specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId\n is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use\n ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the\n stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition,\n you can specify LogicalResourceId to filter the returned result. For more information about resources,\n the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and\n PhysicalResourceId in the same request.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If\n StackName is specified, all the associated resources that are part of the stack\n are returned. If PhysicalResourceId is specified, the associated resources of the\n stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than\n this, you should use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for\n up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not\n both. In addition, you can specify LogicalResourceId to filter the returned\n result. For more information about resources, the LogicalResourceId and\n PhysicalResourceId, see the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName\n and PhysicalResourceId in the same request.
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.
The name or the unique stack ID that is associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to\n the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to\n find which stack the instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId, you must specify\n StackName.
Default: There is no default value.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance,\n PhysicalResourceId corresponds to the InstanceId. You can pass the\n EC2 InstanceId to DescribeStackResources to find which stack the\n instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId, you must\n specify StackName.
Default: There is no default value.
" } } }, @@ -4831,7 +4831,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nReturns the description for the specified stack; if no stack name was specified, then it returns the description\n for all the stacks created. For more information about a stack's event history, see CloudFormation stack creation\n events in the CloudFormation User Guide.
\nIf the stack doesn't exist, a ValidationError is returned.
Returns the description for the specified stack; if no stack name was specified, then it\n returns the description for all the stacks created. For more information about a stack's event\n history, see Understand CloudFormation stack creation events in the\n CloudFormation User Guide.
\nIf the stack doesn't exist, a ValidationError is returned.
If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account, which can impact performance. This requires ListStacks and\n DescribeStacks permissions.
Consider using the ListStacks API if you're not passing a parameter to\n StackName.
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response\n that describes all resources in the account, which can impact performance. This requires\n ListStacks and DescribeStacks permissions.
Consider using the ListStacks API if you're not passing a parameter to\n StackName.
The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the\n request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }]\n }
\nThe name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "NextToken": { @@ -5407,7 +5407,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page\n exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If\n no additional page exists, this value is null.
" } } }, @@ -5433,7 +5433,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns detailed information about an extension that has been registered.
\nIf you specify a VersionId, DescribeType returns information about that specific\n extension version. Otherwise, it returns information about the default extension version.
Returns detailed information about an extension that has been registered.
\nIf you specify a VersionId, DescribeType returns information\n about that specific extension version. Otherwise, it returns information about the default\n extension version.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
\nIf you specify a VersionId, DescribeType returns information about that specific\n extension version. Otherwise, it returns information about the default extension version.
The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
\nIf you specify a VersionId, DescribeType returns information\n about that specific extension version. Otherwise, it returns information about the default\n extension version.
The name of the extension.
\nIf the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the\n type name alias. For more information, see ActivateType.
" + "smithy.api#documentation": "The name of the extension.
\nIf the extension is a public third-party type you have activated with a type name alias,\n CloudFormation returns the type name alias. For more information, see ActivateType.
" } }, "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 extension version isn't\n specified.
\nThis applies only to 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 null. For more\n information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" + "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 Web Services and published by third parties, CloudFormation returns\n null. For more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" } }, "IsDefaultVersion": { "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { - "smithy.api#documentation": "Whether the specified extension version is set as the default version.
\nThis 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\n 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 are activated\n in your account, CloudFormation returns null.
The contract test status of the registered extension version. 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 doesn't return this information for\n public extensions, whether they are activated in 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 published. For more information,\n see Publishing\n extensions to make them available for public 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 extension.
\n NOT_TESTED: Contract tests haven't been performed on the extension.
The contract test status of the registered extension version. To return the extension test\n status of a specific extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in 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\n extensions to make them available for public use in the\n CloudFormation Command Line Interface (CLI) User 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 extension version, you\n must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this information for\n public extensions, whether they are activated in 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 doesn't return this\n information for public extensions, whether they are activated in your account.
" } }, "Description": { @@ -5535,43 +5535,43 @@ "Schema": { "target": "com.amazonaws.cloudformation#TypeSchema", "traits": { - "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource Provider Schema in the\n CloudFormation CLI User Guide.
" + "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource type\n schema in the CloudFormation Command Line Interface (CLI) User Guide.
" } }, "ProvisioningType": { "target": "com.amazonaws.cloudformation#ProvisioningType", "traits": { - "smithy.api#documentation": "For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning\n type during registration, based on the types of handlers in the schema handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during\n stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and\n must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore\n can't actually be provisioned.
create
\nread
\ndelete
\nFor resource type extensions, the provisioning behavior of the resource type. CloudFormation\n determines the provisioning type during registration, based on the types of handlers in the\n schema handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process\n updates to the type during stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the\n type can't be updated and must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include all the following\n handlers, and therefore can't actually be provisioned.
create
\nread
\ndelete
\nThe deprecation status of the extension version.
\nValid values include:
\n\n LIVE: The extension is activated or registered and can be used in CloudFormation operations,\n dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in\n CloudFormation operations.
For public third-party extensions, CloudFormation returns null.
The deprecation status of the extension version.
\nValid values include:
\n\n LIVE: The extension is activated or registered and can be used in\n CloudFormation operations, dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension has been deactivated or deregistered and can no\n longer be used in CloudFormation operations.
For public third-party extensions, CloudFormation returns null.
Contains logging configuration information for private extensions. This applies only to private extensions you\n have registered in your account. For public extensions, both those provided by Amazon Web Services and published by\n third parties, CloudFormation returns 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 null. For\n more information, see RegisterType.
For extensions that are modules, the public third-party extensions that must be activated in your account in\n order for the module itself to be activated.
" + "smithy.api#documentation": "For extensions that are modules, the public third-party extensions that must be activated\n in your account in order for the module itself to be activated.
" } }, "ExecutionRoleArn": { "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to\n private extensions you have registered in your account. For more information, see RegisterType.
\nIf the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution role\n that includes\n the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account.\n CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to register the extension.\n This applies only to private extensions you have registered in your account. For more\n information, see RegisterType.
\nIf the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution\n role\n that includes the necessary permissions to call those Amazon Web Services APIs,\n and provision that execution role in your account. CloudFormation then assumes that execution role\n to provide your 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 operations.
\nValid values include:
\n\n PRIVATE: The extension is only visible and usable within the account in which it is registered.\n CloudFormation marks any extensions you register as PRIVATE.
\n PUBLIC: The extension is publicly visible and usable within any Amazon Web Services\n account.
The scope at which the extension is visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: The extension is only visible and usable within the account in\n which it is registered. CloudFormation marks any extensions you register as\n PRIVATE.
\n PUBLIC: The extension is publicly visible and usable within any Amazon Web Services\n account.
When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.
\nWhen the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see\n RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For\n more information, see ActivateType.
\nWhen the specified private extension version was registered or activated in your account.
" + "smithy.api#documentation": "When the specified private extension version was registered or activated in your\n account.
" } }, "ConfigurationSchema": { "target": "com.amazonaws.cloudformation#ConfigurationSchema", "traits": { - "smithy.api#documentation": "A JSON string that represent the current configuration data for the extension in this account and Region.
\nTo set the configuration data for an extension, use SetTypeConfiguration. For more\n information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + "smithy.api#documentation": "A JSON string that represent the current configuration data for the extension in this\n account and Region.
\nTo set the configuration data for an extension, use SetTypeConfiguration. For more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.
" } }, "PublisherId": { "target": "com.amazonaws.cloudformation#PublisherId", "traits": { - "smithy.api#documentation": "The publisher ID of the extension publisher.
\nThis applies only to public third-party extensions. For private registered extensions, and extensions provided\n by Amazon Web Services, CloudFormation returns null.
The publisher ID of the extension publisher.
\nThis applies only to public third-party extensions. For private registered extensions, and\n extensions provided by Amazon Web Services, CloudFormation returns null.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf 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\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name\n of the public extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account\n and Region, CloudFormation treats that alias as the extension's type name within the account and\n Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of\n the public extension.
" + "smithy.api#documentation": "For public extensions that have been activated for this account and Region, the Amazon\n Resource Name (ARN) of the public extension.
" } }, "PublicVersionNumber": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { - "smithy.api#documentation": "The version number of a public third-party extension.
\nThis applies only if you specify a public extension you have activated in your account, or specify a public\n extension without specifying a version. For all other extensions, CloudFormation returns null.
The version number of a public third-party extension.
\nThis applies only if you specify a public extension you have activated in your account, or\n specify a public extension without specifying a version. For all other extensions, CloudFormation\n returns null.
The latest version of a public extension that is available for use.
\nThis only applies if you specify a public extension, and you don't specify a version. For all other requests,\n CloudFormation returns null.
The latest version of a public extension that is available for\n use.
\nThis only applies if you specify a public extension, and you don't specify a version. For\n all other requests, 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\n null.
Whether the extension is activated in the account and Region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation\n returns null.
Whether CloudFormation automatically updates the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions released by the publisher\n must be manually updated. For more information, see Activating public extensions for\n use in your account in the CloudFormation User Guide.
" + "smithy.api#documentation": "Whether CloudFormation automatically updates the extension in this account and Region when a\n new minor version is published by the extension publisher. Major versions\n released by the publisher must be manually updated. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.
" } } }, @@ -5665,7 +5665,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about an extension's registration, including its current status and type and version\n identifiers.
\nWhen you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.
\nOnce the registration request has completed, use DescribeType to return detailed information\n about an extension.
", + "smithy.api#documentation": "Returns information about an extension's registration, including its current status and\n type and version identifiers.
\nWhen you initiate a registration request using RegisterType, you can\n then use DescribeTypeRegistration to monitor the progress of that\n registration request.
\nOnce the registration request has completed, use DescribeType to return\n detailed information about an extension.
", "smithy.api#idempotent": {}, "smithy.waiters#waitable": { "TypeRegistrationComplete": { @@ -5704,7 +5704,7 @@ "target": "com.amazonaws.cloudformation#RegistrationToken", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier for this registration request.
\nThis registration token is generated by CloudFormation when you initiate a registration request using RegisterType.
", + "smithy.api#documentation": "The identifier for this registration request.
\nThis registration token is generated by CloudFormation when you initiate a registration\n request using RegisterType.
", "smithy.api#required": {} } } @@ -5731,13 +5731,13 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
The Amazon Resource Name (ARN) of the extension being registered.
\nFor registration requests with a ProgressStatus of other than\n COMPLETE, this will be null.
The Amazon Resource Name (ARN) of this specific version of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
The Amazon Resource Name (ARN) of this specific version of the extension being\n registered.
\nFor registration requests with a ProgressStatus of other than\n COMPLETE, this will be null.
Detects whether a stack's actual configuration differs, or has drifted, from its expected\n configuration, as defined in the stack template and any values specified as template parameters. For each resource in\n the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected\n template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A\n stack is considered to have drifted if one or more of its resources differ from their expected template\n configurations. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift\n Detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of resources contained\n within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack\n drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts\n to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack.\n Perform DetectStackDrift directly on the nested stack itself.
Detects whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. For each resource in the stack that\n supports drift detection, CloudFormation compares the actual configuration of the resource with\n its expected template configuration. Only resource properties explicitly defined in the stack\n template are checked for drift. A stack is considered to have drifted if one or more of its\n resources differ from their expected template configurations. For more information, see Detect unmanaged configuration changes to stacks and resources with drift\n detection.
\nUse DetectStackDrift to detect drift on all supported resources for a given\n stack, or DetectStackResourceDrift to detect drift on individual\n resources.
For a list of stack resources that currently support drift detection, see Resource\n type support for imports and drift detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of\n resources contained within the stack. Use DescribeStackDriftDetectionStatus\n to monitor the progress of a detect stack drift operation. Once the drift detection operation\n has completed, use DescribeStackResourceDrifts to return drift information\n about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks\n belonging to that stack. Perform DetectStackDrift directly on the nested stack\n itself.
The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.
", + "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of drift results CloudFormation retains for any given stack, and for\n how long, may vary.
", "smithy.api#required": {} } } @@ -5830,7 +5830,7 @@ "target": "com.amazonaws.cloudformation#DetectStackResourceDriftOutput" }, "traits": { - "smithy.api#documentation": "Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. This information includes actual and expected property values for resources in\n which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift.\n For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse 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 don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
" + "smithy.api#documentation": "Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. This information includes actual and\n expected property values for resources in which CloudFormation detects drift. Only resource\n properties explicitly defined in the stack template are checked for drift. For more\n information about stack and resource drift, see Detect unmanaged\n configuration changes to stacks and resources with drift detection.
\nUse DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all resources in a given stack that\n support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of\n resources that support drift detection, see Resource\n type support for imports and drift detection.
" } }, "com.amazonaws.cloudformation#DetectStackResourceDriftInput": { @@ -5864,7 +5864,7 @@ "target": "com.amazonaws.cloudformation#StackResourceDrift", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information about whether the resource's actual configuration has drifted from its expected template\n configuration, including actual and expected property values and any differences detected.
", + "smithy.api#documentation": "Information about whether the resource's actual configuration has drifted from its\n expected template configuration, including actual and expected property values and any\n differences detected.
", "smithy.api#required": {} } } @@ -5893,7 +5893,7 @@ } ], "traits": { - "smithy.api#documentation": "Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift\n detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift\n detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set drift detection\n operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the\n drift detection operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
\nUse DescribeStackSet to return detailed information about the stack set, including detailed\n information about the last completed drift operation performed on the stack set. (Information\n about drift operations that are in progress isn't included.)
\nUse ListStackInstances to return a list of stack instances belonging to the stack set,\n including the drift status and last drift time checked of each instance.
\nUse DescribeStackInstance to return detailed information about a specific stack instance,\n including its drift status and last drift time checked.
\nFor more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in\n stack sets.
\nYou can only run a single drift detection operation on a given stack set at one time.
\nTo stop a drift detection stack set operation, use StopStackSetOperation.
" + "smithy.api#documentation": "Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it\n performs drift detection on the stack associated with each stack instance in the stack set.\n For more information, see How CloudFormation performs drift\n detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set\n drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection\n operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each\n stack.
Once the operation has completed, use the following actions to return drift\n information:
\nUse DescribeStackSet to return detailed information about the stack\n set, including detailed information about the last completed drift\n operation performed on the stack set. (Information about drift operations that are in\n progress isn't included.)
\nUse ListStackInstances to return a list of stack instances belonging\n to the stack set, including the drift status and last drift time checked of each\n instance.
\nUse DescribeStackInstance to return detailed information about a\n specific stack instance, including its drift status and last drift time checked.
\nFor more information about performing a drift detection operation on a stack set, see\n Detecting unmanaged 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 StopStackSetOperation.
" } }, "com.amazonaws.cloudformation#DetectStackSetDriftInput": { @@ -5910,7 +5910,7 @@ "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" } }, "OperationId": { @@ -5923,7 +5923,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nThe ID of the drift detection stack set operation.
\nYou can use this operation ID with DescribeStackSetOperation to monitor the progress of the\n drift detection operation.
" + "smithy.api#documentation": "The ID of the drift detection stack set operation.
\nYou can use this operation ID with DescribeStackSetOperation to monitor\n the progress of the drift detection operation.
" } } }, @@ -6009,7 +6009,7 @@ "target": "com.amazonaws.cloudformation#EstimateTemplateCostOutput" }, "traits": { - "smithy.api#documentation": "Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly\n Calculator URL with a query string that describes the resources required to run the template.
" + "smithy.api#documentation": "Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple\n Monthly Calculator URL with a query string that describes the resources required to run the\n template.
" } }, "com.amazonaws.cloudformation#EstimateTemplateCostInput": { @@ -6018,13 +6018,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.
\nConditional: You must pass TemplateBody or TemplateURL. If both\n are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's\n located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must\n start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.
An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to\n run the template.
" + "smithy.api#documentation": "An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources\n required to run the template.
" } } }, @@ -6097,7 +6097,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a stack using the input information that was provided when the specified change set was created. After\n the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to\n view the status of the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't\n valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a\n temporary stack policy that overrides the current policy.
\nTo create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to\n True.
Updates a stack using the input information that was provided when the specified change\n set was created. After the call successfully completes, CloudFormation starts updating the stack.\n Use the DescribeStacks action to view the status of the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets associated with\n the stack because they aren't valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the policy during the\n update. You can't specify a temporary stack policy that overrides the current policy.
\nTo create a change set for the entire stack hierarchy, IncludeNestedStacks\n must have been set to True.
The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the change set that you want use to update the\n specified stack.
", "smithy.api#required": {} } }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's\n associated with the change set you want to execute.
" + "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or Amazon Resource Name\n (ARN) that's associated with the change set you want to execute.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name.\n You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.
A unique identifier for this ExecuteChangeSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to execute a\n change set to update a stack with the same name. You might retry ExecuteChangeSet\n requests to ensure that CloudFormation successfully received them.
Preserves the state of previously provisioned resources when an operation fails. This parameter can't be\n specified when the OnStackFailure parameter to the CreateChangeSet API operation was\n specified.
\n True - if the stack creation fails, do nothing. This is equivalent to specifying\n DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.
\n False - if the stack creation fails, roll back the stack. This is equivalent to specifying\n ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.
Default: True\n
Preserves the state of previously provisioned resources when an operation fails. This\n parameter can't be specified when the OnStackFailure parameter to the CreateChangeSet API operation was specified.
\n True - if the stack creation fails, do nothing. This is equivalent to\n specifying DO_NOTHING for the OnStackFailure parameter to the\n CreateChangeSet API operation.
\n False - if the stack creation fails, roll back the stack. This is\n equivalent to specifying ROLLBACK for the OnStackFailure\n parameter to the CreateChangeSet API operation.
Default: True\n
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.
Default: false\n
The name of exported output value. Use this name and the Fn::ImportValue function to import the\n associated value into other stacks. The name is defined in the Export field in the associated stack's\n Outputs section.
The name of exported output value. Use this name and the Fn::ImportValue\n function to import the associated value into other stacks. The name is defined in the\n Export field in the associated stack's Outputs section.
The value of the exported output, such as a resource physical ID. This value is defined in the\n Export field in the associated stack's Outputs section.
The value of the exported output, such as a resource physical ID. This value is defined in\n the Export field in the associated stack's Outputs section.
Retrieves a generated template. If the template is in an InProgress or Pending status\n then the template returned will be the template when the template was last in a Complete status. If the\n template has not yet been in a Complete status then an empty template will be returned.
Retrieves a generated template. If the template is in an InProgress or\n Pending status then the template returned will be the template when the\n template was last in a Complete status. If the template has not yet been in a\n Complete status then an empty template will be returned.
The name or Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
The name or Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}.\n For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
The template body of the generated template, in the language specified by the Language\n parameter.
The template body of the generated template, in the language specified by the\n Language parameter.
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is\n returned.
" + "smithy.api#documentation": "Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null\n value is returned.
" } }, "com.amazonaws.cloudformation#GetStackPolicyInput": { @@ -6517,7 +6517,7 @@ "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or unique stack ID that's associated with the stack whose policy you want to get.
", + "smithy.api#documentation": "The name or unique stack ID that's associated with the stack whose policy you want to\n get.
", "smithy.api#required": {} } } @@ -6533,7 +6533,7 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide.)
" + "smithy.api#documentation": "Structure containing the stack policy body. (For more information, see Prevent updates to stack resources in the\n CloudFormation User Guide.)
" } } }, @@ -6556,7 +6556,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the template body for a specified stack. You can get the template for running or deleted stacks.
\nFor deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been\n deleted.
If the template doesn't exist, a ValidationError is returned.
Returns the template body for a specified stack. You can get the template for running or\n deleted stacks.
\nFor deleted stacks, GetTemplate returns the template for up to 90 days after\n the stack has been deleted.
If the template doesn't exist, a ValidationError is returned.
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "The name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template. If\n you specify a name, you must also specify the StackName.
The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the\n associated template. If you specify a name, you must also specify the\n StackName.
For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original. To get the template after CloudFormation has processed all\n transforms, specify Processed.
If the template doesn't include transforms, Original and Processed return the same\n template. By default, CloudFormation specifies Processed.
For templates that include transforms, the stage of the template that CloudFormation returns.\n To get the user-submitted template, specify Original. To get the template after\n CloudFormation has processed all transforms, specify Processed.
If the template doesn't include transforms, Original and\n Processed return the same template. By default, CloudFormation specifies\n Processed.
Structure containing the template body. (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nCloudFormation returns the same template that was used when the stack was created.
" + "smithy.api#documentation": "Structure containing the template body.
\nCloudFormation returns the same template that was used when the stack was created.
" } }, "StagesAvailable": { "target": "com.amazonaws.cloudformation#StageList", "traits": { - "smithy.api#documentation": "The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the Original template is always\n available. After CloudFormation finishes creating the change set, the Processed template becomes\n available.
The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the\n Original template is always available. After CloudFormation finishes creating the\n change set, the Processed template becomes available.
Returns information about a new or existing template. The GetTemplateSummary action is useful for\n viewing parameter information, such as default parameter values and parameter types, before you create or update a\n stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you can get template\n information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the\n stack has been deleted. If the template doesn't exist, a ValidationError is returned.
Returns information about a new or existing template. The GetTemplateSummary\n action is useful for viewing parameter information, such as default parameter values and\n parameter types, before you create or update a stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you\n can get template information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for\n up to 90 days after the stack has been deleted. If the template doesn't exist, a\n ValidationError is returned.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.
\nConditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with\n https://.
Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location\n for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or the stack ID that's associated with the stack, which aren't always\n interchangeable. For running stacks, you can specify either the stack's name or its unique\n stack ID. For deleted stack, you must specify the unique stack ID.
\nConditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nA list of parameter declarations that describe various properties for each parameter.
" + "smithy.api#documentation": "A list of parameter declarations that describe various properties for each\n parameter.
" } }, "Description": { @@ -6687,25 +6687,25 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you must specify the\n 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\n an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
" + "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you\n must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for\n this parameter when you use the CreateStack or UpdateStack\n actions with your template; otherwise, those actions return an\n InsufficientCapabilities error.
For more information, see Acknowledging IAM resources in CloudFormation templates.
" } }, "CapabilitiesReason": { "target": "com.amazonaws.cloudformation#CapabilitiesReason", "traits": { - "smithy.api#documentation": "The list of resources that generated the values in the Capabilities response element.
The list of resources that generated the values in the Capabilities response\n element.
A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and\n Custom::MyCustomInstance.
The Amazon Web Services template format version, which identifies the capabilities of the template.
" + "smithy.api#documentation": "The Amazon Web Services template format version, which identifies the capabilities of the\n template.
" } }, "Metadata": { @@ -6723,7 +6723,7 @@ "ResourceIdentifierSummaries": { "target": "com.amazonaws.cloudformation#ResourceIdentifierSummaries", "traits": { - "smithy.api#documentation": "A list of resource identifier summaries that describe the target resources of an import operation and the\n properties you can provide during the import to identify the target resources. For example, BucketName\n is a possible identifier property for an AWS::S3::Bucket resource.
A list of resource identifier summaries that describe the target resources of an import\n operation and the properties you can provide during the import to identify the target\n resources. For example, BucketName is a possible identifier property for an\n AWS::S3::Bucket resource.
Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a\n new stack set in the same account as the source stack or in a different administrator account and Region, by\n specifying the stack ID of the stack you intend to import.
" + "smithy.api#documentation": "Import existing stacks into a new stack sets. Use the stack import operation to import up\n to 10 stacks into a new stack set in the same account as the source stack or in a different\n administrator account and Region, by specifying the stack ID of the stack you intend to\n import.
" } }, "com.amazonaws.cloudformation#ImportStacksToStackSetInput": { @@ -7059,14 +7059,14 @@ "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack set. The name must be unique in the Region where you create your stack set.
", + "smithy.api#documentation": "The name of the stack set. The name must be unique in the Region where you create your\n stack set.
", "smithy.api#required": {} } }, "StackIds": { "target": "com.amazonaws.cloudformation#StackIdList", "traits": { - "smithy.api#documentation": "The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a\n time.
\nSpecify either StackIds or StackIdsUrl.
The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per\n stack set at a time.
\nSpecify either StackIds or StackIdsUrl.
The list of OU ID's to which the stacks being imported has to be mapped as deployment target.
" + "smithy.api#documentation": "The list of OU ID's to which the stacks being imported has to be mapped as deployment\n target.
" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" } }, "OperationId": { @@ -7097,7 +7097,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
For service managed stack sets, specify DELEGATED_ADMIN.
By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
For service managed stack sets, specify DELEGATED_ADMIN.
Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are\n in the CREATE_IN_PROGRESS or CREATE_PENDING state.
Returns the ID and status of each active change set for a stack. For example, CloudFormation\n lists change sets that are in the CREATE_IN_PROGRESS or\n CREATE_PENDING state.
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
", + "smithy.api#documentation": "The name or the Amazon Resource Name (ARN) of the stack for which you want to list change\n sets.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string (provided by the ListChangeSets response output) that identifies the next page of\n change sets that you want to retrieve.
" + "smithy.api#documentation": "A string (provided by the ListChangeSets response output) that\n identifies the next page of change sets that you want to retrieve.
" } } }, @@ -7326,13 +7326,13 @@ "Summaries": { "target": "com.amazonaws.cloudformation#ChangeSetSummaries", "traits": { - "smithy.api#documentation": "A list of ChangeSetSummary structures that provides the ID and status of each change set for the\n specified stack.
A list of ChangeSetSummary structures that provides the ID and status of each\n change set for the specified stack.
If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional\n page, this value is null.
If the output exceeds 1 MB, a string that identifies the next page of change sets. If\n there is no additional page, this value is null.
Lists all exported output values in the account and Region in which you call this action. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.
\nFor more information, see CloudFormation export stack output\n values.
", + "smithy.api#documentation": "Lists all exported output values in the account and Region in which you call this action.\n Use this action to see the exported output values that you can import into other stacks. To\n import values, use the \n Fn::ImportValue function.
\nFor more information, see Get exported outputs from a deployed CloudFormation stack.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7364,7 +7364,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string (provided by the ListExports response output) that identifies the next page of\n exported output values that you asked to retrieve.
" + "smithy.api#documentation": "A string (provided by the ListExports response output) that identifies\n the next page of exported output values that you asked to retrieve.
" } } }, @@ -7384,7 +7384,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is\n no additional page, this value is null.
" + "smithy.api#documentation": "If the output exceeds 100 exported output values, a string that identifies the next page\n of exports. If there is no additional page, this value is null.
" } } }, @@ -7422,7 +7422,7 @@ "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { - "smithy.api#documentation": " If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. By default the\n ListGeneratedTemplates API action will return at most 50 results in each response. The maximum value is\n 100.
If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. By default the ListGeneratedTemplates API action\n will return at most 50 results in each response. The maximum value is 100.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListGeneratedTemplates again and use that value for the\n NextToken parameter. If the request returns all results, NextToken is set to an empty\n string.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListGeneratedTemplates again\n and use that value for the NextToken parameter. If the request returns all\n results, NextToken is set to an empty string.
Lists all stacks that are importing an exported output value. To modify or remove an exported output value,\n first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
\nFor more information about importing an exported output value, see the Fn::ImportValue\n function.
", + "smithy.api#documentation": "Lists all stacks that are importing an exported output value. To modify or remove an\n exported output value, first use this action to see which stacks are using it. To see the\n exported output values in your account, see ListExports.
\nFor more information about importing an exported output value, see the Fn::ImportValue function.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7474,14 +7474,14 @@ "target": "com.amazonaws.cloudformation#ExportName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are importing this value.
", + "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are\n importing this value.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string (provided by the ListImports response output) that identifies the next page of stacks\n that are importing the specified exported output value.
" + "smithy.api#documentation": "A string (provided by the ListImports response output) that identifies\n the next page of stacks that are importing the specified exported output value.
" } } }, @@ -7501,7 +7501,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string that identifies the next page of exports. If there is no additional page, this value is null.
" + "smithy.api#documentation": "A string that identifies the next page of exports. If there is no additional page, this\n value is null.
" } } }, @@ -7526,7 +7526,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the related resources for a list of resources from a resource scan. The response indicates whether each\n returned resource is already managed by CloudFormation.
", + "smithy.api#documentation": "Lists the related resources for a list of resources from a resource scan. The response\n indicates whether each returned resource is already managed by CloudFormation.
", "smithy.api#examples": [ { "title": "To list resource scan related resources", @@ -7607,7 +7607,7 @@ "target": "com.amazonaws.cloudformation#ScannedResourceIdentifiers", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The list of resources for which you want to get the related resources. Up to 100 resources can be\n provided.
", + "smithy.api#documentation": "The list of resources for which you want to get the related resources. Up to 100 resources\n can be provided.
", "smithy.api#required": {} } }, @@ -7620,7 +7620,7 @@ "MaxResults": { "target": "com.amazonaws.cloudformation#BoxedMaxResults", "traits": { - "smithy.api#documentation": " If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. By default the\n ListResourceScanRelatedResources API action will return up to 100 results in each response. The maximum\n value is 100.
If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. By default the ListResourceScanRelatedResources API\n action will return up to 100 results in each response. The maximum value is 100.
List of up to MaxResults resources in the specified resource scan related to the specified\n resources.
List of up to MaxResults resources in the specified resource scan related to\n the specified resources.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListResourceScanRelatedResources again and use that value for the\n NextToken parameter. If the request returns all results, NextToken is set to an empty\n string.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call\n ListResourceScanRelatedResources again and use that value for the\n NextToken parameter. If the request returns all results, NextToken\n is set to an empty string.
Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type\n prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates\n whether each returned resource is already managed by CloudFormation.
", + "smithy.api#documentation": "Lists the resources from a resource scan. The results can be filtered by resource\n identifier, resource type prefix, tag key, and tag value. Only resources that match all\n specified filters are returned. The response indicates whether each returned resource is\n already managed by CloudFormation.
", "smithy.api#examples": [ { "title": "To list the resources in your resource scan", @@ -7744,13 +7744,13 @@ "ResourceIdentifier": { "target": "com.amazonaws.cloudformation#ResourceIdentifier", "traits": { - "smithy.api#documentation": "If specified, the returned resources will have the specified resource identifier (or one of them in the case\n where the resource has multiple identifiers).
" + "smithy.api#documentation": "If specified, the returned resources will have the specified resource identifier (or one\n of them in the case where the resource has multiple identifiers).
" } }, "ResourceTypePrefix": { "target": "com.amazonaws.cloudformation#ResourceTypePrefix", "traits": { - "smithy.api#documentation": "If specified, the returned resources will be of any of the resource types with the specified prefix.
" + "smithy.api#documentation": "If specified, the returned resources will be of any of the resource types with the\n specified prefix.
" } }, "TagKey": { @@ -7774,7 +7774,7 @@ "MaxResults": { "target": "com.amazonaws.cloudformation#ResourceScannerMaxResults", "traits": { - "smithy.api#documentation": " If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. By default the\n ListResourceScanResources API action will return at most 100 results in each response. The maximum value\n is 100.
If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. By default the ListResourceScanResources API action\n will return at most 100 results in each response. The maximum value is 100.
List of up to MaxResults resources in the specified resource scan that match all of the specified\n filters.
List of up to MaxResults resources in the specified resource scan that match\n all of the specified filters.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListResourceScanResources again and use that value for the\n NextToken parameter. If the request returns all results, NextToken is set to an empty\n string.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListResourceScanResources\n again and use that value for the NextToken parameter. If the request returns all\n results, NextToken is set to an empty string.
List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
", + "smithy.api#documentation": "List the resource scans from newest to oldest. By default it will return up to 10 resource\n scans.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7832,7 +7832,7 @@ "MaxResults": { "target": "com.amazonaws.cloudformation#ResourceScannerMaxResults", "traits": { - "smithy.api#documentation": " If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. The default value is 10.\n The maximum value is 100.
If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. The default value is 10. The maximum value is 100.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListResourceScans again and use that value for the NextToken\n parameter. If the request returns all results, NextToken is set to an empty string.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListResourceScans again and\n use that value for the NextToken parameter. If the request returns all results,\n NextToken is set to an empty string.
Returns drift information for resources in a stack instance.
\n\n ListStackInstanceResourceDrifts returns drift information for the most recent drift detection\n operation. If an operation is in progress, it may only return partial results.
Returns drift information for resources in a stack instance.
\n\n ListStackInstanceResourceDrifts returns drift information for the most\n recent drift detection operation. If an operation is in progress, it may only return partial\n results.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
If the previous paginated 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 of\n 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 response\n object's NextToken parameter is set to null.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The resource drift status of the stack instance.
\n\n DELETED: The resource differs from its expected template configuration in that the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected template values.
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The resource drift status of the stack instance.
\n\n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nA list of StackInstanceResourceDriftsSummary structures that contain information about the\n specified stack instances.
A list of StackInstanceResourceDriftsSummary structures that contain\n information about the specified stack instances.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
If the previous paginated 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 of\n 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 response\n object's NextToken parameter is set to null.
Returns summary information about stack instances that are associated with the specified stack set. You can\n filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that\n have a specific status.
", + "smithy.api#documentation": "Returns summary information about stack instances that are associated with the specified\n stack set. You can filter for stack instances that are associated with a specific\n Amazon Web Services account name or Region, or that have a specific status.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8004,13 +8004,13 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the previous request didn't return all the remaining results, the response's NextToken parameter\n value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign\n that token to the request 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.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nA list of StackInstanceSummary structures that contain information about the specified stack\n instances.
A list of StackInstanceSummary structures that contain information about the\n specified stack instances.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListStackInstances again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListStackInstances again and\n assign that token to the request object's NextToken parameter. If the request\n returns all results, NextToken is set to null.
Returns descriptions of all resources of the specified stack.
\nFor deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been\n deleted.
", + "smithy.api#documentation": "Returns descriptions of all resources of the specified stack.
\nFor deleted stacks, ListStackResources returns resource information for up to 90 days\n after the stack has been deleted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8086,14 +8086,14 @@ "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", + "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string that identifies the next page of stack resources that you want to retrieve.
" + "smithy.api#documentation": "A string that identifies the next page of stack resources that you want to\n retrieve.
" } } }, @@ -8114,7 +8114,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page\n exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB, a string that identifies the next page of stack resources. If\n no additional page exists, this value is null.
" } } }, @@ -8147,26 +8147,26 @@ "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or unique ID of the stack set that you want to get automatic deployment targets for.
", + "smithy.api#documentation": "The name or unique ID of the stack set that you want to get automatic deployment targets\n for.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string that identifies the next page of stack set deployment targets that you want to retrieve.
" + "smithy.api#documentation": "A string that identifies the next page of stack set deployment targets that you want to\n retrieve.
" } }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for StackSets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\nSpecifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nIf the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the NextToken parameter. If the\n request returns all results, NextToken is set to an empty string.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the\n NextToken parameter. If the request returns all results, NextToken\n is set to an empty string.
If the previous request didn't return all the remaining results, the response object's NextToken\n parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperationResults again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to 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.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nA list of StackSetOperationResultSummary structures that contain information about the specified\n operation results, for accounts and Amazon Web Services Regions that are included in the operation.
A list of StackSetOperationResultSummary structures that contain information\n about the specified operation results, for accounts and Amazon Web Services Regions that are included in the\n operation.
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
If the request doesn't return all results, NextToken is set to a token. To\n retrieve the next set of results, call ListOperationResults again and assign that\n token to the request object's NextToken parameter. If there are no remaining\n results, NextToken is set to null.
The name or unique ID of the stack set that you want to get operation summaries for.
", + "smithy.api#documentation": "The name or unique ID of the stack set that you want to get operation summaries\n for.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperations again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
If the previous paginated 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 of\n results, call ListStackSetOperations 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.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nA list of StackSetOperationSummary structures that contain summary information about operations for\n the specified stack set.
A list of StackSetOperationSummary structures that contain summary\n information about operations for the specified stack set.
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
If the request doesn't return all results, NextToken is set to a token. To\n retrieve the next set of results, call ListOperationResults again and assign that\n token to the request object's NextToken parameter. If there are no remaining\n results, NextToken is set to null.
Returns summary information about stack sets that are associated with the user.
\n[Self-managed permissions] If you set the CallAs parameter to SELF while signed in\n 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\n in to the organization's management account, ListStackSets returns all stack sets in the\n management account.
[Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN\n while signed in to your member account, ListStackSets returns all stack sets with service-managed\n permissions in the management account.
Returns summary information about stack sets that are associated with the user.
\n[Self-managed permissions] If you set the CallAs parameter to\n SELF while signed in to your Amazon Web Services account, ListStackSets\n returns all self-managed stack sets in your Amazon Web Services account.
[Service-managed permissions] If you set the CallAs parameter to\n SELF while signed in to the organization's management account,\n ListStackSets returns all stack sets in the management account.
[Service-managed permissions] If you set the CallAs parameter to\n DELEGATED_ADMIN while signed in to your member account,\n ListStackSets returns all stack sets with service-managed permissions in\n the management account.
If the previous paginated 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 results, call\n ListStackSets again and assign that token to the request object's NextToken parameter. If\n there are no remaining results, the previous response object's NextToken parameter is set to\n 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 of\n results, call ListStackSets again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous response\n object's NextToken parameter is set to null.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
[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.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the management account or as a delegated administrator in a member\n account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nA list of StackSetSummary structures that contain information about the user's stack sets.
A list of StackSetSummary structures that contain information about the\n user's stack sets.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all of the remaining results, NextToken is set\n to a token. To retrieve the next set of results, call ListStackInstances again\n and assign that token to the request object's NextToken parameter. If the request\n returns all results, NextToken is set to null.
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary\n information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter\n is specified, summary information for all stacks is returned (including existing stacks and stacks that have been\n deleted).
", + "smithy.api#documentation": "Returns the summary information for stacks whose status matches the specified\n StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days\n after the stack is deleted. If no StackStatusFilter is specified, summary information for all\n stacks is returned (including existing stacks and stacks that have been deleted).
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8464,7 +8464,7 @@ "StackStatusFilter": { "target": "com.amazonaws.cloudformation#StackStatusFilter", "traits": { - "smithy.api#documentation": "Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified\n status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.
Stack status to use as a filter. Specify one or more stack status codes to list only\n stacks with the specified status codes. For a complete list of stack status codes, see the\n StackStatus parameter of the Stack data type.
A list of StackSummary structures containing information about the specified stacks.
A list of StackSummary structures containing information about the specified\n stacks.
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page\n exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If\n no additional page exists, this value is null.
" } } }, @@ -8523,19 +8523,19 @@ "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
If the previous paginated 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 results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n 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\n object's NextToken parameter value is set to a token. To retrieve the next set of\n 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 response\n object's NextToken parameter is set to null.
A list of extension registration tokens.
\nUse DescribeTypeRegistration to return detailed information about a type registration\n request.
" + "smithy.api#documentation": "A list of extension registration tokens.
\nUse DescribeTypeRegistration to return detailed information about a type\n registration request.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call this action again and assign that token to the request object's NextToken\n parameter. If the request returns all results, NextToken is set to null.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call this action again and assign that token to\n the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
The kind of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The kind of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The Amazon Resource Name (ARN) of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension for which you want version summary\n information.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.
If the previous paginated 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 of\n 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 response\n object's NextToken parameter is set to null.
The deprecation status of the extension versions that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on\n its provisioning behavior and visibility scope.
\n DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.
The default is LIVE.
The deprecation status of the extension versions that you want to get summary information\n about.
\nValid values include:
\n\n LIVE: The extension version is registered and can be used in CloudFormation\n operations, dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension version has been deregistered and can no longer\n be used in CloudFormation operations.
The default is LIVE.
A list of TypeVersionSummary structures that contain information about the specified extension's\n versions.
A list of TypeVersionSummary structures that contain information about the\n specified extension's versions.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
If the request doesn't return all of the remaining results, NextToken is set\n to a token. To retrieve the next set of results, call this action again and assign that token\n to the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
Returns summary information about extension that have been registered with CloudFormation.
", + "smithy.api#documentation": "Returns summary information about extension that have been registered with\n CloudFormation.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -8704,19 +8704,19 @@ "Visibility": { "target": "com.amazonaws.cloudformation#Visibility", "traits": { - "smithy.api#documentation": "The scope at which the extensions are visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account and Region. This\n 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 activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
The default is PRIVATE.
The scope at which the extensions are visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account and\n 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 addition to\n third-party publishers.
The default is PRIVATE.
For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type\n during registration, based on the types of handlers in the schema handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during\n stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and\n must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and\n therefore can't actually be provisioned.
The default is FULLY_MUTABLE.
For resource types, the provisioning behavior of the resource type. CloudFormation determines\n the provisioning type during registration, based on the types of handlers in the schema\n handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process\n updates to the type during stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the\n type can't be updated and must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include create, read, and\n delete handlers, and therefore can't actually be provisioned.
The default is FULLY_MUTABLE.
The deprecation status of the extension that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension is registered for use in CloudFormation operations.
\n DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
The deprecation status of the extension that you want to get summary information\n about.
\nValid values include:
\n\n LIVE: The extension is registered for use in CloudFormation\n operations.
\n DEPRECATED: The extension has been deregistered and can no longer be used\n in CloudFormation operations.
Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For example, specifying\n AWS_TYPES for Category and PRIVATE for Visibility returns an\n empty list of types, but specifying PUBLIC for Visibility returns the desired list.
Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For\n example, specifying AWS_TYPES for Category and PRIVATE\n for Visibility returns an empty list of types, but specifying PUBLIC\n for Visibility returns the desired list.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
If the previous paginated 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 results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n 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\n object's NextToken parameter value is set to a token. To retrieve the next set of\n 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 response\n object's NextToken parameter is set to null.
A list of TypeSummary structures that contain information about the specified extensions.
A list of TypeSummary structures that contain information about the specified\n extensions.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call this action again and assign that token to the request object's NextToken\n parameter. If the request returns all results, NextToken is set to null.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call this action again and assign that token to\n the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log\n entries to CloudWatch Logs.
", "smithy.api#required": {} } }, @@ -8884,18 +8884,18 @@ "TypeHierarchy": { "target": "com.amazonaws.cloudformation#TypeHierarchy", "traits": { - "smithy.api#documentation": "A concatenated list of the module type or types containing the resource. Module types are listed starting with\n the inner-most nested module, and separated by /.
In the following example, the resource was created from a module of type\n AWS::First::Example::MODULE, that's nested inside a parent module of type\n AWS::Second::Example::MODULE.
\n AWS::First::Example::MODULE/AWS::Second::Example::MODULE\n
A concatenated list of the module type or types containing the resource. Module types are\n listed starting with the inner-most nested module, and separated by /.
In the following example, the resource was created from a module of type\n AWS::First::Example::MODULE, that's nested inside a parent module of type\n AWS::Second::Example::MODULE.
\n AWS::First::Example::MODULE/AWS::Second::Example::MODULE\n
A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed\n 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\n parent module, moduleB.
\n moduleA/moduleB\n
For more information, see Referencing resources in a module\n in the CloudFormation User Guide.
" + "smithy.api#documentation": "A concatenated list of the logical IDs of the module or modules containing the resource.\n Modules are listed starting with the inner-most nested module, and separated by\n /.
In the following example, the resource was created from a module, moduleA,\n that's nested inside a parent module, moduleB.
\n moduleA/moduleB\n
For more information, see Reference module resources in\n CloudFormation templates in the CloudFormation User Guide.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
\nFor more information about modules, see Using modules to encapsulate and reuse resource\n configurations in the CloudFormation User Guide.
" + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
\nFor more information about modules, see Create reusable resource configurations\n that can be included across templates with CloudFormation modules in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#MonitoringTimeInMinutes": { @@ -9249,7 +9249,7 @@ "ParameterKey": { "target": "com.amazonaws.cloudformation#ParameterKey", "traits": { - "smithy.api#documentation": "The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.
" + "smithy.api#documentation": "The key associated with the parameter. If you don't specify a key and value for a particular\n parameter, CloudFormation uses the default value that's specified in your template.
" } }, "ParameterValue": { @@ -9261,13 +9261,13 @@ "UsePreviousValue": { "target": "com.amazonaws.cloudformation#UsePreviousValue", "traits": { - "smithy.api#documentation": "During a stack update, use the existing parameter value that the stack is using for a given parameter key. If\n you specify true, do not specify a parameter value.
During a stack update, use the existing parameter value that the stack is using for a given\n parameter key. If you specify true, do not specify a parameter value.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for\n SSM\n parameter types in the template.
" + "smithy.api#documentation": "Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only\n for Systems Manager parameter types in the template. For more information, see Use\n CloudFormation-supplied parameter types in the CloudFormation User Guide.
" } } }, @@ -9286,7 +9286,7 @@ } }, "traits": { - "smithy.api#documentation": "A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be defined in\n the stack template, CloudFormation returns only the AllowedValues property.
A set of criteria that CloudFormation uses to validate parameter values. Although other\n constraints might be defined in the stack template, CloudFormation returns only the\n AllowedValues property.
Flag that indicates whether the parameter value is shown as plain text in logs and in the Amazon Web Services Management Console.
" + "smithy.api#documentation": "Flag that indicates whether the parameter value is shown as plain text in logs and in the\n Amazon Web Services Management Console.
" } }, "Description": { @@ -9410,7 +9410,7 @@ } }, "traits": { - "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in\n cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context\n key-value pair specifies a resource that contains the targeted resource.
" + "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough to\n uniquely identify that resource. Each context key-value pair specifies a resource that contains\n the targeted resource.
" } }, "com.amazonaws.cloudformation#PolicyAction": { @@ -9485,7 +9485,7 @@ "target": "com.amazonaws.cloudformation#PropertyValue", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The expected property value of the resource property, as defined in the stack template and any values specified\n as template parameters.
", + "smithy.api#documentation": "The expected property value of the resource property, as defined in the stack template and\n any values specified as template parameters.
", "smithy.api#required": {} } }, @@ -9501,13 +9501,13 @@ "target": "com.amazonaws.cloudformation#DifferenceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of property difference.
\n\n ADD: A value has been added to a resource property that's an array or list data type.
\n REMOVE: The property has been removed from the current resource configuration.
\n NOT_EQUAL: The current property value differs from its expected value (as defined in the stack\n template and any values specified as template parameters).
The type of property difference.
\n\n ADD: A value has been added to a resource property that's an array or list\n data type.
\n REMOVE: The property has been removed from the current resource\n configuration.
\n NOT_EQUAL: The current property value differs from its expected value (as\n defined in the stack template and any values specified as template parameters).
Information about a resource property whose actual value differs from its expected value, as defined in the\n stack template and any values specified as template parameters. These will be present only for resources whose\n StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
Information about a resource property whose actual value differs from its expected value, as\n defined in the stack template and any values specified as template parameters. These will be\n present only for resources whose StackResourceDriftStatus is MODIFIED.\n For more information, see Detect unmanaged\n configuration changes to stacks and resources with drift detection.
Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public\n extensions are available for use by all CloudFormation users. For more information about publishing extensions, see\n Publishing extensions to\n make them available for public use in the 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 extension in this\n Region. Public extensions are available for use by all CloudFormation users. For more information\n about publishing extensions, see Publishing extensions to\n make them available for public use in the\n CloudFormation Command Line Interface (CLI) User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more\n information, see RegisterPublisher.
", "smithy.api#idempotent": {} } }, @@ -9584,25 +9584,25 @@ "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { - "smithy.api#documentation": "The type of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The type 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 Type.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The name of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The name of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version number to your\n extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning 2.0.0.
\nIf you don't specify a version number, CloudFormation increments the version number by one minor version\n release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first\n version number to be 1.0.0.
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version\n number to your extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning\n 2.0.0.
\nIf you don't specify a version number, CloudFormation increments the version number by one\n minor version release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation\n automatically sets the first version number to be 1.0.0.
Reports progress of a resource handler to CloudFormation.
\nReserved for use by the CloudFormation CLI. Don't use this API\n in your code.
", + "smithy.api#documentation": "Reports progress of a resource handler to CloudFormation.
\nReserved for use by the CloudFormation\n CLI. Don't use this API in your code.
", "smithy.api#idempotent": {} } }, @@ -9702,7 +9702,7 @@ "target": "com.amazonaws.cloudformation#ClientToken", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
", + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", "smithy.api#required": {} } }, @@ -9710,38 +9710,38 @@ "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
", + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", "smithy.api#required": {} } }, "CurrentOperationStatus": { "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "StatusMessage": { "target": "com.amazonaws.cloudformation#StatusMessage", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "ErrorCode": { "target": "com.amazonaws.cloudformation#HandlerErrorCode", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "ResourceModel": { "target": "com.amazonaws.cloudformation#ResourceModel", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } } }, @@ -9802,7 +9802,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are\n available for use by all CloudFormation users. 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 Registering your account to publish CloudFormation 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.\n Public extensions are available for use by all CloudFormation users. This publisher ID applies to\n your account in all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see\n Prerequisite: Registering your account to publish CloudFormation extensions in the\n CloudFormation Command Line Interface (CLI) User Guide.
\n ", "smithy.api#idempotent": {} } }, @@ -9812,13 +9812,13 @@ "AcceptTermsAndConditions": { "target": "com.amazonaws.cloudformation#AcceptTermsAndConditions", "traits": { - "smithy.api#documentation": "Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and\n conditions in order to register to publish public extensions to the CloudFormation registry.
\nThe default is false.
Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must\n accept the terms and conditions in order to register to publish public extensions to the\n CloudFormation registry.
\nThe default is false.
If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for\n your connection to that account.
\nFor more information, see Registering your account\n to publish CloudFormation extensions in the CloudFormation CLI User Guide.
" + "smithy.api#documentation": "If you are using a Bitbucket or GitHub account for identity verification, the Amazon\n Resource Name (ARN) for your connection to that account.
\nFor more information, see Prerequisite: Registering your account to publish CloudFormation extensions in the\n CloudFormation Command Line Interface (CLI) User Guide.
" } } }, @@ -9854,7 +9854,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it available for use in\n 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, see Creating Resource\n Providers in the CloudFormation CLI User Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and\n per Region. Use DeregisterType to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
\nOnce you have registered a private extension in your account and Region, use SetTypeConfiguration to specify\n configuration properties for the extension. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
", + "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it\n 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, see\n Creating resource types using the CloudFormation CLI in the\n CloudFormation Command Line Interface (CLI) User 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\n to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using RegisterType, you\n can use DescribeTypeRegistration to monitor the progress of the registration\n request.
\nOnce 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 Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.
", "smithy.api#idempotent": {} } }, @@ -9871,7 +9871,7 @@ "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "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,\n MyCompany::Testing::MyTestHook.
\nThe following organization namespaces are reserved and can't be used in your 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, company_or_organization::service::type.
For modules, company_or_organization::service::type::MODULE.
For hooks, MyCompany::Testing::MyTestHook.
The following organization namespaces are reserved and can't be used in your extension\n 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 necessary files for the\n extension you want to register.
\nFor information about generating a schema handler package for the extension you want to register, see submit in the\n CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3 bucket. That's, the user needs\n to have GetObject permissions for\n the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3\n in the Identity and Access Management User 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 in\n the CloudFormation Command Line Interface (CLI) User Guide.
\nThe user registering the extension must be able to access the package in the S3 bucket.\n That's, the user needs to have GetObject permissions for the schema\n handler package. For more information, see Actions, Resources, and Condition Keys for\n Amazon S3 in the Identity and Access Management User 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 contain a trust relationship with the\n CloudFormation service principal (resources.cloudformation.amazonaws.com). For more information about adding\n trust relationships, see Modifying a\n 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 an \n IAM execution role\n that includes\n the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account.\n When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary\n session token, which it then passes to the resource type handler, thereby supplying your resource type with the\n appropriate credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking\n the extension.
\nFor CloudFormation to assume the specified execution role, the role must contain a trust\n relationship with the CloudFormation service principal\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 an\n \n IAM\n execution role\n that includes the necessary permissions to call those\n Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke\n the resource type handler, CloudFormation assumes this execution role to create a temporary\n session token, which it then passes to the resource type handler, thereby supplying your\n resource type with the appropriate credentials.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#RequestToken", "traits": { - "smithy.api#documentation": "A unique identifier that acts as an idempotency key for this registration request. Specifying a client request\n token prevents CloudFormation from generating more than one version of an extension from the same registration request,\n even if the request is submitted multiple times.
" + "smithy.api#documentation": "A unique identifier that acts as an idempotency key for this registration request.\n Specifying a client request token prevents CloudFormation from generating more than one version of\n an extension from the same registration request, even if the request is submitted multiple\n times.
" } } }, @@ -9912,7 +9912,7 @@ "RegistrationToken": { "target": "com.amazonaws.cloudformation#RegistrationToken", "traits": { - "smithy.api#documentation": "The identifier for this registration request.
\nUse this registration token when calling DescribeTypeRegistration, which returns information\n about the status and IDs of the extension registration.
" + "smithy.api#documentation": "The identifier for this registration request.
\nUse this registration token when calling DescribeTypeRegistration, which\n returns information about the status and IDs of the extension registration.
" } } }, @@ -10027,13 +10027,13 @@ "TypeNameAlias": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "An alias assigned to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the\n alias to refer to the extension in your templates, API calls, and CloudFormation console.
" + "smithy.api#documentation": "An alias assigned to the public extension, in this account and Region. If you specify an\n alias for the extension, CloudFormation treats the alias as the extension type name within this\n account and Region. You must use the alias to refer to the extension in your templates, API\n calls, and CloudFormation console.
" } }, "OriginalTypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The type name of the public extension.
\nIf 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\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
The type name of the public extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account\n and Region, CloudFormation treats that alias as the extension's type name within the account and\n Region, not the type name of the public extension. For more information, see Use\n aliases to refer to extensions in the CloudFormation User Guide.
For extensions that are modules, a public third-party extension that must be activated in your account in order\n for the module itself to be activated.
\nFor more information, see Activating public modules for use in your\n account in the CloudFormation User Guide.
" + "smithy.api#documentation": "For extensions that are modules, a public third-party extension that must be activated in\n your account in order for the module itself to be activated.
\nFor more information, see Requirements for activating third-party public modules in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#RequiredActivatedTypes": { @@ -10138,13 +10138,13 @@ "PolicyAction": { "target": "com.amazonaws.cloudformation#PolicyAction", "traits": { - "smithy.api#documentation": "The action that will be taken on the physical resource when the change set is executed.
\n\n Delete The resource will be deleted.
\n Retain The resource will be retained.
\n Snapshot The resource will have a snapshot taken.
\n ReplaceAndDelete The resource will be replaced and then deleted.
\n ReplaceAndRetain The resource will be replaced and then retained.
\n ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.
The action that will be taken on the physical resource when the change set is\n executed.
\n\n Delete The resource will be deleted.
\n Retain The resource will be retained.
\n Snapshot The resource will have a snapshot taken.
\n ReplaceAndDelete The resource will be replaced and then deleted.
\n ReplaceAndRetain The resource will be replaced and then retained.
\n ReplaceAndSnapshot The resource will be replaced and then have a snapshot\n taken.
The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify\n (changes a resource), Remove (deletes a resource), Import (imports a resource), or\n Dynamic (exact action for the resource can't be determined).
The action that CloudFormation takes on the resource, such as Add (adds a new\n resource), Modify (changes a resource), Remove (deletes a resource),\n Import (imports a resource), or Dynamic (exact action for the resource\n can't be determined).
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they\n haven't been created.
" + "smithy.api#documentation": "The resource's physical ID (resource name). Resources that you are adding don't have\n physical IDs because they haven't been created.
" } }, "ResourceType": { @@ -10168,19 +10168,19 @@ "Replacement": { "target": "com.amazonaws.cloudformation#Replacement", "traits": { - "smithy.api#documentation": "For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and\n deleting the old one. This value depends on the value of the RequiresRecreation property in the\n ResourceTargetDefinition structure. For example, if the RequiresRecreation field is\n Always and the Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always and the\n Evaluation field is Dynamic, Replacement is Conditionally.
If you have multiple changes with different RequiresRecreation values, the Replacement\n value depends on the change with the most impact. A RequiresRecreation value of Always has\n the most impact, followed by Conditionally, and then Never.
For the Modify action, indicates whether CloudFormation will replace the resource\n by creating a new one and deleting the old one. This value depends on the value of the\n RequiresRecreation property in the ResourceTargetDefinition structure.\n For example, if the RequiresRecreation field is Always and the\n Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always and the\n Evaluation field is Dynamic, Replacement is\n Conditional.
If you have multiple changes with different RequiresRecreation values, the\n Replacement value depends on the change with the most impact. A\n RequiresRecreation value of Always has the most impact, followed by\n Conditional, and then Never.
For the Modify action, indicates which resource attribute is triggering this update, such as a\n change in the resource attribute's Metadata, Properties, or Tags.
For the Modify action, indicates which resource attribute is triggering this\n update, such as a change in the resource attribute's Metadata,\n Properties, or Tags.
For the Modify action, a list of ResourceChangeDetail structures that describes the\n changes that CloudFormation will make to the resource.
For the Modify action, a list of ResourceChangeDetail structures\n that describes the changes that CloudFormation will make to the resource.
Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
" } }, "BeforeContext": { "target": "com.amazonaws.cloudformation#BeforeContext", "traits": { - "smithy.api#documentation": "An encoded JSON string containing the context of the resource before the change is executed.
" + "smithy.api#documentation": "An encoded JSON string containing the context of the resource before the change is\n executed.
" } }, "AfterContext": { "target": "com.amazonaws.cloudformation#AfterContext", "traits": { - "smithy.api#documentation": "An encoded JSON string containing the context of the resource after the change is executed.
" + "smithy.api#documentation": "An encoded JSON string containing the context of the resource after the change is\n executed.
" } } }, "traits": { - "smithy.api#documentation": "The ResourceChange structure describes the resource and the action that CloudFormation will perform on it if\n you execute this change set.
The ResourceChange structure describes the resource and the action that\n CloudFormation will perform on it if you execute this change set.
A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether\n the resource will be recreated.
A ResourceTargetDefinition structure that describes the field that CloudFormation\n will change and whether the resource will be recreated.
Indicates whether CloudFormation can determine the target value, and whether the target value will change before you\n execute a change set.
\nFor Static evaluations, CloudFormation can determine that the target value will change, and its value. For\n example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows\n that this property value will change, and its value, so this is a Static evaluation.
For Dynamic evaluations, can't determine the target value because it depends on the result of an\n intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is\n updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the\n resource is recreated, it will have a new physical ID, so all references to that resource will also be\n updated.
Indicates whether CloudFormation can determine the target value, and whether the target value\n will change before you execute a change set.
\nFor Static evaluations, CloudFormation can determine that the target value will\n change, and its value. For example, if you directly modify the InstanceType property\n of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this\n is a Static evaluation.
For Dynamic evaluations, can't determine the target value because it depends on\n the result of an intrinsic function, such as a Ref or Fn::GetAtt\n intrinsic function, when the stack is updated. For example, if your template includes a reference\n to a resource that's conditionally recreated, the value of the reference (the physical ID of the\n resource) might change, depending on if the resource is recreated. If the resource is recreated,\n it will have a new physical ID, so all references to that resource will also be updated.
The group to which the CausingEntity value belongs. There are five entity groups:
\n ResourceReference entities are Ref intrinsic functions that refer to resources in\n the template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.
\n ParameterReference entities are Ref intrinsic functions that get template parameter\n values, such as { \"Ref\" : \"MyPasswordParameter\" }.
\n ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource\n attribute values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.
\n DirectModification entities are changes that are made directly to the template.
\n Automatic entities are AWS::CloudFormation::Stack resource types, which are also\n known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to Automatic because the nested stack's template might\n have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the parent\n stack.
The group to which the CausingEntity value belongs. There are five entity\n groups:
\n ResourceReference entities are Ref intrinsic functions that refer to\n resources in the template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.
\n ParameterReference entities are Ref intrinsic functions that get\n template parameter values, such as { \"Ref\" : \"MyPasswordParameter\" }.
\n ResourceAttribute entities are Fn::GetAtt intrinsic functions that\n get resource attribute values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\",\n \"PublicDnsName\" ] }.
\n DirectModification entities are changes that are made directly to the\n template.
\n Automatic entities are AWS::CloudFormation::Stack resource types,\n which are also known as nested stacks. If you made no changes to the\n AWS::CloudFormation::Stack resource, CloudFormation sets the\n ChangeSource to Automatic because the nested stack's template might\n have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run\n an update on the parent stack.
The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource field. For example, if you modified the value of the KeyPairName\n parameter, the CausingEntity is the name of the parameter (KeyPairName).
If the ChangeSource value is DirectModification, no value is given for\n CausingEntity.
The identity of the entity that triggered this change. This entity is a member of the group\n that's specified by the ChangeSource field. For example, if you modified the value\n of the KeyPairName parameter, the CausingEntity is the name of the\n parameter (KeyPairName).
If the ChangeSource value is DirectModification, no value is given\n for CausingEntity.
For a resource with Modify as the action, the ResourceChange structure describes the\n changes CloudFormation will make to that resource.
For a resource with Modify as the action, the ResourceChange\n structure describes the changes CloudFormation will make to that resource.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types in the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection in the\n CloudFormation User Guide\n
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair\n could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the\n name of one of the primary identifiers for the resource. (Primary identifiers are specified in\n the primaryIdentifier list in the resource schema.) The value is the value of that\n primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary\n identifiers is TableName so the key-value pair could be \"TableName\":\n \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
A resource included in a generated template. This data type is used with the\n CreateGeneratedTemplate and UpdateGeneratedTemplate API actions.
A resource included in a generated template. This data type is used with the\n CreateGeneratedTemplate and UpdateGeneratedTemplate API\n actions.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection In the\n CloudFormation User Guide\n
A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name\n of one of the primary identifiers for the resource. (Primary identifiers are specified in the\n primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For\n example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the\n key-value pair could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.
A list of up to 256 key-value pairs that identifies the resource in the generated template.\n The key is the name of one of the primary identifiers for the resource. (Primary identifiers are\n specified in the primaryIdentifier list in the resource schema.) The value is the\n value of that primary identifier. For example, for a AWS::DynamoDB::Table resource,\n the primary identifiers is TableName so the key-value pair could be\n \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
Status of the processing of a resource in a generated template.
\nThe resource processing is still in progress.
\nThe resource processing is complete.
\nThe resource processing is pending.
\nThe resource processing has failed.
\nStatus of the processing of a resource in a generated template.
\nThe resource processing is still in progress.
\nThe resource processing is complete.
\nThe resource processing is pending.
\nThe resource processing has failed.
\nThe template resource type of the target resources, such as AWS::S3::Bucket.
The template resource type of the target resources, such as\n AWS::S3::Bucket.
The logical IDs of the target resources of the specified ResourceType, as defined in the import\n template.
The logical IDs of the target resources of the specified ResourceType, as\n defined in the import template.
The resource properties you can provide during the import to identify your target resources. For example,\n BucketName is a possible identifier property for AWS::S3::Bucket resources.
The resource properties you can provide during the import to identify your target\n resources. For example, BucketName is a possible identifier property for\n AWS::S3::Bucket resources.
Describes the target resources of a specific type in your import template (for example, all\n AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources of\n that type.
Describes the target resources of a specific type in your import template (for example,\n all AWS::S3::Bucket resources) and the properties you can provide during the\n import to identify resources of that type.
Status of the resource scan.
\nThe resource scan is still in progress.
\nThe resource scan is complete.
\nThe resource scan has expired.
\nThe resource scan has failed.
\nStatus of the resource scan.
\nThe resource scan is still in progress.
\nThe resource scan is complete.
\nThe resource scan has expired.
\nThe resource scan has failed.
\nThe reason for the resource scan status, providing more information if a failure happened.
" + "smithy.api#documentation": "The reason for the resource scan status, providing more information if a failure\n happened.
" } }, "StartTime": { @@ -10570,7 +10570,7 @@ } }, "traits": { - "smithy.api#documentation": "A summary of the resource scan. This is returned by the ListResourceScan API action.
A summary of the resource scan. This is returned by the ListResourceScan API\n action.
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's\n Metadata, Properties, or Tags.
Indicates which resource attribute is triggering this update, such as a change in the\n resource attribute's Metadata, Properties, or Tags.
If the Attribute value is Properties, the name of the property. For all other\n attributes, the value is null.
If the Attribute value is Properties, the name of the property.\n For all other attributes, the value is null.
If the Attribute value is Properties, indicates whether a change to this property\n causes the resource to be recreated. The value can be Never, Always, or\n Conditionally. To determine the conditions for a Conditionally recreation, see the update\n behavior for that property in the\n CloudFormation User Guide.
If the Attribute value is Properties, indicates whether a change\n to this property causes the resource to be recreated. The value can be Never,\n Always, or Conditionally. To determine the conditions for a\n Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.
The value of the property before the change is executed. Large values can be truncated.
" + "smithy.api#documentation": "The value of the property before the change is executed. Large values can be\n truncated.
" } }, "AfterValue": { "target": "com.amazonaws.cloudformation#AfterValue", "traits": { - "smithy.api#documentation": "The value of the property after the change is executed. Large values can be truncated.
" + "smithy.api#documentation": "The value of the property after the change is executed. Large values can be\n truncated.
" } }, "AttributeChangeType": { @@ -10789,7 +10789,7 @@ } }, "traits": { - "smithy.api#documentation": "The field that CloudFormation will change, such as the name of a resource's property, and whether the resource will be\n recreated.
" + "smithy.api#documentation": "The field that CloudFormation will change, such as the name of a resource's property, and\n whether the resource will be recreated.
" } }, "com.amazonaws.cloudformation#ResourceToImport": { @@ -10799,7 +10799,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported\n resource types, see Resources that support import\n operations in the CloudFormation User Guide.
The type of resource to import into your stack, such as AWS::S3::Bucket. For a\n list of supported resource types, see Resource type\n support for imports and drift detection in the\n CloudFormation User Guide.
A key-value pair that identifies the target resource. The key is an identifier property (for example,\n BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for\n example, MyS3Bucket).
A key-value pair that identifies the target resource. The key is an identifier property (for\n example, BucketName for AWS::S3::Bucket resources) and the value is the\n actual property value (for example, MyS3Bucket).
The triggers to monitor during stack creation or update actions.
\nBy default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update\n operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those\n triggers replace any list of triggers previously specified for the stack. This means:
\nTo use the rollback triggers previously specified for this stack, if any, don't specify this parameter.
\nTo specify new or updated rollback triggers, you must specify all the triggers that you\n want used for this stack, even triggers you've specified before (for example, when creating the stack or during a\n previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied\n to the stack.
\nTo remove all currently specified triggers, specify an empty list for this parameter.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled back.
" + "smithy.api#documentation": "The triggers to monitor during stack creation or update actions.
\nBy default, CloudFormation saves the rollback triggers specified for a stack and applies them to\n any subsequent update operations for the stack, unless you specify otherwise. If you do specify\n rollback triggers for this parameter, those triggers replace any list of triggers previously\n specified for the stack. This means:
\nTo use the rollback triggers previously specified for this stack, if any, don't specify\n this parameter.
\nTo specify new or updated rollback triggers, you must specify all the\n triggers that you want used for this stack, even triggers you've specified before (for example,\n when creating the stack or during a previous stack update). Any triggers that you don't include\n in the updated list of triggers are no longer applied to the stack.
\nTo remove all currently specified triggers, specify an empty list for this\n parameter.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled\n back.
" } }, "MonitoringTimeInMinutes": { "target": "com.amazonaws.cloudformation#MonitoringTimeInMinutes", "traits": { - "smithy.api#documentation": "The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack\n creation or update operation deploys all necessary resources.
\nThe default is 0 minutes.
\nIf you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified\n period of time before cleaning up old resources after update operations. You can use this monitoring period to\n perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
\nIf you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack\n creation and update operations. Then, for update operations, it begins disposing of old resources immediately once\n the operation completes.
" + "smithy.api#documentation": "The amount of time, in minutes, during which CloudFormation should monitor all the rollback\n triggers after the stack creation or update operation deploys all necessary resources.
\nThe default is 0 minutes.
\nIf you specify a monitoring period but don't specify any rollback triggers, CloudFormation still\n waits the specified period of time before cleaning up old resources after update operations. You\n can use this monitoring period to perform any manual stack validation desired, and manually\n cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
\nIf you specify 0 for this parameter, CloudFormation still monitors the specified rollback\n triggers during stack creation and update operations. Then, for update operations, it begins\n disposing of old resources immediately once the operation completes.
" } } }, "traits": { - "smithy.api#documentation": "Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations,\n and for the specified monitoring period afterwards.
\nRollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and\n updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've\n specified. For more information, see Monitor and Roll Back Stack\n Operations.
" + "smithy.api#documentation": "Structure containing the rollback triggers for CloudFormation to monitor during stack creation\n and updating operations, and for the specified monitoring period afterwards.
\nRollback triggers enable you to have CloudFormation monitor the state of your application during\n stack creation and updating, and to roll back that operation if the application breaches the\n threshold of any of the alarms you've specified. For more information, see Roll back your CloudFormation stack on alarm breach with rollback triggers.
" } }, "com.amazonaws.cloudformation#RollbackStack": { @@ -10975,7 +10975,7 @@ } ], "traits": { - "smithy.api#documentation": "When specifying RollbackStack, you preserve the state of previously provisioned resources when an\n 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\n 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\n includes any status in a *_COMPLETE. This includes the following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
When specifying RollbackStack, you preserve the state of previously\n provisioned resources when an operation fails. You can check the status of the stack through\n the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from\n 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\n known stable state includes any status in a *_COMPLETE. This includes the\n following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the\n stack.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the\n stack.
" } }, "ClientRequestToken": { @@ -11004,7 +11004,7 @@ "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.
Default: false\n
The Amazon Resource Name (ARN) of the rollback trigger.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled back.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rollback trigger.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled\n back.
", "smithy.api#required": {} } }, @@ -11041,13 +11041,13 @@ "target": "com.amazonaws.cloudformation#Type", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
", + "smithy.api#documentation": "The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes\n to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.
" + "smithy.api#documentation": "A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the\n alarms you specify goes to ALARM state during the stack operation or within the specified\n monitoring period afterwards, CloudFormation rolls back the entire stack operation.
" } }, "com.amazonaws.cloudformation#RollbackTriggers": { @@ -11087,13 +11087,13 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n Resource type support In the CloudFormation User Guide\n
The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection In the\n CloudFormation User Guide\n
A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair\n could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.
A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the\n name of one of the primary identifiers for the resource. (Primary identifiers are specified in\n the primaryIdentifier list in the resource schema.) The value is the value of that\n primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary\n identifiers is TableName so the key-value pair could be \"TableName\":\n \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
A scanned resource returned by ListResourceScanResources or\n ListResourceScanRelatedResources.
A scanned resource returned by ListResourceScanResources or\n ListResourceScanRelatedResources.
The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide.
The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection In the\n CloudFormation User Guide.
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair\n could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the\n name of one of the primary identifiers for the resource. (Primary identifiers are specified in\n the primaryIdentifier list in the resource schema.) The value is the value of that\n primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary\n identifiers is TableName so the key-value pair could be \"TableName\":\n \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
Identifies a scanned resource. This is used with the ListResourceScanRelatedResources API\n action.
Identifies a scanned resource. This is used with the\n ListResourceScanRelatedResources API action.
Structure containing the stack policy body. For more information, go to Prevent updates to stack resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Structure containing the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for an Amazon S3 bucket must\n start with https://. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum\n size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for\n an Amazon S3 bucket must start with https://. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.
Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
\nTo view the current configuration data for an extension, refer to the ConfigurationSchema element\n of DescribeType. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such\n as third-party credentials. For more details on dynamic references, see Using\n dynamic references to specify template values in the CloudFormation User Guide.
\nSpecifies the configuration data for a registered CloudFormation extension, in the given\n account and Region.
\nTo view the current configuration data for an extension, refer to the\n ConfigurationSchema element of DescribeType. For\n more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive\n configuration definitions, such as third-party credentials. For more details on dynamic\n references, see Specify values stored in\n other services using dynamic references in the\n CloudFormation User Guide.
\nThe Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account\n and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account\n and Region.
\nDo not include the extension versions suffix at the end of the ARN. You can set the configuration for an\n extension, but not for a specific extension version.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.
\nDo not include the extension versions suffix at the end of the ARN. You can set the\n configuration for an extension, but not for a specific extension version.
" } }, "Configuration": { "target": "com.amazonaws.cloudformation#TypeConfiguration", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The configuration data for the extension, in this account and Region.
\nThe configuration data must be formatted as JSON, and validate against the schema returned in the\n ConfigurationSchema response element of DescribeType. For more information, see\n Defining\n account-level configuration data for an extension in the CloudFormation CLI User\n Guide.
The configuration data for the extension, in this account and Region.
\nThe configuration data must be formatted as JSON, and validate against the schema returned\n in the ConfigurationSchema response element of DescribeType. For\n more information, see Defining the account-level configuration of an extension in the\n CloudFormation Command Line Interface (CLI) User Guide.
An alias by which to refer to this extension configuration data.
\nConditional: Specifying a configuration alias is required when setting a configuration for a resource type\n extension.
" + "smithy.api#documentation": "An alias by which to refer to this extension configuration data.
\nConditional: Specifying a configuration alias is required when setting a configuration for\n a resource type extension.
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The name of the extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The name of the extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The type of extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The type of extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The Amazon Resource Name (ARN) for the configuration data, in this account and\n Region.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
", + "smithy.api#documentation": "Specify the default version of an extension. The default version of an extension will be\n used in CloudFormation operations.
", "smithy.api#idempotent": {} } }, @@ -11291,25 +11291,25 @@ "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension for which you want version summary\n information.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
" + "smithy.api#documentation": "The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
" } } }, @@ -11333,7 +11333,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't\n proceed with a stack creation or update until resources receive the required number of signals or the timeout period\n is exceeded. The SignalResource operation is useful in cases where you want to send signals from\n anywhere other than an Amazon EC2 instance.
Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update\n policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the\n required number of signals or the timeout period is exceeded. The SignalResource\n operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2\n instance.
The stack name or unique stack ID that includes the resource that you want to signal.
", + "smithy.api#documentation": "The stack name or unique stack ID that includes the resource that you want to\n signal.
", "smithy.api#required": {} } }, @@ -11351,7 +11351,7 @@ "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in\n the template.
", + "smithy.api#documentation": "The logical ID of the resource that you want to signal. The logical ID is the name of the\n resource that given in the template.
", "smithy.api#required": {} } }, @@ -11359,7 +11359,7 @@ "target": "com.amazonaws.cloudformation#ResourceSignalUniqueId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the\n instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as\n signaling a wait condition), each signal requires a different unique ID.
", + "smithy.api#documentation": "A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the\n instance ID that you are signaling as the unique ID. If you send multiple signals to a single\n resource (such as signaling a wait condition), each signal requires a different unique\n ID.
", "smithy.api#required": {} } }, @@ -11367,7 +11367,7 @@ "target": "com.amazonaws.cloudformation#ResourceSignalStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately\n fail the stack creation or update.
", + "smithy.api#documentation": "The status of the signal, which is either success or failure. A failure signal causes\n CloudFormation to immediately fail the stack creation or update.
", "smithy.api#required": {} } } @@ -11429,13 +11429,13 @@ "LastUpdatedTime": { "target": "com.amazonaws.cloudformation#LastUpdatedTime", "traits": { - "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.
" + "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has been\n updated at least once.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" } }, "StackStatus": { @@ -11485,7 +11485,7 @@ "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack.\n During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that's associated with the stack. During a\n stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
" } }, "Tags": { @@ -11497,43 +11497,43 @@ "EnableTerminationProtection": { "target": "com.amazonaws.cloudformation#EnableTerminationProtection", "traits": { - "smithy.api#documentation": "Whether termination protection is enabled for the stack.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.\n For more information, see Protecting a Stack From Being Deleted\n 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 Protect a CloudFormation\n stack from being deleted in the CloudFormation User Guide.
" } }, "ParentId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this\n stack. For the first level of nested stacks, the root stack is also the parent stack.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct\n parent of this stack. For the first level of nested stacks, the root stack is also the parent\n stack.
\nFor more information, see Embed stacks within other\n stacks using nested stacks in the CloudFormation User Guide.
" } }, "RootId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which\n the nested stack ultimately belongs.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.
\nFor more information, see Embed stacks within other\n stacks using nested stacks in the CloudFormation User Guide.
" } }, "DriftInformation": { "target": "com.amazonaws.cloudformation#StackDriftInformation", "traits": { - "smithy.api#documentation": "Information about whether a stack's actual configuration differs, or has drifted, from its\n expected configuration, as defined in the stack template and any values specified as template parameters. For more\n information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "smithy.api#documentation": "Information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.
" } }, "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation rolls\n back. This includes newly created resources marked with a deletion policy of\n Retain.
Default: false\n
Specifies the deletion mode for the stack. Possible values are:
\n\n STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this\n parameter.
\n FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to\n resource deletion failure.
Specifies the deletion mode for the stack. Possible values are:
\n\n STANDARD - Use the standard behavior. Specifying this value is the same as\n not specifying this parameter.
\n FORCE_DELETE_STACK - Delete the stack if it's stuck in a\n DELETE_FAILED state due to resource deletion failure.
The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or\n resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets\n CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more\n information, see CloudFormation stack deployment in\n the CloudFormation User Guide.
The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is\n present, the resource or resource configuration phase has completed and the stabilization of the\n resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the\n resources in the stack have reached that event. For more information, see Understand\n CloudFormation stack creation events in the CloudFormation User Guide.
Status of the stack's actual configuration compared to its expected template configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack's actual configuration compared to its expected template\n configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack\n is considered to have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected\n template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources\n that support drift detection.
" + "smithy.api#documentation": "Most recent time when a drift detection operation was initiated on the stack, or any of its\n individual resources that support drift detection.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. A stack is considered to have drifted if one or more of its resources have\n drifted.
" + "smithy.api#documentation": "Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. A stack is considered to have drifted if one or\n more of its resources have drifted.
" } }, "com.amazonaws.cloudformation#StackDriftInformationSummary": { @@ -11605,19 +11605,19 @@ "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected template configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack's actual configuration compared to its expected template\n configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack\n is considered to have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected\n template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources\n that support drift detection.
" + "smithy.api#documentation": "Most recent time when a drift detection operation was initiated on the stack, or any of its\n individual resources that support drift detection.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. A stack is considered to have drifted if one or more of its resources have\n drifted.
" + "smithy.api#documentation": "Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. A stack is considered to have drifted if one or\n more of its resources have drifted.
" } }, "com.amazonaws.cloudformation#StackDriftStatus": { @@ -11691,7 +11691,7 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
" + "smithy.api#documentation": "Type of resource. For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.
" } }, "Timestamp": { @@ -11723,7 +11723,7 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "The token passed to the operation that generated this event.
\nAll events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
The token passed to the operation that generated this event.
\nAll events triggered by a given stack operation are assigned the same client request token,\n which you can use to track operations. For example, if you execute a CreateStack\n operation with the token token1, then all the StackEvents generated by\n that operation will have ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
An optional field containing information about the detailed status of the stack event.
\n\n CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more\n information, see CloudFormation stack deployment\n in the CloudFormation User Guide.
\n VALIDATION_FAILED - template validation failed because of invalid properties in the template. The\n ResourceStatusReason field shows what properties are defined incorrectly.
An optional field containing information about the detailed status of the stack\n event.
\n\n CONFIGURATION_COMPLETE - all of the resources in the stack have reached that\n event. For more information, see Understand\n CloudFormation stack creation events in the CloudFormation User Guide.
\n VALIDATION_FAILED - template validation failed because of invalid properties\n in the template. The ResourceStatusReason field shows what properties are defined\n incorrectly.
An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a\n reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist\n without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with\n only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the\n actual stack and the stack status.
" + "smithy.api#documentation": "A CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a\n reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist\n without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with\n only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the\n actual stack and the stack status.
" } }, "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus": { @@ -12062,7 +12062,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", + "smithy.api#documentation": "Type of resource. For more information, see Amazon Web Services resource and \n property types reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, @@ -12287,14 +12287,14 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", + "smithy.api#documentation": "Type of resource. For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, @@ -12329,13 +12329,13 @@ "DriftInformation": { "target": "com.amazonaws.cloudformation#StackResourceDriftInformation", "traits": { - "smithy.api#documentation": "Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "smithy.api#documentation": "Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.
" } }, "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { - "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
" } } }, @@ -12369,14 +12369,14 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", + "smithy.api#documentation": "Type of resource. For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.
", "smithy.api#required": {} } }, @@ -12411,19 +12411,19 @@ "Metadata": { "target": "com.amazonaws.cloudformation#Metadata", "traits": { - "smithy.api#documentation": "The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute\n in the CloudFormation User Guide.
The content of the Metadata attribute declared for the resource. For more\n information, see Metadata attribute\n in the CloudFormation User Guide.
Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "smithy.api#documentation": "Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.
" } }, "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { - "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
" } } }, @@ -12453,13 +12453,13 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by\n CloudFormation.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" } }, "PhysicalResourceIdContext": { "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", "traits": { - "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in\n cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context\n key-value pair specifies a unique resource that contains the targeted resource.
" + "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough to\n uniquely identify that resource. Each context key-value pair specifies a unique resource that\n contains the targeted resource.
" } }, "ResourceType": { @@ -12473,26 +12473,26 @@ "ExpectedProperties": { "target": "com.amazonaws.cloudformation#Properties", "traits": { - "smithy.api#documentation": "A JSON structure containing the expected property values of the stack resource, as defined in the stack template\n and any values specified as template parameters.
\nFor resources whose StackResourceDriftStatus is DELETED, this structure will not be\n present.
A JSON structure containing the expected property values of the stack resource, as defined\n in the stack template and any values specified as template parameters.
\nFor resources whose StackResourceDriftStatus is DELETED, this\n structure will not be present.
A JSON structure containing the actual property values of the stack resource.
\nFor resources whose StackResourceDriftStatus is DELETED, this structure will not be\n present.
A JSON structure containing the actual property values of the stack resource.
\nFor resources whose StackResourceDriftStatus is DELETED, this\n structure will not be present.
A collection of the resource properties whose actual values differ from their expected values. These will be\n present only for resources whose StackResourceDriftStatus is\n MODIFIED.
A collection of the resource properties whose actual values differ from their expected\n values. These will be present only for resources whose StackResourceDriftStatus is\n MODIFIED.
Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected template configuration because the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected values (as defined in the\n stack template and any values specified as template parameters).
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation does not currently return this value.
Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected template configuration\n because the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected values\n (as defined in the stack template and any values specified as template parameters).
\n IN_SYNC: The resource's actual configuration matches its expected template\n configuration.
\n NOT_CHECKED: CloudFormation does not currently return this value.
Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
" } } }, "traits": { - "smithy.api#documentation": "Contains the drift information for a resource that has been checked for drift. This includes actual and expected\n property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the\n stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nResources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
" + "smithy.api#documentation": "Contains the drift information for a resource that has been checked for drift. This includes\n actual and expected property values for resources in which CloudFormation has detected drift. Only\n resource properties explicitly defined in the stack template are checked for drift. For more\n information, see Detect unmanaged\n configuration changes to stacks and resources with drift detection.
\nResources that don't currently support drift detection can't be checked. For a list of\n resources that support drift detection, see Resource type\n support for imports and drift detection.
\nUse DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all resources in a given stack that\n support drift detection.
" } }, "com.amazonaws.cloudformation#StackResourceDriftInformation": { @@ -12522,19 +12522,19 @@ "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected\n configuration.
Any resources that do not currently support drift detection have a status of NOT_CHECKED. For\n more information, see Resources that Support Drift\n Detection.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
Status of the resource's actual configuration compared to its expected configuration
\n\n DELETED: The resource differs from its expected configuration in that it has\n been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from its\n expected configuration.
Any resources that do not currently support drift detection have a status of\n NOT_CHECKED. For more information, see Resource\n type support for imports and drift detection.
\n IN_SYNC: The resource's actual configuration matches its expected\n configuration.
When CloudFormation last checked if the resource had drifted from its expected configuration.
" + "smithy.api#documentation": "When CloudFormation last checked if the resource had drifted from its expected\n configuration.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" + "smithy.api#documentation": "Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" } }, "com.amazonaws.cloudformation#StackResourceDriftInformationSummary": { @@ -12544,19 +12544,19 @@ "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.
Any resources that don't currently support drift detection have a status of NOT_CHECKED. For more\n information, see Resources that Support Drift\n Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources\n included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information\n about skipping resources during rollback operations, see Continue Rolling\n Back an Update in the CloudFormation User Guide.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected configuration in that it has\n been deleted.
\n MODIFIED: The resource differs from its expected 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 Resource\n type support for imports and 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. For more\n 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.
When CloudFormation last checked if the resource had drifted from its expected configuration.
" + "smithy.api#documentation": "When CloudFormation last checked if the resource had drifted from its expected\n configuration.
" } } }, "traits": { - "smithy.api#documentation": "Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" + "smithy.api#documentation": "Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" } }, "com.amazonaws.cloudformation#StackResourceDriftStatus": { @@ -12626,14 +12626,14 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of the resource.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of the\n resource.
" } }, "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
", + "smithy.api#documentation": "Type of resource. (For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.)
", "smithy.api#required": {} } }, @@ -12662,13 +12662,13 @@ "DriftInformation": { "target": "com.amazonaws.cloudformation#StackResourceDriftInformationSummary", "traits": { - "smithy.api#documentation": "Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "smithy.api#documentation": "Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.
" } }, "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { - "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.
" } } }, @@ -12724,7 +12724,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "The capabilities that are allowed in the stack set. Some stack set templates might include resources that can\n affect permissions in 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\n Templates.\n
" + "smithy.api#documentation": "The capabilities that are allowed in the stack set. Some stack set templates might include resources that can\n affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM resources in\n CloudFormation templates.
" } }, "Tags": { @@ -13005,7 +13005,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationStatus", "traits": { - "smithy.api#documentation": "The status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
The status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
Detailed information about the drift status of the stack set. This includes information about drift operations\n currently being performed on the stack set.
\nThis information will only be present for stack set operations whose Action type is\n DETECT_DRIFT.
For more information, see Detecting Unmanaged Changes in Stack Sets in\n the CloudFormation User Guide.
" + "smithy.api#documentation": "Detailed information about the drift status of the stack set. This includes information about drift operations\n currently being performed on the stack set.
\nThis information will only be present for stack set operations whose Action type is\n DETECT_DRIFT.
For more information, see Detect stack set drift in\n the CloudFormation User Guide.
" } }, "StatusReason": { @@ -13149,7 +13149,7 @@ } }, "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" } }, "com.amazonaws.cloudformation#StackSetOperationResultStatus": { @@ -13319,7 +13319,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationStatus", "traits": { - "smithy.api#documentation": "The overall status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
The overall status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" } } }, @@ -13634,7 +13634,7 @@ "LastUpdatedTime": { "target": "com.amazonaws.cloudformation#LastUpdatedTime", "traits": { - "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.
" + "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has been\n updated at least once.
" } }, "DeletionTime": { @@ -13660,19 +13660,19 @@ "ParentId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this\n stack. For the first level of nested stacks, the root stack is also the parent stack.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct\n parent of this stack. For the first level of nested stacks, the root stack is also the parent\n stack.
\nFor more information, see Embed stacks within other\n stacks using nested stacks in the CloudFormation User Guide.
" } }, "RootId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which\n the nested stack ultimately belongs.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.
\nFor more information, see Embed stacks within other\n stacks using nested stacks in the CloudFormation User Guide.
" } }, "DriftInformation": { "target": "com.amazonaws.cloudformation#StackDriftInformationSummary", "traits": { - "smithy.api#documentation": "Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
" + "smithy.api#documentation": "Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.
" } } }, @@ -13726,7 +13726,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a scan of the resources in this account in this Region. You can the status of a scan using the\n ListResourceScans API action.
Starts a scan of the resources in this account in this Region. You can the status of a\n scan using the ListResourceScans API action.
A unique identifier for this StartResourceScan request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to start a new resource scan.
A unique identifier for this StartResourceScan request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to start a new\n resource scan.
The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .
The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An\n example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n\n Required. A string used to identify this tag. You can specify a maximum of 128 characters\n for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix:\n aws:.
\n Required. A string used to identify this tag. You can specify a maximum of\n 128 characters for a tag key. Tags owned by Amazon Web Services have the reserved prefix:\n aws:.
\n Required. A string containing the value for this tag. You can specify a maximum of 256\n characters for a tag value.
", + "smithy.api#documentation": "\n Required. A string containing the value for this tag. You can specify a\n maximum of 256 characters for a tag value.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
" + "smithy.api#documentation": "The Tag type enables you to specify a key-value pair that can be used to store information\n about an CloudFormation stack.
" } }, "com.amazonaws.cloudformation#TagKey": { @@ -13918,13 +13918,13 @@ "DeletionPolicy": { "target": "com.amazonaws.cloudformation#GeneratedTemplateDeletionPolicy", "traits": { - "smithy.api#documentation": "The DeletionPolicy assigned to resources in the generated template. Supported values are:
\n DELETE - delete all resources when the stack is deleted.
\n RETAIN - retain all resources when the stack is deleted.
For more information, see DeletionPolicy attribute in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "The DeletionPolicy assigned to resources in the generated template. Supported\n values are:
\n DELETE - delete all resources when the stack is deleted.
\n RETAIN - retain all resources when the stack is deleted.
For more information, see DeletionPolicy\n attribute in the CloudFormation User Guide.
" } }, "UpdateReplacePolicy": { "target": "com.amazonaws.cloudformation#GeneratedTemplateUpdateReplacePolicy", "traits": { - "smithy.api#documentation": "The UpdateReplacePolicy assigned to resources in the generated template. Supported values\n are:
\n DELETE - delete all resources when the resource is replaced during an update operation.
\n RETAIN - retain all resources when the resource is replaced during an update operation.
For more information, see UpdateReplacePolicy\n attribute in the CloudFormation User Guide.
" + "smithy.api#documentation": "The UpdateReplacePolicy assigned to resources in the generated template.\n Supported values are:
\n DELETE - delete all resources when the resource is replaced during an update\n operation.
\n RETAIN - retain all resources when the resource is replaced during an update\n operation.
For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.
" } } }, @@ -13970,7 +13970,7 @@ "NoEcho": { "target": "com.amazonaws.cloudformation#NoEcho", "traits": { - "smithy.api#documentation": "Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
" + "smithy.api#documentation": "Flag indicating whether the parameter should be displayed as plain text in logs and\n UIs.
" } }, "Description": { @@ -14060,7 +14060,7 @@ "GeneratedTemplateId": { "target": "com.amazonaws.cloudformation#GeneratedTemplateId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For\n example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
The reason for the current template generation status. This will provide more details if a failure\n happened.
" + "smithy.api#documentation": "The reason for the current template generation status. This will provide more details if a\n failure happened.
" } }, "CreationTime": { @@ -14096,7 +14096,7 @@ "NumberOfResources": { "target": "com.amazonaws.cloudformation#NumberOfResources", "traits": { - "smithy.api#documentation": "The number of resources in the generated template. This is a total of resources in pending, in-progress,\n completed, and failed states.
" + "smithy.api#documentation": "The number of resources in the generated template. This is a total of resources in pending,\n in-progress, completed, and failed states.
" } } }, @@ -14110,7 +14110,7 @@ "TreatUnrecognizedResourceTypesAsWarnings": { "target": "com.amazonaws.cloudformation#TreatUnrecognizedResourceTypesAsWarnings", "traits": { - "smithy.api#documentation": "If set to True, any unrecognized resource types generate warnings and not an error. Any\n unrecognized resource types are returned in the Warnings output parameter.
If set to True, any unrecognized resource types generate warnings and not an\n error. Any unrecognized resource types are returned in the Warnings output\n parameter.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
\nFor resource types, this includes passing all contracts tests defined for the type.
\nFor modules, this includes determining if the module's model meets all necessary requirements.
\nFor more information, see Testing your public\n extension prior to publishing in the CloudFormation CLI User Guide.
\nIf you don't specify a version, CloudFormation uses the default version of the extension in your account and Region\n for testing.
\nTo perform testing, CloudFormation assumes the execution role specified when the type was registered. For more\n information, see RegisterType.
\nOnce you've initiated testing on an extension using TestType, you can pass the returned\n TypeVersionArn into DescribeType to monitor the current test\n 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,\n see Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide.
Tests a registered extension to make sure it meets all necessary requirements for being\n published in the CloudFormation registry.
\nFor resource types, this includes passing all contracts tests defined for the\n type.
\nFor modules, this includes determining if the module's model meets all necessary\n requirements.
\nFor more information, see Testing your public extension before publishing in the\n CloudFormation Command Line Interface (CLI) User Guide.
\nIf you don't specify a version, CloudFormation uses the default version of the extension in\n your account and Region for testing.
\nTo perform testing, CloudFormation assumes the execution role specified when the type was\n registered. For more information, see RegisterType.
\nOnce you've initiated testing on an extension using TestType, you can pass\n the returned TypeVersionArn into DescribeType to\n 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.\n For more information, see Publishing extensions\n to make them available for public use in the\n CloudFormation Command Line Interface (CLI) User Guide.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The type of the extension to test.
\nConditional: You must specify Arn, or TypeName and Type.
The type of the extension to test.
\nConditional: You must specify Arn, or TypeName and\n Type.
The name of the extension to test.
\nConditional: You must specify Arn, or TypeName and Type.
The name of the extension to test.
\nConditional: You must specify Arn, or TypeName and\n Type.
The version of the extension to test.
\nYou can specify the version id with either Arn, or with TypeName and\n Type.
If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region\n for testing.
" + "smithy.api#documentation": "The version of the extension to test.
\nYou can specify the version id with either Arn, or with TypeName\n and Type.
If you don't specify a version, CloudFormation uses the default version of the extension in\n this account and Region for testing.
" } }, "LogDeliveryBucket": { "target": "com.amazonaws.cloudformation#S3Bucket", "traits": { - "smithy.api#documentation": "The S3 bucket to which CloudFormation delivers the contract test execution logs.
\nCloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a\n test type status of PASSED or FAILED.
The user calling TestType must be able to access items in the specified S3 bucket. Specifically,\n the user needs the following permissions:
\n GetObject\n
\n PutObject\n
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
" + "smithy.api#documentation": "The S3 bucket to which CloudFormation delivers the contract test execution logs.
\nCloudFormation delivers the logs by the time contract testing has completed and the extension\n 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\n bucket. Specifically, the user needs the following permissions:
\n GetObject\n
\n PutObject\n
For more information, see Actions, Resources, and\n Condition Keys for Amazon S3 in the Identity and Access Management User Guide.
" } } }, @@ -14338,31 +14338,31 @@ "Arn": { "target": "com.amazonaws.cloudformation#TypeConfigurationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the configuration data, in this account and\n Region.
" } }, "Alias": { "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", "traits": { - "smithy.api#documentation": "The alias specified for this configuration, if one was specified when the configuration was set.
" + "smithy.api#documentation": "The alias specified for this configuration, if one was specified when the configuration was\n set.
" } }, "Configuration": { "target": "com.amazonaws.cloudformation#TypeConfiguration", "traits": { - "smithy.api#documentation": "A JSON string specifying the configuration data for the extension, in this account and Region.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns {}.
A JSON string specifying the configuration data for the extension, in this account and\n Region.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n {}.
When the configuration data was last updated for this extension.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns null.
When the configuration data was last updated for this extension.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n null.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account\n and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account\n and Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.
" } }, "TypeName": { @@ -14379,7 +14379,7 @@ } }, "traits": { - "smithy.api#documentation": "Detailed information concerning the specification of a CloudFormation extension in a given account and\n Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + "smithy.api#documentation": "Detailed information concerning the specification of a CloudFormation extension in a given\n account and Region.
\nFor more information, see Edit configuration data\n for extensions in your account in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#TypeConfigurationDetailsList": { @@ -14394,13 +14394,13 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account\n and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account\n and Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.
" } }, "TypeConfigurationAlias": { "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", "traits": { - "smithy.api#documentation": "The alias specified for this configuration, if one was specified when the configuration was set.
" + "smithy.api#documentation": "The alias specified for this configuration, if one was specified when the configuration was\n set.
" } }, "TypeConfigurationArn": { @@ -14443,7 +14443,7 @@ "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage", "traits": { - "smithy.api#documentation": "An message with details about the error that occurred.
" + "smithy.api#documentation": "A message with details about the error that occurred.
" } } }, @@ -14463,13 +14463,13 @@ "Category": { "target": "com.amazonaws.cloudformation#Category", "traits": { - "smithy.api#documentation": "The category of extensions to return.
\n\n REGISTERED: Private extensions that have been registered for this account and Region.
\n ACTIVATED: Public extensions that have been activated for this account and Region.
\n THIRD_PARTY: Extensions available for use from publishers other than Amazon. This\n includes:
Private extensions registered in the account.
\nPublic extensions from publishers other than Amazon, whether activated or not.
\n\n AWS_TYPES: Extensions available for use from Amazon.
The category of extensions to return.
\n\n REGISTERED: Private extensions that have been registered for this account and\n Region.
\n ACTIVATED: Public extensions that have been activated for this account and\n Region.
\n THIRD_PARTY: Extensions available for use from publishers other than Amazon.\n This includes:
Private extensions registered in the account.
\nPublic extensions from publishers other than Amazon, whether activated or not.
\n\n AWS_TYPES: Extensions available for use from Amazon.
The id of the publisher of the extension.
\nExtensions published by Amazon aren't assigned a publisher ID. Use the AWS_TYPES category to\n specify a list of types published by Amazon.
The id of the publisher of the extension.
\nExtensions published by Amazon aren't assigned a publisher ID. Use the\n AWS_TYPES category to specify a list of types published by Amazon.
An message with details about the error that occurred.
" + "smithy.api#documentation": "A message with details about the error that occurred.
" } } }, @@ -14553,13 +14553,13 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The name of the extension.
\nIf you specified a TypeNameAlias when you call the ActivateType API operation in your account\n and Region, CloudFormation considers that alias as the type name.
The name of the extension.
\nIf you specified a TypeNameAlias when you call the ActivateType API\n operation in your account and Region, CloudFormation considers that alias as the type name.
The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns null. For more information, see\n RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" + "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\n null. For more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" } }, "TypeArn": { @@ -14571,7 +14571,7 @@ "LastUpdated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.
\nFor all other extension types, CloudFormation returns null.
When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more\n information, see ActivateType.
\nFor all other extension types, CloudFormation returns null.
The ID of the extension publisher, if the extension is published by a third party. Extensions published by\n Amazon don't return a publisher ID.
" + "smithy.api#documentation": "The ID of the extension publisher, if the extension is published by a third party.\n Extensions published by Amazon don't return a publisher ID.
" } }, "OriginalTypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf 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\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of\n the public extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account\n and Region, CloudFormation treats that alias as the extension's type name within the account and\n Region, not the type name of the public extension. For more information, see Use\n aliases to refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region.
\nHow you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n 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 in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of\n the public extension to be used for CloudFormation operations in this account and Region.
\nHow you specified AutoUpdate when enabling the extension affects whether\n CloudFormation automatically updates the extension in this account and Region when a new version is\n released. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest version of the public\n extension that is available. For any extensions other than activated third-arty extensions,\n CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n 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 in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest\n version of the public extension that is available. For any extensions other\n than activated third-party extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether\n CloudFormation automatically updates the extension in this account and Region when a new version is\n released. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.
The service used to verify the publisher identity.
\nFor more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.
" + "smithy.api#documentation": "The service used to verify the publisher identity.
\nFor more information, see Publishing extensions to make\n them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
" } }, "PublisherName": { "target": "com.amazonaws.cloudformation#PublisherName", "traits": { - "smithy.api#documentation": "The publisher name, as defined in the public profile for that publisher in the service used to verify the\n publisher identity.
" + "smithy.api#documentation": "The publisher name, as defined in the public profile for that publisher in the service used\n to verify the publisher identity.
" } }, "IsActivated": { "target": "com.amazonaws.cloudformation#IsActivated", "traits": { - "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 activated by\n 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.
" } } }, @@ -14700,13 +14700,13 @@ "VersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it's registered.
" + "smithy.api#documentation": "The ID of a specific version of the extension. The version ID is the value at the end of the\n Amazon Resource Name (ARN) assigned to the extension version when it's registered.
" } }, "IsDefaultVersion": { "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { - "smithy.api#documentation": "Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and extensions published by Amazon.\n For public third-party extensions, 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 extensions\n published by Amazon. For public third-party extensions, CloudFormation returns\n null.
For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region. For any extensions other than activated third-arty\n extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n 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 in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of\n the public extension to be used for CloudFormation operations in this account and Region. For any\n extensions other than activated third-party extensions, CloudFormation returns\n null.
How you specified AutoUpdate when enabling the extension affects whether\n CloudFormation automatically updates the extension in this account and Region when a new version is\n released. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.
Updates a generated template. This can be used to change the name, add and remove resources, refresh resources,\n and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of\n the update to the generated template using the DescribeGeneratedTemplate API action.
Updates a generated template. This can be used to change the name, add and remove\n resources, refresh resources, and change the DeletionPolicy and\n UpdateReplacePolicy settings. You can check the status of the update to the\n generated template using the DescribeGeneratedTemplate API action.
If true, update the resource properties in the generated template with their current live state.\n This feature is useful when the resource properties in your generated a template does not reflect the live state of\n the resource properties. This happens when a user update the resource properties after generating a template.
If true, update the resource properties in the generated template with their\n current live state. This feature is useful when the resource properties in your generated a\n template does not reflect the live state of the resource properties. This happens when a user\n update the resource properties after generating a template.
The configuration details of the generated template, including the DeletionPolicy and\n UpdateReplacePolicy.
The configuration details of the generated template, including the\n DeletionPolicy and UpdateReplacePolicy.
The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}.\n For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .
Updates a stack as specified in the template. After the call completes successfully, the stack update starts.\n You can check the status of the stack through the DescribeStacks action.
\nTo get a copy of the template for an existing stack, you can use the GetTemplate\n action.
\nFor more information about creating an update template, updating a stack, and monitoring the progress of the\n update, see Updating a Stack.
" + "smithy.api#documentation": "Updates a stack as specified in the template. After the call completes successfully, the\n stack update starts. You can check the status of the stack through the DescribeStacks action.
\nTo get a copy of the template for an existing stack, you can use the GetTemplate action.
\nFor more information about updating a stack and monitoring the progress of the update, see\n Managing\n Amazon Web Services resources as a single unit with CloudFormation stacks in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#UpdateStackInput": { @@ -14909,85 +14909,85 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.
\nConditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's\n located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must\n start with https://.
Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are updating.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are\n updating.
\nConditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
Structure containing the temporary overriding stack policy body. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is 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 associated\n 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 to a policy (max size:\n 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with\n https://. You 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 during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" + "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point to\n a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The\n location for an Amazon S3 bucket must start with https://. You can specify either the\n 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 associated\n with the stack will be used.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
A list of Parameter structures that specify input parameters for the stack.\n For more information, see the Parameter data\n type.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n 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 Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n 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 permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\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\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change 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 more macros, and you choose\n to update a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros and nested\n stacks, you must update the stack directly from the template using this capability.
\nYou should only update stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation Macros to Perform Custom Processing\n on Templates.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
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 IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n 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 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 can\n 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 set\n from the processed template, so that they can review the changes resulting from the macros\n before actually updating the stack. If your stack template contains one or more macros,\n and you choose to update a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n 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 the\n template using this capability.
\nYou should only update stacks directly from a stack template that contains macros if\n you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function operation\n without CloudFormation being notified.
\nFor more information, see Perform custom processing\n on CloudFormation templates with template macros.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
The template resource types that you have permissions to work with for this update stack action, such as\n AWS::EC2::Instance, 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\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can be specified.
The template resource types that you have permissions to work with for this update stack\n action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack\n update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this\n parameter for CloudFormation-specific condition keys in IAM policies. For more information, see\n Control access with Identity and Access Management.
\nOnly one of the Capabilities and ResourceType parameters can\n be specified.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role\n for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses\n this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that is generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to update the\n stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that is generated from\n your user credentials.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the\n specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" } }, "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the StackPolicyBody or the\n 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\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" + "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.
You might update the stack policy, for example, in order to protect a new resource that\n you created during a stack update. If you don't specify a stack policy, the current policy\n that is associated with the stack is unchanged.
" } }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located\n in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with\n https://. You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" + "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a policy\n (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an\n Amazon S3 bucket must start with https://. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.
You might update the stack policy, for example, in order to protect a new resource that\n you created during a stack update. If you don't specify a stack policy, the current policy\n that is associated with the stack is unchanged.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack.\n Specify an empty list to remove all notification topics.
" + "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation\n associates with the stack. Specify an empty list to remove all notification topics.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the\n stack. You can specify a maximum number of 50 tags.
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value,\n CloudFormation removes all associated tags.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to\n supported resources in the stack. You can specify a maximum number of 50 tags.
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you\n specify an empty value, CloudFormation removes all associated tags.
" } }, "DisableRollback": { @@ -14999,13 +14999,13 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry\n 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\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this UpdateStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to update a stack\n with the same name. You might retry UpdateStack requests to ensure that\n CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.
Default: false\n
When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.
Default: false\n
Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
\nYou can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to\n create additional stack instances, use CreateStackInstances.
\nDuring stack set updates, any parameters overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only update the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template. If you add a parameter to a template, before you can override the parameter value specified in the stack\n set you must first use UpdateStackSet to update all stack\n instances with the updated template and parameter value specified in the stack set. Once a stack instance has been\n updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
Updates the parameter values for stack instances for the specified accounts, within the\n specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and\n Region.
\nYou can only update stack instances in Amazon Web Services Regions and accounts where they already\n exist; to create additional stack instances, use CreateStackInstances.
\nDuring stack set updates, any parameters overridden for a stack instance aren't updated,\n but retain their overridden value.
\nYou can only update the parameter values that are specified in the\n stack set; to add or delete a parameter itself, use UpdateStackSet\n to update the stack set template. If you add a parameter to a template, before you can\n override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and\n parameter value specified in the stack set. Once a stack instance has been updated with the\n new parameter, you can then override the parameter value using\n UpdateStackInstances.
[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update\n parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the\n specified accounts and Amazon Web Services Regions.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to\n update parameter values for stack instances. The overridden parameter values will be applied\n to all stack instances in the specified accounts and Amazon Web Services Regions.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
[Service-managed permissions] The Organizations accounts for which you want to update parameter values\n for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are\n currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future\n won't use the overridden values.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Service-managed permissions] The Organizations accounts for which you want to\n update parameter values for stack instances. If your update targets OUs, the overridden\n parameter values only apply to the accounts that are currently in the target OUs and their\n child OUs. Accounts added to the target OUs and their child OUs in the future won't use the\n overridden values.
\nYou can specify Accounts or DeploymentTargets, but not\n both.
The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack\n instances. The overridden parameter values will be applied to all stack instances in the specified accounts and\n Amazon Web Services Regions.
", + "smithy.api#documentation": "The names of one or more Amazon Web Services Regions in which you want to update parameter values for\n stack instances. The overridden parameter values will be applied to all stack instances in the\n specified accounts and Amazon Web Services Regions.
", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of input parameters whose values you want to update for the specified stack instances.
\nAny overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values\n during stack instance update operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter\n to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to\n update all stack instances with the updated template and parameter value specified in the stack set. Once a stack\n instance has been updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
A list of input parameters whose values you want to update for the specified stack\n instances.
\nAny overridden parameter values will be applied to all stack instances in the specified\n accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how\n CloudFormation sets parameter values during stack instance update operations:
\nTo override the current value for a parameter, include the parameter and specify its\n value.
\nTo leave an overridden parameter set to its present value, include the parameter and\n specify UsePreviousValue as true. (You can't specify both a\n value and set UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a\n parameter list but don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at\n all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't\n updated, but retain their overridden value.
\nYou can only override the parameter values that are specified in the\n stack set; to add or delete a parameter itself, use UpdateStackSet to update the\n stack set template. If you add a parameter to a template, before you can override the\n parameter value specified in the stack set you must first use UpdateStackSet\n to update all stack instances with the updated template and parameter value specified in the\n stack set. Once a stack instance has been updated with the new parameter, you can then\n override the parameter value using UpdateStackInstances.
The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
", + "smithy.api#documentation": "The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n might retry stack set operation requests to ensure that CloudFormation successfully received\n them.
\nIf you don't specify an operation ID, the SDK generates one\n automatically.
", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nUpdates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
\nEven if the stack set operation created by updating the stack set fails (completely or partially, below or above\n a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
" + "smithy.api#documentation": "Updates the stack set, and associated stack instances in the specified accounts and\n Amazon Web Services Regions.
\nEven if the stack set operation created by updating the stack set fails (completely or\n partially, below or above a specified failure tolerance), the stack set is updated with your\n changes. Subsequent CreateStackInstances calls on the specified stack set\n use the updated stack set.
" } }, "com.amazonaws.cloudformation#UpdateStackSetInput": { @@ -15188,19 +15188,19 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes.
\nConditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.
The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information,\n see Template\n Anatomy in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
The location of the file that contains the template body. The URL must point to a template\n (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager\n document.
\nConditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.
Use the existing template that's associated with the stack set that you're updating.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
Use the existing template that's associated with the stack set that you're\n updating.
\nConditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly\n acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n 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 permissions associated with\n them and edit their permissions if necessary.
\n\n AWS::IAM::AccessKey\n
\n\n AWS::IAM::Group\n
\n\n AWS::IAM::Policy\n
\n\n AWS::IAM::Role\n
\n\n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must update the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions,\n if you reference a macro in your template the stack set operation will fail.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack set and its associated stack\n instances.
\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 IAM users. For those stacks sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must\n 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 AWS::IAM::AccessKey\n
\n\n AWS::IAM::Group\n
\n\n AWS::IAM::Policy\n
\n\n AWS::IAM::Role\n
\n\n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more\n macros, you must update the stack set directly from the processed template, without first\n reviewing the resulting changes in a change set. To update the stack set directly, you\n must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of\n macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if\n you specify this capability for a stack set with service-managed permissions, if you\n reference a macro in your template the stack set operation will fail.
\nThe key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these\n tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
\nIf you specify tags for this parameter, those tags replace any list of tags that are currently associated with\n this stack set. This means:
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
\nIf you specify any tags using this parameter, you must specify all\n the tags that you want associated with this stack set, even tags you've specified before (for example, when\n creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the\n updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
\nIf you specify an empty value, CloudFormation removes all currently associated tags.
\nIf you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the\n required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from\n the list of tags you specify, CloudFormation assumes that you want to remove those tags from the stack set, and checks to see\n if you have permission to untag resources. If you don't have the necessary permission(s), the entire\n UpdateStackSet action fails with an access denied error, and the stack set is not\n updated.
The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in the stacks.\n You can specify a maximum number of 50 tags.
\nIf you specify tags for this parameter, those tags replace any list of tags that are\n currently associated with this stack set. This means:
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's\n tags.
\nIf you specify any tags using this parameter, you must specify\n all the tags that you want associated with this stack set, even\n tags you've specified before (for example, when creating the stack set or during a\n previous update of the stack set.). Any tags that you don't include in the updated list of\n tags are removed from the stack set, and therefore from the stacks and resources as\n well.
\nIf you specify an empty value, CloudFormation removes all currently associated\n tags.
\nIf you specify new tags as part of an UpdateStackSet action, CloudFormation\n checks to see if you have the required IAM permission to tag resources. If you omit tags\n that are currently associated with the stack set from the list of tags you specify, CloudFormation\n assumes that you want to remove those tags from the stack set, and checks to see if you have\n permission to untag resources. If you don't have the necessary permission(s), the entire\n UpdateStackSet action fails with an access denied error, and the\n stack set is not updated.
The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users or groups can\n manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized 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 stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific stack sets within the same administrator account.\n For more information, see Granting Permissions for\n Stack Set Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you must\n specify a customized administrator role, even if it is the same customized administrator role\n used with this stack set previously.
" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "The name of the IAM execution role to use to update the stack set. If you do not specify an execution role,\n CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which stack resources users\n and groups can include in their stack sets.
\nIf you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a\n customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long\n as you have permissions to perform operations on the stack set.
" + "smithy.api#documentation": "The name of the IAM execution role to use to update the stack set. If you do not specify\n an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole\n role for the stack set operation.
Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their stack sets.
\nIf you specify a customized execution role, CloudFormation uses that role to update the stack.\n If you do not specify a customized execution role, CloudFormation performs the update using the\n role previously associated with the stack set, so long as you have permissions to perform\n operations on the stack set.
" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "[Service-managed permissions] The Organizations accounts in which to update associated stack\n instances.
\nTo update all the stack instances associated with this stack set, do not specify DeploymentTargets\n or Regions.
If the stack set update includes changes to the template (that is, if TemplateBody or\n TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances with a\n 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\n stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing\n stack instance status.
[Service-managed permissions] The Organizations accounts in which to update\n associated stack instances.
\nTo update all the stack instances associated with this stack set, do not specify\n DeploymentTargets or Regions.
If the stack set update includes changes to the template (that is, if\n TemplateBody or TemplateURL is specified), or the\n Parameters, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Regions, while leaving\n all other stack instances with their existing stack instance status.
Describes how the IAM roles required for stack set operations are created. You cannot modify\n PermissionModel if there are stack instances associated with your stack set.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles required to\n deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set\n Permissions.
Describes how the IAM roles required for stack set operations are created. You cannot\n modify PermissionModel if there are stack instances associated with your stack\n set.
With self-managed permissions, you must create the administrator and\n execution roles required to deploy to target accounts. For more information, see Grant\n Self-Managed Stack Set Permissions.
With service-managed permissions, StackSets automatically creates the\n IAM roles required to deploy to accounts managed by Organizations. For more\n information, see Grant\n Service-Managed Stack Set Permissions.
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).
\nIf you specify AutoDeployment, don't specify DeploymentTargets or\n Regions.
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit\n (OU).
\nIf you specify AutoDeployment, don't specify DeploymentTargets\n or Regions.
The unique ID for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, CloudFormation generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
The unique ID for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n might retry stack set operation requests to ensure that CloudFormation successfully received\n them.
\nIf you don't specify an operation ID, CloudFormation generates one\n automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts,\n you must also specify the Amazon Web Services Regions in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, don't specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation\n updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack\n instances with their existing stack instance status.
[Self-managed permissions] The accounts in which to update associated stack instances. If\n you specify accounts, you must also specify the Amazon Web Services Regions in which to update stack set\n instances.
\nTo update all the stack instances associated with this stack set,\n don't specify the Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while\n leaving all other stack instances with their existing stack instance status.
The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must\n also specify accounts in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, do not specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack\n instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack\n instance status.
The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions,\n you must also specify accounts in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, do\n not specify the Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the stack set update does not include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Regions, while leaving\n all other stack instances with their existing stack instance status.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n 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\n administrator in the CloudFormation User Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.
\nDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.
" } } }, @@ -15316,7 +15316,7 @@ "target": "com.amazonaws.cloudformation#UpdateTerminationProtectionOutput" }, "traits": { - "smithy.api#documentation": "Updates termination protection for the specified stack. If a user attempts to delete a stack with termination\n protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" + "smithy.api#documentation": "Updates termination protection for the specified stack. If a user attempts to delete a\n stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protect a CloudFormation\n stack from being deleted in the CloudFormation User Guide.
\nFor nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" } }, "com.amazonaws.cloudformation#UpdateTerminationProtectionInput": { @@ -15334,7 +15334,7 @@ "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or unique ID of the stack for which you want to set termination protection.
", + "smithy.api#documentation": "The name or unique ID of the stack for which you want to set termination\n protection.
", "smithy.api#required": {} } } @@ -15375,7 +15375,7 @@ "target": "com.amazonaws.cloudformation#ValidateTemplateOutput" }, "traits": { - "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation\n checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation\n error.
" + "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is valid JSON. If\n it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail,\n CloudFormation returns a template validation error.
" } }, "com.amazonaws.cloudformation#ValidateTemplateInput": { @@ -15384,13 +15384,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template Anatomy in the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.
\nConditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size:\n 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. The location\n for an Amazon S3 bucket must start with https://.
Conditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.
The capabilities found within the template. If your template contains IAM resources, you must specify the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or\n UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities\n error.
\nFor more information, see Acknowledging IAM Resources in\n CloudFormation Templates.
" + "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you\n must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use\n the CreateStack or UpdateStack actions with your template;\n otherwise, those actions return an InsufficientCapabilities error.
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
" } }, "CapabilitiesReason": { "target": "com.amazonaws.cloudformation#CapabilitiesReason", "traits": { - "smithy.api#documentation": "The list of resources that generated the values in the Capabilities response element.
The list of resources that generated the values in the Capabilities response\n element.
The type of this warning. For more information, see IaC generator and write-only\n properties in the CloudFormation User Guide.
\n\n MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive write-only properties.\n The IaC generator selects one set of mutually exclusive properties and converts the included properties into\n parameters. The parameter names have a suffix OneOf and the parameter descriptions indicate that the\n corresponding property can be replaced with other exclusive properties.
\n UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource. One example of\n unsupported properties would be a required write-only property that is an array, because a parameter cannot be an\n array. Another example is an optional write-only property.
\n MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are found in the resource,\n and the type of that property can be any of several types.
Currently the resource and property reference documentation does not indicate if a property uses a type of\n oneOf or anyOf. You need to look at the resource provider schema.
The type of this warning. For more information, see Resolve\n write-only properties in the CloudFormation User Guide.
\n\n MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive\n write-only properties. The IaC generator selects one set of mutually exclusive properties and\n converts the included properties into parameters. The parameter names have a suffix\n OneOf and the parameter descriptions indicate that the corresponding property can\n be replaced with other exclusive properties.
\n UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource.\n One example of unsupported properties would be a required write-only property that is an array,\n because a parameter cannot be an array. Another example is an optional write-only\n property.
\n MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are\n found in the resource, and the type of that property can be any of several types.
Currently the resource and property reference documentation does not indicate if a property\n uses a type of oneOf or anyOf. You need to look at the resource\n provider schema.
The path of the property. For example, if this is for the S3Bucket member of the Code\n property, the property path would be Code/S3Bucket.
The path of the property. For example, if this is for the S3Bucket member of\n the Code property, the property path would be Code/S3Bucket.
A list of all of the unrecognized resource types. This is only returned if the\n TemplateSummaryConfig parameter has the TreatUnrecognizedResourceTypesAsWarning\n configuration set to True.
A list of all of the unrecognized resource types. This is only returned if the\n TemplateSummaryConfig parameter has the\n TreatUnrecognizedResourceTypesAsWarning configuration set to\n True.