<?php
// This file was auto-generated from sdk-root/src/data/cloudformation/2010-05-15/docs-2.json
return [ 'version' => '2.0', 'service' => '<fullname>CloudFormation</fullname> <p>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 Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.</p> <p>With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.</p> <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p> <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product\'s technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>', 'operations' => [ 'ActivateOrganizationsAccess' => '<p>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.</p>', 'ActivateType' => '<p>Activates a public third-party extension, such as a resource or module, to make it available for use in stack templates in your current account and Region. It can also create CloudFormation Hooks, which allow you to evaluate resource configurations before CloudFormation provisions them. Hooks integrate with both CloudFormation and Cloud Control API operations.</p> <p>After you activate an extension, you can use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to set specific properties for the extension.</p> <p>To see which extensions have been activated, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListTypes.html">ListTypes</a>. To see configuration details for an extension, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public-activate-extension.html">Activate a third-party public extension in your account</a> in the <i>CloudFormation User Guide</i>. For information about creating Hooks, see the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html">CloudFormation Hooks User Guide</a>.</p>', 'BatchDescribeTypeConfigurations' => '<p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry in your current account and Region.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration data for extensions in your account</a> in the <i>CloudFormation User Guide</i>.</p>', 'CancelUpdateStack' => '<p>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.</p> <note> <p>You can cancel only stacks that are in the <code>UPDATE_IN_PROGRESS</code> state.</p> </note>', 'ContinueUpdateRollback' => '<p>Continues rolling back a stack from <code>UPDATE_ROLLBACK_FAILED</code> to <code>UPDATE_ROLLBACK_COMPLETE</code> 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 <code>UPDATE_ROLLBACK_COMPLETE</code> state) and then try to update the stack again.</p> <p>A stack enters the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can\'t roll back all changes after a failed stack update. For example, this might occur when a stack attempts to roll back to an old database that was deleted outside of CloudFormation. Because CloudFormation doesn\'t know the instance was deleted, it assumes the instance still exists and attempts to roll back to it, causing the update rollback to fail.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html">Continue rolling back an update</a> in the <i>CloudFormation User Guide</i>. For information for troubleshooting a failed update rollback, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed">Update rollback failed</a>.</p>', 'CreateChangeSet' => '<p>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.</p> <p>To create a change set for a stack that doesn\'t exist, for the <code>ChangeSetType</code> parameter, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code> for the <code>ChangeSetType</code> parameter. To create a change set for an import operation, specify <code>IMPORT</code> for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the <a>DescribeChangeSet</a> action.</p> <p>When you are satisfied with the changes the change set will make, execute the change set by using the <a>ExecuteChangeSet</a> action. CloudFormation doesn\'t make changes until you execute the change set.</p> <p>To create a change set for the entire stack hierarchy, set <code>IncludeNestedStacks</code> to <code>True</code>.</p>', 'CreateGeneratedTemplate' => '<p>Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the <code>DescribeGeneratedTemplate</code> API action.</p>', 'CreateStack' => '<p>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 <a>DescribeStacks</a> operation.</p> <p>For more information about creating a stack and monitoring stack progress, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html">Managing Amazon Web Services resources as a single unit with CloudFormation stacks</a> in the <i>CloudFormation User Guide</i>.</p>', 'CreateStackInstances' => '<p>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 <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for <code>Regions</code>.</p> <note> <p>The maximum number of organizational unit (OUs) supported by a <code>CreateStackInstances</code> operation is 50.</p> <p>If you need more than 50, consider the following options:</p> <ul> <li> <p> <i>Batch processing:</i> If you don\'t want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.</p> </li> <li> <p> <i>Parent OU strategy:</i> If you don\'t mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.</p> </li> </ul> </note>', 'CreateStackRefactor' => '<p>Creates a refactor across multiple stacks, with the list of stacks and resources that are affected.</p>', 'CreateStackSet' => '<p>Creates a StackSet.</p>', 'DeactivateOrganizationsAccess' => '<p>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.</p>', 'DeactivateType' => '<p>Deactivates a public third-party extension, such as a resource or module, or a CloudFormation Hook when you no longer use it.</p> <p>Deactivating an extension deletes the configuration details that are associated with it. To temporarily disable a CloudFormation Hook instead, you can use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a>.</p> <p>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.</p> <p>To see which extensions are currently activated, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListTypes.html">ListTypes</a>.</p>', 'DeleteChangeSet' => '<p>Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.</p> <p>If the call successfully completes, CloudFormation successfully deleted the change set.</p> <p>If <code>IncludeNestedStacks</code> specifies <code>True</code> during the creation of the nested change set, then <code>DeleteChangeSet</code> 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 <code>REVIEW_IN_PROGRESS</code>.</p>', 'DeleteGeneratedTemplate' => '<p>Deleted a generated template.</p>', 'DeleteStack' => '<p>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don\'t show up in the <a>DescribeStacks</a> operation if the deletion has been completed successfully.</p> <p>For more information about deleting a stack, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-delete-stack.html">Delete a stack from the CloudFormation console</a> in the <i>CloudFormation User Guide</i>.</p>', 'DeleteStackInstances' => '<p>Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.</p> <note> <p>The maximum number of organizational unit (OUs) supported by a <code>DeleteStackInstances</code> operation is 50.</p> <p>If you need more than 50, consider the following options:</p> <ul> <li> <p> <i>Batch processing:</i> If you don\'t want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.</p> </li> <li> <p> <i>Parent OU strategy:</i> If you don\'t mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.</p> </li> </ul> </note>', 'DeleteStackSet' => '<p>Deletes a StackSet. Before you can delete a StackSet, all its member stack instances must be deleted. For more information about how to complete this, see <a>DeleteStackInstances</a>.</p>', 'DeregisterType' => '<p>Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.</p> <p>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.</p> <p>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.</p> <p>To view the deprecation status of an extension or extension version, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private-deregister-extension.html">Remove third-party private extensions from your account</a> in the <i>CloudFormation User Guide</i>.</p>', 'DescribeAccountLimits' => '<p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">Understand CloudFormation quotas</a> in the <i>CloudFormation User Guide</i>.</p>', 'DescribeChangeSet' => '<p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html">Update CloudFormation stacks using change sets</a> in the <i>CloudFormation User Guide</i>.</p>', 'DescribeChangeSetHooks' => '<p>Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.</p>', 'DescribeGeneratedTemplate' => '<p>Describes a generated template. The output includes details about the progress of the creation of a generated template started by a <code>CreateGeneratedTemplate</code> API action or the update of a generated template started with an <code>UpdateGeneratedTemplate</code> API action.</p>', 'DescribeOrganizationsAccess' => '<p>Retrieves information about the account\'s <code>OrganizationAccess</code> status. This API can be called either by the management account or the delegated administrator by using the <code>CallAs</code> parameter. This API can also be called without the <code>CallAs</code> parameter by the management account.</p>', 'DescribePublisher' => '<p>Returns information about a CloudFormation extension publisher.</p> <p>If you don\'t supply a <code>PublisherId</code>, and you have registered as an extension publisher, <code>DescribePublisher</code> returns information about your own publisher account.</p> <p>For more information about registering as a publisher, see:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to make them available for public use</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i> </p> </li> </ul>', 'DescribeResourceScan' => '<p>Describes details of a resource scan.</p>', 'DescribeStackDriftDetectionStatus' => '<p>Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack\'s actual configuration differs, or has <i>drifted</i>, 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p> <p>Use <a>DetectStackDrift</a> to initiate a stack drift detection operation. <code>DetectStackDrift</code> returns a <code>StackDriftDetectionId</code> you can use to monitor the progress of the operation using <code>DescribeStackDriftDetectionStatus</code>. Once the drift detection operation has completed, use <a>DescribeStackResourceDrifts</a> to return drift information about the stack and its resources.</p>', 'DescribeStackEvents' => '<p>Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack\'s event history, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html">Understand CloudFormation stack creation events</a> in the <i>CloudFormation User Guide</i>.</p> <note> <p>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</p> </note>', 'DescribeStackInstance' => '<p>Returns the stack instance that\'s associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.</p> <p>For a list of stack instances that are associated with a specific StackSet, use <a>ListStackInstances</a>.</p>', 'DescribeStackRefactor' => '<p>Describes the stack refactor status.</p>', 'DescribeStackResource' => '<p>Returns a description of the specified resource in the specified stack.</p> <p>For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.</p>', 'DescribeStackResourceDrifts' => '<p>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.</p> <p>For a given stack, there will be one <code>StackResourceDrift</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a>.</p> <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual resources, or <a>DetectStackDrift</a> to detect drift on all supported resources for a given stack.</p>', 'DescribeStackResources' => '<p>Returns Amazon Web Services resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned.</p> <note> <p>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</p> </note> <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted.</p> <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">CloudFormation User Guide</a>.</p> <note> <p>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</p> </note>', 'DescribeStackSet' => '<p>Returns the description of the specified StackSet.</p> <note> <p>This API provides <i>strongly consistent</i> reads meaning it will always return the most up-to-date data.</p> </note>', 'DescribeStackSetOperation' => '<p>Returns the description of the specified StackSet operation.</p> <note> <p>This API provides <i>strongly consistent</i> reads meaning it will always return the most up-to-date data.</p> </note>', 'DescribeStacks' => '<p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html">Understand CloudFormation stack creation events</a> in the <i>CloudFormation User Guide</i>.</p> <note> <p>If the stack doesn\'t exist, a <code>ValidationError</code> is returned.</p> </note>', 'DescribeType' => '<p>Returns detailed information about an extension from the CloudFormation registry in your current account and Region.</p> <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific extension version. Otherwise, it returns information about the default extension version.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration data for extensions in your account</a> in the <i>CloudFormation User Guide</i>.</p>', 'DescribeTypeRegistration' => '<p>Returns information about an extension\'s registration, including its current status and type and version identifiers.</p> <p>When you initiate a registration request using <a>RegisterType</a>, you can then use <a>DescribeTypeRegistration</a> to monitor the progress of that registration request.</p> <p>Once the registration request has completed, use <a>DescribeType</a> to return detailed information about an extension.</p>', 'DetectStackDrift' => '<p>Detects whether a stack\'s actual configuration differs, or has <i>drifted</i>, 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p> <p>Use <code>DetectStackDrift</code> to detect drift on all supported resources for a given stack, or <a>DetectStackResourceDrift</a> to detect drift on individual resources.</p> <p>For a list of stack resources that currently support drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a>.</p> <p> <code>DetectStackDrift</code> can take up to several minutes, depending on the number of resources contained within the stack. Use <a>DescribeStackDriftDetectionStatus</a> to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use <a>DescribeStackResourceDrifts</a> to return drift information about the stack and its resources.</p> <p>When detecting drift on a stack, CloudFormation doesn\'t detect drift on any nested stacks belonging to that stack. Perform <code>DetectStackDrift</code> directly on the nested stack itself.</p>', 'DetectStackResourceDrift' => '<p>Returns information about whether a resource\'s actual configuration differs, or has <i>drifted</i>, 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p> <p>Use <code>DetectStackResourceDrift</code> to detect drift on individual resources, or <a>DetectStackDrift</a> to detect drift on all resources in a given stack that support drift detection.</p> <p>Resources that don\'t currently support drift detection can\'t be checked. For a list of resources that support drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a>.</p>', 'DetectStackSetDrift' => '<p>Detect drift on a StackSet. When CloudFormation performs drift detection on a StackSet, it performs drift detection on the stack associated with each stack instance in the StackSet. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Performing drift detection on CloudFormation StackSets</a>.</p> <p> <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the StackSet drift detection operation. Use this operation id with <a>DescribeStackSetOperation</a> 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 StackSet, in addition to the number of resources included in each stack.</p> <p>Once the operation has completed, use the following actions to return drift information:</p> <ul> <li> <p>Use <a>DescribeStackSet</a> to return detailed information about the stack set, including detailed information about the last <i>completed</i> drift operation performed on the StackSet. (Information about drift operations that are in progress isn\'t included.)</p> </li> <li> <p>Use <a>ListStackInstances</a> to return a list of stack instances belonging to the StackSet, including the drift status and last drift time checked of each instance.</p> </li> <li> <p>Use <a>DescribeStackInstance</a> to return detailed information about a specific stack instance, including its drift status and last drift time checked.</p> </li> </ul> <p>You can only run a single drift detection operation on a given StackSet at one time.</p> <p>To stop a drift detection StackSet operation, use <a>StopStackSetOperation</a>.</p>', 'EstimateTemplateCost' => '<p>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.</p>', 'ExecuteChangeSet' => '<p>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 <a>DescribeStacks</a> action to view the status of the update.</p> <p>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.</p> <p>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.</p> <p>To create a change set for the entire stack hierarchy, <code>IncludeNestedStacks</code> must have been set to <code>True</code>.</p>', 'ExecuteStackRefactor' => '<p>Executes the stack refactor operation.</p>', 'GetGeneratedTemplate' => '<p>Retrieves a generated template. If the template is in an <code>InProgress</code> or <code>Pending</code> status then the template returned will be the template when the template was last in a <code>Complete</code> status. If the template has not yet been in a <code>Complete</code> status then an empty template will be returned.</p>', 'GetStackPolicy' => '<p>Returns the stack policy for a specified stack. If a stack doesn\'t have a policy, a null value is returned.</p>', 'GetTemplate' => '<p>Returns the template body for a specified stack. You can get the template for running or deleted stacks.</p> <p>For deleted stacks, <code>GetTemplate</code> returns the template for up to 90 days after the stack has been deleted.</p> <note> <p>If the template doesn\'t exist, a <code>ValidationError</code> is returned.</p> </note>', 'GetTemplateSummary' => '<p>Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or StackSet.</p> <p>You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a StackSet, or a running or deleted stack.</p> <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template doesn\'t exist, a <code>ValidationError</code> is returned.</p>', 'ImportStacksToStackSet' => '<p>Import existing stacks into a new StackSets. Use the stack import operation to import up to 10 stacks into a new StackSet 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.</p>', 'ListChangeSets' => '<p>Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> or <code>CREATE_PENDING</code> state.</p>', 'ListExports' => '<p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-importvalue.html"> Fn::ImportValue</a> function.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html">Get exported outputs from a deployed CloudFormation stack</a>.</p>', 'ListGeneratedTemplates' => '<p>Lists your generated templates in this Region.</p>', 'ListHookResults' => '<p>Returns summaries of invoked Hooks. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-view-invocations.html">View invocation summaries for CloudFormation Hooks</a> in the <i>CloudFormation Hooks User Guide</i>.</p> <p>This operation supports the following parameter combinations:</p> <ul> <li> <p>No parameters: Returns all Hook invocation summaries.</p> </li> <li> <p> <code>TypeArn</code> only: Returns summaries for a specific Hook.</p> </li> <li> <p> <code>TypeArn</code> and <code>Status</code>: Returns summaries for a specific Hook filtered by status.</p> </li> <li> <p> <code>TargetId</code> and <code>TargetType</code>: Returns summaries for a specific Hook invocation target.</p> </li> </ul>', 'ListImports' => '<p>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 <a>ListExports</a>.</p> <p>For more information about importing an exported output value, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-importvalue.html">Fn::ImportValue</a> function.</p>', 'ListResourceScanRelatedResources' => '<p>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.</p>', 'ListResourceScanResources' => '<p>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.</p>', 'ListResourceScans' => '<p>List the resource scans from newest to oldest. By default it will return up to 10 resource scans.</p>', 'ListStackInstanceResourceDrifts' => '<p>Returns drift information for resources in a stack instance.</p> <note> <p> <code>ListStackInstanceResourceDrifts</code> returns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.</p> </note>', 'ListStackInstances' => '<p>Returns summary information about stack instances that are associated with the specified StackSet. 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.</p>', 'ListStackRefactorActions' => '<p>Lists the stack refactor actions that will be taken after calling the <a>ExecuteStackRefactor</a> action.</p>', 'ListStackRefactors' => '<p>Lists all account stack refactor operations and their statuses.</p>', 'ListStackResources' => '<p>Returns descriptions of all resources of the specified stack.</p> <p>For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.</p>', 'ListStackSetAutoDeploymentTargets' => '<p>Returns summary information about deployment targets for a StackSet.</p>', 'ListStackSetOperationResults' => '<p>Returns summary information about the results of a StackSet operation.</p> <note> <p>This API provides <i>eventually consistent</i> reads meaning it may take some time but will eventually return the most up-to-date data.</p> </note>', 'ListStackSetOperations' => '<p>Returns summary information about operations performed on a StackSet.</p> <note> <p>This API provides <i>eventually consistent</i> reads meaning it may take some time but will eventually return the most up-to-date data.</p> </note>', 'ListStackSets' => '<p>Returns summary information about StackSets that are associated with the user.</p> <note> <p>This API provides <i>strongly consistent</i> reads meaning it will always return the most up-to-date data.</p> </note> <ul> <li> <p>[Self-managed permissions] If you set the <code>CallAs</code> parameter to <code>SELF</code> while signed in to your Amazon Web Services account, <code>ListStackSets</code> returns all self-managed StackSets in your Amazon Web Services account.</p> </li> <li> <p>[Service-managed permissions] If you set the <code>CallAs</code> parameter to <code>SELF</code> while signed in to the organization\'s management account, <code>ListStackSets</code> returns all StackSets in the management account.</p> </li> <li> <p>[Service-managed permissions] If you set the <code>CallAs</code> parameter to <code>DELEGATED_ADMIN</code> while signed in to your member account, <code>ListStackSets</code> returns all StackSets with service-managed permissions in the management account.</p> </li> </ul>', 'ListStacks' => '<p>Returns the summary information for stacks whose status matches the specified <code>StackStatusFilter</code>. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no <code>StackStatusFilter</code> is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).</p>', 'ListTypeRegistrations' => '<p>Returns a list of registration tokens for the specified extension(s).</p>', 'ListTypeVersions' => '<p>Returns summary information about the versions of an extension.</p>', 'ListTypes' => '<p>Returns summary information about all extensions, including your private resource types, modules, and Hooks as well as all public extensions from Amazon Web Services and third-party publishers.</p>', 'PublishType' => '<p>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 <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to make them available for public use</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p> <p>To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>.</p>', 'RecordHandlerProgress' => '<p>Reports progress of a resource handler to CloudFormation.</p> <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. Don\'t use this API in your code.</p>', 'RegisterPublisher' => '<p>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.</p> <p>For information about requirements for registering as a public extension publisher, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs">Prerequisite: Registering your account to publish CloudFormation extensions</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p> <p/>', 'RegisterType' => '<p>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:</p> <ul> <li> <p>Validating the extension schema.</p> </li> <li> <p>Determining which handlers, if any, have been specified for the extension.</p> </li> <li> <p>Making the extension available for use in your account.</p> </li> </ul> <p>For more information about how to develop extensions and ready them for registration, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html">Creating resource types using the CloudFormation CLI</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p> <p>You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html">DeregisterType</a> to deregister specific extension versions if necessary.</p> <p>Once you have initiated a registration request using <a>RegisterType</a>, you can use <a>DescribeTypeRegistration</a> to monitor the progress of the registration request.</p> <p>Once you have registered a private extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration data for extensions in your account</a> in the <i>CloudFormation User Guide</i>.</p>', 'RollbackStack' => '<p>When specifying <code>RollbackStack</code>, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the <a>DescribeStacks</a> operation.</p> <p>Rolls back the specified stack to the last known stable state from <code>CREATE_FAILED</code> or <code>UPDATE_FAILED</code> stack statuses.</p> <p>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 <code>*_COMPLETE</code>. This includes the following stack statuses.</p> <ul> <li> <p> <code>CREATE_COMPLETE</code> </p> </li> <li> <p> <code>UPDATE_COMPLETE</code> </p> </li> <li> <p> <code>UPDATE_ROLLBACK_COMPLETE</code> </p> </li> <li> <p> <code>IMPORT_COMPLETE</code> </p> </li> <li> <p> <code>IMPORT_ROLLBACK_COMPLETE</code> </p> </li> </ul>', 'SetStackPolicy' => '<p>Sets a stack policy for a specified stack.</p>', 'SetTypeConfiguration' => '<p>Specifies the configuration data for a CloudFormation extension, such as a resource or Hook, in the given account and Region.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration data for extensions in your account</a> in the <i>CloudFormation User Guide</i>.</p> <p>To view the current configuration data for an extension, refer to the <code>ConfigurationSchema</code> element of <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.</p> <important> <p>It\'s strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html">Specify values stored in other services using dynamic references</a> in the <i>CloudFormation User Guide</i>.</p> </important> <p>For more information about setting the configuration data for resource types, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration">Defining the account-level configuration of an extension</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>. For more information about setting the configuration data for Hooks, see the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html">CloudFormation Hooks User Guide</a>.</p>', 'SetTypeDefaultVersion' => '<p>Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.</p>', 'SignalResource' => '<p>Sends a signal to the specified resource with a success or failure status. You can use the <code>SignalResource</code> 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 <code>SignalResource</code> operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.</p>', 'StartResourceScan' => '<p>Starts a scan of the resources in this account in this Region. You can the status of a scan using the <code>ListResourceScans</code> API action.</p>', 'StopStackSetOperation' => '<p>Stops an in-progress operation on a StackSet and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.</p>', 'TestType' => '<p>Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.</p> <ul> <li> <p>For resource types, this includes passing all contracts tests defined for the type.</p> </li> <li> <p>For modules, this includes determining if the module\'s model meets all necessary requirements.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing">Testing your public extension before publishing</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p> <p>If you don\'t specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.</p> <p>To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p> <p>Once you\'ve initiated testing on an extension using <code>TestType</code>, you can pass the returned <code>TypeVersionArn</code> into <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a> to monitor the current test status and test status description for the extension.</p> <p>An extension must have a test status of <code>PASSED</code> before it can be published. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html">Publishing extensions to make them available for public use</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>', 'UpdateGeneratedTemplate' => '<p>Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the <code>DeletionPolicy</code> and <code>UpdateReplacePolicy</code> settings. You can check the status of the update to the generated template using the <code>DescribeGeneratedTemplate</code> API action.</p>', 'UpdateStack' => '<p>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 <a>DescribeStacks</a> action.</p> <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p> <p>For more information about updating a stack and monitoring the progress of the update, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html">Managing Amazon Web Services resources as a single unit with CloudFormation stacks</a> in the <i>CloudFormation User Guide</i>.</p>', 'UpdateStackInstances' => '<p>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.</p> <p>You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">CreateStackInstances</a>.</p> <p>During StackSet updates, any parameters overridden for a stack instance aren\'t updated, but retain their overridden value.</p> <p>You can only update the parameter <i>values</i> that are specified in the StackSet. To add or delete a parameter itself, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update the StackSet template. If you add a parameter to a template, before you can override the parameter value specified in the StackSet you must first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the StackSet. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p> <note> <p>The maximum number of organizational unit (OUs) supported by a <code>UpdateStackInstances</code> operation is 50.</p> <p>If you need more than 50, consider the following options:</p> <ul> <li> <p> <i>Batch processing:</i> If you don\'t want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.</p> </li> <li> <p> <i>Parent OU strategy:</i> If you don\'t mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.</p> </li> </ul> </note>', 'UpdateStackSet' => '<p>Updates the StackSet and associated stack instances in the specified accounts and Amazon Web Services Regions.</p> <p>Even if the StackSet operation created by updating the StackSet fails (completely or partially, below or above a specified failure tolerance), the StackSet is updated with your changes. Subsequent <a>CreateStackInstances</a> calls on the specified StackSet use the updated StackSet.</p> <note> <p>The maximum number of organizational unit (OUs) supported by a <code>UpdateStackSet</code> operation is 50.</p> <p>If you need more than 50, consider the following options:</p> <ul> <li> <p> <i>Batch processing:</i> If you don\'t want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.</p> </li> <li> <p> <i>Parent OU strategy:</i> If you don\'t mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.</p> </li> </ul> </note>', 'UpdateTerminationProtection' => '<p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protect a CloudFormation stack from being deleted</a> in the <i>CloudFormation User Guide</i>.</p> <p>For <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested stacks</a>, termination protection is set on the root stack and can\'t be changed directly on the nested stack.</p>', 'ValidateTemplate' => '<p>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.</p>', ], 'shapes' => [ 'AcceptTermsAndConditions' => [ 'base' => NULL, 'refs' => [ 'RegisterPublisherInput$AcceptTermsAndConditions' => '<p>Whether you accept the <a href="https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf">Terms and Conditions</a> 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.</p> <p>The default is <code>false</code>.</p>', ], ], 'Account' => [ 'base' => NULL, 'refs' => [ 'AccountList$member' => NULL, 'DescribeStackInstanceInput$StackInstanceAccount' => '<p>The ID of an Amazon Web Services account that\'s associated with this stack instance.</p>', 'ListStackInstanceResourceDriftsInput$StackInstanceAccount' => '<p>The name of the Amazon Web Services account that you want to list resource drifts for.</p>', 'ListStackInstancesInput$StackInstanceAccount' => '<p>The name of the Amazon Web Services account that you want to list stack instances for.</p>', 'StackInstance$Account' => '<p>[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.</p>', 'StackInstanceSummary$Account' => '<p>[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.</p>', 'StackSetOperationResultSummary$Account' => '<p>[Self-managed permissions] The name of the Amazon Web Services account for this operation result.</p>', ], ], 'AccountFilterType' => [ 'base' => NULL, 'refs' => [ 'DeploymentTargets$AccountFilterType' => '<p>Refines which accounts will have stack operations performed on them by specifying how to use the <code>Accounts</code> and <code>OrganizationalUnitIds</code> properties together.</p> <p>The following values determine how CloudFormation selects target accounts:</p> <ul> <li> <p> <code>INTERSECTION</code>: Performs stack operations only on specific individual accounts within the selected OUs. Only accounts that are both specified in the <code>Accounts</code> property and belong to the specified OUs will be targeted.</p> </li> <li> <p> <code>DIFFERENCE</code>: Performs stack operations on all accounts in the selected OUs except for specific accounts listed in the <code>Accounts</code> property. This enables you to exclude certain accounts within an OU, such as suspended accounts.</p> </li> <li> <p> <code>UNION</code>: Performs stack operations on the specified OUs plus additional individual accounts listed in the <code>Accounts</code> property. This is the default value if <code>AccountFilterType</code> is not provided. This lets you target an entire OU and individual accounts from a different OU in one request. Note that <code>UNION</code> is not supported for <code>CreateStackInstances</code> operations.</p> </li> <li> <p> <code>NONE</code>: Performs stack operations on all accounts in the specified organizational units (OUs).</p> </li> </ul>', ], ], 'AccountGateResult' => [ 'base' => '<p>Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a StackSet operation in an account and Region.</p> <p>For each account and Region, CloudFormation lets you specify a Lambda function that encapsulates any requirements that must be met before CloudFormation can proceed with a StackSet operation in that account and Region. CloudFormation invokes the function each time a StackSet operation is requested for that account and Region; if the function returns <code>FAILED</code>, CloudFormation cancels the operation in that account and Region, and sets the StackSet operation result status for that account and Region to <code>FAILED</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html">Prevent failed StackSets deployments using target account gates</a> in the <i>CloudFormation User Guide</i>.</p>', 'refs' => [ 'StackSetOperationResultSummary$AccountGateResult' => '<p>The results of the account gate function CloudFormation invokes, if present, before proceeding with StackSet operations in an account.</p>', ], ], 'AccountGateStatus' => [ 'base' => NULL, 'refs' => [ 'AccountGateResult$Status' => '<p>The status of the account gate function.</p> <ul> <li> <p> <code>SUCCEEDED</code>: The account gate function has determined that the account and Region passes any requirements for a StackSet operation to occur. CloudFormation proceeds with the stack operation in that account and Region.</p> </li> <li> <p> <code>FAILED</code>: The account gate function has determined that the account and Region doesn\'t meet the requirements for a StackSet operation to occur. CloudFormation cancels the StackSet operation in that account and Region, and sets the StackSet operation result status for that account and Region to <code>FAILED</code>.</p> </li> <li> <p> <code>SKIPPED</code>: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:</p> <ul> <li> <p>An account gate function hasn\'t been specified for the account and Region. CloudFormation proceeds with the StackSet operation in this account and Region.</p> </li> <li> <p>The <code>AWSCloudFormationStackSetExecutionRole</code> of the administration account lacks permissions to invoke the function. CloudFormation proceeds with the StackSet operation in this account and Region.</p> </li> <li> <p>Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the StackSet operation in this account and Region.</p> </li> </ul> </li> </ul>', ], ], 'AccountGateStatusReason' => [ 'base' => NULL, 'refs' => [ 'AccountGateResult$StatusReason' => '<p>The reason for the account gate status assigned to this account and Region for the StackSet operation.</p>', ], ], 'AccountLimit' => [ 'base' => '<p>Describes the current CloudFormation limits for your account.</p> <p>CloudFormation has the following limits per account:</p> <ul> <li> <p>Number of concurrent resources</p> </li> <li> <p>Number of stacks</p> </li> <li> <p>Number of stack outputs</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">Understand CloudFormation quotas</a> in the <i>CloudFormation User Guide</i>.</p>', 'refs' => [ 'AccountLimitList$member' => NULL, ], ], 'AccountLimitList' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsOutput$AccountLimits' => '<p>An account limit structure that contain a list of CloudFormation account limits and their values.</p>', ], ], 'AccountList' => [ 'base' => NULL, 'refs' => [ 'CreateStackInstancesInput$Accounts' => '<p>[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>', 'DeleteStackInstancesInput$Accounts' => '<p>[Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>', 'DeploymentTargets$Accounts' => '<p>The Amazon Web Services account IDs where you want to perform stack operations. How these accounts are used depends on the <code>AccountFilterType</code> property.</p> <p>If you have many account numbers, you can provide those accounts using the <code>AccountsUrl</code> property instead.</p>', 'UpdateStackInstancesInput$Accounts' => '<p>[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts 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.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>', 'UpdateStackSetInput$Accounts' => '<p>[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 StackSet instances.</p> <p>To update <i>all</i> the stack instances associated with this StackSet, don\'t specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the StackSet update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the StackSet 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.</p>', ], ], 'AccountsUrl' => [ 'base' => NULL, 'refs' => [ 'DeploymentTargets$AccountsUrl' => '<p>The Amazon S3 URL path to a file that contains a list of Amazon Web Services account IDs. The file format must be either <code>.csv</code> or <code>.txt</code>, and the data can be comma-separated or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000 accounts).</p> <p>This property serves the same purpose as <code>Accounts</code> but allows you to specify a large number of accounts.</p>', ], ], 'ActivateOrganizationsAccessInput' => [ 'base' => NULL, 'refs' => [], ], 'ActivateOrganizationsAccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'ActivateTypeInput' => [ 'base' => NULL, 'refs' => [], ], 'ActivateTypeOutput' => [ 'base' => NULL, 'refs' => [], ], 'AfterContext' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$AfterContext' => '<p>An encoded JSON string that contains the context of the resource after the change is executed.</p>', ], ], 'AfterValue' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$AfterValue' => '<p>The value of the property after the change is executed. Large values can be truncated.</p>', ], ], 'AllowedValue' => [ 'base' => NULL, 'refs' => [ 'AllowedValues$member' => NULL, ], ], 'AllowedValues' => [ 'base' => NULL, 'refs' => [ 'ParameterConstraints$AllowedValues' => '<p>A list of values that are permitted for a parameter.</p>', ], ], 'AlreadyExistsException' => [ 'base' => '<p>The resource with the name requested already exists.</p>', 'refs' => [], ], 'Arn' => [ 'base' => NULL, 'refs' => [ 'RollbackTrigger$Arn' => '<p>The Amazon Resource Name (ARN) of the rollback trigger.</p> <p>If a specified trigger is missing, the entire stack operation fails and is rolled back.</p>', ], ], 'AttributeChangeType' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$AttributeChangeType' => '<p>The type of change to be made to the property if the change is executed.</p> <ul> <li> <p> <code>Add</code> The item will be added.</p> </li> <li> <p> <code>Remove</code> The item will be removed.</p> </li> <li> <p> <code>Modify</code> The item will be modified.</p> </li> </ul>', ], ], 'AutoDeployment' => [ 'base' => '<p>Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html">Enable or disable automatic deployments for StackSets in Organizations</a> in the <i>CloudFormation User Guide</i>.</p>', 'refs' => [ 'CreateStackSetInput$AutoDeployment' => '<p>Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html">Enable or disable automatic deployments for StackSets in Organizations</a> in the <i>CloudFormation User Guide</i>.</p> <p>Required if the permissions model is <code>SERVICE_MANAGED</code>. (Not used with self-managed permissions.)</p>', 'StackSet$AutoDeployment' => '<p>Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). Valid only if the StackSet uses service-managed permissions.</p>', 'StackSetSummary$AutoDeployment' => '<p>[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organizational unit (OU).</p>', 'UpdateStackSetInput$AutoDeployment' => '<p>[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html">Enable or disable automatic deployments for StackSets in Organizations</a> in the <i>CloudFormation User Guide</i>.</p> <p>If you specify <code>AutoDeployment</code>, don\'t specify <code>DeploymentTargets</code> or <code>Regions</code>.</p>', ], ], 'AutoDeploymentNullable' => [ 'base' => NULL, 'refs' => [ 'AutoDeployment$Enabled' => '<p>If set to <code>true</code>, StackSets automatically deploys additional stack instances to Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.</p>', ], ], 'AutoUpdate' => [ 'base' => NULL, 'refs' => [ 'ActivateTypeInput$AutoUpdate' => '<p>Whether to automatically update the extension in this account and Region when a new <i>minor</i> version is published by the extension publisher. Major versions released by the publisher must be manually updated.</p> <p>The default is <code>true</code>.</p>', 'DescribeTypeOutput$AutoUpdate' => '<p>Whether CloudFormation automatically updates the extension in this account and Region when a new <i>minor</i> version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto">Automatically use new versions of extensions</a> in the <i>CloudFormation User Guide</i>.</p>', ], ], 'BatchDescribeTypeConfigurationsError' => [ 'base' => '<p>Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.</p>', 'refs' => [ 'BatchDescribeTypeConfigurationsErrors$member' => NULL, ], ], 'BatchDescribeTypeConfigurationsErrors' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeTypeConfigurationsOutput$Errors' => '<p>A list of information concerning any errors generated during the setting of the specified configurations.</p>', ], ], 'BatchDescribeTypeConfigurationsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDescribeTypeConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BeforeContext' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$BeforeContext' => '<p>An encoded JSON string that contains the context of the resource before the change is executed.</p>', ], ], 'BeforeValue' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$BeforeValue' => '<p>The value of the property before the change is executed. Large values can be truncated.</p>', ], ], 'BoxedInteger' => [ 'base' => NULL, 'refs' => [ 'DescribeStackDriftDetectionStatusOutput$DriftedStackResourceCount' => '<p>Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of <code>DETECTION_COMPLETE</code>. This value will be 0 for stacks whose drift status is <code>IN_SYNC</code>.</p>', ], ], 'BoxedMaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeStackResourceDriftsInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', 'ListResourceScanRelatedResourcesInput$MaxResults' => '<p>If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can use for the <code>NextToken</code> parameter to get the next set of results. By default the <code>ListResourceScanRelatedResources</code> API action will return up to 100 results in each response. The maximum value is 100.</p>', ], ], 'CFNRegistryException' => [ 'base' => '<p>An error occurred during a CloudFormation registry operation.</p>', 'refs' => [], ], 'CallAs' => [ 'base' => NULL, 'refs' => [ 'CreateStackInstancesInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'CreateStackSetInput$CallAs' => '<p>Specifies whether you are acting as an account administrator in the organization\'s management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>To create a StackSet with service-managed permissions while signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>To create a StackSet with service-managed permissions while signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul> <p>StackSets with service-managed permissions are created in the management account, including StackSets that are created by delegated administrators.</p> <p>Valid only if the permissions model is <code>SERVICE_MANAGED</code>.</p>', 'DeleteStackInstancesInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'DeleteStackSetInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'DescribeOrganizationsAccessInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'DescribeStackInstanceInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'DescribeStackSetInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'DescribeStackSetOperationInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'DetectStackSetDriftInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'GetTemplateSummaryInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'ImportStacksToStackSetInput$CallAs' => '<p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>For service managed StackSets, specify <code>DELEGATED_ADMIN</code>.</p> </li> </ul>', 'ListStackInstanceResourceDriftsInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'ListStackInstancesInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'ListStackSetAutoDeploymentTargetsInput$CallAs' => '<p>Specifies whether you are acting as an account administrator in the organization\'s management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'ListStackSetOperationResultsInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'ListStackSetOperationsInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'ListStackSetsInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'StopStackSetOperationInput$CallAs' => '<p>Specifies whether you are acting as an account administrator in the organization\'s management account or as a delegated administrator in a member account. Valid only if the StackSet uses service-managed permissions.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'UpdateStackInstancesInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', 'UpdateStackSetInput$CallAs' => '<p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>', ], ], 'CancelUpdateStackInput' => [ 'base' => '<p>The input for the <a>CancelUpdateStack</a> action.</p>', 'refs' => [], ], 'Capabilities' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$Capabilities' => '<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>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.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don\'t specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-accesskey.html"> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-group.html"> AWS::IAM::Group</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-managedpolicy.html"> AWS::IAM::ManagedPolicy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-policy.html"> AWS::IAM::Policy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-role.html"> AWS::IAM::Role</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html"> AWS::IAM::User</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-usertogroupaddition.html">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html">AWS::Include</a> and <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.</p> <note> <p>This capacity doesn\'t apply to creating change sets, and specifying it when creating change sets has no effect.</p> <p>If you want to create a stack from a stack template that contains macros <i>and</i> nested stacks, you must create or update the stack directly from the template using the <a>CreateStack</a> or <a>UpdateStack</a> action, and specifying this capability.</p> </note> <p>For more information about macros, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Perform custom processing on CloudFormation templates with template macros</a>.</p> </li> </ul> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>', 'CreateStackInput$Capabilities' => '<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>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.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don\'t specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-accesskey.html">AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-group.html">AWS::IAM::Group</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-managedpolicy.html"> AWS::IAM::ManagedPolicy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-policy.html">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-role.html">AWS::IAM::Role</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html">AWS::IAM::User</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-usertogroupaddition.html">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html">AWS::Include</a> and <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.</p> <p>If you want to create a stack from a stack template that contains macros <i>and</i> nested stacks, you must create the stack directly from the template using this capability.</p> <important> <p>You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.</p> <p>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.</p> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Perform custom processing on CloudFormation templates with template macros</a>.</p> </li> </ul> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>', 'CreateStackSetInput$Capabilities' => '<p>In some cases, you must explicitly acknowledge that your StackSet template contains certain capabilities in order for CloudFormation to create the StackSet and related stack instances.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>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 StackSets, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don\'t specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-accesskey.html">AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-group.html">AWS::IAM::Group</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-policy.html">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-role.html">AWS::IAM::Role</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html">AWS::IAM::User</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-usertogroupaddition.html">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some templates reference macros. If your StackSet template references one or more macros, you must create the StackSet directly from the processed template, without first reviewing the resulting changes in a change set. To create the StackSet directly, you must acknowledge this capability. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Perform custom processing on CloudFormation templates with template macros</a>.</p> <important> <p>StackSets with service-managed permissions don\'t currently support the use of macros in templates. (This includes the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html">AWS::Include</a> and <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a StackSet with service-managed permissions, if you reference a macro in your template the StackSet operation will fail.</p> </important> </li> </ul>', 'DescribeChangeSetOutput$Capabilities' => '<p>If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.</p>', 'GetTemplateSummaryOutput$Capabilities' => '<p>The capabilities found within the template. If your template contains IAM resources, you must specify the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p>', 'Stack$Capabilities' => '<p>The capabilities allowed in the stack.</p>', 'StackSet$Capabilities' => '<p>The capabilities that are allowed in the StackSet. Some StackSet 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p>', 'UpdateStackInput$Capabilities' => '<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>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.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don\'t specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-accesskey.html"> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-group.html"> AWS::IAM::Group</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-managedpolicy.html"> AWS::IAM::ManagedPolicy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-policy.html">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-role.html"> AWS::IAM::Role</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html"> AWS::IAM::User</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-usertogroupaddition.html">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html">AWS::Include</a> and <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.</p> <p>If you want to update a stack from a stack template that contains macros <i>and</i> nested stacks, you must update the stack directly from the template using this capability.</p> <important> <p>You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.</p> <p>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.</p> </important> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Perform custom processing on CloudFormation templates with template macros</a>.</p> </li> </ul> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>', 'UpdateStackSetInput$Capabilities' => '<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the StackSet and its associated stack instances.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>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.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don\'t specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-accesskey.html">AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-group.html">AWS::IAM::Group</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-policy.html">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-role.html">AWS::IAM::Role</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html">AWS::IAM::User</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-usertogroupaddition.html">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some templates reference macros. If your StackSet template references one or more macros, you must update the StackSet directly from the processed template, without first reviewing the resulting changes in a change set. To update the StackSet directly, you must acknowledge this capability. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Perform custom processing on CloudFormation templates with template macros</a>.</p> <important> <p>StackSets with service-managed permissions do not currently support the use of macros in templates. (This includes the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html">AWS::Include</a> and <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a StackSet with service-managed permissions, if you reference a macro in your template the StackSet operation will fail.</p> </important> </li> </ul>', 'ValidateTemplateOutput$Capabilities' => '<p>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 <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p>', ], ], 'CapabilitiesReason' => [ 'base' => NULL, 'refs' => [ 'GetTemplateSummaryOutput$CapabilitiesReason' => '<p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>', 'ValidateTemplateOutput$CapabilitiesReason' => '<p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>', ], ], 'Capability' => [ 'base' => NULL, 'refs' => [ 'Capabilities$member' => NULL, ], ], 'Category' => [ 'base' => NULL, 'refs' => [ 'TypeFilters$Category' => '<p>The category of extensions to return.</p> <ul> <li> <p> <code>REGISTERED</code>: Private extensions that have been registered for this account and Region.</p> </li> <li> <p> <code>ACTIVATED</code>: Public extensions that have been activated for this account and Region.</p> </li> <li> <p> <code>THIRD_PARTY</code>: Extensions available for use from publishers other than Amazon. This includes:</p> <ul> <li> <p>Private extensions registered in the account.</p> </li> <li> <p>Public extensions from publishers other than Amazon, whether activated or not.</p> </li> </ul> </li> <li> <p> <code>AWS_TYPES</code>: Extensions available for use from Amazon.</p> </li> </ul>', ], ], 'CausingEntity' => [ 'base' => NULL, 'refs' => [ 'ResourceChangeDetail$CausingEntity' => '<p>The identity of the entity that triggered this change. This entity is a member of the group that\'s specified by the <code>ChangeSource</code> field. For example, if you modified the value of the <code>KeyPairName</code> parameter, the <code>CausingEntity</code> is the name of the parameter (<code>KeyPairName</code>).</p> <p>If the <code>ChangeSource</code> value is <code>DirectModification</code>, no value is given for <code>CausingEntity</code>.</p>', ], ], 'Change' => [ 'base' => '<p>The <code>Change</code> structure describes the changes CloudFormation will perform if you execute the change set.</p>', 'refs' => [ 'Changes$member' => NULL, ], ], 'ChangeAction' => [ 'base' => NULL, 'refs' => [ 'ChangeSetHookResourceTargetDetails$ResourceAction' => '<p>Specifies the action of the resource.</p>', 'ResourceChange$Action' => '<p>The action that CloudFormation takes on the resource, such as <code>Add</code> (adds a new resource), <code>Modify</code> (changes a resource), <code>Remove</code> (deletes a resource), <code>Import</code> (imports a resource), or <code>Dynamic</code> (exact action for the resource can\'t be determined).</p>', ], ], 'ChangeSetHook' => [ 'base' => '<p>Specifies the resource, the Hook, and the Hook version to be invoked.</p>', 'refs' => [ 'ChangeSetHooks$member' => NULL, ], ], 'ChangeSetHookResourceTargetDetails' => [ 'base' => '<p>Specifies <code>RESOURCE</code> type target details for activated Hooks.</p>', 'refs' => [ 'ChangeSetHookTargetDetails$ResourceTargetDetails' => '<p>Required if <code>TargetType</code> is <code>RESOURCE</code>.</p>', ], ], 'ChangeSetHookTargetDetails' => [ 'base' => '<p>Specifies target details for an activated Hook.</p>', 'refs' => [ 'ChangeSetHook$TargetDetails' => '<p>Specifies details about the target that the Hook will run against.</p>', ], ], 'ChangeSetHooks' => [ 'base' => NULL, 'refs' => [ 'DescribeChangeSetHooksOutput$Hooks' => '<p>List of Hook objects.</p>', ], ], 'ChangeSetHooksStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeChangeSetHooksOutput$Status' => '<p>Provides the status of the change set hook.</p>', ], ], 'ChangeSetId' => [ 'base' => NULL, 'refs' => [ 'ChangeSetSummary$ChangeSetId' => '<p>The ID of the change set.</p>', 'ChangeSetSummary$ParentChangeSetId' => '<p>The parent change set ID.</p>', 'ChangeSetSummary$RootChangeSetId' => '<p>The root change set ID.</p>', 'CreateChangeSetOutput$Id' => '<p>The Amazon Resource Name (ARN) of the change set.</p>', 'DescribeChangeSetHooksOutput$ChangeSetId' => '<p>The change set identifier (stack ID).</p>', 'DescribeChangeSetOutput$ChangeSetId' => '<p>The Amazon Resource Name (ARN) of the change set.</p>', 'DescribeChangeSetOutput$ParentChangeSetId' => '<p>Specifies the change set ID of the parent change set in the current nested change set hierarchy.</p>', 'DescribeChangeSetOutput$RootChangeSetId' => '<p>Specifies the change set ID of the root change set in the current nested change set hierarchy.</p>', 'ResourceChange$ChangeSetId' => '<p>The change set ID of the nested change set.</p>', 'Stack$ChangeSetId' => '<p>The unique ID of the change set.</p>', ], ], 'ChangeSetName' => [ 'base' => NULL, 'refs' => [ 'ChangeSetSummary$ChangeSetName' => '<p>The name of the change set.</p>', 'CreateChangeSetInput$ChangeSetName' => '<p>The name of the change set. The name must be unique among all change sets that are associated with the specified stack.</p> <p>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.</p>', 'DescribeChangeSetHooksOutput$ChangeSetName' => '<p>The change set name.</p>', 'DescribeChangeSetOutput$ChangeSetName' => '<p>The name of the change set.</p>', ], ], 'ChangeSetNameOrId' => [ 'base' => NULL, 'refs' => [ 'DeleteChangeSetInput$ChangeSetName' => '<p>The name or Amazon Resource Name (ARN) of the change set that you want to delete.</p>', 'DescribeChangeSetHooksInput$ChangeSetName' => '<p>The name or Amazon Resource Name (ARN) of the change set that you want to describe.</p>', 'DescribeChangeSetInput$ChangeSetName' => '<p>The name or Amazon Resource Name (ARN) of the change set that you want to describe.</p>', 'ExecuteChangeSetInput$ChangeSetName' => '<p>The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.</p>', 'GetTemplateInput$ChangeSetName' => '<p>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 <code>StackName</code>.</p>', ], ], 'ChangeSetNotFoundException' => [ 'base' => '<p>The specified change set name or ID doesn\'t exit. To view valid change sets for a stack, use the <code>ListChangeSets</code> operation.</p>', 'refs' => [], ], 'ChangeSetStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeSetSummary$Status' => '<p>The state of the change set, such as <code>CREATE_PENDING</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>', 'DescribeChangeSetOutput$Status' => '<p>The current status of the change set, such as <code>CREATE_PENDING</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>', ], ], 'ChangeSetStatusReason' => [ 'base' => NULL, 'refs' => [ 'ChangeSetSummary$StatusReason' => '<p>A description of the change set\'s status. For example, if your change set is in the <code>FAILED</code> state, CloudFormation shows the error message.</p>', 'DescribeChangeSetOutput$StatusReason' => '<p>A description of the change set\'s status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.</p>', ], ], 'ChangeSetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListChangeSetsOutput$Summaries' => '<p>A list of <code>ChangeSetSummary</code> structures that provides the ID and status of each change set for the specified stack.</p>', ], ], 'ChangeSetSummary' => [ 'base' => '<p>The <code>ChangeSetSummary</code> structure describes a change set, its status, and the stack with which it\'s associated.</p>', 'refs' => [ 'ChangeSetSummaries$member' => NULL, ], ], 'ChangeSetType' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$ChangeSetType' => '<p>The type of change set operation. To create a change set for a new stack, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code>. To create a change set for an import operation, specify <code>IMPORT</code>.</p> <p>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 <code>REVIEW_IN_PROGRESS</code> state until you execute the change set.</p> <p>By default, CloudFormation specifies <code>UPDATE</code>. You can\'t use the <code>UPDATE</code> type to create a change set for a new stack or the <code>CREATE</code> type to create a change set for an existing stack.</p>', ], ], 'ChangeSource' => [ 'base' => NULL, 'refs' => [ 'ResourceChangeDetail$ChangeSource' => '<p>The group to which the <code>CausingEntity</code> value belongs. There are five entity groups:</p> <ul> <li> <p> <code>ResourceReference</code> entities are <code>Ref</code> intrinsic functions that refer to resources in the template, such as <code>{ "Ref" : "MyEC2InstanceResource" }</code>.</p> </li> <li> <p> <code>ParameterReference</code> entities are <code>Ref</code> intrinsic functions that get template parameter values, such as <code>{ "Ref" : "MyPasswordParameter" }</code>.</p> </li> <li> <p> <code>ResourceAttribute</code> entities are <code>Fn::GetAtt</code> intrinsic functions that get resource attribute values, such as <code>{ "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }</code>.</p> </li> <li> <p> <code>DirectModification</code> entities are changes that are made directly to the template.</p> </li> <li> <p> <code>Automatic</code> entities are <code>AWS::CloudFormation::Stack</code> resource types, which are also known as nested stacks. If you made no changes to the <code>AWS::CloudFormation::Stack</code> resource, CloudFormation sets the <code>ChangeSource</code> to <code>Automatic</code> 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.</p> </li> </ul>', ], ], 'ChangeType' => [ 'base' => NULL, 'refs' => [ 'Change$Type' => '<p>The type of entity that CloudFormation changes.</p> <ul> <li> <p> <code>Resource</code> This change is for a resource.</p> </li> </ul>', ], ], 'Changes' => [ 'base' => NULL, 'refs' => [ 'DescribeChangeSetOutput$Changes' => '<p>A list of <code>Change</code> structures that describes the resources CloudFormation changes if you execute the change set.</p>', ], ], 'ClientRequestToken' => [ 'base' => NULL, 'refs' => [ 'CancelUpdateStackInput$ClientRequestToken' => '<p>A unique identifier for this <code>CancelUpdateStack</code> 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 <code>CancelUpdateStack</code> requests to ensure that CloudFormation successfully received them.</p>', 'ContinueUpdateRollbackInput$ClientRequestToken' => '<p>A unique identifier for this <code>ContinueUpdateRollback</code> 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 <code>ContinueUpdateRollback</code> requests to ensure that CloudFormation successfully received them.</p>', 'CreateStackInput$ClientRequestToken' => '<p>A unique identifier for this <code>CreateStack</code> 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 <code>CreateStack</code> requests to ensure that CloudFormation successfully received them.</p> <p>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 <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p> <p>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 <i>Console-StackOperation-ID</i>, 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: <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>', 'CreateStackInstancesInput$OperationId' => '<p>The unique identifier for this StackSet operation.</p> <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.</p> <p>If you don\'t specify an operation ID, the SDK generates one automatically.</p> <p>Repeating this StackSet operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>.</p>', 'CreateStackInstancesOutput$OperationId' => '<p>The unique identifier for this StackSet operation.</p>', 'CreateStackSetInput$ClientRequestToken' => '<p>A unique identifier for this <code>CreateStackSet</code> request. Specify this token if you plan to retry requests so that CloudFormation knows that you\'re not attempting to create another StackSet with the same name. You might retry <code>CreateStackSet</code> requests to ensure that CloudFormation successfully received them.</p> <p>If you don\'t specify an operation ID, the SDK generates one automatically.</p>', 'DeleteStackInput$ClientRequestToken' => '<p>A unique identifier for this <code>DeleteStack</code> 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 <code>DeleteStack</code> requests to ensure that CloudFormation successfully received them.</p> <p>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 <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p> <p>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 <i>Console-StackOperation-ID</i>, 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: <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>', 'DeleteStackInstancesInput$OperationId' => '<p>The unique identifier for this StackSet operation.</p> <p>If you don\'t specify an operation ID, the SDK generates one automatically.</p> <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You can retry StackSet operation requests to ensure that CloudFormation successfully received them.</p> <p>Repeating this StackSet operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>.</p>', 'DeleteStackInstancesOutput$OperationId' => '<p>The unique identifier for this StackSet operation.</p>', 'DescribeStackSetOperationInput$OperationId' => '<p>The unique ID of the StackSet operation.</p>', 'DetectStackSetDriftInput$OperationId' => '<p> <i>The ID of the StackSet operation.</i> </p>', 'DetectStackSetDriftOutput$OperationId' => '<p>The ID of the drift detection StackSet operation.</p> <p>You can use this operation ID with <a>DescribeStackSetOperation</a> to monitor the progress of the drift detection operation.</p>', 'ExecuteChangeSetInput$ClientRequestToken' => '<p>A unique identifier for this <code>ExecuteChangeSet</code> 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 <code>ExecuteChangeSet</code> requests to ensure that CloudFormation successfully received them.</p>', 'ImportStacksToStackSetInput$OperationId' => '<p>A unique, user defined, identifier for the StackSet operation.</p>', 'ImportStacksToStackSetOutput$OperationId' => '<p>The unique identifier for the StackSet operation.</p>', 'ListStackInstanceResourceDriftsInput$OperationId' => '<p>The unique ID of the drift operation.</p>', 'ListStackSetOperationResultsInput$OperationId' => '<p>The ID of the StackSet operation.</p>', 'RecordHandlerProgressInput$ClientRequestToken' => '<p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>', 'RollbackStackInput$ClientRequestToken' => '<p>A unique identifier for this <code>RollbackStack</code> request.</p>', 'StackEvent$ClientRequestToken' => '<p>The token passed to the operation that generated this event.</p> <p>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 <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p> <p>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 <i>Console-StackOperation-ID</i>, 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: <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>', 'StackInstance$LastOperationId' => '<p>The last unique ID of a StackSet operation performed on a stack instance.</p>', 'StackInstanceSummary$LastOperationId' => '<p>The last unique ID of a StackSet operation performed on a stack instance.</p>', 'StackSetOperation$OperationId' => '<p>The unique ID of a StackSet operation.</p>', 'StackSetOperationSummary$OperationId' => '<p>The unique ID of the StackSet operation.</p>', 'StartResourceScanInput$ClientRequestToken' => '<p>A unique identifier for this <code>StartResourceScan</code> 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.</p>', 'StopStackSetOperationInput$OperationId' => '<p>The ID of the stack operation.</p>', 'UpdateStackInput$ClientRequestToken' => '<p>A unique identifier for this <code>UpdateStack</code> 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 <code>UpdateStack</code> requests to ensure that CloudFormation successfully received them.</p> <p>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 <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p> <p>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 <i>Console-StackOperation-ID</i>, 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: <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>', 'UpdateStackInstancesInput$OperationId' => '<p>The unique identifier for this StackSet operation.</p> <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.</p> <p>If you don\'t specify an operation ID, the SDK generates one automatically.</p>', 'UpdateStackInstancesOutput$OperationId' => '<p>The unique identifier for this StackSet operation.</p>', 'UpdateStackSetInput$OperationId' => '<p>The unique ID for this StackSet operation.</p> <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.</p> <p>If you don\'t specify an operation ID, CloudFormation generates one automatically.</p> <p>Repeating this StackSet operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>.</p>', 'UpdateStackSetOutput$OperationId' => '<p>The unique ID for this StackSet operation.</p>', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$ClientToken' => '<p>A unique identifier for this <code>CreateChangeSet</code> 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 <code>CreateChangeSet</code> requests to ensure that CloudFormation successfully received them.</p>', 'RecordHandlerProgressInput$BearerToken' => '<p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>', ], ], 'ConcurrencyMode' => [ 'base' => NULL, 'refs' => [ 'StackSetOperationPreferences$ConcurrencyMode' => '<p>Specifies how the concurrency level behaves during the operation execution.</p> <ul> <li> <p> <code>STRICT_FAILURE_TOLERANCE</code>: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of <code>FailureToleranceCount</code> +1. The initial actual concurrency is set to the lower of either the value of the <code>MaxConcurrentCount</code>, or the value of <code>FailureToleranceCount</code> +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.</p> <p>If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.</p> </li> <li> <p> <code>SOFT_FAILURE_TOLERANCE</code>: This option decouples <code>FailureToleranceCount</code> from the actual concurrency. This allows StackSet operations to run at the concurrency level set by the <code>MaxConcurrentCount</code> value, or <code>MaxConcurrentPercentage</code>, regardless of the number of failures.</p> </li> </ul>', ], ], 'ConcurrentResourcesLimitExceededException' => [ 'base' => '<p>No more than 5 generated templates can be in an <code>InProgress</code> or <code>Pending</code> status at one time. This error is also returned if a generated template that is in an <code>InProgress</code> or <code>Pending</code> status is attempted to be updated or deleted.</p>', 'refs' => [], ], 'ConfigurationSchema' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeOutput$ConfigurationSchema' => '<p>A JSON string that represent the current configuration data for the extension in this account and Region.</p> <p>To set the configuration data for an extension, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a>.</p>', ], ], 'ConnectionArn' => [ 'base' => NULL, 'refs' => [ 'RegisterPublisherInput$ConnectionArn' => '<p>If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs">Prerequisite: Registering your account to publish CloudFormation extensions</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>', ], ], 'ContinueUpdateRollbackInput' => [ 'base' => '<p>The input for the <a>ContinueUpdateRollback</a> action.</p>', 'refs' => [], ], 'ContinueUpdateRollbackOutput' => [ 'base' => '<p>The output for a <a>ContinueUpdateRollback</a> operation.</p>', 'refs' => [], ], 'CreateChangeSetInput' => [ 'base' => '<p>The input for the <a>CreateChangeSet</a> action.</p>', 'refs' => [], ], 'CreateChangeSetOutput' => [ 'base' => '<p>The output for the <a>CreateChangeSet</a> action.</p>', 'refs' => [], ], 'CreateGeneratedTemplateInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateGeneratedTemplateOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStackInput' => [ 'base' => '<p>The input for <a>CreateStack</a> action.</p>', 'refs' => [], ], 'CreateStackInstancesInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStackInstancesOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStackOutput' => [ 'base' => '<p>The output for a <a>CreateStack</a> action.</p>', 'refs' => [], ], 'CreateStackRefactorInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStackRefactorOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStackSetInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateStackSetOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreatedButModifiedException' => [ 'base' => '<p>The specified resource exists, but has been changed.</p>', 'refs' => [], ], 'CreationTime' => [ 'base' => NULL, 'refs' => [ 'ChangeSetSummary$CreationTime' => '<p>The start time when the change set was created, in UTC.</p>', 'DescribeChangeSetOutput$CreationTime' => '<p>The start time when the change set was created, in UTC.</p>', 'DescribeGeneratedTemplateOutput$CreationTime' => '<p>The time the generated template was created.</p>', 'Stack$CreationTime' => '<p>The time at which the stack was created.</p>', 'StackSummary$CreationTime' => '<p>The time the stack was created.</p>', 'TemplateSummary$CreationTime' => '<p>The time the generated template was created.</p>', ], ], 'DeactivateOrganizationsAccessInput' => [ 'base' => NULL, 'refs' => [], ], 'DeactivateOrganizationsAccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeactivateTypeInput' => [ 'base' => NULL, 'refs' => [], ], 'DeactivateTypeOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteChangeSetInput' => [ 'base' => '<p>The input for the <a>DeleteChangeSet</a> action.</p>', 'refs' => [], ], 'DeleteChangeSetOutput' => [ 'base' => '<p>The output for the <a>DeleteChangeSet</a> action.</p>', 'refs' => [], ], 'DeleteGeneratedTemplateInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStackInput' => [ 'base' => '<p>The input for <a>DeleteStack</a> action.</p>', 'refs' => [], ], 'DeleteStackInstancesInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStackInstancesOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStackSetInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteStackSetOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeletionMode' => [ 'base' => NULL, 'refs' => [ 'DeleteStackInput$DeletionMode' => '<p>Specifies the deletion mode for the stack. Possible values are:</p> <ul> <li> <p> <code>STANDARD</code> - Use the standard behavior. Specifying this value is the same as not specifying this parameter.</p> </li> <li> <p> <code>FORCE_DELETE_STACK</code> - Delete the stack if it\'s stuck in a <code>DELETE_FAILED</code> state due to resource deletion failure.</p> </li> </ul>', 'Stack$DeletionMode' => '<p>Specifies the deletion mode for the stack. Possible values are:</p> <ul> <li> <p> <code>STANDARD</code> - Use the standard behavior. Specifying this value is the same as not specifying this parameter.</p> </li> <li> <p> <code>FORCE_DELETE_STACK</code> - Delete the stack if it\'s stuck in a <code>DELETE_FAILED</code> state due to resource deletion failure.</p> </li> </ul>', ], ], 'DeletionTime' => [ 'base' => NULL, 'refs' => [ 'Stack$DeletionTime' => '<p>The time the stack was deleted.</p>', 'StackSummary$DeletionTime' => '<p>The time the stack was deleted.</p>', ], ], 'DeploymentTargets' => [ 'base' => '<p>Specifies the Organizations accounts where you want to create, update, or delete stack instances. You can target either your entire organization or specific accounts using organizational units (OUs) and account filter options.</p> <p>CloudFormation doesn\'t deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.</p> <p>When performing create operations, if you specify both <code>OrganizationalUnitIds</code> and <code>Accounts</code>, you must also specify the <code>AccountFilterType</code> property.</p>', 'refs' => [ 'CreateStackInstancesInput$DeploymentTargets' => '<p>[Service-managed permissions] The Organizations accounts in which to create stack instances in the specified Amazon Web Services Regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>', 'DeleteStackInstancesInput$DeploymentTargets' => '<p>[Service-managed permissions] The Organizations accounts from which to delete stack instances.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>', 'StackSetOperation$DeploymentTargets' => '<p>The Organizations accounts affected by the stack operation. Valid only if the StackSet uses service-managed permissions.</p>', 'UpdateStackInstancesInput$DeploymentTargets' => '<p>[Service-managed permissions] The Organizations accounts in 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.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>', 'UpdateStackSetInput$DeploymentTargets' => '<p>[Service-managed permissions] The Organizations accounts in which to update associated stack instances.</p> <p>To update all the stack instances associated with this StackSet, do not specify <code>DeploymentTargets</code> or <code>Regions</code>.</p> <p>If the StackSet update includes changes to the template (that is, if <code>TemplateBody</code> or <code>TemplateURL</code> is specified), or the <code>Parameters</code>, CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the StackSet 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.</p>', ], ], 'DeprecatedStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeOutput$DeprecatedStatus' => '<p>The deprecation status of the extension version.</p> <p>Valid values include:</p> <ul> <li> <p> <code>LIVE</code>: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.</p> </li> <li> <p> <code>DEPRECATED</code>: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.</p> </li> </ul> <p>For public third-party extensions, CloudFormation returns <code>null</code>.</p>', 'ListTypeVersionsInput$DeprecatedStatus' => '<p>The deprecation status of the extension versions that you want to get summary information about.</p> <p>Valid values include:</p> <ul> <li> <p> <code>LIVE</code>: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.</p> </li> <li> <p> <code>DEPRECATED</code>: The extension version has been deregistered and can no longer be used in CloudFormation operations.</p> </li> </ul> <p>The default is <code>LIVE</code>.</p>', 'ListTypesInput$DeprecatedStatus' => '<p>The deprecation status of the extension that you want to get summary information about.</p> <p>Valid values include:</p> <ul> <li> <p> <code>LIVE</code>: The extension is registered for use in CloudFormation operations.</p> </li> <li> <p> <code>DEPRECATED</code>: The extension has been deregistered and can no longer be used in CloudFormation operations.</p> </li> </ul>', ], ], 'DeregisterTypeInput' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTypeOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeAccountLimitsInput' => [ 'base' => '<p>The input for the <a>DescribeAccountLimits</a> action.</p>', 'refs' => [], ], 'DescribeAccountLimitsOutput' => [ 'base' => '<p>The output for the <a>DescribeAccountLimits</a> action.</p>', 'refs' => [], ], 'DescribeChangeSetHooksInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeChangeSetHooksOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeChangeSetInput' => [ 'base' => '<p>The input for the <a>DescribeChangeSet</a> action.</p>', 'refs' => [], ], 'DescribeChangeSetOutput' => [ 'base' => '<p>The output for the <a>DescribeChangeSet</a> action.</p>', 'refs' => [], ], 'DescribeGeneratedTemplateInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGeneratedTemplateOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationsAccessInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeOrganizationsAccessOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePublisherInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribePublisherOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResourceScanInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeResourceScanOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackDriftDetectionStatusInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackDriftDetectionStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackEventsInput' => [ 'base' => '<p>The input for <a>DescribeStackEvents</a> action.</p>', 'refs' => [], ], 'DescribeStackEventsOutput' => [ 'base' => '<p>The output for a <a>DescribeStackEvents</a> action.</p>', 'refs' => [], ], 'DescribeStackInstanceInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackInstanceOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackRefactorInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackRefactorOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackResourceDriftsInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackResourceDriftsOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackResourceInput' => [ 'base' => '<p>The input for <a>DescribeStackResource</a> action.</p>', 'refs' => [], ], 'DescribeStackResourceOutput' => [ 'base' => '<p>The output for a <a>DescribeStackResource</a> action.</p>', 'refs' => [], ], 'DescribeStackResourcesInput' => [ 'base' => '<p>The input for <a>DescribeStackResources</a> action.</p>', 'refs' => [], ], 'DescribeStackResourcesOutput' => [ 'base' => '<p>The output for a <a>DescribeStackResources</a> action.</p>', 'refs' => [], ], 'DescribeStackSetInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackSetOperationInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackSetOperationOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStackSetOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeStacksInput' => [ 'base' => '<p>The input for <a>DescribeStacks</a> action.</p>', 'refs' => [], ], 'DescribeStacksOutput' => [ 'base' => '<p>The output for a <a>DescribeStacks</a> action.</p>', 'refs' => [], ], 'DescribeTypeInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTypeOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTypeRegistrationInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTypeRegistrationOutput' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ChangeSetSummary$Description' => '<p>Descriptive information about the change set.</p>', 'CreateChangeSetInput$Description' => '<p>A description to help you identify this change set.</p>', 'CreateStackRefactorInput$Description' => '<p>A description to help you identify the stack refactor.</p>', 'CreateStackSetInput$Description' => '<p>A description of the StackSet. You can use the description to identify the StackSet\'s purpose or other important information.</p>', 'DescribeChangeSetOutput$Description' => '<p>Information about the change set.</p>', 'DescribeStackRefactorOutput$Description' => '<p>A description to help you identify the refactor.</p>', 'DescribeTypeOutput$Description' => '<p>The description of the extension.</p>', 'DescribeTypeRegistrationOutput$Description' => '<p>The description of the extension registration request.</p>', 'GetTemplateSummaryOutput$Description' => '<p>The value that\'s defined in the <code>Description</code> property of the template.</p>', 'Output$Description' => '<p>User defined description associated with the output.</p>', 'ParameterDeclaration$Description' => '<p>The description that\'s associate with the parameter.</p>', 'Stack$Description' => '<p>A user-defined description associated with the stack.</p>', 'StackRefactorAction$Description' => '<p>A description to help you identify the refactor.</p>', 'StackRefactorSummary$Description' => '<p>A description to help you identify the refactor.</p>', 'StackResource$Description' => '<p>User defined description associated with the resource.</p>', 'StackResourceDetail$Description' => '<p>User defined description associated with the resource.</p>', 'StackSet$Description' => '<p>A description of the StackSet that you specify when the StackSet is created or updated.</p>', 'StackSetSummary$Description' => '<p>A description of the StackSet that you specify when the StackSet is created or updated.</p>', 'TemplateParameter$Description' => '<p>User defined description associated with the parameter.</p>', 'TypeSummary$Description' => '<p>The description of the extension.</p>', 'TypeVersionSummary$Description' => '<p>The description of the extension version.</p>', 'UpdateStackSetInput$Description' => '<p>A brief description of updates that you are making.</p>', 'ValidateTemplateOutput$Description' => '<p>The description found within the template.</p>', ], ], 'DetailedStatus' => [ 'base' => NULL, 'refs' => [ 'Stack$DetailedStatus' => '<p>The detailed status of the resource or stack. If <code>CONFIGURATION_COMPLETE</code> is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The StackSets <code>CONFIGURATION_COMPLETE</code> when all of the resources in the stack have reached that event. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html">Understand CloudFormation stack creation events</a> in the <i>CloudFormation User Guide</i>.</p>', 'StackEvent$DetailedStatus' => '<p>An optional field that contains information about the detailed status of the stack event.</p> <ul> <li> <p> <code>CONFIGURATION_COMPLETE</code> - all of the resources in the stack have reached that event. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html">Understand CloudFormation stack creation events</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul> <ul> <li> <p> <code>VALIDATION_FAILED</code> - template validation failed because of invalid properties in the template. The <code>ResourceStatusReason</code> field shows what properties are defined incorrectly.</p> </li> </ul>', ], ], 'DetectStackDriftInput' => [ 'base' => NULL, 'refs' => [], ], 'DetectStackDriftOutput' => [ 'base' => NULL, 'refs' => [], ], 'DetectStackResourceDriftInput' => [ 'base' => NULL, 'refs' => [], ], 'DetectStackResourceDriftOutput' => [ 'base' => NULL, 'refs' => [], ], 'DetectStackSetDriftInput' => [ 'base' => NULL, 'refs' => [], ], 'DetectStackSetDriftOutput' => [ 'base' => NULL, 'refs' => [], ], 'DetectionReason' => [ 'base' => NULL, 'refs' => [ 'StackRefactorAction$DetectionReason' => '<p>The description of the detection type.</p>', ], ], 'DifferenceType' => [ 'base' => NULL, 'refs' => [ 'PropertyDifference$DifferenceType' => '<p>The type of property difference.</p> <ul> <li> <p> <code>ADD</code>: A value has been added to a resource property that\'s an array or list data type.</p> </li> <li> <p> <code>REMOVE</code>: The property has been removed from the current resource configuration.</p> </li> <li> <p> <code>NOT_EQUAL</code>: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).</p> </li> </ul>', ], ], 'DisableRollback' => [ 'base' => NULL, 'refs' => [ 'CreateStackInput$DisableRollback' => '<p>Set to <code>true</code> to disable rollback of the stack if stack creation failed. You can specify either <code>DisableRollback</code> or <code>OnFailure</code>, but not both.</p> <p>Default: <code>false</code> </p>', 'ExecuteChangeSetInput$DisableRollback' => '<p>Preserves the state of previously provisioned resources when an operation fails. This parameter can\'t be specified when the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation was specified.</p> <ul> <li> <p> <code>True</code> - if the stack creation fails, do nothing. This is equivalent to specifying <code>DO_NOTHING</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p> </li> <li> <p> <code>False</code> - if the stack creation fails, roll back the stack. This is equivalent to specifying <code>ROLLBACK</code> for the <code>OnStackFailure</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html">CreateChangeSet</a> API operation.</p> </li> </ul> <p>Default: <code>True</code> </p>', 'Stack$DisableRollback' => '<p>Boolean to enable or disable rollback on stack creation failures:</p> <ul> <li> <p> <code>true</code>: disable rollback.</p> </li> <li> <p> <code>false</code>: enable rollback.</p> </li> </ul>', 'UpdateStackInput$DisableRollback' => '<p>Preserve the state of previously provisioned resources when an operation fails.</p> <p>Default: <code>False</code> </p>', ], ], 'DriftedStackInstancesCount' => [ 'base' => NULL, 'refs' => [ 'StackSetDriftDetectionDetails$DriftedStackInstancesCount' => '<p>The number of stack instances that have drifted from the expected template and parameter configuration of the StackSet. A stack instance is considered to have drifted if one or more of the resources in the associated stack don\'t match their expected configuration.</p>', ], ], 'EnableStackCreation' => [ 'base' => NULL, 'refs' => [ 'CreateStackRefactorInput$EnableStackCreation' => '<p>Determines if a new stack is created with the refactor.</p>', ], ], 'EnableTerminationProtection' => [ 'base' => NULL, 'refs' => [ 'CreateStackInput$EnableTerminationProtection' => '<p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protect CloudFormation stacks from being deleted</a> in the <i>CloudFormation User Guide</i>. Termination protection is deactivated on stacks by default.</p> <p>For <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested stacks</a>, termination protection is set on the root stack and can\'t be changed directly on the nested stack.</p>', 'Stack$EnableTerminationProtection' => '<p>Whether termination protection is enabled for the stack.</p> <p>For <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested stacks</a>, termination protection is set on the root stack and can\'t be changed directly on the nested stack. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protect a CloudFormation stack from being deleted</a> in the <i>CloudFormation User Guide</i>.</p>', 'UpdateTerminationProtectionInput$EnableTerminationProtection' => '<p>Whether to enable termination protection on the specified stack.</p>', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeTypeConfigurationsError$ErrorCode' => '<p>The error code.</p>', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeTypeConfigurationsError$ErrorMessage' => '<p>The error message.</p>', 'CFNRegistryException$Message' => '<p>A message with details about the error that occurred.</p>', ], ], 'EstimateTemplateCostInput' => [ 'base' => '<p>The input for an <a>EstimateTemplateCost</a> action.</p>', 'refs' => [], ], 'EstimateTemplateCostOutput' => [ 'base' => '<p>The output for a <a>EstimateTemplateCost</a> action.</p>', 'refs' => [], ], 'EvaluationType' => [ 'base' => NULL, 'refs' => [ 'ResourceChangeDetail$Evaluation' => '<p>Indicates whether CloudFormation can determine the target value, and whether the target value will change before you execute a change set.</p> <p>For <code>Static</code> evaluations, CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the <code>InstanceType</code> property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a <code>Static</code> evaluation.</p> <p>For <code>Dynamic</code> evaluations, can\'t determine the target value because it depends on the result of an intrinsic function, such as a <code>Ref</code> or <code>Fn::GetAtt</code> 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.</p>', ], ], 'EventId' => [ 'base' => NULL, 'refs' => [ 'StackEvent$EventId' => '<p>The unique identifier of this event.</p>', ], ], 'ExecuteChangeSetInput' => [ 'base' => '<p>The input for the <a>ExecuteChangeSet</a> action.</p>', 'refs' => [], ], 'ExecuteChangeSetOutput' => [ 'base' => '<p>The output for the <a>ExecuteChangeSet</a> action.</p>', 'refs' => [], ], 'ExecuteStackRefactorInput' => [ 'base' => NULL, 'refs' => [], ], 'ExecutionRoleName' => [ 'base' => NULL, 'refs' => [ 'CreateStackSetInput$ExecutionRoleName' => '<p>The name of the IAM execution role to use to create the StackSet. If you do not specify an execution role, CloudFormation uses the <code>AWSCloudFormationStackSetExecutionRole</code> role for the StackSet operation.</p> <p>Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their StackSets.</p> <p>Valid only if the permissions model is <code>SELF_MANAGED</code>.</p>', 'StackSet$ExecutionRoleName' => '<p>The name of the IAM execution role used to create or update the StackSet.</p> <p>Use customized execution roles to control which stack resources users and groups can include in their StackSets.</p>', 'StackSetOperation$ExecutionRoleName' => '<p>The name of the IAM execution role used to create or update the StackSet.</p> <p>Use customized execution roles to control which stack resources users and groups can include in their StackSets.</p>', 'UpdateStackSetInput$ExecutionRoleName' => '<p>[Self-managed permissions] 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 <code>AWSCloudFormationStackSetExecutionRole</code> role for the StackSet operation.</p> <p>Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their StackSets.</p> <p>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 StackSet, so long as you have permissions to perform operations on the StackSet.</p>', ], ], 'ExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeSetSummary$ExecutionStatus' => '<p>If the change set execution status is <code>AVAILABLE</code>, 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 <code>UNAVAILABLE</code> state because CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>', 'DescribeChangeSetOutput$ExecutionStatus' => '<p>If the change set execution status is <code>AVAILABLE</code>, 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 <code>UNAVAILABLE</code> state because CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>', ], ], 'ExecutionStatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeStackRefactorOutput$ExecutionStatusReason' => '<p>A detailed explanation for the stack refactor <code>ExecutionStatus</code>.</p>', 'StackRefactorSummary$ExecutionStatusReason' => '<p>A detailed explanation for the stack refactor <code>ExecutionStatus</code>.</p>', ], ], 'Export' => [ 'base' => '<p>The <code>Export</code> structure describes the exported output values for a stack.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html">Get exported outputs from a deployed CloudFormation stack</a>.</p>', 'refs' => [ 'Exports$member' => NULL, ], ], 'ExportName' => [ 'base' => NULL, 'refs' => [ 'Export$Name' => '<p>The name of exported output value. Use this name and the <code>Fn::ImportValue</code> function to import the associated value into other stacks. The name is defined in the <code>Export</code> field in the associated stack\'s <code>Outputs</code> section.</p>', 'ListImportsInput$ExportName' => '<p>The name of the exported output value. CloudFormation returns the stack names that are importing this value.</p>', 'Output$ExportName' => '<p>The name of the export associated with the output.</p>', ], ], 'ExportValue' => [ 'base' => NULL, 'refs' => [ 'Export$Value' => '<p>The value of the exported output, such as a resource physical ID. This value is defined in the <code>Export</code> field in the associated stack\'s <code>Outputs</code> section.</p>', ], ], 'Exports' => [ 'base' => NULL, 'refs' => [ 'ListExportsOutput$Exports' => '<p>The output for the <a>ListExports</a> action.</p>', ], ], 'FailedStackInstancesCount' => [ 'base' => NULL, 'refs' => [ 'StackSetDriftDetectionDetails$FailedStackInstancesCount' => '<p>The number of stack instances for which the drift detection operation failed.</p>', 'StackSetOperationStatusDetails$FailedStackInstancesCount' => '<p>The number of stack instances for which the StackSet operation failed.</p>', ], ], 'FailureToleranceCount' => [ 'base' => NULL, 'refs' => [ 'StackSetOperationPreferences$FailureToleranceCount' => '<p>The number of accounts per Region this operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn\'t attempt the operation in any subsequent Regions.</p> <p>You can specify either <code>FailureToleranceCount</code> or <code>FailureTolerancePercentage</code>, but not both.</p> <p>By default, <code>0</code> is specified.</p>', ], ], 'FailureTolerancePercentage' => [ 'base' => NULL, 'refs' => [ 'StackSetOperationPreferences$FailureTolerancePercentage' => '<p>The percentage of accounts per Region this stack operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn\'t attempt the operation in any subsequent Regions.</p> <p>When calculating the number of accounts based on the specified percentage, CloudFormation rounds <i>down</i> to the next whole number.</p> <p>You can specify either <code>FailureToleranceCount</code> or <code>FailureTolerancePercentage</code>, but not both.</p> <p>By default, <code>0</code> is specified.</p>', ], ], 'GeneratedTemplateDeletionPolicy' => [ 'base' => NULL, 'refs' => [ 'TemplateConfiguration$DeletionPolicy' => '<p>The <code>DeletionPolicy</code> assigned to resources in the generated template. Supported values are:</p> <ul> <li> <p> <code>DELETE</code> - delete all resources when the stack is deleted.</p> </li> <li> <p> <code>RETAIN</code> - retain all resources when the stack is deleted.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy attribute</a> in the <i>CloudFormation User Guide</i>.</p>', ], ], 'GeneratedTemplateId' => [ 'base' => NULL, 'refs' => [ 'CreateGeneratedTemplateOutput$GeneratedTemplateId' => '<p>The ID of the generated template.</p>', 'DescribeGeneratedTemplateOutput$GeneratedTemplateId' => '<p>The Amazon Resource Name (ARN) of the generated template. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}</code>. For example, <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:generatedtemplate/<i>2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc</i> </code>.</p>', 'TemplateSummary$GeneratedTemplateId' => '<p>The Amazon Resource Name (ARN) of the generated template. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}</code>. For example, <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:generatedtemplate/<i>2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc</i> </code>.</p>', 'UpdateGeneratedTemplateOutput$GeneratedTemplateId' => '<p>The Amazon Resource Name (ARN) of the generated template. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}</code>. For example, <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:generatedtemplate/<i>2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc</i> </code>.</p>', ], ], 'GeneratedTemplateName' => [ 'base' => NULL, 'refs' => [ 'CreateGeneratedTemplateInput$GeneratedTemplateName' => '<p>The name assigned to the generated template.</p>', 'DeleteGeneratedTemplateInput$GeneratedTemplateName' => '<p>The name or Amazon Resource Name (ARN) of a generated template.</p>', 'DescribeGeneratedTemplateInput$GeneratedTemplateName' => '<p>The name or Amazon Resource Name (ARN) of a generated template.</p>', 'DescribeGeneratedTemplateOutput$GeneratedTemplateName' => '<p>The name of the generated template.</p>', 'GetGeneratedTemplateInput$GeneratedTemplateName' => '<p>The name or Amazon Resource Name (ARN) of the generated template. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}</code>. For example, <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:generatedtemplate/<i>2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc</i> </code>.</p>', 'TemplateSummary$GeneratedTemplateName' => '<p>The name of the generated template.</p>', 'UpdateGeneratedTemplateInput$GeneratedTemplateName' => '<p>The name or Amazon Resource Name (ARN) of a generated template.</p>', 'UpdateGeneratedTemplateInput$NewGeneratedTemplateName' => '<p>An optional new name to assign to the generated template.</p>', ], ], 'GeneratedTemplateNotFoundException' => [ 'base' => '<p>The generated template was not found.</p>', 'refs' => [], ], 'GeneratedTemplateResourceStatus' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$ResourceStatus' => '<p>Status of the processing of a resource in a generated template.</p> <dl> <dt> InProgress </dt> <dd> <p>The resource processing is still in progress.</p> </dd> <dt> Complete </dt> <dd> <p>The resource processing is complete.</p> </dd> <dt> Pending </dt> <dd> <p>The resource processing is pending.</p> </dd> <dt> Failed </dt> <dd> <p>The resource processing has failed.</p> </dd> </dl>', ], ], 'GeneratedTemplateStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeGeneratedTemplateOutput$Status' => '<p>The status of the template generation. Supported values are:</p> <ul> <li> <p> <code>CreatePending</code> - the creation of the template is pending.</p> </li> <li> <p> <code>CreateInProgress</code> - the creation of the template is in progress.</p> </li> <li> <p> <code>DeletePending</code> - the deletion of the template is pending.</p> </li> <li> <p> <code>DeleteInProgress</code> - the deletion of the template is in progress.</p> </li> <li> <p> <code>UpdatePending</code> - the update of the template is pending.</p> </li> <li> <p> <code>UpdateInProgress</code> - the update of the template is in progress.</p> </li> <li> <p> <code>Failed</code> - the template operation failed.</p> </li> <li> <p> <code>Complete</code> - the template operation is complete.</p> </li> </ul>', 'GetGeneratedTemplateOutput$Status' => '<p>The status of the template generation. Supported values are:</p> <ul> <li> <p> <code>CreatePending</code> - the creation of the template is pending.</p> </li> <li> <p> <code>CreateInProgress</code> - the creation of the template is in progress.</p> </li> <li> <p> <code>DeletePending</code> - the deletion of the template is pending.</p> </li> <li> <p> <code>DeleteInProgress</code> - the deletion of the template is in progress.</p> </li> <li> <p> <code>UpdatePending</code> - the update of the template is pending.</p> </li> <li> <p> <code>UpdateInProgress</code> - the update of the template is in progress.</p> </li> <li> <p> <code>Failed</code> - the template operation failed.</p> </li> <li> <p> <code>Complete</code> - the template operation is complete.</p> </li> </ul>', 'TemplateSummary$Status' => '<p>The status of the template generation. Supported values are:</p> <ul> <li> <p> <code>CreatePending</code> - the creation of the template is pending.</p> </li> <li> <p> <code>CreateInProgress</code> - the creation of the template is in progress.</p> </li> <li> <p> <code>DeletePending</code> - the deletion of the template is pending.</p> </li> <li> <p> <code>DeleteInProgress</code> - the deletion of the template is in progress.</p> </li> <li> <p> <code>UpdatePending</code> - the update of the template is pending.</p> </li> <li> <p> <code>UpdateInProgress</code> - the update of the template is in progress.</p> </li> <li> <p> <code>Failed</code> - the template operation failed.</p> </li> <li> <p> <code>Complete</code> - the template operation is complete.</p> </li> </ul>', ], ], 'GeneratedTemplateUpdateReplacePolicy' => [ 'base' => NULL, 'refs' => [ 'TemplateConfiguration$UpdateReplacePolicy' => '<p>The <code>UpdateReplacePolicy</code> assigned to resources in the generated template. Supported values are:</p> <ul> <li> <p> <code>DELETE</code> - delete all resources when the resource is replaced during an update operation.</p> </li> <li> <p> <code>RETAIN</code> - retain all resources when the resource is replaced during an update operation.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html">UpdateReplacePolicy attribute</a> in the <i>CloudFormation User Guide</i>.</p>', ], ], 'GetGeneratedTemplateInput' => [ 'base' => NULL, 'refs' => [], ], 'GetGeneratedTemplateOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetStackPolicyInput' => [ 'base' => '<p>The input for the <a>GetStackPolicy</a> action.</p>', 'refs' => [], ], 'GetStackPolicyOutput' => [ 'base' => '<p>The output for the <a>GetStackPolicy</a> action.</p>', 'refs' => [], ], 'GetTemplateInput' => [ 'base' => '<p>The input for a <a>GetTemplate</a> action.</p>', 'refs' => [], ], 'GetTemplateOutput' => [ 'base' => '<p>The output for <a>GetTemplate</a> action.</p>', 'refs' => [], ], 'GetTemplateSummaryInput' => [ 'base' => '<p>The input for the <a>GetTemplateSummary</a> action.</p>', 'refs' => [], ], 'GetTemplateSummaryOutput' => [ 'base' => '<p>The output for the <a>GetTemplateSummary</a> action.</p>', 'refs' => [], ], 'HandlerErrorCode' => [ 'base' => NULL, 'refs' => [ 'RecordHandlerProgressInput$ErrorCode' => '<p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>', ], ], 'HookFailureMode' => [ 'base' => NULL, 'refs' => [ 'ChangeSetHook$FailureMode' => '<p>Specify the Hook failure mode for non-compliant resources in the followings ways.</p> <ul> <li> <p> <code>FAIL</code> Stops provisioning resources.</p> </li> <li> <p> <code>WARN</code> Allows provisioning to continue with a warning message.</p> </li> </ul>', 'HookResultSummary$FailureMode' => '<p>The failure mode of the invocation.</p>', 'StackEvent$HookFailureMode' => '<p>Specify the Hook failure mode for non-compliant resources in the followings ways.</p> <ul> <li> <p> <code>FAIL</code> Stops provisioning resources.</p> </li> <li> <p> <code>WARN</code> Allows provisioning to continue with a warning message.</p> </li> </ul>', ], ], 'HookInvocationCount' => [ 'base' => NULL, 'refs' => [ 'Change$HookInvocationCount' => '<p>Is either <code>null</code>, if no Hooks invoke for the resource, or contains the number of Hooks that will invoke for the resource.</p>', ], ], 'HookInvocationId' => [ 'base' => NULL, 'refs' => [ 'HookResultSummary$HookResultId' => '<p>The unique identifier for this Hook invocation result.</p>', 'StackEvent$HookInvocationId' => '<p>The unique identifier of the Hook invocation.</p>', ], ], 'HookInvocationPoint' => [ 'base' => NULL, 'refs' => [ 'ChangeSetHook$InvocationPoint' => '<p>The specific point in the provisioning process where the Hook is invoked.</p>', 'HookResultSummary$InvocationPoint' => '<p>The specific point in the provisioning process where the Hook is invoked.</p>', 'StackEvent$HookInvocationPoint' => '<p>The specific point in the provisioning process where the Hook is invoked.</p>', ], ], 'HookResultId' => [ 'base' => NULL, 'refs' => [ 'HookResultSummary$TargetId' => '<p>The unique identifier of the Hook invocation target.</p>', 'HookResultSummary$HookExecutionTarget' => '<p>The ARN of the target stack or request token of the Cloud Control API operation.</p> <p>Only shown in responses when the request does not specify <code>TargetType</code> and <code>TargetId</code> filters.</p>', 'ListHookResultsInput$TargetId' => '<p>Filters results by the unique identifier of the target the Hook was invoked against.</p> <p>For change sets, this is the change set ARN. When the target is a Cloud Control API operation, this value must be the <code>HookRequestToken</code> returned by the Cloud Control API request. For more information on the <code>HookRequestToken</code>, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ProgressEvent.html">ProgressEvent</a>.</p> <p>Required when <code>TargetType</code> is specified and cannot be used otherwise.</p>', 'ListHookResultsOutput$TargetId' => '<p>The unique identifier of the Hook invocation target.</p>', ], ], 'HookResultNotFoundException' => [ 'base' => '<p>The specified target doesn\'t have any requested Hook invocations.</p>', 'refs' => [], ], 'HookResultSummaries' => [ 'base' => NULL, 'refs' => [ 'ListHookResultsOutput$HookResults' => '<p>A list of <code>HookResultSummary</code> structures that provides the status and Hook status reason for each Hook invocation for the specified target.</p>', ], ], 'HookResultSummary' => [ 'base' => '<p>Describes a Hook invocation, its status, and the reason for its status.</p>', 'refs' => [ 'HookResultSummaries$member' => NULL, ], ], 'HookStatus' => [ 'base' => NULL, 'refs' => [ 'HookResultSummary$Status' => '<p>The status of the Hook invocation. The following statuses are possible:</p> <ul> <li> <p> <code>HOOK_IN_PROGRESS</code>: The Hook is currently running.</p> </li> <li> <p> <code>HOOK_COMPLETE_SUCCEEDED</code>: The Hook completed successfully.</p> </li> <li> <p> <code>HOOK_COMPLETE_FAILED</code>: The Hook completed but failed validation.</p> </li> <li> <p> <code>HOOK_FAILED</code>: The Hook encountered an error during execution.</p> </li> </ul>', 'ListHookResultsInput$Status' => '<p>Filters results by the status of Hook invocations. Can only be used in combination with <code>TypeArn</code>. Valid values are:</p> <ul> <li> <p> <code>HOOK_IN_PROGRESS</code>: The Hook is currently running.</p> </li> <li> <p> <code>HOOK_COMPLETE_SUCCEEDED</code>: The Hook completed successfully.</p> </li> <li> <p> <code>HOOK_COMPLETE_FAILED</code>: The Hook completed but failed validation.</p> </li> <li> <p> <code>HOOK_FAILED</code>: The Hook encountered an error during execution.</p> </li> </ul>', 'StackEvent$HookStatus' => '<p>Provides the status of the change set Hook.</p>', ], ], 'HookStatusReason' => [ 'base' => NULL, 'refs' => [ 'HookResultSummary$HookStatusReason' => '<p>A description of the Hook results status. For example, if the Hook result is in a failed state, this may contain additional information for the failed state.</p>', 'StackEvent$HookStatusReason' => '<p>Provides the reason for the Hook status.</p>', ], ], 'HookTargetType' => [ 'base' => NULL, 'refs' => [ 'ChangeSetHookTargetDetails$TargetType' => '<p>The name of the type.</p>', ], ], 'HookTargetTypeName' => [ 'base' => NULL, 'refs' => [ 'ChangeSetHookResourceTargetDetails$ResourceType' => '<p>The type of CloudFormation resource, such as <code>AWS::S3::Bucket</code>.</p>', ], ], 'HookType' => [ 'base' => NULL, 'refs' => [ 'StackEvent$HookType' => '<p>The name of the Hook.</p>', ], ], 'HookTypeArn' => [ 'base' => NULL, 'refs' => [ 'HookResultSummary$TypeArn' => '<p>The ARN of the Hook that was invoked.</p>', 'ListHookResultsInput$TypeArn' => '<p>Filters results by the ARN of the Hook. Can be used alone or in combination with <code>Status</code>.</p>', ], ], 'HookTypeConfigurationVersionId' => [ 'base' => NULL, 'refs' => [ 'ChangeSetHook$TypeConfigurationVersionId' => '<p>The version ID of the type configuration.</p>', 'HookResultSummary$TypeConfigurationVersionId' => '<p>The version of the Hook configuration.</p>', ], ], 'HookTypeName' => [ 'base' => NULL, 'refs' => [ 'ChangeSetHook$TypeName' => '<p>The unique name for your Hook. Specifies a three-part namespace for your Hook, with a recommended pattern of <code>Organization::Service::Hook</code>.</p> <note> <p>The following organization namespaces are reserved and can\'t be used in your Hook type names:</p> <ul> <li> <p> <code>Alexa</code> </p> </li> <li> <p> <code>AMZN</code> </p> </li> <li> <p> <code>Amazon</code> </p> </li> <li> <p> <code>ASK</code> </p> </li> <li> <p> <code>AWS</code> </p> </li> <li> <p> <code>Custom</code> </p> </li> <li> <p> <code>Dev</code> </p> </li> </ul> </note>', 'HookResultSummary$TypeName' => '<p>The name of the Hook that was invoked.</p>', ], ], 'HookTypeVersionId' => [ 'base' => NULL, 'refs' => [ 'ChangeSetHook$TypeVersionId' => '<p>The version ID of the type specified.</p>', 'HookResultSummary$TypeVersionId' => '<p>The version of the Hook that was invoked.</p>', ], ], 'IdentityProvider' => [ 'base' => NULL, 'refs' => [ 'DescribePublisherOutput$IdentityProvider' => '<p>The type of account used as the identity provider when registering this publisher with CloudFormation.</p>', 'TypeSummary$PublisherIdentity' => '<p>The service used to verify the publisher identity.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to make them available for public use</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>', ], ], 'ImportExistingResources' => [ 'base' => NULL, 'refs' => [ 'ChangeSetSummary$ImportExistingResources' => '<p>Indicates if the change set imports resources that already exist.</p>', 'CreateChangeSetInput$ImportExistingResources' => '<p>Indicates if the change set auto-imports resources that already exist. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/import-resources-automatically.html">Import Amazon Web Services resources into a CloudFormation stack automatically</a> in the <i>CloudFormation User Guide</i>.</p> <note> <p>This parameter can only import resources that have custom names in templates. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-name.html">name type</a> in the <i>CloudFormation User Guide</i>. To import resources that do not accept custom names, such as EC2 instances, use the <code>ResourcesToImport</code> parameter instead.</p> </note>', 'DescribeChangeSetOutput$ImportExistingResources' => '<p>Indicates if the change set imports resources that already exist.</p> <note> <p>This parameter can only import resources that have <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-name.html">custom names</a> in templates. To import resources that do not accept custom names, such as EC2 instances, use the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html">resource import</a> feature instead.</p> </note>', ], ], 'ImportStacksToStackSetInput' => [ 'base' => NULL, 'refs' => [], ], 'ImportStacksToStackSetOutput' => [ 'base' => NULL, 'refs' => [], ], 'Imports' => [ 'base' => NULL, 'refs' => [ 'ListImportsOutput$Imports' => '<p>A list of stack names that are importing the specified exported output value.</p>', ], ], 'InProgressStackInstancesCount' => [ 'base' => NULL, 'refs' => [ 'StackSetDriftDetectionDetails$InProgressStackInstancesCount' => '<p>The number of stack instances that are currently being checked for drift.</p>', ], ], 'InSyncStackInstancesCount' => [ 'base' => NULL, 'refs' => [ 'StackSetDriftDetectionDetails$InSyncStackInstancesCount' => '<p>The number of stack instances which match the expected template and parameter configuration of the StackSet.</p>', ], ], 'IncludeNestedStacks' => [ 'base' => NULL, 'refs' => [ 'ChangeSetSummary$IncludeNestedStacks' => '<p>Specifies the current setting of <code>IncludeNestedStacks</code> for the change set.</p>', 'CreateChangeSetInput$IncludeNestedStacks' => '<p>Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to <code>False</code>. To include nested sets in a change set, specify <code>True</code>.</p>', 'DescribeChangeSetOutput$IncludeNestedStacks' => '<p>Verifies if <code>IncludeNestedStacks</code> is set to <code>True</code>.</p>', ], ], 'IncludePropertyValues' => [ 'base' => NULL, 'refs' => [ 'DescribeChangeSetInput$IncludePropertyValues' => '<p>If <code>true</code>, the returned changes include detailed changes in the property values.</p>', ], ], 'InsufficientCapabilitiesException' => [ 'base' => '<p>The template contains resources with capabilities that weren\'t specified in the Capabilities parameter.</p>', 'refs' => [], ], 'InvalidChangeSetStatusException' => [ 'base' => '<p>The specified change set can\'t be used to update the stack. For example, the change set status might be <code>CREATE_IN_PROGRESS</code>, or the stack status might be <code>UPDATE_IN_PROGRESS</code>.</p>', 'refs' => [], ], 'InvalidOperationException' => [ 'base' => '<p>The specified operation isn\'t valid.</p>', 'refs' => [], ], 'InvalidStateTransitionException' => [ 'base' => '<p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. CloudFormation doesn\'t return this error to users.</p>', 'refs' => [], ], 'IsActivated' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeOutput$IsActivated' => '<p>Whether the extension is activated in the account and Region.</p> <p>This only applies to public third-party extensions. For all other extensions, CloudFormation returns <code>null</code>.</p>', 'TypeSummary$IsActivated' => '<p>Whether the extension is activated for this account and Region.</p> <p>This applies only to third-party public extensions. Extensions published by Amazon are activated by default.</p>', ], ], 'IsDefaultConfiguration' => [ 'base' => NULL, 'refs' => [ 'TypeConfigurationDetails$IsDefaultConfiguration' => '<p>Whether this configuration data is the default configuration for the extension.</p>', ], ], 'IsDefaultVersion' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeOutput$IsDefaultVersion' => '<p>Whether the specified extension version is set as the default version.</p> <p>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 <code>null</code>.</p>', 'TypeVersionSummary$IsDefaultVersion' => '<p>Whether the specified extension version is set as the default version.</p> <p>This applies only to private extensions you have registered in your account, and extensions published by Amazon. For public third-party extensions, CloudFormation returns <code>null</code>.</p>', ], ], 'JazzLogicalResourceIds' => [ 'base' => NULL, 'refs' => [ 'UpdateGeneratedTemplateInput$RemoveResources' => '<p>A list of logical ids for resources to remove from the generated template.</p>', ], ], 'JazzResourceIdentifierProperties' => [ 'base' => NULL, 'refs' => [ 'ScannedResource$ResourceIdentifier' => '<p>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 <code>primaryIdentifier</code> list in the resource schema.) The value is the value of that primary identifier. For example, for a <code>AWS::DynamoDB::Table</code> resource, the primary identifiers is <code>TableName</code> so the key-value pair could be <code>"TableName": "MyDDBTable"</code>. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier">primaryIdentifier</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>', 'ScannedResourceIdentifier$ResourceIdentifier' => '<p>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 <code>primaryIdentifier</code> list in the resource schema.) The value is the value of that primary identifier. For example, for a <code>AWS::DynamoDB::Table</code> resource, the primary identifiers is <code>TableName</code> so the key-value pair could be <code>"TableName": "MyDDBTable"</code>. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier">primaryIdentifier</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>', ], ], 'JazzResourceIdentifierPropertyKey' => [ 'base' => NULL, 'refs' => [ 'JazzResourceIdentifierProperties$key' => NULL, ], ], 'JazzResourceIdentifierPropertyValue' => [ 'base' => NULL, 'refs' => [ 'JazzResourceIdentifierProperties$value' => NULL, ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'PhysicalResourceIdContextKeyValuePair$Key' => '<p>The resource context key.</p>', ], ], 'LastUpdatedTime' => [ 'base' => NULL, 'refs' => [ 'DescribeGeneratedTemplateOutput$LastUpdatedTime' => '<p>The time the generated template was last updated.</p>', 'Stack$LastUpdatedTime' => '<p>The time the stack was last updated. This field will only be returned if the stack has been updated at least once.</p>', 'StackSummary$LastUpdatedTime' => '<p>The time the stack was last updated. This field will only be returned if the stack has been updated at least once.</p>', 'TemplateSummary$LastUpdatedTime' => '<p>The time the generated template was last updated.</p>', ], ], 'LimitExceededException' => [ 'base' => '<p>The quota for the resource has already been reached.</p> <p>For information about resource and stack limitations, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation quotas</a> in the <i>CloudFormation User Guide</i>.</p>', 'refs' => [], ], 'LimitName' => [ 'base' => NULL, 'refs' => [ 'AccountLimit$Name' => '<p>The name of the account limit.</p> <p>Values: <code>ConcurrentResourcesLimit</code> | <code>StackLimit</code> | <code>StackOutputsLimit</code> </p>', ], ], 'LimitValue' => [ 'base' => NULL, 'refs' => [ 'AccountLimit$Value' => '<p>The value that\'s associated with the account limit name.</p>', ], ], 'ListChangeSetsInput' => [ 'base' => '<p>The input for the <a>ListChangeSets</a> action.</p>', 'refs' => [], ], 'ListChangeSetsOutput' => [ 'base' => '<p>The output for the <a>ListChangeSets</a> action.</p>', 'refs' => [], ], 'ListExportsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListExportsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListGeneratedTemplatesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListGeneratedTemplatesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListHookResultsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListHookResultsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListHookResultsTargetType' => [ 'base' => NULL, 'refs' => [ 'HookResultSummary$TargetType' => '<p>The target type that the Hook was invoked against.</p>', 'ListHookResultsInput$TargetType' => '<p>Filters results by target type. Currently, only <code>CHANGE_SET</code> and <code>CLOUD_CONTROL</code> are supported filter options.</p> <p>Required when <code>TargetId</code> is specified and cannot be used otherwise.</p>', 'ListHookResultsOutput$TargetType' => '<p>The target type.</p>', ], ], 'ListImportsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListImportsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceScanRelatedResourcesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceScanRelatedResourcesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceScanResourcesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceScanResourcesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceScansInput' => [ 'base' => NULL, 'refs' => [], ], 'ListResourceScansOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackInstanceResourceDriftsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackInstanceResourceDriftsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackInstancesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackInstancesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackRefactorActionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackRefactorActionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackRefactorsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackRefactorsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackResourcesInput' => [ 'base' => '<p>The input for the <a>ListStackResource</a> action.</p>', 'refs' => [], ], 'ListStackResourcesOutput' => [ 'base' => '<p>The output for a <a>ListStackResources</a> action.</p>', 'refs' => [], ], 'ListStackSetAutoDeploymentTargetsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackSetAutoDeploymentTargetsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackSetOperationResultsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackSetOperationResultsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackSetOperationsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackSetOperationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackSetsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListStackSetsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListStacksInput' => [ 'base' => '<p>The input for <a>ListStacks</a> action.</p>', 'refs' => [], ], 'ListStacksOutput' => [ 'base' => '<p>The output for <a>ListStacks</a> action.</p>', 'refs' => [], ], 'ListTypeRegistrationsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTypeRegistrationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTypeVersionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTypeVersionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTypesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTypesOutput' => [ 'base' => NULL, 'refs' => [], ], 'LogGroupName' => [ 'base' => NULL, 'refs' => [ 'LoggingConfig$LogGroupName' => '<p>The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension\'s handlers.</p>', ], ], 'LoggingConfig' => [ 'base' => '<p>Contains logging configuration information for an extension.</p>', 'refs' => [ 'ActivateTypeInput$LoggingConfig' => '<p>Contains logging configuration information for an extension.</p>', 'DescribeTypeOutput$LoggingConfig' => '<p>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 <code>null</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>', 'RegisterTypeInput$LoggingConfig' => '<p>Specifies logging configuration information for an extension.</p>', ], ], 'LogicalIdHierarchy' => [ 'base' => NULL, 'refs' => [ 'ModuleInfo$LogicalIdHierarchy' => '<p>A concatenated list of the logical IDs of the module or modules that contains the resource. Modules are listed starting with the inner-most nested module, and separated by <code>/</code>.</p> <p>In the following example, the resource was created from a module, <code>moduleA</code>, that\'s nested inside a parent module, <code>moduleB</code>.</p> <p> <code>moduleA/moduleB</code> </p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/module-ref-resources.html">Reference module resources in CloudFormation templates</a> in the <i>CloudFormation User Guide</i>.</p>', ], ], 'LogicalResourceId' => [ 'base' => NULL, 'refs' => [ 'ChangeSetHookResourceTargetDetails$LogicalResourceId' => '<p>The resource\'s logical ID, which is defined in the stack\'s template.</p>', 'DescribeChangeSetHooksInput$LogicalResourceId' => '<p>If specified, lists only the Hooks related to the specified <code>LogicalResourceId</code>.</p>', 'DescribeStackResourceInput$LogicalResourceId' => '<p>The logical name of the resource as specified in the template.</p>', 'DescribeStackResourcesInput$LogicalResourceId' => '<p>The logical name of the resource as specified in the template.</p>', 'DetectStackResourceDriftInput$LogicalResourceId' => '<p>The logical name of the resource for which to return drift information.</p>', 'JazzLogicalResourceIds$member' => NULL, 'LogicalResourceIds$member' => NULL, 'ResourceChange$LogicalResourceId' => '<p>The resource\'s logical ID, which is defined in the stack\'s template.</p>', 'ResourceDefinition$LogicalResourceId' => '<p>The logical resource id for this resource in the generated template.</p>', 'ResourceDetail$LogicalResourceId' => '<p>The logical id for this resource in the final generated template.</p>', 'ResourceLocation$LogicalResourceId' => '<p>The logical name of the resource specified in the template.</p>', 'ResourceToImport$LogicalResourceId' => '<p>The logical ID of the target resource as specified in the template.</p>', 'RetainResources$member' => NULL, 'SignalResourceInput$LogicalResourceId' => '<p>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.</p>', 'StackEvent$LogicalResourceId' => '<p>The logical name of the resource specified in the template.</p>', 'StackInstanceResourceDriftsSummary$LogicalResourceId' => '<p>The logical name of the resource specified in the template.</p>', 'StackResource$LogicalResourceId' => '<p>The logical name of the resource specified in the template.</p>', 'StackResourceDetail$LogicalResourceId' => '<p>The logical name of the resource specified in the template.</p>', 'StackResourceDrift$LogicalResourceId' => '<p>The logical name of the resource specified in the template.</p>', 'StackResourceSummary$LogicalResourceId' => '<p>The logical name of the resource specified in the template.</p>', ], ], 'LogicalResourceIds' => [ 'base' => NULL, 'refs' => [ 'DetectStackDriftInput$LogicalResourceIds' => '<p>The logical names of any resources you want to use as filters.</p>', 'ResourceIdentifierSummary$LogicalResourceIds' => '<p>The logical IDs of the target resources of the specified <code>ResourceType</code>, as defined in the import template.</p>', ], ], 'MajorVersion' => [ 'base' => NULL, 'refs' => [ 'ActivateTypeInput$MajorVersion' => '<p>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 <i>minor</i> version of the major version selected.</p> <p>You can specify <code>MajorVersion</code> or <code>VersionBump</code>, but not both.</p>', ], ], 'ManagedByStack' => [ 'base' => NULL, 'refs' => [ 'ScannedResource$ManagedByStack' => '<p>If <code>true</code>, the resource is managed by a CloudFormation stack.</p>', ], ], 'ManagedExecution' => [ 'base' => '<p>Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.</p>', 'refs' => [ 'CreateStackSetInput$ManagedExecution' => '<p>Describes whether CloudFormation performs non-conflicting operations concurrently and queues conflicting operations.</p>', 'StackSet$ManagedExecution' => '<p>Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.</p>', 'StackSetSummary$ManagedExecution' => '<p>Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.</p>', 'UpdateStackSetInput$ManagedExecution' => '<p>Describes whether CloudFormation performs non-conflicting operations concurrently and queues conflicting operations.</p>', ], ], 'ManagedExecutionNullable' => [ 'base' => NULL, 'refs' => [ 'ManagedExecution$Active' => '<p>When <code>true</code>, CloudFormation performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, CloudFormation starts queued operations in request order.</p> <note> <p>If there are already running or queued operations, CloudFormation queues all incoming operations even if they are non-conflicting.</p> <p>You can\'t modify your StackSet\'s execution configuration while there are running or queued operations for that StackSet.</p> </note> <p>When <code>false</code> (default), StackSets performs one operation at a time in request order.</p>', ], ], 'MaxConcurrentCount' => [ 'base' => NULL, 'refs' => [ 'StackSetOperationPreferences$MaxConcurrentCount' => '<p>The maximum number of accounts in which to perform this operation at one time. This can depend on the value of <code>FailureToleranceCount</code> depending on your <code>ConcurrencyMode</code>. <code>MaxConcurrentCount</code> is at most one more than the <code>FailureToleranceCount</code> if you\'re using <code>STRICT_FAILURE_TOLERANCE</code>.</p> <p>Note that this setting lets you specify the <i>maximum</i> for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.</p> <p>You can specify either <code>MaxConcurrentCount</code> or <code>MaxConcurrentPercentage</code>, but not both.</p> <p>By default, <code>1</code> is specified.</p>', ], ], 'MaxConcurrentPercentage' => [ 'base' => NULL, 'refs' => [ 'StackSetOperationPreferences$MaxConcurrentPercentage' => '<p>The maximum percentage of accounts in which to perform this operation at one time.</p> <p>When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.</p> <p>Note that this setting lets you specify the <i>maximum</i> for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.</p> <p>You can specify either <code>MaxConcurrentCount</code> or <code>MaxConcurrentPercentage</code>, but not both.</p> <p>By default, <code>1</code> is specified.</p>', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListGeneratedTemplatesInput$MaxResults' => '<p>If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can use for the <code>NextToken</code> parameter to get the next set of results. By default the <code>ListGeneratedTemplates</code> API action will return at most 50 results in each response. The maximum value is 100.</p>', 'ListStackInstanceResourceDriftsInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', 'ListStackInstancesInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', 'ListStackRefactorActionsInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', 'ListStackRefactorsInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', 'ListStackSetAutoDeploymentTargetsInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', 'ListStackSetOperationResultsInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', 'ListStackSetOperationsInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', 'ListStackSetsInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', 'ListTypeRegistrationsInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', 'ListTypeVersionsInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', 'ListTypesInput$MaxResults' => '<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>', ], ], 'Metadata' => [ 'base' => NULL, 'refs' => [ 'GetTemplateSummaryOutput$Metadata' => '<p>The value that\'s defined for the <code>Metadata</code> property of the template.</p>', 'StackResourceDetail$Metadata' => '<p>The content of the <code>Metadata</code> attribute declared for the resource. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html">Metadata attribute</a> in the <i>CloudFormation User Guide</i>.</p>', ], ], 'ModuleInfo' => [ 'base' => '<p>Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.</p> <p>For more information about modules, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html">Create reusable resource configurations that can be included across templates with CloudFormation modules</a> in the <i>CloudFormation User Guide</i>.</p>', 'refs' => [ 'ResourceChange$ModuleInfo' => '<p>Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.</p>', 'StackResource$ModuleInfo' => '<p>Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.</p>', 'StackResourceDetail$ModuleInfo' => '<p>Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.</p>', 'StackResourceDrift$ModuleInfo' => '<p>Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.</p>', 'StackResourceSummary$ModuleInfo' => '<p>Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.</p>', ], ], 'MonitoringTimeInMinutes' => [ 'base' => NULL, 'refs' => [ 'RollbackConfiguration$MonitoringTimeInMinutes' => '<p>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.</p> <p>The default is 0 minutes.</p> <p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html">CancelUpdateStack</a>, for example) as necessary.</p> <p>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.</p>', ], ], 'NameAlreadyExistsException' => [ 'base' => '<p>The specified name is already in use.</p>', 'refs' => [], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeAccountLimitsInput$NextToken' => '<p>A string that identifies the next page of limits that you want to retrieve.</p>', 'DescribeAccountLimitsOutput$NextToken' => '<p>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.</p>', 'DescribeChangeSetHooksInput$NextToken' => '<p>A string, provided by the <code>DescribeChangeSetHooks</code> response output, that identifies the next page of information that you want to retrieve.</p>', 'DescribeChangeSetHooksOutput$NextToken' => '<p>Pagination token, <code>null</code> or empty if no more results.</p>', 'DescribeChangeSetInput$NextToken' => '<p>A string (provided by the <a>DescribeChangeSet</a> response output) that identifies the next page of information that you want to retrieve.</p>', 'DescribeChangeSetOutput$NextToken' => '<p>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.</p>', 'DescribeStackEventsInput$NextToken' => '<p>A string that identifies the next page of events that you want to retrieve.</p>', 'DescribeStackEventsOutput$NextToken' => '<p>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.</p>', 'DescribeStackResourceDriftsInput$NextToken' => '<p>A string that identifies the next page of stack resource drift results.</p>', 'DescribeStackResourceDriftsOutput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>DescribeStackResourceDrifts</code> again and assign that token to the request object\'s <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>', 'DescribeStacksInput$NextToken' => '<p>A string that identifies the next page of stacks that you want to retrieve.</p>', 'DescribeStacksOutput$NextToken' => '<p>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.</p>', 'ListChangeSetsInput$NextToken' => '<p>A string (provided by the <a>ListChangeSets</a> response output) that identifies the next page of change sets that you want to retrieve.</p>', 'ListChangeSetsOutput$NextToken' => '<p>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 <code>null</code>.</p>', 'ListExportsInput$NextToken' => '<p>A string (provided by the <a>ListExports</a> response output) that identifies the next page of exported output values that you asked to retrieve.</p>', 'ListExportsOutput$NextToken' => '<p>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.</p>', 'ListGeneratedTemplatesInput$NextToken' => '<p>A string that identifies the next page of resource scan results.</p>', 'ListGeneratedTemplatesOutput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListGeneratedTemplates</code> again and use that value for the <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to an empty string.</p>', 'ListHookResultsInput$NextToken' => '<p>A string that identifies the next page of events that you want to retrieve.</p>', 'ListHookResultsOutput$NextToken' => '<p>Pagination token, <code>null</code> or empty if no more results.</p>', 'ListImportsInput$NextToken' => '<p>A string (provided by the <a>ListImports</a> response output) that identifies the next page of stacks that are importing the specified exported output value.</p>', 'ListImportsOutput$NextToken' => '<p>A string that identifies the next page of exports. If there is no additional page, this value is null.</p>', 'ListResourceScanRelatedResourcesInput$NextToken' => '<p>A string that identifies the next page of resource scan results.</p>', 'ListResourceScanRelatedResourcesOutput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListResourceScanRelatedResources</code> again and use that value for the <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to an empty string.</p>', 'ListResourceScanResourcesInput$NextToken' => '<p>A string that identifies the next page of resource scan results.</p>', 'ListResourceScanResourcesOutput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListResourceScanResources</code> again and use that value for the <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to an empty string.</p>', 'ListResourceScansInput$NextToken' => '<p>A string that identifies the next page of resource scan results.</p>', 'ListResourceScansOutput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListResourceScans</code> again and use that value for the <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to an empty string.</p>', 'ListStackInstanceResourceDriftsInput$NextToken' => '<p>If the previous paginated request didn\'t return all of the remaining results, the response object\'s <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If there are no remaining results, the previous response object\'s <code>NextToken</code> parameter is set to <code>null</code>.</p>', 'ListStackInstanceResourceDriftsOutput$NextToken' => '<p>If the previous paginated request didn\'t return all of the remaining results, the response object\'s <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If there are no remaining results, the previous response object\'s <code>NextToken</code> parameter is set to <code>null</code>.</p>', 'ListStackInstancesInput$NextToken' => '<p>If the previous request didn\'t return all the remaining results, the response\'s <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListStackInstances</code> again and assign that token to the request object\'s <code>NextToken</code> parameter. If there are no remaining results, the previous response object\'s <code>NextToken</code> parameter is set to <code>null</code>.</p>', 'ListStackInstancesOutput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListStackInstances</code> again and assign that token to the request object\'s <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>', 'ListStackRefactorActionsInput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>', 'ListStackRefactorActionsOutput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>', 'ListStackRefactorsInput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>', 'ListStackRefactorsOutput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>', 'ListStackResourcesInput$NextToken' => '<p>A string that identifies the next page of stack resources that you want to retrieve.</p>', 'ListStackResourcesOutput$NextToken' => '<p>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.</p>', 'ListStackSetAutoDeploymentTargetsInput$NextToken' => '<p>A string that identifies the next page of deployment targets that you want to retrieve.</p>', 'ListStackSetAutoDeploymentTargetsOutput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStackSetAutoDeploymentTargets.html">ListStackSetAutoDeploymentTargets</a> again and use that value for the <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to an empty string.</p>', 'ListStackSetOperationResultsInput$NextToken' => '<p>If the previous request didn\'t return all the remaining results, the response object\'s <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListStackSetOperationResults</code> again and assign that token to the request object\'s <code>NextToken</code> parameter. If there are no remaining results, the previous response object\'s <code>NextToken</code> parameter is set to <code>null</code>.</p>', 'ListStackSetOperationResultsOutput$NextToken' => '<p>If the request doesn\'t return all results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListOperationResults</code> again and assign that token to the request object\'s <code>NextToken</code> parameter. If there are no remaining results, <code>NextToken</code> is set to <code>null</code>.</p>', 'ListStackSetOperationsInput$NextToken' => '<p>If the previous paginated request didn\'t return all of the remaining results, the response object\'s <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListStackSetOperations</code> again and assign that token to the request object\'s <code>NextToken</code> parameter. If there are no remaining results, the previous response object\'s <code>NextToken</code> parameter is set to <code>null</code>.</p>', 'ListStackSetOperationsOutput$NextToken' => '<p>If the request doesn\'t return all results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListOperationResults</code> again and assign that token to the request object\'s <code>NextToken</code> parameter. If there are no remaining results, <code>NextToken</code> is set to <code>null</code>.</p>', 'ListStackSetsInput$NextToken' => '<p>If the previous paginated request didn\'t return all the remaining results, the response object\'s <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListStackSets</code> again and assign that token to the request object\'s <code>NextToken</code> parameter. If there are no remaining results, the previous response object\'s <code>NextToken</code> parameter is set to <code>null</code>.</p>', 'ListStackSetsOutput$NextToken' => '<p>If the request doesn\'t return all of the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListStackInstances</code> again and assign that token to the request object\'s <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>', 'ListStacksInput$NextToken' => '<p>A string that identifies the next page of stacks that you want to retrieve.</p>', 'ListStacksOutput$NextToken' => '<p>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.</p>', 'ListTypeRegistrationsInput$NextToken' => '<p>If the previous paginated request didn\'t return all the remaining results, the response object\'s <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If there are no remaining results, the previous response object\'s <code>NextToken</code> parameter is set to <code>null</code>.</p>', 'ListTypeRegistrationsOutput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>', 'ListTypeVersionsInput$NextToken' => '<p>If the previous paginated request didn\'t return all of the remaining results, the response object\'s <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If there are no remaining results, the previous response object\'s <code>NextToken</code> parameter is set to <code>null</code>.</p>', 'ListTypeVersionsOutput$NextToken' => '<p>If the request doesn\'t return all of the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>', 'ListTypesInput$NextToken' => '<p>If the previous paginated request didn\'t return all the remaining results, the response object\'s <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If there are no remaining results, the previous response object\'s <code>NextToken</code> parameter is set to <code>null</code>.</p>', 'ListTypesOutput$NextToken' => '<p>If the request doesn\'t return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object\'s <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>', ], ], 'NoEcho' => [ 'base' => NULL, 'refs' => [ 'ParameterDeclaration$NoEcho' => '<p>Flag that indicates whether the parameter value is shown as plain text in logs and in the Amazon Web Services Management Console.</p>', 'TemplateParameter$NoEcho' => '<p>Flag indicating whether the parameter should be displayed as plain text in logs and UIs.</p>', ], ], 'NotificationARN' => [ 'base' => NULL, 'refs' => [ 'NotificationARNs$member' => NULL, ], ], 'NotificationARNs' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$NotificationARNs' => '<p>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.</p>', 'CreateStackInput$NotificationARNs' => '<p>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).</p>', 'DescribeChangeSetOutput$NotificationARNs' => '<p>The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the change set.</p>', 'Stack$NotificationARNs' => '<p>Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.</p>', 'UpdateStackInput$NotificationARNs' => '<p>Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.</p>', ], ], 'NumberOfResources' => [ 'base' => NULL, 'refs' => [ 'TemplateSummary$NumberOfResources' => '<p>The number of resources in the generated template. This is a total of resources in pending, in-progress, completed, and failed states.</p>', ], ], 'OnFailure' => [ 'base' => NULL, 'refs' => [ 'CreateStackInput$OnFailure' => '<p>Determines what action will be taken if stack creation fails. This must be one of: <code>DO_NOTHING</code>, <code>ROLLBACK</code>, or <code>DELETE</code>. You can specify either <code>OnFailure</code> or <code>DisableRollback</code>, but not both.</p> <note> <p>Although the default setting is <code>ROLLBACK</code>, there is one exception. This exception occurs when a StackSet attempts to deploy a stack instance and the stack instance fails to create successfully. In this case, the <code>CreateStack</code> call overrides the default setting and sets the value of <code>OnFailure</code> to <code>DELETE</code>.</p> </note> <p>Default: <code>ROLLBACK</code> </p>', ], ], 'OnStackFailure' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$OnStackFailure' => '<p>Determines what action will be taken if stack creation fails. If this parameter is specified, the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation must not be specified. This must be one of these values:</p> <ul> <li> <p> <code>DELETE</code> - Deletes the change set if the stack creation fails. This is only valid when the <code>ChangeSetType</code> parameter is set to <code>CREATE</code>. If the deletion of the stack fails, the status of the stack is <code>DELETE_FAILED</code>.</p> </li> <li> <p> <code>DO_NOTHING</code> - if the stack creation fails, do nothing. This is equivalent to specifying <code>true</code> for the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation.</p> </li> <li> <p> <code>ROLLBACK</code> - if the stack creation fails, roll back the stack. This is equivalent to specifying <code>false</code> for the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation.</p> </li> </ul> <p>For nested stacks, when the <code>OnStackFailure</code> parameter is set to <code>DELETE</code> 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.</p>', 'DescribeChangeSetOutput$OnStackFailure' => '<p>Determines what action will be taken if stack creation fails. When this parameter is specified, the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation must not be specified. This must be one of these values:</p> <ul> <li> <p> <code>DELETE</code> - Deletes the change set if the stack creation fails. This is only valid when the <code>ChangeSetType</code> parameter is set to <code>CREATE</code>. If the deletion of the stack fails, the status of the stack is <code>DELETE_FAILED</code>.</p> </li> <li> <p> <code>DO_NOTHING</code> - if the stack creation fails, do nothing. This is equivalent to specifying <code>true</code> for the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation.</p> </li> <li> <p> <code>ROLLBACK</code> - if the stack creation fails, roll back the stack. This is equivalent to specifying <code>false</code> for the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation.</p> </li> </ul>', ], ], 'OperationIdAlreadyExistsException' => [ 'base' => '<p>The specified operation ID already exists.</p>', 'refs' => [], ], 'OperationInProgressException' => [ 'base' => '<p>Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack set at a given time.</p>', 'refs' => [], ], 'OperationNotFoundException' => [ 'base' => '<p>The specified ID refers to an operation that doesn\'t exist.</p>', 'refs' => [], ], 'OperationResultFilter' => [ 'base' => '<p>The status that operation results are filtered by.</p>', 'refs' => [ 'OperationResultFilters$member' => NULL, ], ], 'OperationResultFilterName' => [ 'base' => NULL, 'refs' => [ 'OperationResultFilter$Name' => '<p>The type of filter to apply.</p>', ], ], 'OperationResultFilterValues' => [ 'base' => NULL, 'refs' => [ 'OperationResultFilter$Values' => '<p>The value to filter by.</p>', ], ], 'OperationResultFilters' => [ 'base' => NULL, 'refs' => [ 'ListStackSetOperationResultsInput$Filters' => '<p>The filter to apply to operation results.</p>', ], ], 'OperationStatus' => [ 'base' => NULL, 'refs' => [ 'RecordHandlerProgressInput$OperationStatus' => '<p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>', 'RecordHandlerProgressInput$CurrentOperationStatus' => '<p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>', ], ], 'OperationStatusCheckFailedException' => [ 'base' => '<p>Error reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. CloudFormation doesn\'t return this error to users.</p>', 'refs' => [], ], 'OptionalSecureUrl' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeOutput$SourceUrl' => '<p>The URL of the source code for the extension.</p>', 'DescribeTypeOutput$DocumentationUrl' => '<p>The URL of a page providing detailed documentation for this extension.</p>', ], ], 'OrganizationStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeOrganizationsAccessOutput$Status' => '<p>Presents the status of the <code>OrganizationAccess</code>.</p>', ], ], 'OrganizationalUnitId' => [ 'base' => NULL, 'refs' => [ 'OrganizationalUnitIdList$member' => NULL, 'StackInstance$OrganizationalUnitId' => '<p>[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html">DeploymentTargets</a>.</p>', 'StackInstanceSummary$OrganizationalUnitId' => '<p>[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html">DeploymentTargets</a>.</p>', 'StackSetAutoDeploymentTargetSummary$OrganizationalUnitId' => '<p>The organization root ID or organizational unit (OU) IDs where the StackSet is targeted.</p>', 'StackSetOperationResultSummary$OrganizationalUnitId' => '<p>[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html">DeploymentTargets</a>.</p>', ], ], 'OrganizationalUnitIdList' => [ 'base' => NULL, 'refs' => [ 'DeploymentTargets$OrganizationalUnitIds' => '<p>The organization root ID or organizational unit (OU) IDs where you want to perform stack operations. CloudFormation will perform operations on accounts within these OUs and their child OUs.</p>', 'ImportStacksToStackSetInput$OrganizationalUnitIds' => '<p>The list of OU ID\'s to which the imported stacks must be mapped as deployment targets.</p>', 'StackSet$OrganizationalUnitIds' => '<p>[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html">DeploymentTargets</a>.</p>', ], ], 'Output' => [ 'base' => '<p>The Output data type.</p>', 'refs' => [ 'Outputs$member' => NULL, ], ], 'OutputKey' => [ 'base' => NULL, 'refs' => [ 'Output$OutputKey' => '<p>The key associated with the output.</p>', ], ], 'OutputValue' => [ 'base' => NULL, 'refs' => [ 'Output$OutputValue' => '<p>The value associated with the output.</p>', ], ], 'Outputs' => [ 'base' => NULL, 'refs' => [ 'Stack$Outputs' => '<p>A list of output structures.</p>', ], ], 'Parameter' => [ 'base' => '<p>The Parameter data type.</p>', 'refs' => [ 'Parameters$member' => NULL, ], ], 'ParameterConstraints' => [ 'base' => '<p>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 <code>AllowedValues</code> property.</p>', 'refs' => [ 'ParameterDeclaration$ParameterConstraints' => '<p>The criteria that CloudFormation uses to validate parameter values.</p>', ], ], 'ParameterDeclaration' => [ 'base' => '<p>The ParameterDeclaration data type.</p>', 'refs' => [ 'ParameterDeclarations$member' => NULL, ], ], 'ParameterDeclarations' => [ 'base' => NULL, 'refs' => [ 'GetTemplateSummaryOutput$Parameters' => '<p>A list of parameter declarations that describe various properties for each parameter.</p>', ], ], 'ParameterKey' => [ 'base' => NULL, 'refs' => [ 'Parameter$ParameterKey' => '<p>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.</p>', 'ParameterDeclaration$ParameterKey' => '<p>The name that\'s associated with the parameter.</p>', 'TemplateParameter$ParameterKey' => '<p>The name associated with the parameter.</p>', ], ], 'ParameterType' => [ 'base' => NULL, 'refs' => [ 'ParameterDeclaration$ParameterType' => '<p>The type of parameter.</p>', ], ], 'ParameterValue' => [ 'base' => NULL, 'refs' => [ 'Parameter$ParameterValue' => '<p>The input value associated with the parameter.</p>', 'Parameter$ResolvedValue' => '<p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-supplied-parameter-types.html">Specify existing resources at runtime with CloudFormation-supplied parameter types</a> in the <i>CloudFormation User Guide</i>.</p>', 'ParameterDeclaration$DefaultValue' => '<p>The default value of the parameter.</p>', 'TemplateParameter$DefaultValue' => '<p>The default value associated with the parameter.</p>', ], ], 'Parameters' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$Parameters' => '<p>A list of <code>Parameter</code> structures that specify input parameters for the change set. For more information, see the <a>Parameter</a> data type.</p>', 'CreateStackInput$Parameters' => '<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data type.</p>', 'CreateStackInstancesInput$ParameterOverrides' => '<p>A list of StackSet parameters whose values you want to override in the selected stack instances.</p> <p>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:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave an overridden parameter set to its present value, include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You can\'t specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> <li> <p>To set an overridden parameter back to the value specified in the StackSet, specify a parameter list but don\'t include the parameter in the list.</p> </li> <li> <p>To leave all parameters set to their present values, don\'t specify this property at all.</p> </li> </ul> <p>During StackSet updates, any parameter values overridden for a stack instance aren\'t updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the StackSet; to add or delete a parameter itself, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update the StackSet template.</p>', 'CreateStackSetInput$Parameters' => '<p>The input parameters for the StackSet template.</p>', 'DescribeChangeSetOutput$Parameters' => '<p>A list of <code>Parameter</code> structures that describes the input parameters and their values used to create the change set. For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data type.</p>', 'EstimateTemplateCostInput$Parameters' => '<p>A list of <code>Parameter</code> structures that specify input parameters.</p>', 'Stack$Parameters' => '<p>A list of <code>Parameter</code> structures.</p>', 'StackInstance$ParameterOverrides' => '<p>A list of parameters from the StackSet template whose values have been overridden in this stack instance.</p>', 'StackSet$Parameters' => '<p>A list of input parameters for a StackSet.</p>', 'UpdateStackInput$Parameters' => '<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data type.</p>', 'UpdateStackInstancesInput$ParameterOverrides' => '<p>A list of input parameters whose values you want to update for the specified stack instances.</p> <p>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:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave an overridden parameter set to its present value, include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You can\'t specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> <li> <p>To set an overridden parameter back to the value specified in the StackSet, specify a parameter list but don\'t include the parameter in the list.</p> </li> <li> <p>To leave all parameters set to their present values, don\'t specify this property at all.</p> </li> </ul> <p>During StackSet updates, any parameter values overridden for a stack instance aren\'t updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the StackSet. To add or delete a parameter itself, use <code>UpdateStackSet</code> to update the StackSet template. If you add a parameter to a template, before you can override the parameter value specified in the StackSet you must first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the StackSet. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>', 'UpdateStackSetInput$Parameters' => '<p>A list of input parameters for the StackSet template.</p>', ], ], 'PercentageCompleted' => [ 'base' => NULL, 'refs' => [ 'DescribeResourceScanOutput$PercentageCompleted' => '<p>The percentage of the resource scan that has been completed.</p>', 'ResourceScanSummary$PercentageCompleted' => '<p>The percentage of the resource scan that has been completed.</p>', ], ], 'PermissionModels' => [ 'base' => NULL, 'refs' => [ 'CreateStackSetInput$PermissionModel' => '<p>Describes how the IAM roles required for StackSet operations are created. By default, <code>SELF-MANAGED</code> is specified.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html">Grant self-managed permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html">Activate trusted access for StackSets with Organizations</a>.</p> </li> </ul>', 'StackSet$PermissionModel' => '<p>Describes how the IAM roles required for StackSet operations are created.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html">Grant self-managed permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html">Activate trusted access for StackSets with Organizations</a>.</p> </li> </ul>', 'StackSetSummary$PermissionModel' => '<p>Describes how the IAM roles required for StackSet operations are created.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html">Grant self-managed permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html">Activate trusted access for StackSets with Organizations</a>.</p> </li> </ul>', 'UpdateStackSetInput$PermissionModel' => '<p>Describes how the IAM roles required for StackSet operations are created. You cannot modify <code>PermissionModel</code> if there are stack instances associated with your stack set.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html">Grant self-managed permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html">Activate trusted access for StackSets with Organizations</a>.</p> </li> </ul>', ], ], 'PhysicalResourceId' => [ 'base' => NULL, 'refs' => [ 'DescribeStackResourcesInput$PhysicalResourceId' => '<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p> <p>For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack.</p> <p>Required: Conditional. If you don\'t specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>.</p>', 'ResourceChange$PhysicalResourceId' => '<p>The resource\'s physical ID (resource name). Resources that you are adding don\'t have physical IDs because they haven\'t been created.</p>', 'StackEvent$PhysicalResourceId' => '<p>The name or unique identifier associated with the physical instance of the resource.</p>', 'StackInstanceResourceDriftsSummary$PhysicalResourceId' => '<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>', 'StackRefactorAction$PhysicalResourceId' => '<p>The name or unique identifier associated with the physical instance of the resource.</p>', 'StackResource$PhysicalResourceId' => '<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>', 'StackResourceDetail$PhysicalResourceId' => '<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>', 'StackResourceDrift$PhysicalResourceId' => '<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>', 'StackResourceSummary$PhysicalResourceId' => '<p>The name or unique identifier that corresponds to a physical instance ID of the resource.</p>', ], ], 'PhysicalResourceIdContext' => [ 'base' => NULL, 'refs' => [ 'StackInstanceResourceDriftsSummary$PhysicalResourceIdContext' => '<p>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.</p>', 'StackResourceDrift$PhysicalResourceIdContext' => '<p>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.</p>', ], ], 'PhysicalResourceIdContextKeyValuePair' => [ 'base' => '<p>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.</p>', 'refs' => [ 'PhysicalResourceIdContext$member' => NULL, ], ], 'PolicyAction' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$PolicyAction' => '<p>The action that will be taken on the physical resource when the change set is executed.</p> <ul> <li> <p> <code>Delete</code> The resource will be deleted.</p> </li> <li> <p> <code>Retain</code> The resource will be retained.</p> </li> <li> <p> <code>Snapshot</code> The resource will have a snapshot taken.</p> </li> <li> <p> <code>ReplaceAndDelete</code> The resource will be replaced and then deleted.</p> </li> <li> <p> <code>ReplaceAndRetain</code> The resource will be replaced and then retained.</p> </li> <li> <p> <code>ReplaceAndSnapshot</code> The resource will be replaced and then have a snapshot taken.</p> </li> </ul>', ], ], 'PrivateTypeArn' => [ 'base' => NULL, 'refs' => [ 'ActivateTypeOutput$Arn' => '<p>The Amazon Resource Name (ARN) of the activated extension in this account and Region.</p>', 'DeactivateTypeInput$Arn' => '<p>The Amazon Resource Name (ARN) for the extension in this account and Region.</p> <p>Conditional: You must specify either <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>', 'DeregisterTypeInput$Arn' => '<p>The Amazon Resource Name (ARN) of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'PublishTypeInput$Arn' => '<p>The Amazon Resource Name (ARN) of the extension.</p> <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>', 'SetTypeDefaultVersionInput$Arn' => '<p>The Amazon Resource Name (ARN) of the extension for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', ], ], 'Properties' => [ 'base' => NULL, 'refs' => [ 'StackResourceDrift$ExpectedProperties' => '<p>A JSON structure that contains the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.</p> <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this structure will not be present.</p>', 'StackResourceDrift$ActualProperties' => '<p>A JSON structure that contains the actual property values of the stack resource.</p> <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this structure will not be present.</p>', ], ], 'PropertyDescription' => [ 'base' => NULL, 'refs' => [ 'WarningProperty$Description' => '<p>The description of the property from the resource provider schema.</p>', ], ], 'PropertyDifference' => [ 'base' => '<p>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 <code>StackResourceDriftStatus</code> is <code>MODIFIED</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p>', 'refs' => [ 'PropertyDifferences$member' => NULL, ], ], 'PropertyDifferences' => [ 'base' => NULL, 'refs' => [ 'StackInstanceResourceDriftsSummary$PropertyDifferences' => '<p>Status of the actual configuration of the resource compared to its expected configuration. These will be present only for resources whose <code>StackInstanceResourceDriftStatus</code> is <code>MODIFIED</code>. </p>', 'StackResourceDrift$PropertyDifferences' => '<p>A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose <code>StackResourceDriftStatus</code> is <code>MODIFIED</code>.</p>', ], ], 'PropertyName' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$Name' => '<p>If the <code>Attribute</code> value is <code>Properties</code>, the name of the property. For all other attributes, the value is null.</p>', ], ], 'PropertyPath' => [ 'base' => NULL, 'refs' => [ 'PropertyDifference$PropertyPath' => '<p>The fully-qualified path to the resource property.</p>', 'WarningProperty$PropertyPath' => '<p>The path of the property. For example, if this is for the <code>S3Bucket</code> member of the <code>Code</code> property, the property path would be <code>Code/S3Bucket</code>.</p>', ], ], 'PropertyValue' => [ 'base' => NULL, 'refs' => [ 'PropertyDifference$ExpectedValue' => '<p>The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.</p>', 'PropertyDifference$ActualValue' => '<p>The actual property value of the resource property.</p>', ], ], 'ProvisioningType' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeOutput$ProvisioningType' => '<p>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.</p> <p>Valid values include:</p> <ul> <li> <p> <code>FULLY_MUTABLE</code>: The resource type includes an update handler to process updates to the type during stack update operations.</p> </li> <li> <p> <code>IMMUTABLE</code>: 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.</p> </li> <li> <p> <code>NON_PROVISIONABLE</code>: The resource type doesn\'t include all the following handlers, and therefore can\'t actually be provisioned.</p> <ul> <li> <p>create</p> </li> <li> <p>read</p> </li> <li> <p>delete</p> </li> </ul> </li> </ul>', 'ListTypesInput$ProvisioningType' => '<p>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.</p> <p>Valid values include:</p> <ul> <li> <p> <code>FULLY_MUTABLE</code>: The resource type includes an update handler to process updates to the type during stack update operations.</p> </li> <li> <p> <code>IMMUTABLE</code>: 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.</p> </li> <li> <p> <code>NON_PROVISIONABLE</code>: The resource type doesn\'t include create, read, and delete handlers, and therefore can\'t actually be provisioned.</p> </li> </ul> <p>The default is <code>FULLY_MUTABLE</code>.</p>', ], ], 'PublicVersionNumber' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeInput$PublicVersionNumber' => '<p>The version number of a public third-party extension.</p>', 'DescribeTypeOutput$PublicVersionNumber' => '<p>The version number of a public third-party extension.</p> <p>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 <code>null</code>.</p>', 'DescribeTypeOutput$LatestPublicVersion' => '<p>The latest version of a public extension <i>that is available</i> for use.</p> <p>This only applies if you specify a public extension, and you don\'t specify a version. For all other requests, CloudFormation returns <code>null</code>.</p>', 'PublishTypeInput$PublicVersionNumber' => '<p>The version number to assign to this version of the extension.</p> <p>Use the following format, and adhere to semantic versioning when assigning a version number to your extension:</p> <p> <code>MAJOR.MINOR.PATCH</code> </p> <p>For more information, see <a href="https://semver.org/">Semantic Versioning 2.0.0</a>.</p> <p>If you don\'t specify a version number, CloudFormation increments the version number by one minor version release.</p> <p>You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be <code>1.0.0</code>.</p>', 'TypeSummary$PublicVersionNumber' => '<p>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.</p> <p>How you specified <code>AutoUpdate</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto">Automatically use new versions of extensions</a> in the <i>CloudFormation User Guide</i>.</p>', 'TypeSummary$LatestPublicVersion' => '<p>For public extensions that have been activated for this account and Region, the latest version of the public extension <i>that is available</i>. For any extensions other than activated third-party extensions, CloudFormation returns <code>null</code>.</p> <p>How you specified <code>AutoUpdate</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto">Automatically use new versions of extensions</a> in the <i>CloudFormation User Guide</i>.</p>', 'TypeVersionSummary$PublicVersionNumber' => '<p>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 <code>null</code>.</p> <p>How you specified <code>AutoUpdate</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto">Automatically use new versions of extensions</a> in the <i>CloudFormation User Guide</i>.</p>', ], ], 'PublishTypeInput' => [ 'base' => NULL, 'refs' => [], ], 'PublishTypeOutput' => [ 'base' => NULL, 'refs' => [], ], 'PublisherId' => [ 'base' => NULL, 'refs' => [ 'ActivateTypeInput$PublisherId' => '<p>The ID of the extension publisher.</p> <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.</p>', 'DescribePublisherInput$PublisherId' => '<p>The ID of the extension publisher.</p> <p>If you don\'t supply a <code>PublisherId</code>, and you have registered as an extension publisher, <code>DescribePublisher</code> returns information about your own publisher account.</p>', 'DescribePublisherOutput$PublisherId' => '<p>The ID of the extension publisher.</p>', 'DescribeTypeInput$PublisherId' => '<p>The publisher ID of the extension publisher.</p> <p>Extensions provided by Amazon Web Services are not assigned a publisher ID.</p>', 'DescribeTypeOutput$PublisherId' => '<p>The publisher ID of the extension publisher.</p> <p>This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns <code>null</code>.</p>', 'ListTypeVersionsInput$PublisherId' => '<p>The publisher ID of the extension publisher.</p> <p>Extensions published by Amazon aren\'t assigned a publisher ID.</p>', 'RegisterPublisherOutput$PublisherId' => '<p>The ID assigned this account by CloudFormation for publishing extensions.</p>', 'RequiredActivatedType$PublisherId' => '<p>The publisher ID of the extension publisher.</p>', 'TypeFilters$PublisherId' => '<p>The id of the publisher of the extension.</p> <p>Extensions published by Amazon aren\'t assigned a publisher ID. Use the <code>AWS_TYPES</code> category to specify a list of types published by Amazon.</p>', 'TypeSummary$PublisherId' => '<p>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.</p>', ], ], 'PublisherName' => [ 'base' => NULL, 'refs' => [ 'TypeSummary$PublisherName' => '<p>The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.</p>', ], ], 'PublisherProfile' => [ 'base' => NULL, 'refs' => [ 'DescribePublisherOutput$PublisherProfile' => '<p>The URL to the publisher\'s profile with the identity provider.</p>', ], ], 'PublisherStatus' => [ 'base' => NULL, 'refs' => [ 'DescribePublisherOutput$PublisherStatus' => '<p>Whether the publisher is verified. Currently, all registered publishers are verified.</p>', ], ], 'Reason' => [ 'base' => NULL, 'refs' => [ 'StackInstance$StatusReason' => '<p>The explanation for the specific status code that\'s assigned to this stack instance.</p>', 'StackInstanceSummary$StatusReason' => '<p>The explanation for the specific status code assigned to this stack instance.</p>', 'StackSetOperationResultSummary$StatusReason' => '<p>The reason for the assigned result status.</p>', ], ], 'RecordHandlerProgressInput' => [ 'base' => NULL, 'refs' => [], ], 'RecordHandlerProgressOutput' => [ 'base' => NULL, 'refs' => [], ], 'RefreshAllResources' => [ 'base' => NULL, 'refs' => [ 'UpdateGeneratedTemplateInput$RefreshAllResources' => '<p>If <code>true</code>, 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.</p>', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'DescribeStackInstanceInput$StackInstanceRegion' => '<p>The name of a Region that\'s associated with this stack instance.</p>', 'ListStackInstanceResourceDriftsInput$StackInstanceRegion' => '<p>The name of the Region where you want to list resource drifts.</p>', 'ListStackInstancesInput$StackInstanceRegion' => '<p>The name of the Region where you want to list stack instances.</p>', 'RegionList$member' => NULL, 'StackInstance$Region' => '<p>The name of the Amazon Web Services Region that the stack instance is associated with.</p>', 'StackInstanceSummary$Region' => '<p>The name of the Amazon Web Services Region that the stack instance is associated with.</p>', 'StackSetOperationResultSummary$Region' => '<p>The name of the Amazon Web Services Region for this operation result.</p>', ], ], 'RegionConcurrencyType' => [ 'base' => NULL, 'refs' => [ 'StackSetOperationPreferences$RegionConcurrencyType' => '<p>The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.</p>', ], ], 'RegionList' => [ 'base' => NULL, 'refs' => [ 'CreateStackInstancesInput$Regions' => '<p>The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.</p>', 'DeleteStackInstancesInput$Regions' => '<p>The Amazon Web Services Regions where you want to delete StackSet instances.</p>', 'StackSet$Regions' => '<p>Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.</p>', 'StackSetAutoDeploymentTargetSummary$Regions' => '<p>The list of Regions targeted for this organization or OU.</p>', 'StackSetOperationPreferences$RegionOrder' => '<p>The order of the Regions where you want to perform the stack operation.</p>', 'UpdateStackInstancesInput$Regions' => '<p>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.</p>', 'UpdateStackSetInput$Regions' => '<p>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 StackSet instances.</p> <p>To update <i>all</i> the stack instances associated with this StackSet, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the StackSet update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Regions. If the StackSet 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.</p>', ], ], 'RegisterPublisherInput' => [ 'base' => NULL, 'refs' => [], ], 'RegisterPublisherOutput' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTypeInput' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTypeOutput' => [ 'base' => NULL, 'refs' => [], ], 'RegistrationStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeRegistrationOutput$ProgressStatus' => '<p>The current status of the extension registration request.</p>', 'ListTypeRegistrationsInput$RegistrationStatusFilter' => '<p>The current status of the extension registration request.</p> <p>The default is <code>IN_PROGRESS</code>.</p>', ], ], 'RegistrationToken' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeRegistrationInput$RegistrationToken' => '<p>The identifier for this registration request.</p> <p>This registration token is generated by CloudFormation when you initiate a registration request using <a>RegisterType</a>.</p>', 'RegisterTypeOutput$RegistrationToken' => '<p>The identifier for this registration request.</p> <p>Use this registration token when calling <a>DescribeTypeRegistration</a>, which returns information about the status and IDs of the extension registration.</p>', 'RegistrationTokenList$member' => NULL, ], ], 'RegistrationTokenList' => [ 'base' => NULL, 'refs' => [ 'ListTypeRegistrationsOutput$RegistrationTokenList' => '<p>A list of extension registration tokens.</p> <p>Use <a>DescribeTypeRegistration</a> to return detailed information about a type registration request.</p>', ], ], 'RegistryType' => [ 'base' => NULL, 'refs' => [ 'DeregisterTypeInput$Type' => '<p>The kind of extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'DescribeTypeInput$Type' => '<p>The kind of extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'DescribeTypeOutput$Type' => '<p>The kind of extension.</p>', 'ListTypeRegistrationsInput$Type' => '<p>The kind of extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'ListTypeVersionsInput$Type' => '<p>The kind of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'ListTypesInput$Type' => '<p>The type of extension.</p>', 'RegisterTypeInput$Type' => '<p>The kind of extension.</p>', 'SetTypeDefaultVersionInput$Type' => '<p>The kind of extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'TypeSummary$Type' => '<p>The kind of extension.</p>', 'TypeVersionSummary$Type' => '<p>The kind of extension.</p>', ], ], 'RelatedResources' => [ 'base' => NULL, 'refs' => [ 'ListResourceScanRelatedResourcesOutput$RelatedResources' => '<p>List of up to <code>MaxResults</code> resources in the specified resource scan related to the specified resources.</p>', ], ], 'Replacement' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$Replacement' => '<p>For the <code>Modify</code> 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 <code>RequiresRecreation</code> property in the <code>ResourceTargetDefinition</code> structure. For example, if the <code>RequiresRecreation</code> field is <code>Always</code> and the <code>Evaluation</code> field is <code>Static</code>, <code>Replacement</code> is <code>True</code>. If the <code>RequiresRecreation</code> field is <code>Always</code> and the <code>Evaluation</code> field is <code>Dynamic</code>, <code>Replacement</code> is <code>Conditional</code>.</p> <p>If you have multiple changes with different <code>RequiresRecreation</code> values, the <code>Replacement</code> value depends on the change with the most impact. A <code>RequiresRecreation</code> value of <code>Always</code> has the most impact, followed by <code>Conditional</code>, and then <code>Never</code>.</p>', ], ], 'RequestToken' => [ 'base' => NULL, 'refs' => [ 'RegisterTypeInput$ClientRequestToken' => '<p>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.</p>', ], ], 'RequiredActivatedType' => [ 'base' => '<p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/module-versioning.html#requirements-for-modules">Requirements for activating third-party public modules</a> in the <i>CloudFormation User Guide</i>.</p>', 'refs' => [ 'RequiredActivatedTypes$member' => NULL, ], ], 'RequiredActivatedTypes' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeOutput$RequiredActivatedTypes' => '<p>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.</p>', ], ], 'RequiredProperty' => [ 'base' => NULL, 'refs' => [ 'WarningProperty$Required' => '<p>If <code>true</code>, the specified property is required.</p>', ], ], 'RequiresRecreation' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$RequiresRecreation' => '<p>If the <code>Attribute</code> value is <code>Properties</code>, indicates whether a change to this property causes the resource to be recreated. The value can be <code>Never</code>, <code>Always</code>, or <code>Conditionally</code>. To determine the conditions for a <code>Conditionally</code> recreation, see the update behavior for that property in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.</p>', ], ], 'ResourceAttribute' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$Attribute' => '<p>Indicates which resource attribute is triggering this update, such as a change in the resource attribute\'s <code>Metadata</code>, <code>Properties</code>, or <code>Tags</code>.</p>', 'Scope$member' => NULL, ], ], 'ResourceChange' => [ 'base' => '<p>The <code>ResourceChange</code> structure describes the resource and the action that CloudFormation will perform on it if you execute this change set.</p>', 'refs' => [ 'Change$ResourceChange' => '<p>A <code>ResourceChange</code> structure that describes the resource and action that CloudFormation will perform.</p>', ], ], 'ResourceChangeDetail' => [ 'base' => '<p>For a resource with <code>Modify</code> as the action, the <code>ResourceChange</code> structure describes the changes CloudFormation will make to that resource.</p>', 'refs' => [ 'ResourceChangeDetails$member' => NULL, ], ], 'ResourceChangeDetails' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$Details' => '<p>For the <code>Modify</code> action, a list of <code>ResourceChangeDetail</code> structures that describes the changes that CloudFormation will make to the resource.</p>', ], ], 'ResourceDefinition' => [ 'base' => '<p>A resource included in a generated template. This data type is used with the <code>CreateGeneratedTemplate</code> and <code>UpdateGeneratedTemplate</code> API actions.</p>', 'refs' => [ 'ResourceDefinitions$member' => NULL, ], ], 'ResourceDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateGeneratedTemplateInput$Resources' => '<p>An optional list of resources to be included in the generated template.</p> <p>If no resources are specified,the template will be created without any resources. Resources can be added to the template using the <code>UpdateGeneratedTemplate</code> API action.</p>', 'UpdateGeneratedTemplateInput$AddResources' => '<p>An optional list of resources to be added to the generated template.</p>', ], ], 'ResourceDetail' => [ 'base' => '<p>Details about a resource in a generated template</p>', 'refs' => [ 'ResourceDetails$member' => NULL, ], ], 'ResourceDetails' => [ 'base' => NULL, 'refs' => [ 'DescribeGeneratedTemplateOutput$Resources' => '<p>A list of objects describing the details of the resources in the template generation.</p>', ], ], 'ResourceIdentifier' => [ 'base' => NULL, 'refs' => [ 'ListResourceScanResourcesInput$ResourceIdentifier' => '<p>If specified, the returned resources will have the specified resource identifier (or one of them in the case where the resource has multiple identifiers).</p>', ], ], 'ResourceIdentifierProperties' => [ 'base' => NULL, 'refs' => [ 'ResourceDefinition$ResourceIdentifier' => '<p>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 <code>primaryIdentifier</code> list in the resource schema.) The value is the value of that primary identifier. For example, for a <code>AWS::DynamoDB::Table</code> resource, the primary identifiers is <code>TableName</code> so the key-value pair could be <code>"TableName": "MyDDBTable"</code>. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier">primaryIdentifier</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>', 'ResourceDetail$ResourceIdentifier' => '<p>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 <code>primaryIdentifier</code> list in the resource schema.) The value is the value of that primary identifier. For example, for a <code>AWS::DynamoDB::Table</code> resource, the primary identifiers is <code>TableName</code> so the key-value pair could be <code>"TableName": "MyDDBTable"</code>. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier">primaryIdentifier</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p>', 'ResourceToImport$ResourceIdentifier' => '<p>A key-value pair that identifies the target resource. The key is an identifier property (for example, <code>BucketName</code> for <code>AWS::S3::Bucket</code> resources) and the value is the actual property value (for example, <code>MyS3Bucket</code>).</p>', ], ], 'ResourceIdentifierPropertyKey' => [ 'base' => NULL, 'refs' => [ 'ResourceIdentifierProperties$key' => NULL, 'ResourceIdentifiers$member' => NULL, ], ], 'ResourceIdentifierPropertyValue' => [ 'base' => NULL, 'refs' => [ 'ResourceIdentifierProperties$value' => NULL, ], ], 'ResourceIdentifierSummaries' => [ 'base' => NULL, 'refs' => [ 'GetTemplateSummaryOutput$ResourceIdentifierSummaries' => '<p>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, <code>BucketName</code> is a possible identifier property for an <code>AWS::S3::Bucket</code> resource.</p>', ], ], 'ResourceIdentifierSummary' => [ 'base' => '<p>Describes the target resources of a specific type in your import template (for example, all <code>AWS::S3::Bucket</code> resources) and the properties you can provide during the import to identify resources of that type.</p>', 'refs' => [ 'ResourceIdentifierSummaries$member' => NULL, ], ], 'ResourceIdentifiers' => [ 'base' => NULL, 'refs' => [ 'ResourceIdentifierSummary$ResourceIdentifiers' => '<p>The resource properties you can provide during the import to identify your target resources. For example, <code>BucketName</code> is a possible identifier property for <code>AWS::S3::Bucket</code> resources.</p>', ], ], 'ResourceLocation' => [ 'base' => '<p>The location of the resource in a stack template.</p>', 'refs' => [ 'ResourceMapping$Source' => '<p>The source stack <code>StackName</code> and <code>LogicalResourceId</code> for the resource being refactored.</p>', 'ResourceMapping$Destination' => '<p>The destination stack <code>StackName</code> and <code>LogicalResourceId</code> for the resource being refactored.</p>', ], ], 'ResourceMapping' => [ 'base' => '<p>Specifies the current source of the resource and the destination of where it will be moved to.</p>', 'refs' => [ 'ResourceMappings$member' => NULL, 'StackRefactorAction$ResourceMapping' => '<p>The mapping for the stack resource <code>Source</code> and stack resource <code>Destination</code>.</p>', ], ], 'ResourceMappings' => [ 'base' => NULL, 'refs' => [ 'CreateStackRefactorInput$ResourceMappings' => '<p>The mappings for the stack resource <code>Source</code> and stack resource <code>Destination</code>.</p>', ], ], 'ResourceModel' => [ 'base' => NULL, 'refs' => [ 'RecordHandlerProgressInput$ResourceModel' => '<p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>', ], ], 'ResourceProperties' => [ 'base' => NULL, 'refs' => [ 'StackEvent$ResourceProperties' => '<p>BLOB of the properties used to create the resource.</p>', ], ], 'ResourcePropertyPath' => [ 'base' => NULL, 'refs' => [ 'ResourceTargetDefinition$Path' => '<p>The property path of the property.</p>', ], ], 'ResourceScanId' => [ 'base' => NULL, 'refs' => [ 'DescribeResourceScanInput$ResourceScanId' => '<p>The Amazon Resource Name (ARN) of the resource scan.</p>', 'DescribeResourceScanOutput$ResourceScanId' => '<p>The Amazon Resource Name (ARN) of the resource scan. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}</code>. An example is <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:resourceScan/<i>f5b490f7-7ed4-428a-aa06-31ff25db0772</i> </code>.</p>', 'ListResourceScanRelatedResourcesInput$ResourceScanId' => '<p>The Amazon Resource Name (ARN) of the resource scan.</p>', 'ListResourceScanResourcesInput$ResourceScanId' => '<p>The Amazon Resource Name (ARN) of the resource scan.</p>', 'ResourceScanSummary$ResourceScanId' => '<p>The Amazon Resource Name (ARN) of the resource scan.</p>', 'StartResourceScanOutput$ResourceScanId' => '<p>The Amazon Resource Name (ARN) of the resource scan. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}</code>. An example is <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:resourceScan/<i>f5b490f7-7ed4-428a-aa06-31ff25db0772</i> </code>.</p>', ], ], 'ResourceScanInProgressException' => [ 'base' => '<p>A resource scan is currently in progress. Only one can be run at a time for an account in a Region.</p>', 'refs' => [], ], 'ResourceScanLimitExceededException' => [ 'base' => '<p>The limit on resource scans has been exceeded. Reasons include:</p> <ul> <li> <p>Exceeded the daily quota for resource scans.</p> </li> <li> <p>A resource scan recently failed. You must wait 10 minutes before starting a new resource scan.</p> </li> <li> <p>The last resource scan failed after exceeding 100,000 resources. When this happens, you must wait 24 hours before starting a new resource scan.</p> </li> </ul>', 'refs' => [], ], 'ResourceScanNotFoundException' => [ 'base' => '<p>The resource scan was not found.</p>', 'refs' => [], ], 'ResourceScanStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeResourceScanOutput$Status' => '<p>Status of the resource scan.</p> <dl> <dt> IN_PROGRESS </dt> <dd> <p>The resource scan is still in progress.</p> </dd> <dt> COMPLETE </dt> <dd> <p>The resource scan is complete.</p> </dd> <dt> EXPIRED </dt> <dd> <p>The resource scan has expired.</p> </dd> <dt> FAILED </dt> <dd> <p>The resource scan has failed.</p> </dd> </dl>', 'ResourceScanSummary$Status' => '<p>Status of the resource scan.</p> <dl> <dt> IN_PROGRESS </dt> <dd> <p>The resource scan is still in progress.</p> </dd> <dt> COMPLETE </dt> <dd> <p>The resource scan is complete.</p> </dd> <dt> EXPIRED </dt> <dd> <p>The resource scan has expired.</p> </dd> <dt> FAILED </dt> <dd> <p>The resource scan has failed.</p> </dd> </dl>', ], ], 'ResourceScanStatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeResourceScanOutput$StatusReason' => '<p>The reason for the resource scan status, providing more information if a failure happened.</p>', 'ResourceScanSummary$StatusReason' => '<p>The reason for the resource scan status, providing more information if a failure happened.</p>', ], ], 'ResourceScanSummaries' => [ 'base' => NULL, 'refs' => [ 'ListResourceScansOutput$ResourceScanSummaries' => '<p>The list of scans returned.</p>', ], ], 'ResourceScanSummary' => [ 'base' => '<p>A summary of the resource scan. This is returned by the <code>ListResourceScan</code> API action.</p>', 'refs' => [ 'ResourceScanSummaries$member' => NULL, ], ], 'ResourceScannerMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListResourceScanResourcesInput$MaxResults' => '<p>If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can use for the <code>NextToken</code> parameter to get the next set of results. By default the <code>ListResourceScanResources</code> API action will return at most 100 results in each response. The maximum value is 100.</p>', 'ListResourceScansInput$MaxResults' => '<p>If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can use for the <code>NextToken</code> parameter to get the next set of results. The default value is 10. The maximum value is 100.</p>', ], ], 'ResourceSignalStatus' => [ 'base' => NULL, 'refs' => [ 'SignalResourceInput$Status' => '<p>The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.</p>', ], ], 'ResourceSignalUniqueId' => [ 'base' => NULL, 'refs' => [ 'SignalResourceInput$UniqueId' => '<p>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.</p>', ], ], 'ResourceStatus' => [ 'base' => NULL, 'refs' => [ 'StackEvent$ResourceStatus' => '<p>Current status of the resource.</p>', 'StackResource$ResourceStatus' => '<p>Current status of the resource.</p>', 'StackResourceDetail$ResourceStatus' => '<p>Current status of the resource.</p>', 'StackResourceSummary$ResourceStatus' => '<p>Current status of the resource.</p>', ], ], 'ResourceStatusReason' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$ResourceStatusReason' => '<p>The reason for the resource detail, providing more information if a failure happened.</p>', 'StackEvent$ResourceStatusReason' => '<p>Success/failure message associated with the resource.</p>', 'StackResource$ResourceStatusReason' => '<p>Success/failure message associated with the resource.</p>', 'StackResourceDetail$ResourceStatusReason' => '<p>Success/failure message associated with the resource.</p>', 'StackResourceSummary$ResourceStatusReason' => '<p>Success/failure message associated with the resource.</p>', ], ], 'ResourceTargetDefinition' => [ 'base' => '<p>The field that CloudFormation will change, such as the name of a resource\'s property, and whether the resource will be recreated.</p>', 'refs' => [ 'ResourceChangeDetail$Target' => '<p>A <code>ResourceTargetDefinition</code> structure that describes the field that CloudFormation will change and whether the resource will be recreated.</p>', ], ], 'ResourceToImport' => [ 'base' => '<p>Describes the target resource of an import operation.</p>', 'refs' => [ 'ResourcesToImport$member' => NULL, ], ], 'ResourceToSkip' => [ 'base' => NULL, 'refs' => [ 'ResourcesToSkip$member' => NULL, ], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$ResourceType' => '<p>The type of CloudFormation resource, such as <code>AWS::S3::Bucket</code>.</p>', 'ResourceDefinition$ResourceType' => '<p>The type of the resource, such as <code>AWS::DynamoDB::Table</code>. For the list of supported resources, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a> in the <i>CloudFormation User Guide</i> </p>', 'ResourceDetail$ResourceType' => '<p>The type of the resource, such as <code>AWS::DynamoDB::Table</code>. For the list of supported resources, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a> In the <i>CloudFormation User Guide</i> </p>', 'ResourceIdentifierSummary$ResourceType' => '<p>The template resource type of the target resources, such as <code>AWS::S3::Bucket</code>.</p>', 'ResourceToImport$ResourceType' => '<p>The type of resource to import into your stack, such as <code>AWS::S3::Bucket</code>. For a list of supported resource types, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a> in the <i>CloudFormation User Guide</i>.</p>', 'ResourceTypes$member' => NULL, 'ScannedResource$ResourceType' => '<p>The type of the resource, such as <code>AWS::DynamoDB::Table</code>. For the list of supported resources, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a> In the <i>CloudFormation User Guide</i> </p>', 'ScannedResourceIdentifier$ResourceType' => '<p>The type of the resource, such as <code>AWS::DynamoDB::Table</code>. For the list of supported resources, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a> In the <i>CloudFormation User Guide</i>.</p>', 'StackEvent$ResourceType' => '<p>Type of resource. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.</p>', 'StackInstanceResourceDriftsSummary$ResourceType' => '<p>Type of resource. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.</p>', 'StackResource$ResourceType' => '<p>Type of resource. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.</p>', 'StackResourceDetail$ResourceType' => '<p>Type of resource. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.</p>', 'StackResourceDrift$ResourceType' => '<p>The type of the resource.</p>', 'StackResourceSummary$ResourceType' => '<p>Type of resource. (For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.)</p>', ], ], 'ResourceTypeFilter' => [ 'base' => NULL, 'refs' => [ 'ResourceTypeFilters$member' => NULL, ], ], 'ResourceTypeFilters' => [ 'base' => NULL, 'refs' => [ 'ScanFilter$Types' => '<p>An array of strings where each string represents an Amazon Web Services resource type you want to scan. Each string defines the resource type using the format <code>AWS::ServiceName::ResourceType</code>, for example, <code>AWS::DynamoDB::Table</code>. For the full list of supported resource types, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support</a> table in the <i>CloudFormation User Guide</i>.</p> <p>To scan all resource types within a service, you can use a wildcard, represented by an asterisk (<code>*</code>). You can place an asterisk at only the end of the string, for example, <code>AWS::S3::*</code>.</p>', ], ], 'ResourceTypePrefix' => [ 'base' => NULL, 'refs' => [ 'ListResourceScanResourcesInput$ResourceTypePrefix' => '<p>If specified, the returned resources will be of any of the resource types with the specified prefix.</p>', ], ], 'ResourceTypes' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$ResourceTypes' => '<p>The template resource types that you have permissions to work with if you execute this change set, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html">Control access with Identity and Access Management</a> in the <i>CloudFormation User Guide</i>.</p> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>', 'CreateStackInput$ResourceTypes' => '<p>The template resource types that you have permissions to work with for this create stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. Use the following syntax to describe template resource types: <code>AWS::*</code> (for all Amazon Web Services resources), <code>Custom::*</code> (for all custom resources), <code>Custom::<i>logical_ID</i> </code> (for a specific custom resource), <code>AWS::<i>service_name</i>::*</code> (for all resources of a particular Amazon Web Services service), and <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i> </code> (for a specific Amazon Web Services resource).</p> <p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html">Control access with Identity and Access Management</a>.</p> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>', 'DescribeResourceScanOutput$ResourceTypes' => '<p>The list of resource types for the specified scan. Resource types are only available for scans with a <code>Status</code> set to <code>COMPLETE</code> or <code>FAILED </code>.</p>', 'GetTemplateSummaryOutput$ResourceTypes' => '<p>A list of all the template resource types that are defined in the template, such as <code>AWS::EC2::Instance</code>, <code>AWS::Dynamo::Table</code>, and <code>Custom::MyCustomInstance</code>.</p>', 'UpdateStackInput$ResourceTypes' => '<p>The template resource types that you have permissions to work with for this update stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html">Control access with Identity and Access Management</a>.</p> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>', 'Warnings$UnrecognizedResourceTypes' => '<p>A list of all of the unrecognized resource types. This is only returned if the <code>TemplateSummaryConfig</code> parameter has the <code>TreatUnrecognizedResourceTypesAsWarning</code> configuration set to <code>True</code>.</p>', ], ], 'ResourcesFailed' => [ 'base' => NULL, 'refs' => [ 'TemplateProgress$ResourcesFailed' => '<p>The number of resources that failed the template generation.</p>', ], ], 'ResourcesPending' => [ 'base' => NULL, 'refs' => [ 'TemplateProgress$ResourcesPending' => '<p>The number of resources that are still pending the template generation.</p>', ], ], 'ResourcesProcessing' => [ 'base' => NULL, 'refs' => [ 'TemplateProgress$ResourcesProcessing' => '<p>The number of resources that are in-process for the template generation.</p>', ], ], 'ResourcesRead' => [ 'base' => NULL, 'refs' => [ 'DescribeResourceScanOutput$ResourcesRead' => '<p>The number of resources that were read. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED</code>.</p> <note> <p>This field may be 0 if the resource scan failed with a <code>ResourceScanLimitExceededException</code>.</p> </note>', ], ], 'ResourcesScanned' => [ 'base' => NULL, 'refs' => [ 'DescribeResourceScanOutput$ResourcesScanned' => '<p>The number of resources that were listed. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED </code>.</p>', ], ], 'ResourcesSucceeded' => [ 'base' => NULL, 'refs' => [ 'TemplateProgress$ResourcesSucceeded' => '<p>The number of resources that succeeded the template generation.</p>', ], ], 'ResourcesToImport' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$ResourcesToImport' => '<p>The resources to import into your stack.</p>', ], ], 'ResourcesToSkip' => [ 'base' => NULL, 'refs' => [ 'ContinueUpdateRollbackInput$ResourcesToSkip' => '<p>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 <code>UPDATE_FAILED</code> state because a rollback failed. You can\'t specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason.</p> <important> <p>Specify this property to skip rolling back resources that CloudFormation can\'t successfully roll back. We recommend that you <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> troubleshoot</a> resources before skipping them. CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> 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.</p> </important> <p>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.</p> <p>To skip resources that are part of nested stacks, use the following format: <code>NestedStackName.ResourceLogicalID</code>. If you want to specify the logical ID of a stack resource (<code>Type: AWS::CloudFormation::Stack</code>) in the <code>ResourcesToSkip</code> list, then its corresponding embedded stack must be in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>.</p> <note> <p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks">Continue rolling back from failed nested stack updates</a>.</p> </note>', ], ], 'RetainExceptOnCreate' => [ 'base' => NULL, 'refs' => [ 'CreateStackInput$RetainExceptOnCreate' => '<p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p> <p>Default: <code>false</code> </p>', 'ExecuteChangeSetInput$RetainExceptOnCreate' => '<p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p> <p>Default: <code>false</code> </p>', 'RollbackStackInput$RetainExceptOnCreate' => '<p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p> <p>Default: <code>false</code> </p>', 'Stack$RetainExceptOnCreate' => '<p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p> <p>Default: <code>false</code> </p>', 'UpdateStackInput$RetainExceptOnCreate' => '<p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p> <p>Default: <code>false</code> </p>', ], ], 'RetainResources' => [ 'base' => NULL, 'refs' => [ 'DeleteStackInput$RetainResources' => '<p>For stacks in the <code>DELETE_FAILED</code> 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.</p> <p>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.</p>', ], ], 'RetainStacks' => [ 'base' => NULL, 'refs' => [ 'DeleteStackInstancesInput$RetainStacks' => '<p>Removes the stack instances from the specified StackSet, but doesn\'t delete the stacks. You can\'t reassociate a retained stack or add an existing, saved stack to a new stack set.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">StackSet operation options</a>.</p>', ], ], 'RetainStacksNullable' => [ 'base' => NULL, 'refs' => [ 'StackSetOperation$RetainStacks' => '<p>For StackSet operations of action type <code>DELETE</code>, specifies whether to remove the stack instances from the specified StackSet, but doesn\'t delete the stacks. You can\'t re-associate a retained stack, or add an existing, saved stack to a new StackSet.</p>', ], ], 'RetainStacksOnAccountRemovalNullable' => [ 'base' => NULL, 'refs' => [ 'AutoDeployment$RetainStacksOnAccountRemoval' => '<p>If set to <code>true</code>, stack resources are retained when an account is removed from a target organization or OU. If set to <code>false</code>, stack resources are deleted. Specify only if <code>Enabled</code> is set to <code>True</code>.</p>', ], ], 'RoleARN' => [ 'base' => NULL, 'refs' => [ 'ContinueUpdateRollbackInput$RoleARN' => '<p>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.</p> <p>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.</p>', 'CreateChangeSetInput$RoleARN' => '<p>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.</p> <p>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.</p>', 'CreateStackInput$RoleARN' => '<p>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.</p> <p>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.</p>', 'CreateStackSetInput$AdministrationRoleARN' => '<p>The Amazon Resource Name (ARN) of the IAM role to use to create this StackSet.</p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html">Grant self-managed permissions</a> in the <i>CloudFormation User Guide</i>.</p> <p>Valid only if the permissions model is <code>SELF_MANAGED</code>.</p>', 'DeleteStackInput$RoleARN' => '<p>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.</p> <p>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.</p>', 'RollbackStackInput$RoleARN' => '<p>The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the stack.</p>', 'Stack$RoleARN' => '<p>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.</p>', 'StackSet$AdministrationRoleARN' => '<p>The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.</p> <p>Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Prerequisites for using CloudFormation StackSets</a> in the <i>CloudFormation User Guide</i>.</p>', 'StackSetOperation$AdministrationRoleARN' => '<p>The Amazon Resource Name (ARN) of the IAM role used to perform this StackSet operation.</p> <p>Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html">Grant self-managed permissions</a> in the <i>CloudFormation User Guide</i>.</p>', 'UpdateStackInput$RoleARN' => '<p>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.</p> <p>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.</p>', 'UpdateStackSetInput$AdministrationRoleARN' => '<p>[Self-managed permissions] The Amazon Resource Name (ARN) of the IAM role to use to update this StackSet.</p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html">Grant self-managed permissions</a> in the <i>CloudFormation User Guide</i>.</p> <p>If you specified a customized administrator role when you created the StackSet, you must specify a customized administrator role, even if it is the same customized administrator role used with this StackSet previously.</p>', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'ActivateTypeInput$ExecutionRoleArn' => '<p>The name of the IAM execution role to use to activate the extension.</p>', 'DescribeTypeOutput$ExecutionRoleArn' => '<p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p> <p>If the registered extension calls any Amazon Web Services APIs, you must create an <i> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM execution role</a> </i> that includes the necessary permissions to call those 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.</p>', 'LoggingConfig$LogRoleArn' => '<p>The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.</p>', 'RegisterTypeInput$ExecutionRoleArn' => '<p>The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.</p> <p>For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principal (<code>resources.cloudformation.amazonaws.com</code>). For more information about adding trust relationships, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy">Modifying a role trust policy</a> in the <i>Identity and Access Management User Guide</i>.</p> <p>If your extension calls Amazon Web Services APIs in any of its handlers, you must create an <i> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM execution role</a> </i> that includes the necessary permissions to call those 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.</p>', ], ], 'RollbackConfiguration' => [ 'base' => '<p>Structure that contains the rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p> <p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html">Roll back your CloudFormation stack on alarm breach with rollback triggers</a>.</p>', 'refs' => [ 'CreateChangeSetInput$RollbackConfiguration' => '<p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>', 'CreateStackInput$RollbackConfiguration' => '<p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>', 'DescribeChangeSetOutput$RollbackConfiguration' => '<p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>', 'Stack$RollbackConfiguration' => '<p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>', 'UpdateStackInput$RollbackConfiguration' => '<p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>', ], ], 'RollbackStackInput' => [ 'base' => NULL, 'refs' => [], ], 'RollbackStackOutput' => [ 'base' => NULL, 'refs' => [], ], 'RollbackTrigger' => [ 'base' => '<p>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.</p>', 'refs' => [ 'RollbackTriggers$member' => NULL, ], ], 'RollbackTriggers' => [ 'base' => NULL, 'refs' => [ 'RollbackConfiguration$RollbackTriggers' => '<p>The triggers to monitor during stack creation or update actions.</p> <p>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:</p> <ul> <li> <p>To use the rollback triggers previously specified for this stack, if any, don\'t specify this parameter.</p> </li> <li> <p>To specify new or updated rollback triggers, you must specify <i>all</i> 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.</p> </li> <li> <p>To remove all currently specified triggers, specify an empty list for this parameter.</p> </li> </ul> <p>If a specified trigger is missing, the entire stack operation fails and is rolled back.</p>', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'TestTypeInput$LogDeliveryBucket' => '<p>The S3 bucket to which CloudFormation delivers the contract test execution logs.</p> <p>CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of <code>PASSED</code> or <code>FAILED</code>.</p> <p>The user calling <code>TestType</code> must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:</p> <ul> <li> <p> <code>GetObject</code> </p> </li> <li> <p> <code>PutObject</code> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a> in the <i>Identity and Access Management User Guide</i>.</p>', ], ], 'S3Url' => [ 'base' => NULL, 'refs' => [ 'RegisterTypeInput$SchemaHandlerPackage' => '<p>A URL to the S3 bucket that contains the extension project package that contains the necessary files for the extension you want to register.</p> <p>For information about generating a schema handler package for the extension you want to register, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html">submit</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p> <note> <p>The user registering the extension must be able to access the package in the S3 bucket. That\'s, the user needs to have <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> permissions for the schema handler package. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a> in the <i>Identity and Access Management User Guide</i>.</p> </note>', ], ], 'ScanFilter' => [ 'base' => '<p>A filter that is used to specify which resource types to scan.</p>', 'refs' => [ 'ScanFilters$member' => NULL, ], ], 'ScanFilters' => [ 'base' => NULL, 'refs' => [ 'DescribeResourceScanOutput$ScanFilters' => '<p>The scan filters that were used.</p>', 'StartResourceScanInput$ScanFilters' => '<p>The scan filters to use.</p>', ], ], 'ScanType' => [ 'base' => NULL, 'refs' => [ 'ListResourceScansInput$ScanTypeFilter' => '<p>The scan type that you want to get summary information about. The default is <code>FULL</code>.</p>', 'ResourceScanSummary$ScanType' => '<p>The scan type that has been completed.</p>', ], ], 'ScannedResource' => [ 'base' => '<p>A scanned resource returned by <code>ListResourceScanResources</code> or <code>ListResourceScanRelatedResources</code>.</p>', 'refs' => [ 'RelatedResources$member' => NULL, 'ScannedResources$member' => NULL, ], ], 'ScannedResourceIdentifier' => [ 'base' => '<p>Identifies a scanned resource. This is used with the <code>ListResourceScanRelatedResources</code> API action.</p>', 'refs' => [ 'ScannedResourceIdentifiers$member' => NULL, ], ], 'ScannedResourceIdentifiers' => [ 'base' => NULL, 'refs' => [ 'ListResourceScanRelatedResourcesInput$Resources' => '<p>The list of resources for which you want to get the related resources. Up to 100 resources can be provided.</p>', ], ], 'ScannedResources' => [ 'base' => NULL, 'refs' => [ 'ListResourceScanResourcesOutput$Resources' => '<p>List of up to <code>MaxResults</code> resources in the specified resource scan that match all of the specified filters.</p>', ], ], 'Scope' => [ 'base' => NULL, 'refs' => [ 'ResourceChange$Scope' => '<p>For the <code>Modify</code> action, indicates which resource attribute is triggering this update, such as a change in the resource attribute\'s <code>Metadata</code>, <code>Properties</code>, or <code>Tags</code>.</p>', ], ], 'SetStackPolicyInput' => [ 'base' => '<p>The input for the <a>SetStackPolicy</a> action.</p>', 'refs' => [], ], 'SetTypeConfigurationInput' => [ 'base' => NULL, 'refs' => [], ], 'SetTypeConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'SetTypeDefaultVersionInput' => [ 'base' => NULL, 'refs' => [], ], 'SetTypeDefaultVersionOutput' => [ 'base' => NULL, 'refs' => [], ], 'SignalResourceInput' => [ 'base' => '<p>The input for the <a>SignalResource</a> action.</p>', 'refs' => [], ], 'Stack' => [ 'base' => '<p>The Stack data type.</p>', 'refs' => [ 'Stacks$member' => NULL, ], ], 'StackDefinition' => [ 'base' => '<p>Describes the stack and the template used by the stack.</p>', 'refs' => [ 'StackDefinitions$member' => NULL, ], ], 'StackDefinitions' => [ 'base' => NULL, 'refs' => [ 'CreateStackRefactorInput$StackDefinitions' => '<p>The stacks being refactored.</p>', ], ], 'StackDriftDetectionId' => [ 'base' => NULL, 'refs' => [ 'DescribeStackDriftDetectionStatusInput$StackDriftDetectionId' => '<p>The ID of the drift detection results of this operation.</p> <p>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.</p>', 'DescribeStackDriftDetectionStatusOutput$StackDriftDetectionId' => '<p>The ID of the drift detection results of this operation.</p> <p>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.</p>', 'DetectStackDriftOutput$StackDriftDetectionId' => '<p>The ID of the drift detection results of this operation.</p> <p>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.</p>', ], ], 'StackDriftDetectionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeStackDriftDetectionStatusOutput$DetectionStatus' => '<p>The status of the stack drift detection operation.</p> <ul> <li> <p> <code>DETECTION_COMPLETE</code>: 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.)</p> <p>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.</p> </li> <li> <p> <code>DETECTION_FAILED</code>: 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.</p> </li> <li> <p> <code>DETECTION_IN_PROGRESS</code>: The stack drift detection operation is currently in progress.</p> </li> </ul>', ], ], 'StackDriftDetectionStatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeStackDriftDetectionStatusOutput$DetectionStatusReason' => '<p>The reason the stack drift detection operation has its current status.</p>', ], ], 'StackDriftInformation' => [ 'base' => '<p>Contains information about whether the stack\'s actual configuration differs, or has <i>drifted</i>, 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.</p>', 'refs' => [ 'Stack$DriftInformation' => '<p>Information about whether a stack\'s actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p>', ], ], 'StackDriftInformationSummary' => [ 'base' => '<p>Contains information about whether the stack\'s actual configuration differs, or has <i>drifted</i>, 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.</p>', 'refs' => [ 'StackSummary$DriftInformation' => '<p>Summarizes information about whether a stack\'s actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p>', ], ], 'StackDriftStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeStackDriftDetectionStatusOutput$StackDriftStatus' => '<p>Status of the stack\'s actual configuration compared to its expected configuration.</p> <ul> <li> <p> <code>DRIFTED</code>: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation hasn\'t checked if the stack differs from its expected template configuration.</p> </li> <li> <p> <code>IN_SYNC</code>: The stack\'s actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: CloudFormation could not run drift detection for a resource in the stack. See the <code>DetectionStatusReason</code> for details.</p> </li> </ul>', 'StackDriftInformation$StackDriftStatus' => '<p>Status of the stack\'s actual configuration compared to its expected template configuration.</p> <ul> <li> <p> <code>DRIFTED</code>: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation hasn\'t checked if the stack differs from its expected template configuration.</p> </li> <li> <p> <code>IN_SYNC</code>: The stack\'s actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: CloudFormation could not run drift detection for a resource in the stack.</p> </li> </ul>', 'StackDriftInformationSummary$StackDriftStatus' => '<p>Status of the stack\'s actual configuration compared to its expected template configuration.</p> <ul> <li> <p> <code>DRIFTED</code>: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation hasn\'t checked if the stack differs from its expected template configuration.</p> </li> <li> <p> <code>IN_SYNC</code>: The stack\'s actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: CloudFormation could not run drift detection for a resource in the stack.</p> </li> </ul>', 'StackInstance$DriftStatus' => '<p>Status of the stack instance\'s actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.</p> <ul> <li> <p> <code>DRIFTED</code>: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation hasn\'t checked if the stack instance differs from its expected StackSet configuration.</p> </li> <li> <p> <code>IN_SYNC</code>: The stack instance\'s actual configuration matches its expected StackSset configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: This value is reserved for future use.</p> </li> </ul>', 'StackInstanceSummary$DriftStatus' => '<p>Status of the stack instance\'s actual configuration compared to the expected template and parameter configuration of the StackSet it belongs to.</p> <ul> <li> <p> <code>DRIFTED</code>: The stack differs from the expected template and parameter configuration of the StackSet it belongs to. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation hasn\'t checked if the stack instance differs from its expected StackSet configuration.</p> </li> <li> <p> <code>IN_SYNC</code>: The stack instance\'s actual configuration matches its expected StackSet configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: This value is reserved for future use.</p> </li> </ul>', 'StackSetSummary$DriftStatus' => '<p>Status of the StackSet\'s actual configuration compared to its expected template and parameter configuration.</p> <ul> <li> <p> <code>DRIFTED</code>: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation hasn\'t checked the StackSet for drift.</p> </li> <li> <p> <code>IN_SYNC</code>: All the stack instances belonging to the StackSet match the expected template and parameter configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: This value is reserved for future use.</p> </li> </ul>', ], ], 'StackEvent' => [ 'base' => '<p>The StackEvent data type.</p>', 'refs' => [ 'StackEvents$member' => NULL, ], ], 'StackEvents' => [ 'base' => NULL, 'refs' => [ 'DescribeStackEventsOutput$StackEvents' => '<p>A list of <code>StackEvents</code> structures.</p>', ], ], 'StackId' => [ 'base' => NULL, 'refs' => [ 'ChangeSetSummary$StackId' => '<p>The ID of the stack with which the change set is associated.</p>', 'CreateChangeSetOutput$StackId' => '<p>The unique ID of the stack.</p>', 'CreateStackOutput$StackId' => '<p>Unique identifier of the stack.</p>', 'CreateStackSetInput$StackId' => '<p>The stack ID you are importing into a new StackSet. Specify the Amazon Resource Name (ARN) of the stack.</p>', 'DescribeChangeSetHooksOutput$StackId' => '<p>The stack identifier (stack ID).</p>', 'DescribeChangeSetOutput$StackId' => '<p>The Amazon Resource Name (ARN) of the stack that\'s associated with the change set.</p>', 'DescribeGeneratedTemplateOutput$StackId' => '<p>The stack ARN of the base stack if a base stack was provided when generating the template.</p>', 'DescribeStackDriftDetectionStatusOutput$StackId' => '<p>The ID of the stack.</p>', 'Export$ExportingStackId' => '<p>The stack that contains the exported output name and value.</p>', 'RollbackStackOutput$StackId' => '<p>Unique identifier of the stack.</p>', 'Stack$StackId' => '<p>Unique identifier of the stack.</p>', 'Stack$ParentId' => '<p>For nested stacks, 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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Nested stacks</a> in the <i>CloudFormation User Guide</i>.</p>', 'Stack$RootId' => '<p>For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately belongs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Nested stacks</a> in the <i>CloudFormation User Guide</i>.</p>', 'StackEvent$StackId' => '<p>The unique ID name of the instance of the stack.</p>', 'StackIdList$member' => NULL, 'StackIds$member' => NULL, 'StackInstance$StackId' => '<p>The ID of the stack instance.</p>', 'StackInstanceResourceDriftsSummary$StackId' => '<p>The ID of the stack instance.</p>', 'StackInstanceSummary$StackId' => '<p>The ID of the stack instance.</p>', 'StackResource$StackId' => '<p>Unique identifier of the stack.</p>', 'StackResourceDetail$StackId' => '<p>Unique identifier of the stack.</p>', 'StackResourceDrift$StackId' => '<p>The ID of the stack.</p>', 'StackSummary$StackId' => '<p>Unique stack identifier.</p>', 'StackSummary$ParentId' => '<p>For nested stacks, 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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Nested stacks</a> in the <i>CloudFormation User Guide</i>.</p>', 'StackSummary$RootId' => '<p>For nested stacks, the stack ID of the top-level stack to which the nested stack ultimately belongs.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">Nested stacks</a> in the <i>CloudFormation User Guide</i>.</p>', 'UpdateStackOutput$StackId' => '<p>Unique identifier of the stack.</p>', 'UpdateTerminationProtectionOutput$StackId' => '<p>The unique ID of the stack.</p>', ], ], 'StackIdList' => [ 'base' => NULL, 'refs' => [ 'ImportStacksToStackSetInput$StackIds' => '<p>The IDs of the stacks you are importing into a StackSet. You import up to 10 stacks per StackSet at a time.</p> <p>Specify either <code>StackIds</code> or <code>StackIdsUrl</code>.</p>', ], ], 'StackIds' => [ 'base' => NULL, 'refs' => [ 'DescribeStackRefactorOutput$StackIds' => '<p>The unique ID for each stack.</p>', ], ], 'StackIdsUrl' => [ 'base' => NULL, 'refs' => [ 'ImportStacksToStackSetInput$StackIdsUrl' => '<p>The Amazon S3 URL which contains list of stack ids to be inputted.</p> <p>Specify either <code>StackIds</code> or <code>StackIdsUrl</code>.</p>', ], ], 'StackInstance' => [ 'base' => '<p>A CloudFormation stack, in a specific account and Region, that\'s part of a StackSet 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 StackSet. Each stack instance contains the ID of its associated StackSet, in addition to the ID of the actual stack and the stack status.</p>', 'refs' => [ 'DescribeStackInstanceOutput$StackInstance' => '<p>The stack instance that matches the specified request parameters.</p>', ], ], 'StackInstanceComprehensiveStatus' => [ 'base' => '<p>The detailed status of the stack instance.</p>', 'refs' => [ 'StackInstance$StackInstanceStatus' => '<p>The detailed status of the stack instance.</p>', 'StackInstanceSummary$StackInstanceStatus' => '<p>The detailed status of the stack instance.</p>', ], ], 'StackInstanceDetailedStatus' => [ 'base' => NULL, 'refs' => [ 'StackInstanceComprehensiveStatus$DetailedStatus' => '<ul> <li> <p> <code>CANCELLED</code>: The operation in the specified account and Region has been canceled. This is either because a user has stopped the StackSet operation, or because the failure tolerance of the StackSet operation has been exceeded.</p> </li> <li> <p> <code>FAILED</code>: The operation in the specified account and Region failed. If the StackSet operation fails in enough accounts within a Region, the failure tolerance for the StackSet operation as a whole might be exceeded.</p> </li> <li> <p> <code>FAILED_IMPORT</code>: The import of the stack instance in the specified account and Region failed and left the stack in an unstable state. Once the issues causing the failure are fixed, the import operation can be retried. If enough StackSet operations fail in enough accounts within a Region, the failure tolerance for the StackSet operation as a whole might be exceeded.</p> </li> <li> <p> <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further <code>UpdateStackSet</code> operations. You might need to perform a <code>DeleteStackInstances</code> operation, with <code>RetainStacks</code> set to <code>true</code>, to delete the stack instance, and then delete the stack manually.</p> </li> <li> <p> <code>PENDING</code>: The operation in the specified account and Region has yet to start.</p> </li> <li> <p> <code>RUNNING</code>: The operation in the specified account and Region is currently in progress.</p> </li> <li> <p> <code>SKIPPED_SUSPENDED_ACCOUNT</code>: The operation in the specified account and Region has been skipped because the account was suspended at the time of the operation.</p> </li> <li> <p> <code>SUCCEEDED</code>: The operation in the specified account and Region completed successfully.</p> </li> </ul>', ], ], 'StackInstanceFilter' => [ 'base' => '<p>The filter to apply to stack instances</p>', 'refs' => [ 'StackInstanceFilters$member' => NULL, ], ], 'StackInstanceFilterName' => [ 'base' => NULL, 'refs' => [ 'StackInstanceFilter$Name' => '<p>The type of filter to apply.</p>', ], ], 'StackInstanceFilterValues' => [ 'base' => NULL, 'refs' => [ 'StackInstanceFilter$Values' => '<p>The status to filter by.</p>', ], ], 'StackInstanceFilters' => [ 'base' => NULL, 'refs' => [ 'ListStackInstancesInput$Filters' => '<p>The filter to apply to stack instances</p>', ], ], 'StackInstanceNotFoundException' => [ 'base' => '<p>The specified stack instance doesn\'t exist.</p>', 'refs' => [], ], 'StackInstanceResourceDriftsSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStackInstanceResourceDriftsOutput$Summaries' => '<p>A list of <code>StackInstanceResourceDriftsSummary</code> structures that contain information about the specified stack instances.</p>', ], ], 'StackInstanceResourceDriftsSummary' => [ 'base' => '<p>The structure containing summary information about resource drifts for a stack instance.</p>', 'refs' => [ 'StackInstanceResourceDriftsSummaries$member' => NULL, ], ], 'StackInstanceStatus' => [ 'base' => NULL, 'refs' => [ 'StackInstance$Status' => '<p>The status of the stack instance, in terms of its synchronization with its associated stack set.</p> <ul> <li> <p> <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further <code>UpdateStackSet</code> operations. You might need to perform a <code>DeleteStackInstances</code> operation, with <code>RetainStacks</code> set to <code>true</code>, to delete the stack instance, and then delete the stack manually. <code>INOPERABLE</code> can be returned here when the cause is a failed import. If it\'s due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, look at the <code>DetailedStatus</code> member in the <code>StackInstanceSummary</code> member that is a peer to this <code>Status</code> member.</p> </li> <li> <p> <code>OUTDATED</code>: The stack isn\'t currently up to date with the StackSet because:</p> <ul> <li> <p>The associated stack failed during a <code>CreateStackSet</code> or <code>UpdateStackSet</code> operation.</p> </li> <li> <p>The stack was part of a <code>CreateStackSet</code> or <code>UpdateStackSet</code> operation that failed or was stopped before the stack was created or updated.</p> </li> </ul> </li> <li> <p> <code>CURRENT</code>: The stack is currently up to date with the StackSet.</p> </li> </ul>', 'StackInstanceSummary$Status' => '<p>The status of the stack instance, in terms of its synchronization with its associated stack set.</p> <ul> <li> <p> <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further <code>UpdateStackSet</code> operations. You might need to perform a <code>DeleteStackInstances</code> operation, with <code>RetainStacks</code> set to <code>true</code>, to delete the stack instance, and then delete the stack manually. <code>INOPERABLE</code> can be returned here when the cause is a failed import. If it\'s due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, call the <a>DescribeStackInstance</a> API operation, look at the <code>DetailedStatus</code> member returned in the <code>StackInstanceSummary</code> member.</p> </li> <li> <p> <code>OUTDATED</code>: The stack isn\'t currently up to date with the StackSet because:</p> <ul> <li> <p>The associated stack failed during a <code>CreateStackSet</code> or <code>UpdateStackSet</code> operation.</p> </li> <li> <p>The stack was part of a <code>CreateStackSet</code> or <code>UpdateStackSet</code> operation that failed or was stopped before the stack was created or updated.</p> </li> </ul> </li> <li> <p> <code>CURRENT</code>: The stack is currently up to date with the StackSet.</p> </li> </ul>', ], ], 'StackInstanceSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStackInstancesOutput$Summaries' => '<p>A list of <code>StackInstanceSummary</code> structures that contain information about the specified stack instances.</p>', ], ], 'StackInstanceSummary' => [ 'base' => '<p>The structure that contains summary information about a stack instance.</p>', 'refs' => [ 'StackInstanceSummaries$member' => NULL, ], ], 'StackName' => [ 'base' => NULL, 'refs' => [ 'CancelUpdateStackInput$StackName' => '<note> <p>If you don\'t pass a parameter to <code>StackName</code>, the API returns a response that describes all resources in the account.</p> <p>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:</p> <p> <code>{ "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }</code> </p> </note> <p>The name or the unique stack ID that\'s associated with the stack.</p>', 'ChangeSetSummary$StackName' => '<p>The name of the stack with which the change set is associated.</p>', 'CreateGeneratedTemplateInput$StackName' => '<p>An optional name or ARN of a stack to use as the base stack for the generated template.</p>', 'CreateStackInput$StackName' => '<p>The name that\'s associated with the stack. The name must be unique in the Region in which you are creating the stack.</p> <note> <p>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.</p> </note>', 'DeleteStackInput$StackName' => '<p>The name or the unique stack ID that\'s associated with the stack.</p>', 'DescribeChangeSetHooksOutput$StackName' => '<p>The stack name.</p>', 'DescribeChangeSetOutput$StackName' => '<p>The name of the stack that\'s associated with the change set.</p>', 'DescribeStackEventsInput$StackName' => '<p>The name or the unique stack ID that\'s associated with the stack, which aren\'t always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack\'s name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul>', 'DescribeStackResourceInput$StackName' => '<p>The name or the unique stack ID that\'s associated with the stack, which aren\'t always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack\'s name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul>', 'DescribeStackResourcesInput$StackName' => '<p>The name or the unique stack ID that is associated with the stack, which aren\'t always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack\'s name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul> <p>Required: Conditional. If you don\'t specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>.</p>', 'DescribeStacksInput$StackName' => '<note> <p>If you don\'t pass a parameter to <code>StackName</code>, the API returns a response that describes all resources in the account, which can impact performance. This requires <code>ListStacks</code> and <code>DescribeStacks</code> permissions.</p> <p>Consider using the <a>ListStacks</a> API if you\'re not passing a parameter to <code>StackName</code>.</p> <p>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:</p> <p>{ "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }</p> </note> <p>The name or the unique stack ID that\'s associated with the stack, which aren\'t always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack\'s name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul>', 'GetStackPolicyInput$StackName' => '<p>The name or unique stack ID that\'s associated with the stack whose policy you want to get.</p>', 'GetTemplateInput$StackName' => '<p>The name or the unique stack ID that\'s associated with the stack, which aren\'t always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack\'s name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul>', 'Imports$member' => NULL, 'ListStackResourcesInput$StackName' => '<p>The name or the unique stack ID that is associated with the stack, which aren\'t always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack\'s name or its unique stack ID.</p> </li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p> </li> </ul>', 'ResourceLocation$StackName' => '<p>The name associated with the stack.</p>', 'SetStackPolicyInput$StackName' => '<p>The name or unique stack ID that you want to associate a policy with.</p>', 'Stack$StackName' => '<p>The name associated with the stack.</p>', 'StackDefinition$StackName' => '<p>The name associated with the stack.</p>', 'StackEvent$StackName' => '<p>The name associated with a stack.</p>', 'StackResource$StackName' => '<p>The name associated with the stack.</p>', 'StackResourceDetail$StackName' => '<p>The name associated with the stack.</p>', 'StackSummary$StackName' => '<p>The name associated with the stack.</p>', 'UpdateStackInput$StackName' => '<p>The name or unique stack ID of the stack to update.</p>', ], ], 'StackNameOrId' => [ 'base' => NULL, 'refs' => [ 'ContinueUpdateRollbackInput$StackName' => '<p>The name or the unique ID of the stack that you want to continue rolling back.</p> <note> <p>Don\'t specify the name of a nested stack (a stack that was created by using the <code>AWS::CloudFormation::Stack</code> resource). Instead, use this operation on the parent stack (the stack that contains the <code>AWS::CloudFormation::Stack</code> resource).</p> </note>', 'CreateChangeSetInput$StackName' => '<p>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.</p>', 'DeleteChangeSetInput$StackName' => '<p>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.</p>', 'DescribeChangeSetHooksInput$StackName' => '<p>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.</p>', 'DescribeChangeSetInput$StackName' => '<p>If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.</p>', 'DescribeStackResourceDriftsInput$StackName' => '<p>The name of the stack for which you want drift information.</p>', 'DetectStackDriftInput$StackName' => '<p>The name of the stack for which you want to detect drift.</p>', 'DetectStackResourceDriftInput$StackName' => '<p>The name of the stack to which the resource belongs.</p>', 'ExecuteChangeSetInput$StackName' => '<p>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.</p>', 'GetTemplateSummaryInput$StackName' => '<p>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.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>', 'ListChangeSetsInput$StackName' => '<p>The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.</p>', 'RollbackStackInput$StackName' => '<p>The name that\'s associated with the stack.</p>', 'SignalResourceInput$StackName' => '<p>The stack name or unique stack ID that includes the resource that you want to signal.</p>', 'UpdateTerminationProtectionInput$StackName' => '<p>The name or unique ID of the stack for which you want to set termination protection.</p>', ], ], 'StackNotFoundException' => [ 'base' => '<p>The specified stack ARN doesn\'t exist or stack doesn\'t exist corresponding to the ARN in input.</p>', 'refs' => [], ], 'StackPolicyBody' => [ 'base' => NULL, 'refs' => [ 'CreateStackInput$StackPolicyBody' => '<p>Structure that contains the stack policy body. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html">Prevent updates to stack resources</a> in the <i>CloudFormation User Guide</i>. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>', 'GetStackPolicyOutput$StackPolicyBody' => '<p>Structure that contains the stack policy body. (For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html">Prevent updates to stack resources</a> in the <i>CloudFormation User Guide</i>.)</p>', 'SetStackPolicyInput$StackPolicyBody' => '<p>Structure that contains the stack policy body. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html">Prevent updates to stack resources</a> in the <i>CloudFormation User Guide</i>. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>', 'UpdateStackInput$StackPolicyBody' => '<p>Structure that contains a new stack policy body. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p> <p>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.</p>', ], ], 'StackPolicyDuringUpdateBody' => [ 'base' => NULL, 'refs' => [ 'UpdateStackInput$StackPolicyDuringUpdateBody' => '<p>Structure that contains the temporary overriding stack policy body. You can specify either the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not both.</p> <p>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.</p>', ], ], 'StackPolicyDuringUpdateURL' => [ 'base' => NULL, 'refs' => [ 'UpdateStackInput$StackPolicyDuringUpdateURL' => '<p>Location of a file that contains 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 <code>https://</code>. URLs from S3 static websites are not supported.</p> <p>You can specify either the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not both.</p> <p>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.</p>', ], ], 'StackPolicyURL' => [ 'base' => NULL, 'refs' => [ 'CreateStackInput$StackPolicyURL' => '<p>Location of a file that contains 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 <code>https://</code>. URLs from S3 static websites are not supported.</p> <p>You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>', 'SetStackPolicyInput$StackPolicyURL' => '<p>Location of a file that contains 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 <code>https://</code>. URLs from S3 static websites are not supported.</p> <p>You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>', 'UpdateStackInput$StackPolicyURL' => '<p>Location of a file that contains 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 <code>https://</code>. URLs from S3 static websites are not supported.</p> <p>You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p> <p>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.</p>', ], ], 'StackRefactorAction' => [ 'base' => '<p>Describes the stack and the action that CloudFormation will perform on it if you execute the stack refactor.</p>', 'refs' => [ 'StackRefactorActions$member' => NULL, ], ], 'StackRefactorActionEntity' => [ 'base' => NULL, 'refs' => [ 'StackRefactorAction$Entity' => '<p>The type that will be evaluated in the <code>StackRefactorAction</code>. The following are potential <code>Entity</code> types:</p> <ul> <li> <p> <code>Stack</code> </p> </li> <li> <p> <code>Resource</code> </p> </li> </ul>', ], ], 'StackRefactorActionType' => [ 'base' => NULL, 'refs' => [ 'StackRefactorAction$Action' => '<p>The action that CloudFormation takes on the stack.</p>', ], ], 'StackRefactorActions' => [ 'base' => NULL, 'refs' => [ 'ListStackRefactorActionsOutput$StackRefactorActions' => '<p>The stack refactor actions.</p>', ], ], 'StackRefactorDetection' => [ 'base' => NULL, 'refs' => [ 'StackRefactorAction$Detection' => '<p>The detection type is one of the following:</p> <ul> <li> <p>Auto: CloudFormation figured out the mapping on its own.</p> </li> <li> <p>Manual: The customer provided the mapping in the <code>ResourceMapping</code> parameter.</p> </li> </ul>', ], ], 'StackRefactorExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeStackRefactorOutput$ExecutionStatus' => '<p>The stack refactor execution operation status that\'s provided after calling the <a>ExecuteStackRefactor</a> action.</p>', 'StackRefactorExecutionStatusFilter$member' => NULL, 'StackRefactorSummary$ExecutionStatus' => '<p>The operation status that\'s provided after calling the <a>ExecuteStackRefactor</a> action.</p>', ], ], 'StackRefactorExecutionStatusFilter' => [ 'base' => NULL, 'refs' => [ 'ListStackRefactorsInput$ExecutionStatusFilter' => '<p>Execution status to use as a filter. Specify one or more execution status codes to list only stack refactors with the specified execution status codes.</p>', ], ], 'StackRefactorId' => [ 'base' => NULL, 'refs' => [ 'CreateStackRefactorOutput$StackRefactorId' => '<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>', 'DescribeStackRefactorInput$StackRefactorId' => '<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>', 'DescribeStackRefactorOutput$StackRefactorId' => '<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>', 'ExecuteStackRefactorInput$StackRefactorId' => '<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>', 'ListStackRefactorActionsInput$StackRefactorId' => '<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>', 'StackRefactorSummary$StackRefactorId' => '<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>', ], ], 'StackRefactorNotFoundException' => [ 'base' => '<p>The specified stack refactor can\'t be found.</p>', 'refs' => [], ], 'StackRefactorResourceIdentifier' => [ 'base' => NULL, 'refs' => [ 'StackRefactorAction$ResourceIdentifier' => '<p>A key-value pair that identifies the target resource. The key is an identifier property (for example, <code>BucketName</code> for <code>AWS::S3::Bucket</code> resources) and the value is the actual property value (for example, <code>MyS3Bucket</code>).</p>', ], ], 'StackRefactorStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeStackRefactorOutput$Status' => '<p>The stack refactor operation status that\'s provided after calling the <a>CreateStackRefactor</a> action.</p>', 'StackRefactorSummary$Status' => '<p>The stack refactor operation status that\'s provided after calling the <a>CreateStackRefactor</a> action.</p>', ], ], 'StackRefactorStatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeStackRefactorOutput$StatusReason' => '<p>A detailed explanation for the stack refactor operation <code>Status</code>.</p>', 'StackRefactorSummary$StatusReason' => '<p>A detailed explanation for the stack refactor <code>Status</code>.</p>', ], ], 'StackRefactorSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStackRefactorsOutput$StackRefactorSummaries' => '<p>Provides a summary of a stack refactor, including the following:</p> <ul> <li> <p> <code>StackRefactorId</code> </p> </li> <li> <p> <code>Status</code> </p> </li> <li> <p> <code>StatusReason</code> </p> </li> <li> <p> <code>ExecutionStatus</code> </p> </li> <li> <p> <code>ExecutionStatusReason</code> </p> </li> <li> <p> <code>Description</code> </p> </li> </ul>', ], ], 'StackRefactorSummary' => [ 'base' => '<p>The summary of a stack refactor operation.</p>', 'refs' => [ 'StackRefactorSummaries$member' => NULL, ], ], 'StackRefactorTagResources' => [ 'base' => NULL, 'refs' => [ 'StackRefactorAction$TagResources' => '<p>Assigns one or more tags to specified resources.</p>', ], ], 'StackRefactorUntagResources' => [ 'base' => NULL, 'refs' => [ 'StackRefactorAction$UntagResources' => '<p>Removes one or more tags to specified resources.</p>', ], ], 'StackResource' => [ 'base' => '<p>The StackResource data type.</p>', 'refs' => [ 'StackResources$member' => NULL, ], ], 'StackResourceDetail' => [ 'base' => '<p>Contains detailed information about the specified stack resource.</p>', 'refs' => [ 'DescribeStackResourceOutput$StackResourceDetail' => '<p>A <code>StackResourceDetail</code> structure that contains the description of the specified resource in the specified stack.</p>', ], ], 'StackResourceDrift' => [ 'base' => '<p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p> <p>Resources that don\'t currently support drift detection can\'t be checked. For a list of resources that support drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a>.</p> <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual resources, or <a>DetectStackDrift</a> to detect drift on all resources in a given stack that support drift detection.</p>', 'refs' => [ 'DetectStackResourceDriftOutput$StackResourceDrift' => '<p>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.</p>', 'StackResourceDrifts$member' => NULL, ], ], 'StackResourceDriftInformation' => [ 'base' => '<p>Contains information about whether the resource\'s actual configuration differs, or has <i>drifted</i>, from its expected configuration.</p>', 'refs' => [ 'StackResource$DriftInformation' => '<p>Information about whether the resource\'s actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p>', 'StackResourceDetail$DriftInformation' => '<p>Information about whether the resource\'s actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p>', ], ], 'StackResourceDriftInformationSummary' => [ 'base' => '<p>Summarizes information about whether the resource\'s actual configuration differs, or has <i>drifted</i>, from its expected configuration.</p>', 'refs' => [ 'StackResourceSummary$DriftInformation' => '<p>Information about whether the resource\'s actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detect unmanaged configuration changes to stacks and resources with drift detection</a>.</p>', ], ], 'StackResourceDriftStatus' => [ 'base' => NULL, 'refs' => [ 'StackInstanceResourceDriftsSummary$StackResourceDriftStatus' => '<p>The drift status of the resource in a stack instance.</p> <ul> <li> <p> <code>DELETED</code>: The resource differs from its expected template configuration in that the resource has been deleted.</p> </li> <li> <p> <code>MODIFIED</code>: One or more resource properties differ from their expected template values.</p> </li> <li> <p> <code>IN_SYNC</code>: The resource\'s actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation doesn\'t currently return this value.</p> </li> </ul>', 'StackResourceDrift$StackResourceDriftStatus' => '<p>Status of the resource\'s actual configuration compared to its expected configuration.</p> <ul> <li> <p> <code>DELETED</code>: The resource differs from its expected template configuration because the resource has been deleted.</p> </li> <li> <p> <code>MODIFIED</code>: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).</p> </li> <li> <p> <code>IN_SYNC</code>: The resource\'s actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation does not currently return this value.</p> </li> <li> <p> <code>UNKNOWN</code>: CloudFormation could not run drift detection for the resource. See the <code>DriftStatusReason</code> for details.</p> </li> </ul>', 'StackResourceDriftInformation$StackResourceDriftStatus' => '<p>Status of the resource\'s actual configuration compared to its expected configuration</p> <ul> <li> <p> <code>DELETED</code>: The resource differs from its expected configuration in that it has been deleted.</p> </li> <li> <p> <code>MODIFIED</code>: The resource differs from its expected configuration.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation has not checked if the resource differs from its expected configuration.</p> <p>Any resources that do not currently support drift detection have a status of <code>NOT_CHECKED</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a>.</p> </li> <li> <p> <code>IN_SYNC</code>: The resource\'s actual configuration matches its expected configuration.</p> </li> </ul>', 'StackResourceDriftInformationSummary$StackResourceDriftStatus' => '<p>Status of the resource\'s actual configuration compared to its expected configuration.</p> <ul> <li> <p> <code>DELETED</code>: The resource differs from its expected configuration in that it has been deleted.</p> </li> <li> <p> <code>MODIFIED</code>: The resource differs from its expected configuration.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation hasn\'t checked if the resource differs from its expected configuration.</p> <p>Any resources that don\'t currently support drift detection have a status of <code>NOT_CHECKED</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a>. If you performed an <a>ContinueUpdateRollback</a> operation on a stack, any resources included in <code>ResourcesToSkip</code> will also have a status of <code>NOT_CHECKED</code>. For more information about skipping resources during rollback operations, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html">Continue rolling back an update</a> in the <i>CloudFormation User Guide</i>.</p> </li> <li> <p> <code>IN_SYNC</code>: The resource\'s actual configuration matches its expected configuration.</p> </li> </ul>', 'StackResourceDriftStatusFilters$member' => NULL, ], ], 'StackResourceDriftStatusFilters' => [ 'base' => NULL, 'refs' => [ 'DescribeStackResourceDriftsInput$StackResourceDriftStatusFilters' => '<p>The resource drift status values to use as filters for the resource drift results returned.</p> <ul> <li> <p> <code>DELETED</code>: The resource differs from its expected template configuration in that the resource has been deleted.</p> </li> <li> <p> <code>MODIFIED</code>: One or more resource properties differ from their expected template values.</p> </li> <li> <p> <code>IN_SYNC</code>: The resource\'s actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation doesn\'t currently return this value.</p> </li> <li> <p> <code>UNKNOWN</code>: CloudFormation could not run drift detection for the resource.</p> </li> </ul>', 'ListStackInstanceResourceDriftsInput$StackInstanceResourceDriftStatuses' => '<p>The resource drift status of the stack instance. </p> <ul> <li> <p> <code>DELETED</code>: The resource differs from its expected template configuration in that the resource has been deleted.</p> </li> <li> <p> <code>MODIFIED</code>: One or more resource properties differ from their expected template values.</p> </li> <li> <p> <code>IN_SYNC</code>: The resource\'s actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation doesn\'t currently return this value.</p> </li> </ul>', ], ], 'StackResourceDriftStatusReason' => [ 'base' => NULL, 'refs' => [ 'StackResourceDrift$DriftStatusReason' => '<p>The reason for the drift status. </p>', ], ], 'StackResourceDrifts' => [ 'base' => NULL, 'refs' => [ 'DescribeStackResourceDriftsOutput$StackResourceDrifts' => '<p>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.</p> <p>For a given stack, there will be one <code>StackResourceDrift</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resource type support for imports and drift detection</a>.</p>', ], ], 'StackResourceSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStackResourcesOutput$StackResourceSummaries' => '<p>A list of <code>StackResourceSummary</code> structures.</p>', ], ], 'StackResourceSummary' => [ 'base' => '<p>Contains high-level information about the specified stack resource.</p>', 'refs' => [ 'StackResourceSummaries$member' => NULL, ], ], 'StackResources' => [ 'base' => NULL, 'refs' => [ 'DescribeStackResourcesOutput$StackResources' => '<p>A list of <code>StackResource</code> structures.</p>', ], ], 'StackSet' => [ 'base' => '<p>A structure that contains information about a StackSet. With StackSets, you can provision stacks across Amazon Web Services accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.</p>', 'refs' => [ 'DescribeStackSetOutput$StackSet' => '<p>The specified StackSet.</p>', ], ], 'StackSetARN' => [ 'base' => NULL, 'refs' => [ 'StackSet$StackSetARN' => '<p>The Amazon Resource Name (ARN) of the StackSet.</p>', ], ], 'StackSetAutoDeploymentTargetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStackSetAutoDeploymentTargetsOutput$Summaries' => '<p>An array of summaries of the deployment targets for the StackSet.</p>', ], ], 'StackSetAutoDeploymentTargetSummary' => [ 'base' => '<p>One of the targets for the StackSet. Returned by the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStackSetAutoDeploymentTargets.html">ListStackSetAutoDeploymentTargets</a> API operation.</p>', 'refs' => [ 'StackSetAutoDeploymentTargetSummaries$member' => NULL, ], ], 'StackSetDriftDetectionDetails' => [ 'base' => '<p>Detailed information about the drift status of the StackSet.</p> <p>For StackSets, contains information about the last <i>completed</i> drift operation performed on the StackSet. Information about drift operations in-progress isn\'t included.</p> <p>For StackSet operations, includes information about drift operations currently being performed on the StackSet.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Performing drift detection on CloudFormation StackSets</a> in the <i>CloudFormation User Guide</i>.</p>', 'refs' => [ 'StackSet$StackSetDriftDetectionDetails' => '<p>Detailed information about the drift status of the StackSet.</p> <p>For StackSets, contains information about the last <i>completed</i> drift operation performed on the StackSet. Information about drift operations currently in progress isn\'t included.</p>', 'StackSetOperation$StackSetDriftDetectionDetails' => '<p>Detailed information about the drift status of the StackSet. This includes information about drift operations currently being performed on the StackSet.</p> <p>This information will only be present for StackSet operations whose <code>Action</code> type is <code>DETECT_DRIFT</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Performing drift detection on CloudFormation StackSets</a> in the <i>CloudFormation User Guide</i>.</p>', ], ], 'StackSetDriftDetectionStatus' => [ 'base' => NULL, 'refs' => [ 'StackSetDriftDetectionDetails$DriftDetectionStatus' => '<p>The status of the StackSet drift detection operation.</p> <ul> <li> <p> <code>COMPLETED</code>: The drift detection operation completed without failing on any stack instances.</p> </li> <li> <p> <code>FAILED</code>: The drift detection operation exceeded the specified failure tolerance.</p> </li> <li> <p> <code>PARTIAL_SUCCESS</code>: The drift detection operation completed without exceeding the failure tolerance for the operation.</p> </li> <li> <p> <code>IN_PROGRESS</code>: The drift detection operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has canceled the drift detection operation.</p> </li> </ul>', ], ], 'StackSetDriftStatus' => [ 'base' => NULL, 'refs' => [ 'StackSetDriftDetectionDetails$DriftStatus' => '<p>Status of the StackSet\'s actual configuration compared to its expected template and parameter configuration.</p> <ul> <li> <p> <code>DRIFTED</code>: One or more of the stack instances belonging to the StackSet differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: CloudFormation hasn\'t checked the StackSet for drift.</p> </li> <li> <p> <code>IN_SYNC</code>: All of the stack instances belonging to the StackSet stack match the expected template and parameter configuration.</p> </li> </ul>', ], ], 'StackSetId' => [ 'base' => NULL, 'refs' => [ 'CreateStackSetOutput$StackSetId' => '<p>The ID of the StackSet that you\'re creating.</p>', 'StackInstance$StackSetId' => '<p>The name or unique ID of the StackSet that the stack instance is associated with.</p>', 'StackInstanceSummary$StackSetId' => '<p>The name or unique ID of the StackSet that the stack instance is associated with.</p>', 'StackSet$StackSetId' => '<p>The ID of the StackSet.</p>', 'StackSetOperation$StackSetId' => '<p>The ID of the StackSet.</p>', 'StackSetSummary$StackSetId' => '<p>The ID of the StackSet.</p>', ], ], 'StackSetName' => [ 'base' => NULL, 'refs' => [ 'CreateStackInstancesInput$StackSetName' => '<p>The name or unique ID of the StackSet that you want to create stack instances from.</p>', 'CreateStackSetInput$StackSetName' => '<p>The name to associate with the StackSet. The name must be unique in the Region where you create your StackSet.</p> <note> <p>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.</p> </note>', 'DeleteStackInstancesInput$StackSetName' => '<p>The name or unique ID of the StackSet that you want to delete stack instances for.</p>', 'DeleteStackSetInput$StackSetName' => '<p>The name or unique ID of the StackSet that you\'re deleting. You can obtain this value by running <a>ListStackSets</a>.</p>', 'DescribeStackInstanceInput$StackSetName' => '<p>The name or the unique stack ID of the StackSet that you want to get stack instance information for.</p>', 'DescribeStackSetInput$StackSetName' => '<p>The name or unique ID of the StackSet whose description you want.</p>', 'DescribeStackSetOperationInput$StackSetName' => '<p>The name or the unique stack ID of the StackSet for the stack operation.</p>', 'ListStackInstancesInput$StackSetName' => '<p>The name or unique ID of the StackSet that you want to list stack instances for.</p>', 'ListStackSetOperationResultsInput$StackSetName' => '<p>The name or unique ID of the StackSet that you want to get operation results for.</p>', 'ListStackSetOperationsInput$StackSetName' => '<p>The name or unique ID of the StackSet that you want to get operation summaries for.</p>', 'StackSet$StackSetName' => '<p>The name that\'s associated with the StackSet.</p>', 'StackSetSummary$StackSetName' => '<p>The name of the StackSet.</p>', 'StopStackSetOperationInput$StackSetName' => '<p>The name or unique ID of the StackSet that you want to stop the operation for.</p>', 'UpdateStackSetInput$StackSetName' => '<p>The name or unique ID of the StackSet that you want to update.</p>', ], ], 'StackSetNameOrId' => [ 'base' => NULL, 'refs' => [ 'DetectStackSetDriftInput$StackSetName' => '<p>The name of the StackSet on which to perform the drift detection operation.</p>', 'GetTemplateSummaryInput$StackSetName' => '<p>The name or unique ID of the StackSet from which the stack was created.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>', 'ImportStacksToStackSetInput$StackSetName' => '<p>The name of the StackSet. The name must be unique in the Region where you create your StackSet.</p>', 'ListStackInstanceResourceDriftsInput$StackSetName' => '<p>The name or unique ID of the StackSet that you want to list drifted resources for.</p>', 'ListStackSetAutoDeploymentTargetsInput$StackSetName' => '<p>The name or unique ID of the StackSet that you want to get automatic deployment targets for.</p>', 'UpdateStackInstancesInput$StackSetName' => '<p>The name or unique ID of the StackSet associated with the stack instances.</p>', ], ], 'StackSetNotEmptyException' => [ 'base' => '<p>You can\'t yet delete this StackSet, because it still contains one or more stack instances. Delete all stack instances from the StackSet before deleting the StackSet.</p>', 'refs' => [], ], 'StackSetNotFoundException' => [ 'base' => '<p>The specified StackSet doesn\'t exist.</p>', 'refs' => [], ], 'StackSetOperation' => [ 'base' => '<p>The structure that contains information about a StackSet operation.</p>', 'refs' => [ 'DescribeStackSetOperationOutput$StackSetOperation' => '<p>The specified StackSet operation.</p>', ], ], 'StackSetOperationAction' => [ 'base' => NULL, 'refs' => [ 'StackSetOperation$Action' => '<p>The type of StackSet operation: <code>CREATE</code>, <code>UPDATE</code>, or <code>DELETE</code>. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself, in addition to <i>all</i> associated stack instances.</p>', 'StackSetOperationSummary$Action' => '<p>The type of operation: <code>CREATE</code>, <code>UPDATE</code>, or <code>DELETE</code>. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and <i>all</i> associated StackSet instances.</p>', ], ], 'StackSetOperationPreferences' => [ 'base' => '<p>The user-specified preferences for how CloudFormation performs a StackSet operation.</p> <p>For more information about maximum concurrent accounts and failure tolerance, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">StackSet operation options</a>.</p> <note> <p> <code>StackSetOperationPreferences</code> don\'t apply to <code>AutoDeployment</code>, even if it\'s enabled.</p> </note>', 'refs' => [ 'CreateStackInstancesInput$OperationPreferences' => '<p>Preferences for how CloudFormation performs this StackSet operation.</p>', 'DeleteStackInstancesInput$OperationPreferences' => '<p>Preferences for how CloudFormation performs this StackSet operation.</p>', 'DetectStackSetDriftInput$OperationPreferences' => '<p>The user-specified preferences for how CloudFormation performs a StackSet operation.</p> <p>For more information about maximum concurrent accounts and failure tolerance, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">StackSet operation options</a>.</p>', 'ImportStacksToStackSetInput$OperationPreferences' => '<p>The user-specified preferences for how CloudFormation performs a StackSet operation.</p> <p>For more information about maximum concurrent accounts and failure tolerance, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">StackSet operation options</a>.</p>', 'StackSetOperation$OperationPreferences' => '<p>The preferences for how CloudFormation performs this StackSet operation.</p>', 'StackSetOperationSummary$OperationPreferences' => '<p>The user-specified preferences for how CloudFormation performs a StackSet operation.</p> <p>For more information about maximum concurrent accounts and failure tolerance, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">StackSet operation options</a>.</p>', 'UpdateStackInstancesInput$OperationPreferences' => '<p>Preferences for how CloudFormation performs this StackSet operation.</p>', 'UpdateStackSetInput$OperationPreferences' => '<p>Preferences for how CloudFormation performs this StackSet operation.</p>', ], ], 'StackSetOperationResultStatus' => [ 'base' => NULL, 'refs' => [ 'StackSetOperationResultSummary$Status' => '<p>The result status of the StackSet operation for the given account in the given Region.</p> <ul> <li> <p> <code>CANCELLED</code>: The operation in the specified account and Region has been canceled. This is either because a user has stopped the StackSet operation, or because the failure tolerance of the StackSet operation has been exceeded.</p> </li> <li> <p> <code>FAILED</code>: The operation in the specified account and Region failed.</p> <p>If the StackSet operation fails in enough accounts within a Region, the failure tolerance for the StackSet operation as a whole might be exceeded.</p> </li> <li> <p> <code>RUNNING</code>: The operation in the specified account and Region is currently in progress.</p> </li> <li> <p> <code>PENDING</code>: The operation in the specified account and Region has yet to start.</p> </li> <li> <p> <code>SUCCEEDED</code>: The operation in the specified account and Region completed successfully.</p> </li> </ul>', ], ], 'StackSetOperationResultSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStackSetOperationResultsOutput$Summaries' => '<p>A list of <code>StackSetOperationResultSummary</code> structures that contain information about the specified operation results, for accounts and Amazon Web Services Regions that are included in the operation.</p>', ], ], 'StackSetOperationResultSummary' => [ 'base' => '<p>The structure that contains information about a specified operation\'s results for a given account in a given Region.</p>', 'refs' => [ 'StackSetOperationResultSummaries$member' => NULL, ], ], 'StackSetOperationStatus' => [ 'base' => NULL, 'refs' => [ 'StackSetOperation$Status' => '<p>The status of the operation.</p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you\'ve set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and CloudFormation cancels the operation in any remaining Regions.</p> </li> <li> <p> <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes">StackSets status codes</a> in the <i>CloudFormation User Guide</i>.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has canceled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request.</p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>', 'StackSetOperationSummary$Status' => '<p>The overall status of the operation.</p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you\'ve set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and CloudFormation cancels the operation in any remaining Regions.</p> </li> <li> <p> <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes">StackSet status codes</a> in the <i>CloudFormation User Guide</i>.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has canceled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request.</p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>', ], ], 'StackSetOperationStatusDetails' => [ 'base' => '<p>Detailed information about the StackSet operation.</p>', 'refs' => [ 'StackSetOperation$StatusDetails' => '<p>Detailed information about the StackSet operation.</p>', 'StackSetOperationSummary$StatusDetails' => '<p>Detailed information about the StackSet operation.</p>', ], ], 'StackSetOperationStatusReason' => [ 'base' => NULL, 'refs' => [ 'StackSetOperation$StatusReason' => '<p>The status of the operation in details.</p>', 'StackSetOperationSummary$StatusReason' => '<p>The status of the operation in details.</p>', ], ], 'StackSetOperationSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStackSetOperationsOutput$Summaries' => '<p>A list of <code>StackSetOperationSummary</code> structures that contain summary information about operations for the specified StackSet.</p>', ], ], 'StackSetOperationSummary' => [ 'base' => '<p>The structures that contain summary information about the specified operation.</p>', 'refs' => [ 'StackSetOperationSummaries$member' => NULL, ], ], 'StackSetStatus' => [ 'base' => NULL, 'refs' => [ 'ListStackSetsInput$Status' => '<p>The status of the StackSets that you want to get summary information about.</p>', 'StackSet$Status' => '<p>The status of the StackSet.</p>', 'StackSetSummary$Status' => '<p>The status of the StackSet.</p>', ], ], 'StackSetSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStackSetsOutput$Summaries' => '<p>A list of <code>StackSetSummary</code> structures that contain information about the user\'s StackSets.</p>', ], ], 'StackSetSummary' => [ 'base' => '<p>The structures that contain summary information about the specified StackSet.</p>', 'refs' => [ 'StackSetSummaries$member' => NULL, ], ], 'StackStatus' => [ 'base' => NULL, 'refs' => [ 'Stack$StackStatus' => '<p>Current status of the stack.</p>', 'StackStatusFilter$member' => NULL, 'StackSummary$StackStatus' => '<p>The current status of the stack.</p>', ], ], 'StackStatusFilter' => [ 'base' => NULL, 'refs' => [ 'ListStacksInput$StackStatusFilter' => '<p>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 <code>StackStatus</code> parameter of the <a>Stack</a> data type.</p>', ], ], 'StackStatusReason' => [ 'base' => NULL, 'refs' => [ 'Stack$StackStatusReason' => '<p>Success/failure message associated with the stack status.</p>', 'StackSummary$StackStatusReason' => '<p>Success/Failure message associated with the stack status.</p>', ], ], 'StackSummaries' => [ 'base' => NULL, 'refs' => [ 'ListStacksOutput$StackSummaries' => '<p>A list of <code>StackSummary</code> structures that contains information about the specified stacks.</p>', ], ], 'StackSummary' => [ 'base' => '<p>The StackSummary Data Type</p>', 'refs' => [ 'StackSummaries$member' => NULL, ], ], 'Stacks' => [ 'base' => NULL, 'refs' => [ 'DescribeStacksOutput$Stacks' => '<p>A list of stack structures.</p>', ], ], 'StageList' => [ 'base' => NULL, 'refs' => [ 'GetTemplateOutput$StagesAvailable' => '<p>The stage of the template that you can retrieve. For stacks, the <code>Original</code> and <code>Processed</code> templates are always available. For change sets, the <code>Original</code> template is always available. After CloudFormation finishes creating the change set, the <code>Processed</code> template becomes available.</p>', ], ], 'StaleRequestException' => [ 'base' => '<p>Another operation has been performed on this StackSet since the specified operation was performed.</p>', 'refs' => [], ], 'StartResourceScanInput' => [ 'base' => NULL, 'refs' => [], ], 'StartResourceScanOutput' => [ 'base' => NULL, 'refs' => [], ], 'StatusMessage' => [ 'base' => NULL, 'refs' => [ 'RecordHandlerProgressInput$StatusMessage' => '<p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>.</p>', ], ], 'StopStackSetOperationInput' => [ 'base' => NULL, 'refs' => [], ], 'StopStackSetOperationOutput' => [ 'base' => NULL, 'refs' => [], ], 'SupportedMajorVersion' => [ 'base' => NULL, 'refs' => [ 'SupportedMajorVersions$member' => NULL, ], ], 'SupportedMajorVersions' => [ 'base' => NULL, 'refs' => [ 'RequiredActivatedType$SupportedMajorVersions' => '<p>A list of the major versions of the extension type that the macro supports.</p>', ], ], 'Tag' => [ 'base' => '<p>The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.</p>', 'refs' => [ 'StackRefactorTagResources$member' => NULL, 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'ListResourceScanResourcesInput$TagKey' => '<p>If specified, the returned resources will have a matching tag key.</p>', 'StackRefactorUntagResources$member' => NULL, 'Tag$Key' => '<p>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: <code>aws:</code>.</p>', ], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'ListResourceScanResourcesInput$TagValue' => '<p>If specified, the returned resources will have a matching tag value.</p>', 'Tag$Value' => '<p>A string that contains the value for this tag. You can specify a maximum of 256 characters for a tag value.</p>', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$Tags' => '<p>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.</p>', 'CreateStackInput$Tags' => '<p>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.</p>', 'CreateStackSetInput$Tags' => '<p>The key-value pairs to associate with this StackSet 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.</p> <p>If you specify tags as part of a <code>CreateStackSet</code> action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don\'t, the entire <code>CreateStackSet</code> action fails with an <code>access denied</code> error, and the StackSet is not created.</p>', 'DescribeChangeSetOutput$Tags' => '<p>If you execute the change set, the tags that will be associated with the stack.</p>', 'Stack$Tags' => '<p>A list of <code>Tag</code>s that specify information about the stack.</p>', 'StackSet$Tags' => '<p>A list of tags that specify information about the StackSet. A maximum number of 50 tags can be specified.</p>', 'UpdateStackInput$Tags' => '<p>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.</p> <p>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.</p>', 'UpdateStackSetInput$Tags' => '<p>The key-value pairs to associate with this StackSet 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.</p> <p>If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this StackSet. This means:</p> <ul> <li> <p>If you don\'t specify this parameter, CloudFormation doesn\'t modify the stack\'s tags.</p> </li> <li> <p>If you specify <i>any</i> tags using this parameter, you must specify <i>all</i> the tags that you want associated with this StackSet, even tags you\'ve specified before (for example, when creating the StackSet or during a previous update of the StackSet.). Any tags that you don\'t include in the updated list of tags are removed from the StackSet, and therefore from the stacks and resources as well.</p> </li> <li> <p>If you specify an empty value, CloudFormation removes all currently associated tags.</p> </li> </ul> <p>If you specify new tags as part of an <code>UpdateStackSet</code> 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 StackSet from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the StackSet, and checks to see if you have permission to untag resources. If you don\'t have the necessary permission(s), the entire <code>UpdateStackSet</code> action fails with an <code>access denied</code> error, and the StackSet is not updated.</p>', ], ], 'TemplateBody' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$TemplateBody' => '<p>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.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>', 'CreateStackInput$TemplateBody' => '<p>Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.</p> <p>Conditional: You must specify either <code>TemplateBody</code> or <code>TemplateURL</code>, but not both.</p>', 'CreateStackSetInput$TemplateBody' => '<p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>', 'EstimateTemplateCostInput$TemplateBody' => '<p>Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.</p> <p>Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both are passed, only <code>TemplateBody</code> is used.</p>', 'GetGeneratedTemplateOutput$TemplateBody' => '<p>The template body of the generated template, in the language specified by the <code>Language</code> parameter.</p>', 'GetTemplateOutput$TemplateBody' => '<p>Structure that contains the template body.</p> <p>CloudFormation returns the same template that was used when the stack was created.</p>', 'GetTemplateSummaryInput$TemplateBody' => '<p>Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>', 'StackDefinition$TemplateBody' => '<p>The file path for the stack template file.</p>', 'StackSet$TemplateBody' => '<p>The structure that contains the body of the template that was used to create or update the StackSet.</p>', 'UpdateStackInput$TemplateBody' => '<p>Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>', 'UpdateStackSetInput$TemplateBody' => '<p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>', 'ValidateTemplateInput$TemplateBody' => '<p>Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>', ], ], 'TemplateConfiguration' => [ 'base' => '<p>The configuration details of a generated template.</p>', 'refs' => [ 'CreateGeneratedTemplateInput$TemplateConfiguration' => '<p>The configuration details of the generated template, including the <code>DeletionPolicy</code> and <code>UpdateReplacePolicy</code>.</p>', 'DescribeGeneratedTemplateOutput$TemplateConfiguration' => '<p>The configuration details of the generated template, including the <code>DeletionPolicy</code> and <code>UpdateReplacePolicy</code>.</p>', 'UpdateGeneratedTemplateInput$TemplateConfiguration' => '<p>The configuration details of the generated template, including the <code>DeletionPolicy</code> and <code>UpdateReplacePolicy</code>.</p>', ], ], 'TemplateDescription' => [ 'base' => NULL, 'refs' => [ 'StackSummary$TemplateDescription' => '<p>The template description of the template used to create the stack.</p>', ], ], 'TemplateFormat' => [ 'base' => NULL, 'refs' => [ 'GetGeneratedTemplateInput$Format' => '<p>The language to use to retrieve for the generated template. Supported values are:</p> <ul> <li> <p> <code>JSON</code> </p> </li> <li> <p> <code>YAML</code> </p> </li> </ul>', ], ], 'TemplateParameter' => [ 'base' => '<p>The TemplateParameter data type.</p>', 'refs' => [ 'TemplateParameters$member' => NULL, ], ], 'TemplateParameters' => [ 'base' => NULL, 'refs' => [ 'ValidateTemplateOutput$Parameters' => '<p>A list of <code>TemplateParameter</code> structures.</p>', ], ], 'TemplateProgress' => [ 'base' => '<p>A summary of the progress of the template generation.</p>', 'refs' => [ 'DescribeGeneratedTemplateOutput$Progress' => '<p>An object describing the progress of the template generation.</p>', ], ], 'TemplateStage' => [ 'base' => NULL, 'refs' => [ 'GetTemplateInput$TemplateStage' => '<p>For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify <code>Original</code>. To get the template after CloudFormation has processed all transforms, specify <code>Processed</code>.</p> <p>If the template doesn\'t include transforms, <code>Original</code> and <code>Processed</code> return the same template. By default, CloudFormation specifies <code>Processed</code>.</p>', 'StageList$member' => NULL, ], ], 'TemplateStatusReason' => [ 'base' => NULL, 'refs' => [ 'DescribeGeneratedTemplateOutput$StatusReason' => '<p>The reason for the current template generation status. This will provide more details if a failure happened.</p>', 'TemplateSummary$StatusReason' => '<p>The reason for the current template generation status. This will provide more details if a failure happened.</p>', ], ], 'TemplateSummaries' => [ 'base' => NULL, 'refs' => [ 'ListGeneratedTemplatesOutput$Summaries' => '<p>A list of summaries of the generated templates.</p>', ], ], 'TemplateSummary' => [ 'base' => '<p>The summary of a generated template.</p>', 'refs' => [ 'TemplateSummaries$member' => NULL, ], ], 'TemplateSummaryConfig' => [ 'base' => '<p>Options for the <code>GetTemplateSummary</code> API action.</p>', 'refs' => [ 'GetTemplateSummaryInput$TemplateSummaryConfig' => '<p>Specifies options for the <code>GetTemplateSummary</code> API action.</p>', ], ], 'TemplateURL' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$TemplateURL' => '<p>The URL of the file that contains the revised template. The URL must point to a template (max size: 1 MB) 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 <code>https://</code>. URLs from S3 static websites are not supported.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>', 'CreateStackInput$TemplateURL' => '<p>The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that\'s located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>. URLs from S3 static websites are not supported.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>', 'CreateStackSetInput$TemplateURL' => '<p>The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that\'s located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>. S3 static website URLs are not supported.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>', 'EstimateTemplateCostInput$TemplateURL' => '<p>The URL of a file that contains 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 <code>https://</code>. URLs from S3 static websites are not supported.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>', 'GetTemplateSummaryInput$TemplateURL' => '<p>The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that\'s located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>', 'StackDefinition$TemplateURL' => '<p>The desired final state of the stack template.</p>', 'UpdateStackInput$TemplateURL' => '<p>The URL of a file that contains 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 <code>https://</code>.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>', 'UpdateStackSetInput$TemplateURL' => '<p>The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>. S3 static website URLs are not supported.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>', 'ValidateTemplateInput$TemplateURL' => '<p>The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>', ], ], 'TestTypeInput' => [ 'base' => NULL, 'refs' => [], ], 'TestTypeOutput' => [ 'base' => NULL, 'refs' => [], ], 'ThirdPartyType' => [ 'base' => NULL, 'refs' => [ 'ActivateTypeInput$Type' => '<p>The extension type.</p> <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.</p>', 'DeactivateTypeInput$Type' => '<p>The extension type.</p> <p>Conditional: You must specify either <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>', 'PublishTypeInput$Type' => '<p>The type of the extension.</p> <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>', 'SetTypeConfigurationInput$Type' => '<p>The type of extension.</p> <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and <code>TypeName</code>.</p>', 'TestTypeInput$Type' => '<p>The type of the extension to test.</p> <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>', 'TypeConfigurationIdentifier$Type' => '<p>The type of extension.</p>', ], ], 'ThirdPartyTypeArn' => [ 'base' => NULL, 'refs' => [ 'ActivateTypeInput$PublicTypeArn' => '<p>The Amazon Resource Name (ARN) of the public extension.</p> <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.</p>', ], ], 'TimeoutMinutes' => [ 'base' => NULL, 'refs' => [ 'CreateStackInput$TimeoutInMinutes' => '<p>The amount of time that can pass before the stack status becomes <code>CREATE_FAILED</code>; if <code>DisableRollback</code> is not set or is set to <code>false</code>, the stack will be rolled back.</p>', 'Stack$TimeoutInMinutes' => '<p>The amount of time within which stack creation should complete.</p>', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'DescribeResourceScanOutput$StartTime' => '<p>The time that the resource scan was started.</p>', 'DescribeResourceScanOutput$EndTime' => '<p>The time that the resource scan was finished.</p>', 'DescribeStackDriftDetectionStatusOutput$Timestamp' => '<p>Time at which the stack drift detection operation was initiated.</p>', 'DescribeTypeOutput$LastUpdated' => '<p>When the specified extension version was registered. This applies only to:</p> <ul> <li> <p>Private extensions you have registered in your account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p> </li> <li> <p>Public extensions you have activated in your account with auto-update specified. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a>.</p> </li> </ul>', 'DescribeTypeOutput$TimeCreated' => '<p>When the specified private extension version was registered or activated in your account.</p>', 'HookResultSummary$InvokedAt' => '<p>The timestamp when the Hook was invoked.</p> <p>Only shown in responses when the request does not specify <code>TargetType</code> and <code>TargetId</code> filters.</p>', 'ResourceScanSummary$StartTime' => '<p>The time that the resource scan was started.</p>', 'ResourceScanSummary$EndTime' => '<p>The time that the resource scan was finished.</p>', 'StackDriftInformation$LastCheckTimestamp' => '<p>Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.</p>', 'StackDriftInformationSummary$LastCheckTimestamp' => '<p>Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.</p>', 'StackEvent$Timestamp' => '<p>Time the status was updated.</p>', 'StackInstance$LastDriftCheckTimestamp' => '<p>Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be <code>NULL</code> for any stack instance that drift detection hasn\'t yet been performed on.</p>', 'StackInstanceResourceDriftsSummary$Timestamp' => '<p>Time at which the stack instance drift detection operation was initiated.</p>', 'StackInstanceSummary$LastDriftCheckTimestamp' => '<p>Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be <code>NULL</code> for any stack instance that drift detection hasn\'t yet been performed on.</p>', 'StackResource$Timestamp' => '<p>Time the status was updated.</p>', 'StackResourceDetail$LastUpdatedTimestamp' => '<p>Time the status was updated.</p>', 'StackResourceDrift$Timestamp' => '<p>Time at which CloudFormation performed drift detection on the stack resource.</p>', 'StackResourceDriftInformation$LastCheckTimestamp' => '<p>When CloudFormation last checked if the resource had drifted from its expected configuration.</p>', 'StackResourceDriftInformationSummary$LastCheckTimestamp' => '<p>When CloudFormation last checked if the resource had drifted from its expected configuration.</p>', 'StackResourceSummary$LastUpdatedTimestamp' => '<p>Time the status was updated.</p>', 'StackSetDriftDetectionDetails$LastDriftCheckTimestamp' => '<p>Most recent time when CloudFormation performed a drift detection operation on the StackSet. This value will be <code>NULL</code> for any StackSet that drift detection hasn\'t yet been performed on.</p>', 'StackSetOperation$CreationTimestamp' => '<p>The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.</p>', 'StackSetOperation$EndTimestamp' => '<p>The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn\'t necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.</p>', 'StackSetOperationSummary$CreationTimestamp' => '<p>The time at which the operation was initiated. Note that the creation times for the StackSet operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.</p>', 'StackSetOperationSummary$EndTimestamp' => '<p>The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn\'t necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.</p>', 'StackSetSummary$LastDriftCheckTimestamp' => '<p>Most recent time when CloudFormation performed a drift detection operation on the StackSet. This value will be <code>NULL</code> for any StackSet that drift detection hasn\'t yet been performed on.</p>', 'TypeConfigurationDetails$LastUpdated' => '<p>When the configuration data was last updated for this extension.</p> <p>If a configuration hasn\'t been set for a specified extension, CloudFormation returns <code>null</code>.</p>', 'TypeSummary$LastUpdated' => '<p>When the specified extension version was registered. This applies only to:</p> <ul> <li> <p>Private extensions you have registered in your account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p> </li> <li> <p>Public extensions you have activated in your account with auto-update specified. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a>.</p> </li> </ul> <p>For all other extension types, CloudFormation returns <code>null</code>.</p>', 'TypeVersionSummary$TimeCreated' => '<p>When the version was registered.</p>', ], ], 'TokenAlreadyExistsException' => [ 'base' => '<p>A client request token already exists.</p>', 'refs' => [], ], 'TotalStackInstancesCount' => [ 'base' => NULL, 'refs' => [ 'StackSetDriftDetectionDetails$TotalStackInstancesCount' => '<p>The total number of stack instances belonging to this StackSet.</p> <p>The total number of stack instances is equal to the total of:</p> <ul> <li> <p>Stack instances that match the StackSet configuration.</p> </li> <li> <p>Stack instances that have drifted from the StackSet configuration.</p> </li> <li> <p>Stack instances where the drift detection operation has failed.</p> </li> <li> <p>Stack instances currently being checked for drift.</p> </li> </ul>', ], ], 'TotalWarnings' => [ 'base' => NULL, 'refs' => [ 'DescribeGeneratedTemplateOutput$TotalWarnings' => '<p>The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.</p>', ], ], 'TransformName' => [ 'base' => NULL, 'refs' => [ 'TransformsList$member' => NULL, ], ], 'TransformsList' => [ 'base' => NULL, 'refs' => [ 'GetTemplateSummaryOutput$DeclaredTransforms' => '<p>A list of the transforms that are declared in the template.</p>', 'ValidateTemplateOutput$DeclaredTransforms' => '<p>A list of the transforms that are declared in the template.</p>', ], ], 'TreatUnrecognizedResourceTypesAsWarnings' => [ 'base' => NULL, 'refs' => [ 'TemplateSummaryConfig$TreatUnrecognizedResourceTypesAsWarnings' => '<p>If set to <code>True</code>, any unrecognized resource types generate warnings and not an error. Any unrecognized resource types are returned in the <code>Warnings</code> output parameter.</p>', ], ], 'Type' => [ 'base' => NULL, 'refs' => [ 'RollbackTrigger$Type' => '<p>The resource type of the rollback trigger. Specify either <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-cloudwatch-alarm.html">AWS::CloudWatch::Alarm</a> or <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-cloudwatch-compositealarm.html">AWS::CloudWatch::CompositeAlarm</a> resource types.</p>', ], ], 'TypeArn' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeInput$Arn' => '<p>The Amazon Resource Name (ARN) of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'DescribeTypeOutput$Arn' => '<p>The Amazon Resource Name (ARN) of the extension.</p>', 'DescribeTypeOutput$OriginalTypeArn' => '<p>For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.</p>', 'DescribeTypeRegistrationOutput$TypeArn' => '<p>The Amazon Resource Name (ARN) of the extension being registered.</p> <p>For registration requests with a <code>ProgressStatus</code> of other than <code>COMPLETE</code>, this will be <code>null</code>.</p>', 'DescribeTypeRegistrationOutput$TypeVersionArn' => '<p>The Amazon Resource Name (ARN) of this specific version of the extension being registered.</p> <p>For registration requests with a <code>ProgressStatus</code> of other than <code>COMPLETE</code>, this will be <code>null</code>.</p>', 'ListTypeRegistrationsInput$TypeArn' => '<p>The Amazon Resource Name (ARN) of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'ListTypeVersionsInput$Arn' => '<p>The Amazon Resource Name (ARN) of the extension for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'PublishTypeOutput$PublicTypeArn' => '<p>The Amazon Resource Name (ARN) assigned to the public extension upon publication.</p>', 'SetTypeConfigurationInput$TypeArn' => '<p>The Amazon Resource Name (ARN) for the extension in this account and Region.</p> <p>For public extensions, this will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a> API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a> API operation in this account and Region.</p> <p>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.</p>', 'TestTypeInput$Arn' => '<p>The Amazon Resource Name (ARN) of the extension.</p> <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>', 'TestTypeOutput$TypeVersionArn' => '<p>The Amazon Resource Name (ARN) of the extension.</p>', 'TypeConfigurationDetails$TypeArn' => '<p>The ARN for the extension, in this account and Region.</p> <p>For public extensions, this will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a> API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a> API operation in this account and Region.</p>', 'TypeConfigurationIdentifier$TypeArn' => '<p>The ARN for the extension, in this account and Region.</p> <p>For public extensions, this will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a> API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a> API operation in this account and Region.</p>', 'TypeSummary$TypeArn' => '<p>The ARN of the extension.</p>', 'TypeVersionSummary$Arn' => '<p>The ARN of the extension version.</p>', ], ], 'TypeConfiguration' => [ 'base' => NULL, 'refs' => [ 'SetTypeConfigurationInput$Configuration' => '<p>The configuration data for the extension in this account and Region.</p> <p>The configuration data must be formatted as JSON and validate against the extension\'s schema returned in the <code>Schema</code> response element of <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.</p>', 'TypeConfigurationDetails$Configuration' => '<p>A JSON string specifying the configuration data for the extension, in this account and Region.</p> <p>If a configuration hasn\'t been set for a specified extension, CloudFormation returns <code>{}</code>.</p>', ], ], 'TypeConfigurationAlias' => [ 'base' => NULL, 'refs' => [ 'SetTypeConfigurationInput$ConfigurationAlias' => '<p>An alias by which to refer to this extension configuration data.</p> <p>Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.</p>', 'TypeConfigurationDetails$Alias' => '<p>The alias specified for this configuration, if one was specified when the configuration was set.</p>', 'TypeConfigurationIdentifier$TypeConfigurationAlias' => '<p>The alias specified for this configuration, if one was specified when the configuration was set.</p>', ], ], 'TypeConfigurationArn' => [ 'base' => NULL, 'refs' => [ 'SetTypeConfigurationOutput$ConfigurationArn' => '<p>The Amazon Resource Name (ARN) for the configuration data in this account and Region.</p> <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and <code>TypeName</code>.</p>', 'TypeConfigurationDetails$Arn' => '<p>The ARN for the configuration data, in this account and Region.</p>', 'TypeConfigurationIdentifier$TypeConfigurationArn' => '<p>The ARN for the configuration, in this account and Region.</p>', ], ], 'TypeConfigurationDetails' => [ 'base' => '<p>Detailed information concerning the specification of a CloudFormation extension in a given account and Region.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration data for extensions in your account</a> in the <i>CloudFormation User Guide</i>.</p>', 'refs' => [ 'TypeConfigurationDetailsList$member' => NULL, ], ], 'TypeConfigurationDetailsList' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeTypeConfigurationsOutput$TypeConfigurations' => '<p>A list of any of the specified extension configurations from the CloudFormation registry.</p>', ], ], 'TypeConfigurationIdentifier' => [ 'base' => '<p>Identifying information for the configuration of a CloudFormation extension.</p>', 'refs' => [ 'BatchDescribeTypeConfigurationsError$TypeConfigurationIdentifier' => '<p>Identifying information for the configuration of a CloudFormation extension.</p>', 'TypeConfigurationIdentifiers$member' => NULL, 'UnprocessedTypeConfigurations$member' => NULL, ], ], 'TypeConfigurationIdentifiers' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeTypeConfigurationsInput$TypeConfigurationIdentifiers' => '<p>The list of identifiers for the desired extension configurations.</p>', ], ], 'TypeConfigurationNotFoundException' => [ 'base' => '<p>The specified extension configuration can\'t be found.</p>', 'refs' => [], ], 'TypeFilters' => [ 'base' => '<p>Filter criteria to use in determining which extensions to return.</p>', 'refs' => [ 'ListTypesInput$Filters' => '<p>Filter criteria to use in determining which extensions to return.</p> <p>Filters must be compatible with <code>Visibility</code> to return valid results. For example, specifying <code>AWS_TYPES</code> for <code>Category</code> and <code>PRIVATE</code> for <code>Visibility</code> returns an empty list of types, but specifying <code>PUBLIC</code> for <code>Visibility</code> returns the desired list.</p>', ], ], 'TypeHierarchy' => [ 'base' => NULL, 'refs' => [ 'ModuleInfo$TypeHierarchy' => '<p>A concatenated list of the module type or types that contains the resource. Module types are listed starting with the inner-most nested module, and separated by <code>/</code>.</p> <p>In the following example, the resource was created from a module of type <code>AWS::First::Example::MODULE</code>, that\'s nested inside a parent module of type <code>AWS::Second::Example::MODULE</code>.</p> <p> <code>AWS::First::Example::MODULE/AWS::Second::Example::MODULE</code> </p>', ], ], 'TypeName' => [ 'base' => NULL, 'refs' => [ 'ActivateTypeInput$TypeName' => '<p>The name of the extension.</p> <p>Conditional: You must specify <code>PublicTypeArn</code>, or <code>TypeName</code>, <code>Type</code>, and <code>PublisherId</code>.</p>', 'ActivateTypeInput$TypeNameAlias' => '<p>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.</p> <p>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.</p>', 'DeactivateTypeInput$TypeName' => '<p>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.</p> <p>Conditional: You must specify either <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>', 'DeregisterTypeInput$TypeName' => '<p>The name of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'DescribeTypeInput$TypeName' => '<p>The name of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'DescribeTypeOutput$TypeName' => '<p>The name of the extension.</p> <p>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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a>.</p>', 'DescribeTypeOutput$OriginalTypeName' => '<p>For public extensions that have been activated for this account and Region, the type name of the public extension.</p> <p>If you specified a <code>TypeNameAlias</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias">Use aliases to refer to extensions</a> in the <i>CloudFormation User Guide</i>.</p>', 'ListTypeRegistrationsInput$TypeName' => '<p>The name of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'ListTypeVersionsInput$TypeName' => '<p>The name of the extension for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'PublishTypeInput$TypeName' => '<p>The name of the extension.</p> <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>', 'RegisterTypeInput$TypeName' => '<p>The name of the extension being registered.</p> <p>We suggest that extension names adhere to the following patterns:</p> <ul> <li> <p>For resource types, <code>company_or_organization::service::type</code>.</p> </li> <li> <p>For modules, <code>company_or_organization::service::type::MODULE</code>.</p> </li> <li> <p>For Hooks, <code>MyCompany::Testing::MyTestHook</code>.</p> </li> </ul> <note> <p>The following organization namespaces are reserved and can\'t be used in your extension names:</p> <ul> <li> <p> <code>Alexa</code> </p> </li> <li> <p> <code>AMZN</code> </p> </li> <li> <p> <code>Amazon</code> </p> </li> <li> <p> <code>AWS</code> </p> </li> <li> <p> <code>Custom</code> </p> </li> <li> <p> <code>Dev</code> </p> </li> </ul> </note>', 'RequiredActivatedType$TypeNameAlias' => '<p>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.</p>', 'RequiredActivatedType$OriginalTypeName' => '<p>The type name of the public extension.</p> <p>If you specified a <code>TypeNameAlias</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias">Use aliases to refer to extensions</a> in the <i>CloudFormation User Guide</i>.</p>', 'SetTypeConfigurationInput$TypeName' => '<p>The name of the extension.</p> <p>Conditional: You must specify <code>ConfigurationArn</code>, or <code>Type</code> and <code>TypeName</code>.</p>', 'SetTypeDefaultVersionInput$TypeName' => '<p>The name of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>', 'TestTypeInput$TypeName' => '<p>The name of the extension to test.</p> <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>', 'TypeConfigurationDetails$TypeName' => '<p>The name of the extension.</p>', 'TypeConfigurationIdentifier$TypeName' => '<p>The name of the extension type to which this configuration applies.</p>', 'TypeSummary$TypeName' => '<p>The name of the extension.</p> <p>If you specified a <code>TypeNameAlias</code> when you call the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html">ActivateType</a> API operation in your account and Region, CloudFormation considers that alias as the type name.</p>', 'TypeSummary$OriginalTypeName' => '<p>For public extensions that have been activated for this account and Region, the type name of the public extension.</p> <p>If you specified a <code>TypeNameAlias</code> 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias">Use aliases to refer to extensions</a> in the <i>CloudFormation User Guide</i>.</p>', 'TypeVersionSummary$TypeName' => '<p>The name of the extension.</p>', ], ], 'TypeNamePrefix' => [ 'base' => NULL, 'refs' => [ 'TypeFilters$TypeNamePrefix' => '<p>A prefix to use as a filter for results.</p>', ], ], 'TypeNotFoundException' => [ 'base' => '<p>The specified extension doesn\'t exist in the CloudFormation registry.</p>', 'refs' => [], ], 'TypeSchema' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeOutput$Schema' => '<p>The schema that defines the extension.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">Resource type schema</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i> and the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html">CloudFormation Hooks User Guide</a>.</p>', ], ], 'TypeSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTypesOutput$TypeSummaries' => '<p>A list of <code>TypeSummary</code> structures that contain information about the specified extensions.</p>', ], ], 'TypeSummary' => [ 'base' => '<p>Contains summary information about the specified CloudFormation extension.</p>', 'refs' => [ 'TypeSummaries$member' => NULL, ], ], 'TypeTestsStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeOutput$TypeTestsStatus' => '<p>The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify <code>VersionId</code>.</p> <p>This applies only to registered private extension versions. CloudFormation doesn\'t return this information for public extensions, whether they are activated in your account.</p> <ul> <li> <p> <code>PASSED</code>: The extension has passed all its contract tests.</p> <p>An extension must have a test status of <code>PASSED</code> before it can be published. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html">Publishing extensions to make them available for public use</a> in the <i>CloudFormation Command Line Interface (CLI) User Guide</i>.</p> </li> <li> <p> <code>FAILED</code>: The extension has failed one or more contract tests.</p> </li> <li> <p> <code>IN_PROGRESS</code>: Contract tests are currently being performed on the extension.</p> </li> <li> <p> <code>NOT_TESTED</code>: Contract tests haven\'t been performed on the extension.</p> </li> </ul>', ], ], 'TypeTestsStatusDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeOutput$TypeTestsStatusDescription' => '<p>The description of the test status. To return the extension test status of a specific extension version, you must specify <code>VersionId</code>.</p> <p>This applies only to registered private extension versions. CloudFormation doesn\'t return this information for public extensions, whether they are activated in your account.</p>', ], ], 'TypeVersionId' => [ 'base' => NULL, 'refs' => [ 'DeregisterTypeInput$VersionId' => '<p>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.</p>', 'DescribeTypeInput$VersionId' => '<p>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.</p> <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific extension version. Otherwise, it returns information about the default extension version.</p>', 'DescribeTypeOutput$DefaultVersionId' => '<p>The ID of the default version of the extension. The default version is used when the extension version isn\'t specified.</p> <p>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 <code>null</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p> <p>To set the default version of an extension, use <a>SetTypeDefaultVersion</a>.</p>', 'SetTypeDefaultVersionInput$VersionId' => '<p>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.</p>', 'TestTypeInput$VersionId' => '<p>The version of the extension to test.</p> <p>You can specify the version id with either <code>Arn</code>, or with <code>TypeName</code> and <code>Type</code>.</p> <p>If you don\'t specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.</p>', 'TypeSummary$DefaultVersionId' => '<p>The ID of the default version of the extension. The default version is used when the extension version isn\'t specified.</p> <p>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 <code>null</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p> <p>To set the default version of an extension, use <a>SetTypeDefaultVersion</a>.</p>', 'TypeVersionSummary$VersionId' => '<p>The ID of a specific version of the extension. The version ID is the value at the end of the ARN assigned to the extension version when it\'s registered.</p>', ], ], 'TypeVersionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListTypeVersionsOutput$TypeVersionSummaries' => '<p>A list of <code>TypeVersionSummary</code> structures that contain information about the specified extension\'s versions.</p>', ], ], 'TypeVersionSummary' => [ 'base' => '<p>Contains summary information about a specific version of a CloudFormation extension.</p>', 'refs' => [ 'TypeVersionSummaries$member' => NULL, ], ], 'UnprocessedTypeConfigurations' => [ 'base' => NULL, 'refs' => [ 'BatchDescribeTypeConfigurationsOutput$UnprocessedTypeConfigurations' => '<p>A list of any of the specified extension configurations that CloudFormation could not process for any reason.</p>', ], ], 'UpdateGeneratedTemplateInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGeneratedTemplateOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStackInput' => [ 'base' => '<p>The input for an <a>UpdateStack</a> action.</p>', 'refs' => [], ], 'UpdateStackInstancesInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStackInstancesOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStackOutput' => [ 'base' => '<p>The output for an <a>UpdateStack</a> action.</p>', 'refs' => [], ], 'UpdateStackSetInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStackSetOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTerminationProtectionInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTerminationProtectionOutput' => [ 'base' => NULL, 'refs' => [], ], 'Url' => [ 'base' => NULL, 'refs' => [ 'EstimateTemplateCostOutput$Url' => '<p>An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.</p>', ], ], 'UsePreviousTemplate' => [ 'base' => NULL, 'refs' => [ 'CreateChangeSetInput$UsePreviousTemplate' => '<p>Whether to reuse the template that\'s associated with the stack to create the change set.</p>', 'UpdateStackInput$UsePreviousTemplate' => '<p>Reuse the existing template that is associated with the stack that you are updating.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>', 'UpdateStackSetInput$UsePreviousTemplate' => '<p>Use the existing template that\'s associated with the StackSet that you\'re updating.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>', ], ], 'UsePreviousValue' => [ 'base' => NULL, 'refs' => [ 'Parameter$UsePreviousValue' => '<p>During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify <code>true</code>, do not specify a parameter value.</p>', ], ], 'ValidateTemplateInput' => [ 'base' => '<p>The input for <a>ValidateTemplate</a> action.</p>', 'refs' => [], ], 'ValidateTemplateOutput' => [ 'base' => '<p>The output for <a>ValidateTemplate</a> action.</p>', 'refs' => [], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'PhysicalResourceIdContextKeyValuePair$Value' => '<p>The resource context value.</p>', ], ], 'Version' => [ 'base' => NULL, 'refs' => [ 'GetTemplateSummaryOutput$Version' => '<p>The Amazon Web Services template format version, which identifies the capabilities of the template.</p>', ], ], 'VersionBump' => [ 'base' => NULL, 'refs' => [ 'ActivateTypeInput$VersionBump' => '<p>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 <code>AutoUpdate</code>.</p> <ul> <li> <p> <code>MAJOR</code>: CloudFormation updates the extension to the newest major version, if one is available.</p> </li> <li> <p> <code>MINOR</code>: CloudFormation updates the extension to the newest minor version, if one is available.</p> </li> </ul>', ], ], 'Visibility' => [ 'base' => NULL, 'refs' => [ 'DescribeTypeOutput$Visibility' => '<p>The scope at which the extension is visible and usable in CloudFormation operations.</p> <p>Valid values include:</p> <ul> <li> <p> <code>PRIVATE</code>: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as <code>PRIVATE</code>.</p> </li> <li> <p> <code>PUBLIC</code>: The extension is publicly visible and usable within any Amazon Web Services account.</p> </li> </ul>', 'ListTypesInput$Visibility' => '<p>The scope at which the extensions are visible and usable in CloudFormation operations.</p> <p>Valid values include:</p> <ul> <li> <p> <code>PRIVATE</code>: Extensions that are visible and usable within this account and Region. This includes:</p> <ul> <li> <p>Private extensions you have registered in this account and Region.</p> </li> <li> <p>Public extensions that you have activated in this account and Region.</p> </li> </ul> </li> <li> <p> <code>PUBLIC</code>: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services and third-party publishers.</p> </li> </ul> <p>The default is <code>PRIVATE</code>.</p>', ], ], 'WarningDetail' => [ 'base' => '<p>The warnings generated for a specific resource for this generated template.</p>', 'refs' => [ 'WarningDetails$member' => NULL, ], ], 'WarningDetails' => [ 'base' => NULL, 'refs' => [ 'ResourceDetail$Warnings' => '<p>The warnings generated for this resource.</p>', ], ], 'WarningProperties' => [ 'base' => NULL, 'refs' => [ 'WarningDetail$Properties' => '<p>The properties of the resource that are impacted by this warning.</p>', ], ], 'WarningProperty' => [ 'base' => '<p>A specific property that is impacted by a warning.</p>', 'refs' => [ 'WarningProperties$member' => NULL, ], ], 'WarningType' => [ 'base' => NULL, 'refs' => [ 'WarningDetail$Type' => '<p>The type of this warning. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-write-only-properties.html">Resolve write-only properties</a> in the <i>CloudFormation User Guide</i>.</p> <ul> <li> <p> <code>MUTUALLY_EXCLUSIVE_PROPERTIES</code> - 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 <code>OneOf</code> and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties.</p> </li> <li> <p> <code>UNSUPPORTED_PROPERTIES</code> - 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.</p> </li> <li> <p> <code>MUTUALLY_EXCLUSIVE_TYPES</code> - One or more required write-only properties are found in the resource, and the type of that property can be any of several types.</p> </li> </ul> <note> <p>Currently the resource and property reference documentation does not indicate if a property uses a type of <code>oneOf</code> or <code>anyOf</code>. You need to look at the resource provider schema.</p> </note>', ], ], 'Warnings' => [ 'base' => '<p>Contains any warnings returned by the <code>GetTemplateSummary</code> API action.</p>', 'refs' => [ 'GetTemplateSummaryOutput$Warnings' => '<p>An object that contains any warnings returned.</p>', ], ], ],];
