UNPKG

207 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class CloudFormation extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: CloudFormation.Types.ClientConfiguration)
14 config: Config & CloudFormation.Types.ClientConfiguration;
15 /**
16 * Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
17 */
18 cancelUpdateStack(params: CloudFormation.Types.CancelUpdateStackInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
19 /**
20 * Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
21 */
22 cancelUpdateStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
23 /**
24 * For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again. A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.
25 */
26 continueUpdateRollback(params: CloudFormation.Types.ContinueUpdateRollbackInput, callback?: (err: AWSError, data: CloudFormation.Types.ContinueUpdateRollbackOutput) => void): Request<CloudFormation.Types.ContinueUpdateRollbackOutput, AWSError>;
27 /**
28 * For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again. A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.
29 */
30 continueUpdateRollback(callback?: (err: AWSError, data: CloudFormation.Types.ContinueUpdateRollbackOutput) => void): Request<CloudFormation.Types.ContinueUpdateRollbackOutput, AWSError>;
31 /**
32 * 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 AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack. To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action. When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set.
33 */
34 createChangeSet(params: CloudFormation.Types.CreateChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateChangeSetOutput) => void): Request<CloudFormation.Types.CreateChangeSetOutput, AWSError>;
35 /**
36 * 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 AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack. To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action. When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set.
37 */
38 createChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.CreateChangeSetOutput) => void): Request<CloudFormation.Types.CreateChangeSetOutput, AWSError>;
39 /**
40 * Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
41 */
42 createStack(params: CloudFormation.Types.CreateStackInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateStackOutput) => void): Request<CloudFormation.Types.CreateStackOutput, AWSError>;
43 /**
44 * Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
45 */
46 createStack(callback?: (err: AWSError, data: CloudFormation.Types.CreateStackOutput) => void): Request<CloudFormation.Types.CreateStackOutput, AWSError>;
47 /**
48 * Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. Accounts and Regions are required parameters—you must specify at least one account and one region.
49 */
50 createStackInstances(params: CloudFormation.Types.CreateStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateStackInstancesOutput) => void): Request<CloudFormation.Types.CreateStackInstancesOutput, AWSError>;
51 /**
52 * Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. Accounts and Regions are required parameters—you must specify at least one account and one region.
53 */
54 createStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.CreateStackInstancesOutput) => void): Request<CloudFormation.Types.CreateStackInstancesOutput, AWSError>;
55 /**
56 * Creates a stack set.
57 */
58 createStackSet(params: CloudFormation.Types.CreateStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateStackSetOutput) => void): Request<CloudFormation.Types.CreateStackSetOutput, AWSError>;
59 /**
60 * Creates a stack set.
61 */
62 createStackSet(callback?: (err: AWSError, data: CloudFormation.Types.CreateStackSetOutput) => void): Request<CloudFormation.Types.CreateStackSetOutput, AWSError>;
63 /**
64 * Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set. If the call successfully completes, AWS CloudFormation successfully deleted the change set.
65 */
66 deleteChangeSet(params: CloudFormation.Types.DeleteChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DeleteChangeSetOutput) => void): Request<CloudFormation.Types.DeleteChangeSetOutput, AWSError>;
67 /**
68 * Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set. If the call successfully completes, AWS CloudFormation successfully deleted the change set.
69 */
70 deleteChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.DeleteChangeSetOutput) => void): Request<CloudFormation.Types.DeleteChangeSetOutput, AWSError>;
71 /**
72 * Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
73 */
74 deleteStack(params: CloudFormation.Types.DeleteStackInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
75 /**
76 * Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
77 */
78 deleteStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
79 /**
80 * Deletes stack instances for the specified accounts, in the specified regions.
81 */
82 deleteStackInstances(params: CloudFormation.Types.DeleteStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackInstancesOutput) => void): Request<CloudFormation.Types.DeleteStackInstancesOutput, AWSError>;
83 /**
84 * Deletes stack instances for the specified accounts, in the specified regions.
85 */
86 deleteStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackInstancesOutput) => void): Request<CloudFormation.Types.DeleteStackInstancesOutput, AWSError>;
87 /**
88 * Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.
89 */
90 deleteStackSet(params: CloudFormation.Types.DeleteStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackSetOutput) => void): Request<CloudFormation.Types.DeleteStackSetOutput, AWSError>;
91 /**
92 * Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.
93 */
94 deleteStackSet(callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackSetOutput) => void): Request<CloudFormation.Types.DeleteStackSetOutput, AWSError>;
95 /**
96 * Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
97 */
98 describeAccountLimits(params: CloudFormation.Types.DescribeAccountLimitsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeAccountLimitsOutput) => void): Request<CloudFormation.Types.DescribeAccountLimitsOutput, AWSError>;
99 /**
100 * Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
101 */
102 describeAccountLimits(callback?: (err: AWSError, data: CloudFormation.Types.DescribeAccountLimitsOutput) => void): Request<CloudFormation.Types.DescribeAccountLimitsOutput, AWSError>;
103 /**
104 * Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
105 */
106 describeChangeSet(params: CloudFormation.Types.DescribeChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
107 /**
108 * Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
109 */
110 describeChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
111 /**
112 * Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
113 */
114 describeStackDriftDetectionStatus(params: CloudFormation.Types.DescribeStackDriftDetectionStatusInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackDriftDetectionStatusOutput) => void): Request<CloudFormation.Types.DescribeStackDriftDetectionStatusOutput, AWSError>;
115 /**
116 * Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
117 */
118 describeStackDriftDetectionStatus(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackDriftDetectionStatusOutput) => void): Request<CloudFormation.Types.DescribeStackDriftDetectionStatusOutput, AWSError>;
119 /**
120 * Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide. You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
121 */
122 describeStackEvents(params: CloudFormation.Types.DescribeStackEventsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackEventsOutput) => void): Request<CloudFormation.Types.DescribeStackEventsOutput, AWSError>;
123 /**
124 * Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide. You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
125 */
126 describeStackEvents(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackEventsOutput) => void): Request<CloudFormation.Types.DescribeStackEventsOutput, AWSError>;
127 /**
128 * Returns the stack instance that's associated with the specified stack set, AWS account, and region. For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
129 */
130 describeStackInstance(params: CloudFormation.Types.DescribeStackInstanceInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackInstanceOutput) => void): Request<CloudFormation.Types.DescribeStackInstanceOutput, AWSError>;
131 /**
132 * Returns the stack instance that's associated with the specified stack set, AWS account, and region. For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
133 */
134 describeStackInstance(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackInstanceOutput) => void): Request<CloudFormation.Types.DescribeStackInstanceOutput, AWSError>;
135 /**
136 * Returns a description of the specified resource in the specified stack. For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
137 */
138 describeStackResource(params: CloudFormation.Types.DescribeStackResourceInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceOutput) => void): Request<CloudFormation.Types.DescribeStackResourceOutput, AWSError>;
139 /**
140 * Returns a description of the specified resource in the specified stack. For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
141 */
142 describeStackResource(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceOutput) => void): Request<CloudFormation.Types.DescribeStackResourceOutput, AWSError>;
143 /**
144 * Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift. For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
145 */
146 describeStackResourceDrifts(params: CloudFormation.Types.DescribeStackResourceDriftsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceDriftsOutput) => void): Request<CloudFormation.Types.DescribeStackResourceDriftsOutput, AWSError>;
147 /**
148 * Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift. For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
149 */
150 describeStackResourceDrifts(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceDriftsOutput) => void): Request<CloudFormation.Types.DescribeStackResourceDriftsOutput, AWSError>;
151 /**
152 * Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned. Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead. For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted. You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide. A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
153 */
154 describeStackResources(params: CloudFormation.Types.DescribeStackResourcesInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourcesOutput) => void): Request<CloudFormation.Types.DescribeStackResourcesOutput, AWSError>;
155 /**
156 * Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned. Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead. For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted. You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide. A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
157 */
158 describeStackResources(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourcesOutput) => void): Request<CloudFormation.Types.DescribeStackResourcesOutput, AWSError>;
159 /**
160 * Returns the description of the specified stack set.
161 */
162 describeStackSet(params: CloudFormation.Types.DescribeStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOutput) => void): Request<CloudFormation.Types.DescribeStackSetOutput, AWSError>;
163 /**
164 * Returns the description of the specified stack set.
165 */
166 describeStackSet(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOutput) => void): Request<CloudFormation.Types.DescribeStackSetOutput, AWSError>;
167 /**
168 * Returns the description of the specified stack set operation.
169 */
170 describeStackSetOperation(params: CloudFormation.Types.DescribeStackSetOperationInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOperationOutput) => void): Request<CloudFormation.Types.DescribeStackSetOperationOutput, AWSError>;
171 /**
172 * Returns the description of the specified stack set operation.
173 */
174 describeStackSetOperation(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOperationOutput) => void): Request<CloudFormation.Types.DescribeStackSetOperationOutput, AWSError>;
175 /**
176 * Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. If the stack does not exist, an AmazonCloudFormationException is returned.
177 */
178 describeStacks(params: CloudFormation.Types.DescribeStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
179 /**
180 * Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. If the stack does not exist, an AmazonCloudFormationException is returned.
181 */
182 describeStacks(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
183 /**
184 * Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources. For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection. DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources. When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.
185 */
186 detectStackDrift(params: CloudFormation.Types.DetectStackDriftInput, callback?: (err: AWSError, data: CloudFormation.Types.DetectStackDriftOutput) => void): Request<CloudFormation.Types.DetectStackDriftOutput, AWSError>;
187 /**
188 * Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources. For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection. DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources. When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.
189 */
190 detectStackDrift(callback?: (err: AWSError, data: CloudFormation.Types.DetectStackDriftOutput) => void): Request<CloudFormation.Types.DetectStackDriftOutput, AWSError>;
191 /**
192 * Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection. Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
193 */
194 detectStackResourceDrift(params: CloudFormation.Types.DetectStackResourceDriftInput, callback?: (err: AWSError, data: CloudFormation.Types.DetectStackResourceDriftOutput) => void): Request<CloudFormation.Types.DetectStackResourceDriftOutput, AWSError>;
195 /**
196 * Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection. Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
197 */
198 detectStackResourceDrift(callback?: (err: AWSError, data: CloudFormation.Types.DetectStackResourceDriftOutput) => void): Request<CloudFormation.Types.DetectStackResourceDriftOutput, AWSError>;
199 /**
200 * Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
201 */
202 estimateTemplateCost(params: CloudFormation.Types.EstimateTemplateCostInput, callback?: (err: AWSError, data: CloudFormation.Types.EstimateTemplateCostOutput) => void): Request<CloudFormation.Types.EstimateTemplateCostOutput, AWSError>;
203 /**
204 * Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
205 */
206 estimateTemplateCost(callback?: (err: AWSError, data: CloudFormation.Types.EstimateTemplateCostOutput) => void): Request<CloudFormation.Types.EstimateTemplateCostOutput, AWSError>;
207 /**
208 * Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update. When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack. If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
209 */
210 executeChangeSet(params: CloudFormation.Types.ExecuteChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.ExecuteChangeSetOutput) => void): Request<CloudFormation.Types.ExecuteChangeSetOutput, AWSError>;
211 /**
212 * Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update. When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack. If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
213 */
214 executeChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.ExecuteChangeSetOutput) => void): Request<CloudFormation.Types.ExecuteChangeSetOutput, AWSError>;
215 /**
216 * Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
217 */
218 getStackPolicy(params: CloudFormation.Types.GetStackPolicyInput, callback?: (err: AWSError, data: CloudFormation.Types.GetStackPolicyOutput) => void): Request<CloudFormation.Types.GetStackPolicyOutput, AWSError>;
219 /**
220 * Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
221 */
222 getStackPolicy(callback?: (err: AWSError, data: CloudFormation.Types.GetStackPolicyOutput) => void): Request<CloudFormation.Types.GetStackPolicyOutput, AWSError>;
223 /**
224 * Returns the template body for a specified stack. You can get the template for running or deleted stacks. For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
225 */
226 getTemplate(params: CloudFormation.Types.GetTemplateInput, callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateOutput) => void): Request<CloudFormation.Types.GetTemplateOutput, AWSError>;
227 /**
228 * Returns the template body for a specified stack. You can get the template for running or deleted stacks. For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
229 */
230 getTemplate(callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateOutput) => void): Request<CloudFormation.Types.GetTemplateOutput, AWSError>;
231 /**
232 * Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set. You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack. For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
233 */
234 getTemplateSummary(params: CloudFormation.Types.GetTemplateSummaryInput, callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateSummaryOutput) => void): Request<CloudFormation.Types.GetTemplateSummaryOutput, AWSError>;
235 /**
236 * Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set. You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack. For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
237 */
238 getTemplateSummary(callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateSummaryOutput) => void): Request<CloudFormation.Types.GetTemplateSummaryOutput, AWSError>;
239 /**
240 * Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
241 */
242 listChangeSets(params: CloudFormation.Types.ListChangeSetsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListChangeSetsOutput) => void): Request<CloudFormation.Types.ListChangeSetsOutput, AWSError>;
243 /**
244 * Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
245 */
246 listChangeSets(callback?: (err: AWSError, data: CloudFormation.Types.ListChangeSetsOutput) => void): Request<CloudFormation.Types.ListChangeSetsOutput, AWSError>;
247 /**
248 * Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function. For more information, see AWS CloudFormation Export Stack Output Values.
249 */
250 listExports(params: CloudFormation.Types.ListExportsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListExportsOutput) => void): Request<CloudFormation.Types.ListExportsOutput, AWSError>;
251 /**
252 * Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function. For more information, see AWS CloudFormation Export Stack Output Values.
253 */
254 listExports(callback?: (err: AWSError, data: CloudFormation.Types.ListExportsOutput) => void): Request<CloudFormation.Types.ListExportsOutput, AWSError>;
255 /**
256 * Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports. For more information about importing an exported output value, see the Fn::ImportValue function.
257 */
258 listImports(params: CloudFormation.Types.ListImportsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListImportsOutput) => void): Request<CloudFormation.Types.ListImportsOutput, AWSError>;
259 /**
260 * Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports. For more information about importing an exported output value, see the Fn::ImportValue function.
261 */
262 listImports(callback?: (err: AWSError, data: CloudFormation.Types.ListImportsOutput) => void): Request<CloudFormation.Types.ListImportsOutput, AWSError>;
263 /**
264 * Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region.
265 */
266 listStackInstances(params: CloudFormation.Types.ListStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackInstancesOutput) => void): Request<CloudFormation.Types.ListStackInstancesOutput, AWSError>;
267 /**
268 * Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region.
269 */
270 listStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.ListStackInstancesOutput) => void): Request<CloudFormation.Types.ListStackInstancesOutput, AWSError>;
271 /**
272 * Returns descriptions of all resources of the specified stack. For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
273 */
274 listStackResources(params: CloudFormation.Types.ListStackResourcesInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackResourcesOutput) => void): Request<CloudFormation.Types.ListStackResourcesOutput, AWSError>;
275 /**
276 * Returns descriptions of all resources of the specified stack. For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
277 */
278 listStackResources(callback?: (err: AWSError, data: CloudFormation.Types.ListStackResourcesOutput) => void): Request<CloudFormation.Types.ListStackResourcesOutput, AWSError>;
279 /**
280 * Returns summary information about the results of a stack set operation.
281 */
282 listStackSetOperationResults(params: CloudFormation.Types.ListStackSetOperationResultsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationResultsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationResultsOutput, AWSError>;
283 /**
284 * Returns summary information about the results of a stack set operation.
285 */
286 listStackSetOperationResults(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationResultsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationResultsOutput, AWSError>;
287 /**
288 * Returns summary information about operations performed on a stack set.
289 */
290 listStackSetOperations(params: CloudFormation.Types.ListStackSetOperationsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationsOutput, AWSError>;
291 /**
292 * Returns summary information about operations performed on a stack set.
293 */
294 listStackSetOperations(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationsOutput, AWSError>;
295 /**
296 * Returns summary information about stack sets that are associated with the user.
297 */
298 listStackSets(params: CloudFormation.Types.ListStackSetsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetsOutput) => void): Request<CloudFormation.Types.ListStackSetsOutput, AWSError>;
299 /**
300 * Returns summary information about stack sets that are associated with the user.
301 */
302 listStackSets(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetsOutput) => void): Request<CloudFormation.Types.ListStackSetsOutput, AWSError>;
303 /**
304 * Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
305 */
306 listStacks(params: CloudFormation.Types.ListStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStacksOutput) => void): Request<CloudFormation.Types.ListStacksOutput, AWSError>;
307 /**
308 * Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
309 */
310 listStacks(callback?: (err: AWSError, data: CloudFormation.Types.ListStacksOutput) => void): Request<CloudFormation.Types.ListStacksOutput, AWSError>;
311 /**
312 * Sets a stack policy for a specified stack.
313 */
314 setStackPolicy(params: CloudFormation.Types.SetStackPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
315 /**
316 * Sets a stack policy for a specified stack.
317 */
318 setStackPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
319 /**
320 * Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
321 */
322 signalResource(params: CloudFormation.Types.SignalResourceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
323 /**
324 * Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
325 */
326 signalResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
327 /**
328 * Stops an in-progress operation on a stack set and its associated stack instances.
329 */
330 stopStackSetOperation(params: CloudFormation.Types.StopStackSetOperationInput, callback?: (err: AWSError, data: CloudFormation.Types.StopStackSetOperationOutput) => void): Request<CloudFormation.Types.StopStackSetOperationOutput, AWSError>;
331 /**
332 * Stops an in-progress operation on a stack set and its associated stack instances.
333 */
334 stopStackSetOperation(callback?: (err: AWSError, data: CloudFormation.Types.StopStackSetOperationOutput) => void): Request<CloudFormation.Types.StopStackSetOperationOutput, AWSError>;
335 /**
336 * Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action. To get a copy of the template for an existing stack, you can use the GetTemplate action. For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
337 */
338 updateStack(params: CloudFormation.Types.UpdateStackInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackOutput) => void): Request<CloudFormation.Types.UpdateStackOutput, AWSError>;
339 /**
340 * Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action. To get a copy of the template for an existing stack, you can use the GetTemplate action. For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
341 */
342 updateStack(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackOutput) => void): Request<CloudFormation.Types.UpdateStackOutput, AWSError>;
343 /**
344 * Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances. During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value. You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
345 */
346 updateStackInstances(params: CloudFormation.Types.UpdateStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackInstancesOutput) => void): Request<CloudFormation.Types.UpdateStackInstancesOutput, AWSError>;
347 /**
348 * Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances. During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value. You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
349 */
350 updateStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackInstancesOutput) => void): Request<CloudFormation.Types.UpdateStackInstancesOutput, AWSError>;
351 /**
352 * Updates the stack set, and associated stack instances in the specified accounts and regions. Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
353 */
354 updateStackSet(params: CloudFormation.Types.UpdateStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackSetOutput) => void): Request<CloudFormation.Types.UpdateStackSetOutput, AWSError>;
355 /**
356 * Updates the stack set, and associated stack instances in the specified accounts and regions. Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
357 */
358 updateStackSet(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackSetOutput) => void): Request<CloudFormation.Types.UpdateStackSetOutput, AWSError>;
359 /**
360 * Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
361 */
362 updateTerminationProtection(params: CloudFormation.Types.UpdateTerminationProtectionInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateTerminationProtectionOutput) => void): Request<CloudFormation.Types.UpdateTerminationProtectionOutput, AWSError>;
363 /**
364 * Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
365 */
366 updateTerminationProtection(callback?: (err: AWSError, data: CloudFormation.Types.UpdateTerminationProtectionOutput) => void): Request<CloudFormation.Types.UpdateTerminationProtectionOutput, AWSError>;
367 /**
368 * Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.
369 */
370 validateTemplate(params: CloudFormation.Types.ValidateTemplateInput, callback?: (err: AWSError, data: CloudFormation.Types.ValidateTemplateOutput) => void): Request<CloudFormation.Types.ValidateTemplateOutput, AWSError>;
371 /**
372 * Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.
373 */
374 validateTemplate(callback?: (err: AWSError, data: CloudFormation.Types.ValidateTemplateOutput) => void): Request<CloudFormation.Types.ValidateTemplateOutput, AWSError>;
375 /**
376 * Waits for the stackExists state by periodically calling the underlying CloudFormation.describeStacksoperation every 5 seconds (at most 20 times).
377 */
378 waitFor(state: "stackExists", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
379 /**
380 * Waits for the stackExists state by periodically calling the underlying CloudFormation.describeStacksoperation every 5 seconds (at most 20 times).
381 */
382 waitFor(state: "stackExists", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
383 /**
384 * Waits for the stackCreateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is CREATE_COMPLETE.
385 */
386 waitFor(state: "stackCreateComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
387 /**
388 * Waits for the stackCreateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is CREATE_COMPLETE.
389 */
390 waitFor(state: "stackCreateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
391 /**
392 * Waits for the stackDeleteComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is DELETE_COMPLETE.
393 */
394 waitFor(state: "stackDeleteComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
395 /**
396 * Waits for the stackDeleteComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is DELETE_COMPLETE.
397 */
398 waitFor(state: "stackDeleteComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
399 /**
400 * Waits for the stackUpdateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is UPDATE_COMPLETE.
401 */
402 waitFor(state: "stackUpdateComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
403 /**
404 * Waits for the stackUpdateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is UPDATE_COMPLETE.
405 */
406 waitFor(state: "stackUpdateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
407 /**
408 * Waits for the changeSetCreateComplete state by periodically calling the underlying CloudFormation.describeChangeSetoperation every 30 seconds (at most 120 times). Wait until change set status is CREATE_COMPLETE.
409 */
410 waitFor(state: "changeSetCreateComplete", params: CloudFormation.Types.DescribeChangeSetInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
411 /**
412 * Waits for the changeSetCreateComplete state by periodically calling the underlying CloudFormation.describeChangeSetoperation every 30 seconds (at most 120 times). Wait until change set status is CREATE_COMPLETE.
413 */
414 waitFor(state: "changeSetCreateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
415}
416declare namespace CloudFormation {
417 export type Account = string;
418 export interface AccountGateResult {
419 /**
420 * The status of the account gate function. SUCCEEDED: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region. FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED. SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons: An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region. The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region. Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.
421 */
422 Status?: AccountGateStatus;
423 /**
424 * The reason for the account gate status assigned to this account and region for the stack set operation.
425 */
426 StatusReason?: AccountGateStatusReason;
427 }
428 export type AccountGateStatus = "SUCCEEDED"|"FAILED"|"SKIPPED"|string;
429 export type AccountGateStatusReason = string;
430 export interface AccountLimit {
431 /**
432 * The name of the account limit. Currently, the only account limit is StackLimit.
433 */
434 Name?: LimitName;
435 /**
436 * The value that is associated with the account limit name.
437 */
438 Value?: LimitValue;
439 }
440 export type AccountLimitList = AccountLimit[];
441 export type AccountList = Account[];
442 export type AllowedValue = string;
443 export type AllowedValues = AllowedValue[];
444 export type Arn = string;
445 export type BoxedInteger = number;
446 export type BoxedMaxResults = number;
447 export interface CancelUpdateStackInput {
448 /**
449 * The name or the unique stack ID that is associated with the stack.
450 */
451 StackName: StackName;
452 /**
453 * A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that AWS CloudFormation successfully received them.
454 */
455 ClientRequestToken?: ClientRequestToken;
456 }
457 export type Capabilities = Capability[];
458 export type CapabilitiesReason = string;
459 export type Capability = "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"|string;
460 export type CausingEntity = string;
461 export interface Change {
462 /**
463 * The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource.
464 */
465 Type?: ChangeType;
466 /**
467 * A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform.
468 */
469 ResourceChange?: ResourceChange;
470 }
471 export type ChangeAction = "Add"|"Modify"|"Remove"|string;
472 export type ChangeSetId = string;
473 export type ChangeSetName = string;
474 export type ChangeSetNameOrId = string;
475 export type ChangeSetStatus = "CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"DELETE_COMPLETE"|"FAILED"|string;
476 export type ChangeSetStatusReason = string;
477 export type ChangeSetSummaries = ChangeSetSummary[];
478 export interface ChangeSetSummary {
479 /**
480 * The ID of the stack with which the change set is associated.
481 */
482 StackId?: StackId;
483 /**
484 * The name of the stack with which the change set is associated.
485 */
486 StackName?: StackName;
487 /**
488 * The ID of the change set.
489 */
490 ChangeSetId?: ChangeSetId;
491 /**
492 * The name of the change set.
493 */
494 ChangeSetName?: ChangeSetName;
495 /**
496 * If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
497 */
498 ExecutionStatus?: ExecutionStatus;
499 /**
500 * The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
501 */
502 Status?: ChangeSetStatus;
503 /**
504 * A description of the change set's status. For example, if your change set is in the FAILED state, AWS CloudFormation shows the error message.
505 */
506 StatusReason?: ChangeSetStatusReason;
507 /**
508 * The start time when the change set was created, in UTC.
509 */
510 CreationTime?: CreationTime;
511 /**
512 * Descriptive information about the change set.
513 */
514 Description?: Description;
515 }
516 export type ChangeSetType = "CREATE"|"UPDATE"|string;
517 export type ChangeSource = "ResourceReference"|"ParameterReference"|"ResourceAttribute"|"DirectModification"|"Automatic"|string;
518 export type ChangeType = "Resource"|string;
519 export type Changes = Change[];
520 export type ClientRequestToken = string;
521 export type ClientToken = string;
522 export interface ContinueUpdateRollbackInput {
523 /**
524 * The name or the unique ID of the stack that you want to continue rolling back. Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource).
525 */
526 StackName: StackNameOrId;
527 /**
528 * The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
529 */
530 RoleARN?: RoleARN;
531 /**
532 * A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was cancelled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason. Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED. Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
533 */
534 ResourcesToSkip?: ResourcesToSkip;
535 /**
536 * A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that AWS CloudFormation successfully received them.
537 */
538 ClientRequestToken?: ClientRequestToken;
539 }
540 export interface ContinueUpdateRollbackOutput {
541 }
542 export interface CreateChangeSetInput {
543 /**
544 * The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.
545 */
546 StackName: StackNameOrId;
547 /**
548 * A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified. Conditional: You must specify only TemplateBody or TemplateURL.
549 */
550 TemplateBody?: TemplateBody;
551 /**
552 * The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified. Conditional: You must specify only TemplateBody or TemplateURL.
553 */
554 TemplateURL?: TemplateURL;
555 /**
556 * Whether to reuse the template that is associated with the stack to create the change set.
557 */
558 UsePreviousTemplate?: UsePreviousTemplate;
559 /**
560 * A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.
561 */
562 Parameters?: Parameters;
563 /**
564 * In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation. This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect. Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability. For more information on macros, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
565 */
566 Capabilities?: Capabilities;
567 /**
568 * The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
569 */
570 ResourceTypes?: ResourceTypes;
571 /**
572 * The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
573 */
574 RoleARN?: RoleARN;
575 /**
576 * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
577 */
578 RollbackConfiguration?: RollbackConfiguration;
579 /**
580 * The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
581 */
582 NotificationARNs?: NotificationARNs;
583 /**
584 * Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.
585 */
586 Tags?: Tags;
587 /**
588 * The name of the change set. The name must be unique among all change sets that are associated with the specified stack. A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.
589 */
590 ChangeSetName: ChangeSetName;
591 /**
592 * A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that AWS CloudFormation successfully received them.
593 */
594 ClientToken?: ClientToken;
595 /**
596 * A description to help you identify this change set.
597 */
598 Description?: Description;
599 /**
600 * The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set. By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
601 */
602 ChangeSetType?: ChangeSetType;
603 }
604 export interface CreateChangeSetOutput {
605 /**
606 * The Amazon Resource Name (ARN) of the change set.
607 */
608 Id?: ChangeSetId;
609 /**
610 * The unique ID of the stack.
611 */
612 StackId?: StackId;
613 }
614 export interface CreateStackInput {
615 /**
616 * The name that is associated with the stack. The name must be unique in the region in which you are creating the stack. A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
617 */
618 StackName: StackName;
619 /**
620 * Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
621 */
622 TemplateBody?: TemplateBody;
623 /**
624 * Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
625 */
626 TemplateURL?: TemplateURL;
627 /**
628 * A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
629 */
630 Parameters?: Parameters;
631 /**
632 * Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both. Default: false
633 */
634 DisableRollback?: DisableRollback;
635 /**
636 * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
637 */
638 RollbackConfiguration?: RollbackConfiguration;
639 /**
640 * The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.
641 */
642 TimeoutInMinutes?: TimeoutMinutes;
643 /**
644 * The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).
645 */
646 NotificationARNs?: NotificationARNs;
647 /**
648 * In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation. Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability. You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs. Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
649 */
650 Capabilities?: Capabilities;
651 /**
652 * The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all AWS resource), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular AWS service), and AWS::service_name::resource_logical_ID (for a specific AWS resource). If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
653 */
654 ResourceTypes?: ResourceTypes;
655 /**
656 * The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
657 */
658 RoleARN?: RoleARN;
659 /**
660 * Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both. Default: ROLLBACK
661 */
662 OnFailure?: OnFailure;
663 /**
664 * Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
665 */
666 StackPolicyBody?: StackPolicyBody;
667 /**
668 * Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
669 */
670 StackPolicyURL?: StackPolicyURL;
671 /**
672 * Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
673 */
674 Tags?: Tags;
675 /**
676 * A unique identifier for this CreateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
677 */
678 ClientRequestToken?: ClientRequestToken;
679 /**
680 * Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
681 */
682 EnableTerminationProtection?: EnableTerminationProtection;
683 }
684 export interface CreateStackInstancesInput {
685 /**
686 * The name or unique ID of the stack set that you want to create stack instances from.
687 */
688 StackSetName: StackSetName;
689 /**
690 * The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.
691 */
692 Accounts: AccountList;
693 /**
694 * The names of one or more regions where you want to create stack instances using the specified AWS account(s).
695 */
696 Regions: RegionList;
697 /**
698 * A list of stack set parameters whose values you want to override in the selected stack instances. Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations: To override the current value for a parameter, include the parameter and specify its value. To leave a parameter set to its present value, you can do one of the following: Do not include the parameter in the list. Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.) To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters. To leave all parameters set to their present values, do not specify this property at all. During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value. You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.
699 */
700 ParameterOverrides?: Parameters;
701 /**
702 * Preferences for how AWS CloudFormation performs this stack set operation.
703 */
704 OperationPreferences?: StackSetOperationPreferences;
705 /**
706 * The unique identifier for this stack set operation. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically. Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
707 */
708 OperationId?: ClientRequestToken;
709 }
710 export interface CreateStackInstancesOutput {
711 /**
712 * The unique identifier for this stack set operation.
713 */
714 OperationId?: ClientRequestToken;
715 }
716 export interface CreateStackOutput {
717 /**
718 * Unique identifier of the stack.
719 */
720 StackId?: StackId;
721 }
722 export interface CreateStackSetInput {
723 /**
724 * The name to associate with the stack set. The name must be unique in the region where you create your stack set. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.
725 */
726 StackSetName: StackSetName;
727 /**
728 * A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
729 */
730 Description?: Description;
731 /**
732 * The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
733 */
734 TemplateBody?: TemplateBody;
735 /**
736 * The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
737 */
738 TemplateURL?: TemplateURL;
739 /**
740 * The input parameters for the stack set template.
741 */
742 Parameters?: Parameters;
743 /**
744 * In some cases, you must explicity acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some templates contain macros. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates. Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
745 */
746 Capabilities?: Capabilities;
747 /**
748 * The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified. If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.
749 */
750 Tags?: Tags;
751 /**
752 * The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
753 */
754 AdministrationRoleARN?: RoleARN;
755 /**
756 * The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation. Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
757 */
758 ExecutionRoleName?: ExecutionRoleName;
759 /**
760 * A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically.
761 */
762 ClientRequestToken?: ClientRequestToken;
763 }
764 export interface CreateStackSetOutput {
765 /**
766 * The ID of the stack set that you're creating.
767 */
768 StackSetId?: StackSetId;
769 }
770 export type CreationTime = Date;
771 export interface DeleteChangeSetInput {
772 /**
773 * The name or Amazon Resource Name (ARN) of the change set that you want to delete.
774 */
775 ChangeSetName: ChangeSetNameOrId;
776 /**
777 * If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it.
778 */
779 StackName?: StackNameOrId;
780 }
781 export interface DeleteChangeSetOutput {
782 }
783 export interface DeleteStackInput {
784 /**
785 * The name or the unique stack ID that is associated with the stack.
786 */
787 StackName: StackName;
788 /**
789 * For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources. Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.
790 */
791 RetainResources?: RetainResources;
792 /**
793 * The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
794 */
795 RoleARN?: RoleARN;
796 /**
797 * A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
798 */
799 ClientRequestToken?: ClientRequestToken;
800 }
801 export interface DeleteStackInstancesInput {
802 /**
803 * The name or unique ID of the stack set that you want to delete stack instances for.
804 */
805 StackSetName: StackSetName;
806 /**
807 * The names of the AWS accounts that you want to delete stack instances for.
808 */
809 Accounts: AccountList;
810 /**
811 * The regions where you want to delete stack set instances.
812 */
813 Regions: RegionList;
814 /**
815 * Preferences for how AWS CloudFormation performs this stack set operation.
816 */
817 OperationPreferences?: StackSetOperationPreferences;
818 /**
819 * Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. For more information, see Stack set operation options.
820 */
821 RetainStacks: RetainStacks;
822 /**
823 * The unique identifier for this stack set operation. If you don't specify an operation ID, the SDK generates one automatically. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them. Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
824 */
825 OperationId?: ClientRequestToken;
826 }
827 export interface DeleteStackInstancesOutput {
828 /**
829 * The unique identifier for this stack set operation.
830 */
831 OperationId?: ClientRequestToken;
832 }
833 export interface DeleteStackSetInput {
834 /**
835 * The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.
836 */
837 StackSetName: StackSetName;
838 }
839 export interface DeleteStackSetOutput {
840 }
841 export type DeletionTime = Date;
842 export interface DescribeAccountLimitsInput {
843 /**
844 * A string that identifies the next page of limits that you want to retrieve.
845 */
846 NextToken?: NextToken;
847 }
848 export interface DescribeAccountLimitsOutput {
849 /**
850 * An account limit structure that contain a list of AWS CloudFormation account limits and their values.
851 */
852 AccountLimits?: AccountLimitList;
853 /**
854 * 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.
855 */
856 NextToken?: NextToken;
857 }
858 export interface DescribeChangeSetInput {
859 /**
860 * The name or Amazon Resource Name (ARN) of the change set that you want to describe.
861 */
862 ChangeSetName: ChangeSetNameOrId;
863 /**
864 * If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.
865 */
866 StackName?: StackNameOrId;
867 /**
868 * A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.
869 */
870 NextToken?: NextToken;
871 }
872 export interface DescribeChangeSetOutput {
873 /**
874 * The name of the change set.
875 */
876 ChangeSetName?: ChangeSetName;
877 /**
878 * The ARN of the change set.
879 */
880 ChangeSetId?: ChangeSetId;
881 /**
882 * The ARN of the stack that is associated with the change set.
883 */
884 StackId?: StackId;
885 /**
886 * The name of the stack that is associated with the change set.
887 */
888 StackName?: StackName;
889 /**
890 * Information about the change set.
891 */
892 Description?: Description;
893 /**
894 * A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
895 */
896 Parameters?: Parameters;
897 /**
898 * The start time when the change set was created, in UTC.
899 */
900 CreationTime?: CreationTime;
901 /**
902 * If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
903 */
904 ExecutionStatus?: ExecutionStatus;
905 /**
906 * The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
907 */
908 Status?: ChangeSetStatus;
909 /**
910 * A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
911 */
912 StatusReason?: ChangeSetStatusReason;
913 /**
914 * The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
915 */
916 NotificationARNs?: NotificationARNs;
917 /**
918 * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
919 */
920 RollbackConfiguration?: RollbackConfiguration;
921 /**
922 * If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
923 */
924 Capabilities?: Capabilities;
925 /**
926 * If you execute the change set, the tags that will be associated with the stack.
927 */
928 Tags?: Tags;
929 /**
930 * A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set.
931 */
932 Changes?: Changes;
933 /**
934 * 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.
935 */
936 NextToken?: NextToken;
937 }
938 export interface DescribeStackDriftDetectionStatusInput {
939 /**
940 * The ID of the drift detection results of this operation. AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary.
941 */
942 StackDriftDetectionId: StackDriftDetectionId;
943 }
944 export interface DescribeStackDriftDetectionStatusOutput {
945 /**
946 * The ID of the stack.
947 */
948 StackId: StackId;
949 /**
950 * The ID of the drift detection results of this operation. AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports AWS CloudFormation retains for any given stack, and for how long, may vary.
951 */
952 StackDriftDetectionId: StackDriftDetectionId;
953 /**
954 * Status of the stack's actual configuration compared to its expected configuration. DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration. IN_SYNC: The stack's actual configuration matches its expected template configuration. UNKNOWN: This value is reserved for future use.
955 */
956 StackDriftStatus?: StackDriftStatus;
957 /**
958 * The status of the stack drift detection operation. DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that do not currently support stack detection remain unchecked.) If you specified logical resource IDs for AWS CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift. DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which AWS CloudFormation successfully completed drift detection. DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
959 */
960 DetectionStatus: StackDriftDetectionStatus;
961 /**
962 * The reason the stack drift detection operation has its current status.
963 */
964 DetectionStatusReason?: StackDriftDetectionStatusReason;
965 /**
966 * Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.
967 */
968 DriftedStackResourceCount?: BoxedInteger;
969 /**
970 * Time at which the stack drift detection operation was initiated.
971 */
972 Timestamp: Timestamp;
973 }
974 export interface DescribeStackEventsInput {
975 /**
976 * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value.
977 */
978 StackName?: StackName;
979 /**
980 * A string that identifies the next page of events that you want to retrieve.
981 */
982 NextToken?: NextToken;
983 }
984 export interface DescribeStackEventsOutput {
985 /**
986 * A list of StackEvents structures.
987 */
988 StackEvents?: StackEvents;
989 /**
990 * 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.
991 */
992 NextToken?: NextToken;
993 }
994 export interface DescribeStackInstanceInput {
995 /**
996 * The name or the unique stack ID of the stack set that you want to get stack instance information for.
997 */
998 StackSetName: StackSetName;
999 /**
1000 * The ID of an AWS account that's associated with this stack instance.
1001 */
1002 StackInstanceAccount: Account;
1003 /**
1004 * The name of a region that's associated with this stack instance.
1005 */
1006 StackInstanceRegion: Region;
1007 }
1008 export interface DescribeStackInstanceOutput {
1009 /**
1010 * The stack instance that matches the specified request parameters.
1011 */
1012 StackInstance?: StackInstance;
1013 }
1014 export interface DescribeStackResourceDriftsInput {
1015 /**
1016 * The name of the stack for which you want drift information.
1017 */
1018 StackName: StackNameOrId;
1019 /**
1020 * The resource drift status values to use as filters for the resource drift results returned. DELETED: The resource differs from its expected template configuration in that the resource has been deleted. MODIFIED: One or more resource properties differ from their expected template values. IN_SYNC: The resources's actual configuration matches its expected template configuration. NOT_CHECKED: AWS CloudFormation does not currently return this value.
1021 */
1022 StackResourceDriftStatusFilters?: StackResourceDriftStatusFilters;
1023 /**
1024 * A string that identifies the next page of stack resource drift results.
1025 */
1026 NextToken?: NextToken;
1027 /**
1028 * The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
1029 */
1030 MaxResults?: BoxedMaxResults;
1031 }
1032 export interface DescribeStackResourceDriftsOutput {
1033 /**
1034 * Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects drift. For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.
1035 */
1036 StackResourceDrifts: StackResourceDrifts;
1037 /**
1038 * If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
1039 */
1040 NextToken?: NextToken;
1041 }
1042 export interface DescribeStackResourceInput {
1043 /**
1044 * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value.
1045 */
1046 StackName: StackName;
1047 /**
1048 * The logical name of the resource as specified in the template. Default: There is no default value.
1049 */
1050 LogicalResourceId: LogicalResourceId;
1051 }
1052 export interface DescribeStackResourceOutput {
1053 /**
1054 * A StackResourceDetail structure containing the description of the specified resource in the specified stack.
1055 */
1056 StackResourceDetail?: StackResourceDetail;
1057 }
1058 export interface DescribeStackResourcesInput {
1059 /**
1060 * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value. Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.
1061 */
1062 StackName?: StackName;
1063 /**
1064 * The logical name of the resource as specified in the template. Default: There is no default value.
1065 */
1066 LogicalResourceId?: LogicalResourceId;
1067 /**
1068 * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack. Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName. Default: There is no default value.
1069 */
1070 PhysicalResourceId?: PhysicalResourceId;
1071 }
1072 export interface DescribeStackResourcesOutput {
1073 /**
1074 * A list of StackResource structures.
1075 */
1076 StackResources?: StackResources;
1077 }
1078 export interface DescribeStackSetInput {
1079 /**
1080 * The name or unique ID of the stack set whose description you want.
1081 */
1082 StackSetName: StackSetName;
1083 }
1084 export interface DescribeStackSetOperationInput {
1085 /**
1086 * The name or the unique stack ID of the stack set for the stack operation.
1087 */
1088 StackSetName: StackSetName;
1089 /**
1090 * The unique ID of the stack set operation.
1091 */
1092 OperationId: ClientRequestToken;
1093 }
1094 export interface DescribeStackSetOperationOutput {
1095 /**
1096 * The specified stack set operation.
1097 */
1098 StackSetOperation?: StackSetOperation;
1099 }
1100 export interface DescribeStackSetOutput {
1101 /**
1102 * The specified stack set.
1103 */
1104 StackSet?: StackSet;
1105 }
1106 export interface DescribeStacksInput {
1107 /**
1108 * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value.
1109 */
1110 StackName?: StackName;
1111 /**
1112 * A string that identifies the next page of stacks that you want to retrieve.
1113 */
1114 NextToken?: NextToken;
1115 }
1116 export interface DescribeStacksOutput {
1117 /**
1118 * A list of stack structures.
1119 */
1120 Stacks?: Stacks;
1121 /**
1122 * 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.
1123 */
1124 NextToken?: NextToken;
1125 }
1126 export type Description = string;
1127 export interface DetectStackDriftInput {
1128 /**
1129 * The name of the stack for which you want to detect drift.
1130 */
1131 StackName: StackNameOrId;
1132 /**
1133 * The logical names of any resources you want to use as filters.
1134 */
1135 LogicalResourceIds?: LogicalResourceIds;
1136 }
1137 export interface DetectStackDriftOutput {
1138 /**
1139 * The ID of the drift detection results of this operation. AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary.
1140 */
1141 StackDriftDetectionId: StackDriftDetectionId;
1142 }
1143 export interface DetectStackResourceDriftInput {
1144 /**
1145 * The name of the stack to which the resource belongs.
1146 */
1147 StackName: StackNameOrId;
1148 /**
1149 * The logical name of the resource for which to return drift information.
1150 */
1151 LogicalResourceId: LogicalResourceId;
1152 }
1153 export interface DetectStackResourceDriftOutput {
1154 /**
1155 * 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.
1156 */
1157 StackResourceDrift: StackResourceDrift;
1158 }
1159 export type DifferenceType = "ADD"|"REMOVE"|"NOT_EQUAL"|string;
1160 export type DisableRollback = boolean;
1161 export type EnableTerminationProtection = boolean;
1162 export interface EstimateTemplateCostInput {
1163 /**
1164 * Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.
1165 */
1166 TemplateBody?: TemplateBody;
1167 /**
1168 * Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
1169 */
1170 TemplateURL?: TemplateURL;
1171 /**
1172 * A list of Parameter structures that specify input parameters.
1173 */
1174 Parameters?: Parameters;
1175 }
1176 export interface EstimateTemplateCostOutput {
1177 /**
1178 * An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
1179 */
1180 Url?: Url;
1181 }
1182 export type EvaluationType = "Static"|"Dynamic"|string;
1183 export type EventId = string;
1184 export interface ExecuteChangeSetInput {
1185 /**
1186 * The name or ARN of the change set that you want use to update the specified stack.
1187 */
1188 ChangeSetName: ChangeSetNameOrId;
1189 /**
1190 * If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.
1191 */
1192 StackName?: StackNameOrId;
1193 /**
1194 * A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that AWS CloudFormation successfully received them.
1195 */
1196 ClientRequestToken?: ClientRequestToken;
1197 }
1198 export interface ExecuteChangeSetOutput {
1199 }
1200 export type ExecutionRoleName = string;
1201 export type ExecutionStatus = "UNAVAILABLE"|"AVAILABLE"|"EXECUTE_IN_PROGRESS"|"EXECUTE_COMPLETE"|"EXECUTE_FAILED"|"OBSOLETE"|string;
1202 export interface Export {
1203 /**
1204 * The stack that contains the exported output name and value.
1205 */
1206 ExportingStackId?: StackId;
1207 /**
1208 * The name of exported output value. Use this name and the Fn::ImportValue function to import the associated value into other stacks. The name is defined in the Export field in the associated stack's Outputs section.
1209 */
1210 Name?: ExportName;
1211 /**
1212 * The value of the exported output, such as a resource physical ID. This value is defined in the Export field in the associated stack's Outputs section.
1213 */
1214 Value?: ExportValue;
1215 }
1216 export type ExportName = string;
1217 export type ExportValue = string;
1218 export type Exports = Export[];
1219 export type FailureToleranceCount = number;
1220 export type FailureTolerancePercentage = number;
1221 export interface GetStackPolicyInput {
1222 /**
1223 * The name or unique stack ID that is associated with the stack whose policy you want to get.
1224 */
1225 StackName: StackName;
1226 }
1227 export interface GetStackPolicyOutput {
1228 /**
1229 * Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)
1230 */
1231 StackPolicyBody?: StackPolicyBody;
1232 }
1233 export interface GetTemplateInput {
1234 /**
1235 * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value.
1236 */
1237 StackName?: StackName;
1238 /**
1239 * The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.
1240 */
1241 ChangeSetName?: ChangeSetNameOrId;
1242 /**
1243 * For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed. If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.
1244 */
1245 TemplateStage?: TemplateStage;
1246 }
1247 export interface GetTemplateOutput {
1248 /**
1249 * Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) AWS CloudFormation returns the same template that was used when the stack was created.
1250 */
1251 TemplateBody?: TemplateBody;
1252 /**
1253 * The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After AWS CloudFormation finishes creating the change set, the Processed template becomes available.
1254 */
1255 StagesAvailable?: StageList;
1256 }
1257 export interface GetTemplateSummaryInput {
1258 /**
1259 * Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
1260 */
1261 TemplateBody?: TemplateBody;
1262 /**
1263 * Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
1264 */
1265 TemplateURL?: TemplateURL;
1266 /**
1267 * The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
1268 */
1269 StackName?: StackNameOrId;
1270 /**
1271 * The name or unique ID of the stack set from which the stack was created. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
1272 */
1273 StackSetName?: StackSetNameOrId;
1274 }
1275 export interface GetTemplateSummaryOutput {
1276 /**
1277 * A list of parameter declarations that describe various properties for each parameter.
1278 */
1279 Parameters?: ParameterDeclarations;
1280 /**
1281 * The value that is defined in the Description property of the template.
1282 */
1283 Description?: Description;
1284 /**
1285 * The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
1286 */
1287 Capabilities?: Capabilities;
1288 /**
1289 * The list of resources that generated the values in the Capabilities response element.
1290 */
1291 CapabilitiesReason?: CapabilitiesReason;
1292 /**
1293 * A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
1294 */
1295 ResourceTypes?: ResourceTypes;
1296 /**
1297 * The AWS template format version, which identifies the capabilities of the template.
1298 */
1299 Version?: Version;
1300 /**
1301 * The value that is defined for the Metadata property of the template.
1302 */
1303 Metadata?: Metadata;
1304 /**
1305 * A list of the transforms that are declared in the template.
1306 */
1307 DeclaredTransforms?: TransformsList;
1308 }
1309 export type Imports = StackName[];
1310 export type Key = string;
1311 export type LastUpdatedTime = Date;
1312 export type LimitName = string;
1313 export type LimitValue = number;
1314 export interface ListChangeSetsInput {
1315 /**
1316 * The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
1317 */
1318 StackName: StackNameOrId;
1319 /**
1320 * A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.
1321 */
1322 NextToken?: NextToken;
1323 }
1324 export interface ListChangeSetsOutput {
1325 /**
1326 * A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.
1327 */
1328 Summaries?: ChangeSetSummaries;
1329 /**
1330 * If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.
1331 */
1332 NextToken?: NextToken;
1333 }
1334 export interface ListExportsInput {
1335 /**
1336 * A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve.
1337 */
1338 NextToken?: NextToken;
1339 }
1340 export interface ListExportsOutput {
1341 /**
1342 * The output for the ListExports action.
1343 */
1344 Exports?: Exports;
1345 /**
1346 * 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.
1347 */
1348 NextToken?: NextToken;
1349 }
1350 export interface ListImportsInput {
1351 /**
1352 * The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value.
1353 */
1354 ExportName: ExportName;
1355 /**
1356 * A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.
1357 */
1358 NextToken?: NextToken;
1359 }
1360 export interface ListImportsOutput {
1361 /**
1362 * A list of stack names that are importing the specified exported output value.
1363 */
1364 Imports?: Imports;
1365 /**
1366 * A string that identifies the next page of exports. If there is no additional page, this value is null.
1367 */
1368 NextToken?: NextToken;
1369 }
1370 export interface ListStackInstancesInput {
1371 /**
1372 * The name or unique ID of the stack set that you want to list stack instances for.
1373 */
1374 StackSetName: StackSetName;
1375 /**
1376 * If the previous request didn't return all of the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
1377 */
1378 NextToken?: NextToken;
1379 /**
1380 * The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
1381 */
1382 MaxResults?: MaxResults;
1383 /**
1384 * The name of the AWS account that you want to list stack instances for.
1385 */
1386 StackInstanceAccount?: Account;
1387 /**
1388 * The name of the region where you want to list stack instances.
1389 */
1390 StackInstanceRegion?: Region;
1391 }
1392 export interface ListStackInstancesOutput {
1393 /**
1394 * A list of StackInstanceSummary structures that contain information about the specified stack instances.
1395 */
1396 Summaries?: StackInstanceSummaries;
1397 /**
1398 * If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
1399 */
1400 NextToken?: NextToken;
1401 }
1402 export interface ListStackResourcesInput {
1403 /**
1404 * The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value.
1405 */
1406 StackName: StackName;
1407 /**
1408 * A string that identifies the next page of stack resources that you want to retrieve.
1409 */
1410 NextToken?: NextToken;
1411 }
1412 export interface ListStackResourcesOutput {
1413 /**
1414 * A list of StackResourceSummary structures.
1415 */
1416 StackResourceSummaries?: StackResourceSummaries;
1417 /**
1418 * 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.
1419 */
1420 NextToken?: NextToken;
1421 }
1422 export interface ListStackSetOperationResultsInput {
1423 /**
1424 * The name or unique ID of the stack set that you want to get operation results for.
1425 */
1426 StackSetName: StackSetName;
1427 /**
1428 * The ID of the stack set operation.
1429 */
1430 OperationId: ClientRequestToken;
1431 /**
1432 * If the previous request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
1433 */
1434 NextToken?: NextToken;
1435 /**
1436 * The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
1437 */
1438 MaxResults?: MaxResults;
1439 }
1440 export interface ListStackSetOperationResultsOutput {
1441 /**
1442 * A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and regions that are included in the operation.
1443 */
1444 Summaries?: StackSetOperationResultSummaries;
1445 /**
1446 * If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.
1447 */
1448 NextToken?: NextToken;
1449 }
1450 export interface ListStackSetOperationsInput {
1451 /**
1452 * The name or unique ID of the stack set that you want to get operation summaries for.
1453 */
1454 StackSetName: StackSetName;
1455 /**
1456 * If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
1457 */
1458 NextToken?: NextToken;
1459 /**
1460 * The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
1461 */
1462 MaxResults?: MaxResults;
1463 }
1464 export interface ListStackSetOperationsOutput {
1465 /**
1466 * A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.
1467 */
1468 Summaries?: StackSetOperationSummaries;
1469 /**
1470 * If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.
1471 */
1472 NextToken?: NextToken;
1473 }
1474 export interface ListStackSetsInput {
1475 /**
1476 * If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
1477 */
1478 NextToken?: NextToken;
1479 /**
1480 * The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
1481 */
1482 MaxResults?: MaxResults;
1483 /**
1484 * The status of the stack sets that you want to get summary information about.
1485 */
1486 Status?: StackSetStatus;
1487 }
1488 export interface ListStackSetsOutput {
1489 /**
1490 * A list of StackSetSummary structures that contain information about the user's stack sets.
1491 */
1492 Summaries?: StackSetSummaries;
1493 /**
1494 * If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
1495 */
1496 NextToken?: NextToken;
1497 }
1498 export interface ListStacksInput {
1499 /**
1500 * A string that identifies the next page of stacks that you want to retrieve.
1501 */
1502 NextToken?: NextToken;
1503 /**
1504 * Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.
1505 */
1506 StackStatusFilter?: StackStatusFilter;
1507 }
1508 export interface ListStacksOutput {
1509 /**
1510 * A list of StackSummary structures containing information about the specified stacks.
1511 */
1512 StackSummaries?: StackSummaries;
1513 /**
1514 * 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.
1515 */
1516 NextToken?: NextToken;
1517 }
1518 export type LogicalResourceId = string;
1519 export type LogicalResourceIds = LogicalResourceId[];
1520 export type MaxConcurrentCount = number;
1521 export type MaxConcurrentPercentage = number;
1522 export type MaxResults = number;
1523 export type Metadata = string;
1524 export type MonitoringTimeInMinutes = number;
1525 export type NextToken = string;
1526 export type NoEcho = boolean;
1527 export type NotificationARN = string;
1528 export type NotificationARNs = NotificationARN[];
1529 export type OnFailure = "DO_NOTHING"|"ROLLBACK"|"DELETE"|string;
1530 export interface Output {
1531 /**
1532 * The key associated with the output.
1533 */
1534 OutputKey?: OutputKey;
1535 /**
1536 * The value associated with the output.
1537 */
1538 OutputValue?: OutputValue;
1539 /**
1540 * User defined description associated with the output.
1541 */
1542 Description?: Description;
1543 /**
1544 * The name of the export associated with the output.
1545 */
1546 ExportName?: ExportName;
1547 }
1548 export type OutputKey = string;
1549 export type OutputValue = string;
1550 export type Outputs = Output[];
1551 export interface Parameter {
1552 /**
1553 * The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
1554 */
1555 ParameterKey?: ParameterKey;
1556 /**
1557 * The input value associated with the parameter.
1558 */
1559 ParameterValue?: ParameterValue;
1560 /**
1561 * During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.
1562 */
1563 UsePreviousValue?: UsePreviousValue;
1564 /**
1565 * Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.
1566 */
1567 ResolvedValue?: ParameterValue;
1568 }
1569 export interface ParameterConstraints {
1570 /**
1571 * A list of values that are permitted for a parameter.
1572 */
1573 AllowedValues?: AllowedValues;
1574 }
1575 export interface ParameterDeclaration {
1576 /**
1577 * The name that is associated with the parameter.
1578 */
1579 ParameterKey?: ParameterKey;
1580 /**
1581 * The default value of the parameter.
1582 */
1583 DefaultValue?: ParameterValue;
1584 /**
1585 * The type of parameter.
1586 */
1587 ParameterType?: ParameterType;
1588 /**
1589 * Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
1590 */
1591 NoEcho?: NoEcho;
1592 /**
1593 * The description that is associate with the parameter.
1594 */
1595 Description?: Description;
1596 /**
1597 * The criteria that AWS CloudFormation uses to validate parameter values.
1598 */
1599 ParameterConstraints?: ParameterConstraints;
1600 }
1601 export type ParameterDeclarations = ParameterDeclaration[];
1602 export type ParameterKey = string;
1603 export type ParameterType = string;
1604 export type ParameterValue = string;
1605 export type Parameters = Parameter[];
1606 export type PhysicalResourceId = string;
1607 export type PhysicalResourceIdContext = PhysicalResourceIdContextKeyValuePair[];
1608 export interface PhysicalResourceIdContextKeyValuePair {
1609 /**
1610 * The resource context key.
1611 */
1612 Key: Key;
1613 /**
1614 * The resource context value.
1615 */
1616 Value: Value;
1617 }
1618 export type Properties = string;
1619 export interface PropertyDifference {
1620 /**
1621 * The fully-qualified path to the resource property.
1622 */
1623 PropertyPath: PropertyPath;
1624 /**
1625 * The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.
1626 */
1627 ExpectedValue: PropertyValue;
1628 /**
1629 * The actual property value of the resource property.
1630 */
1631 ActualValue: PropertyValue;
1632 /**
1633 * The type of property difference. ADD: A value has been added to a resource property that is an array or list data type. REMOVE: The property has been removed from the current resource configuration. NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).
1634 */
1635 DifferenceType: DifferenceType;
1636 }
1637 export type PropertyDifferences = PropertyDifference[];
1638 export type PropertyName = string;
1639 export type PropertyPath = string;
1640 export type PropertyValue = string;
1641 export type Reason = string;
1642 export type Region = string;
1643 export type RegionList = Region[];
1644 export type Replacement = "True"|"False"|"Conditional"|string;
1645 export type RequiresRecreation = "Never"|"Conditionally"|"Always"|string;
1646 export type ResourceAttribute = "Properties"|"Metadata"|"CreationPolicy"|"UpdatePolicy"|"DeletionPolicy"|"Tags"|string;
1647 export interface ResourceChange {
1648 /**
1649 * The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).
1650 */
1651 Action?: ChangeAction;
1652 /**
1653 * The resource's logical ID, which is defined in the stack's template.
1654 */
1655 LogicalResourceId?: LogicalResourceId;
1656 /**
1657 * The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
1658 */
1659 PhysicalResourceId?: PhysicalResourceId;
1660 /**
1661 * The type of AWS CloudFormation resource, such as AWS::S3::Bucket.
1662 */
1663 ResourceType?: ResourceType;
1664 /**
1665 * For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally. If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.
1666 */
1667 Replacement?: Replacement;
1668 /**
1669 * For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
1670 */
1671 Scope?: Scope;
1672 /**
1673 * For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.
1674 */
1675 Details?: ResourceChangeDetails;
1676 }
1677 export interface ResourceChangeDetail {
1678 /**
1679 * A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.
1680 */
1681 Target?: ResourceTargetDefinition;
1682 /**
1683 * Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set. For Static evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is a Static evaluation. For Dynamic evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is 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.
1684 */
1685 Evaluation?: EvaluationType;
1686 /**
1687 * The group to which the CausingEntity value belongs. There are five entity groups: ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }. ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }. ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }. DirectModification entities are changes that are made directly to the template. Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, AWS CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.
1688 */
1689 ChangeSource?: ChangeSource;
1690 /**
1691 * The identity of the entity that triggered this change. This entity is a member of the group that is specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName). If the ChangeSource value is DirectModification, no value is given for CausingEntity.
1692 */
1693 CausingEntity?: CausingEntity;
1694 }
1695 export type ResourceChangeDetails = ResourceChangeDetail[];
1696 export type ResourceProperties = string;
1697 export type ResourceSignalStatus = "SUCCESS"|"FAILURE"|string;
1698 export type ResourceSignalUniqueId = string;
1699 export type ResourceStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATE_COMPLETE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"DELETE_SKIPPED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|"UPDATE_COMPLETE"|string;
1700 export type ResourceStatusReason = string;
1701 export interface ResourceTargetDefinition {
1702 /**
1703 * Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
1704 */
1705 Attribute?: ResourceAttribute;
1706 /**
1707 * If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.
1708 */
1709 Name?: PropertyName;
1710 /**
1711 * If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the AWS CloudFormation User Guide.
1712 */
1713 RequiresRecreation?: RequiresRecreation;
1714 }
1715 export type ResourceToSkip = string;
1716 export type ResourceType = string;
1717 export type ResourceTypes = ResourceType[];
1718 export type ResourcesToSkip = ResourceToSkip[];
1719 export type RetainResources = LogicalResourceId[];
1720 export type RetainStacks = boolean;
1721 export type RetainStacksNullable = boolean;
1722 export type RoleARN = string;
1723 export interface RollbackConfiguration {
1724 /**
1725 * The triggers to monitor during stack creation or update actions. By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means: To use the rollback triggers previously specified for this stack, if any, don't specify this parameter. To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack. To remove all currently specified triggers, specify an empty list for this parameter. If a specified trigger is missing, the entire stack operation fails and is rolled back.
1726 */
1727 RollbackTriggers?: RollbackTriggers;
1728 /**
1729 * The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. The default is 0 minutes. If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary. If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.
1730 */
1731 MonitoringTimeInMinutes?: MonitoringTimeInMinutes;
1732 }
1733 export interface RollbackTrigger {
1734 /**
1735 * The Amazon Resource Name (ARN) of the rollback trigger. If a specified trigger is missing, the entire stack operation fails and is rolled back.
1736 */
1737 Arn: Arn;
1738 /**
1739 * The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.
1740 */
1741 Type: Type;
1742 }
1743 export type RollbackTriggers = RollbackTrigger[];
1744 export type Scope = ResourceAttribute[];
1745 export interface SetStackPolicyInput {
1746 /**
1747 * The name or unique stack ID that you want to associate a policy with.
1748 */
1749 StackName: StackName;
1750 /**
1751 * Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
1752 */
1753 StackPolicyBody?: StackPolicyBody;
1754 /**
1755 * Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
1756 */
1757 StackPolicyURL?: StackPolicyURL;
1758 }
1759 export interface SignalResourceInput {
1760 /**
1761 * The stack name or unique stack ID that includes the resource that you want to signal.
1762 */
1763 StackName: StackNameOrId;
1764 /**
1765 * 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.
1766 */
1767 LogicalResourceId: LogicalResourceId;
1768 /**
1769 * 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.
1770 */
1771 UniqueId: ResourceSignalUniqueId;
1772 /**
1773 * The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.
1774 */
1775 Status: ResourceSignalStatus;
1776 }
1777 export interface Stack {
1778 /**
1779 * Unique identifier of the stack.
1780 */
1781 StackId?: StackId;
1782 /**
1783 * The name associated with the stack.
1784 */
1785 StackName: StackName;
1786 /**
1787 * The unique ID of the change set.
1788 */
1789 ChangeSetId?: ChangeSetId;
1790 /**
1791 * A user-defined description associated with the stack.
1792 */
1793 Description?: Description;
1794 /**
1795 * A list of Parameter structures.
1796 */
1797 Parameters?: Parameters;
1798 /**
1799 * The time at which the stack was created.
1800 */
1801 CreationTime: CreationTime;
1802 /**
1803 * The time the stack was deleted.
1804 */
1805 DeletionTime?: DeletionTime;
1806 /**
1807 * The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
1808 */
1809 LastUpdatedTime?: LastUpdatedTime;
1810 /**
1811 * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
1812 */
1813 RollbackConfiguration?: RollbackConfiguration;
1814 /**
1815 * Current status of the stack.
1816 */
1817 StackStatus: StackStatus;
1818 /**
1819 * Success/failure message associated with the stack status.
1820 */
1821 StackStatusReason?: StackStatusReason;
1822 /**
1823 * Boolean to enable or disable rollback on stack creation failures: true: disable rollback false: enable rollback
1824 */
1825 DisableRollback?: DisableRollback;
1826 /**
1827 * SNS topic ARNs to which stack related events are published.
1828 */
1829 NotificationARNs?: NotificationARNs;
1830 /**
1831 * The amount of time within which stack creation should complete.
1832 */
1833 TimeoutInMinutes?: TimeoutMinutes;
1834 /**
1835 * The capabilities allowed in the stack.
1836 */
1837 Capabilities?: Capabilities;
1838 /**
1839 * A list of output structures.
1840 */
1841 Outputs?: Outputs;
1842 /**
1843 * The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
1844 */
1845 RoleARN?: RoleARN;
1846 /**
1847 * A list of Tags that specify information about the stack.
1848 */
1849 Tags?: Tags;
1850 /**
1851 * Whether termination protection is enabled for the stack. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
1852 */
1853 EnableTerminationProtection?: EnableTerminationProtection;
1854 /**
1855 * For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
1856 */
1857 ParentId?: StackId;
1858 /**
1859 * For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
1860 */
1861 RootId?: StackId;
1862 /**
1863 * Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
1864 */
1865 DriftInformation?: StackDriftInformation;
1866 }
1867 export type StackDriftDetectionId = string;
1868 export type StackDriftDetectionStatus = "DETECTION_IN_PROGRESS"|"DETECTION_FAILED"|"DETECTION_COMPLETE"|string;
1869 export type StackDriftDetectionStatusReason = string;
1870 export interface StackDriftInformation {
1871 /**
1872 * Status of the stack's actual configuration compared to its expected template configuration. DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration. IN_SYNC: The stack's actual configuration matches its expected template configuration. UNKNOWN: This value is reserved for future use.
1873 */
1874 StackDriftStatus: StackDriftStatus;
1875 /**
1876 * Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
1877 */
1878 LastCheckTimestamp?: Timestamp;
1879 }
1880 export interface StackDriftInformationSummary {
1881 /**
1882 * Status of the stack's actual configuration compared to its expected template configuration. DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration. IN_SYNC: The stack's actual configuration matches its expected template configuration. UNKNOWN: This value is reserved for future use.
1883 */
1884 StackDriftStatus: StackDriftStatus;
1885 /**
1886 * Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
1887 */
1888 LastCheckTimestamp?: Timestamp;
1889 }
1890 export type StackDriftStatus = "DRIFTED"|"IN_SYNC"|"UNKNOWN"|"NOT_CHECKED"|string;
1891 export interface StackEvent {
1892 /**
1893 * The unique ID name of the instance of the stack.
1894 */
1895 StackId: StackId;
1896 /**
1897 * The unique ID of this event.
1898 */
1899 EventId: EventId;
1900 /**
1901 * The name associated with a stack.
1902 */
1903 StackName: StackName;
1904 /**
1905 * The logical name of the resource specified in the template.
1906 */
1907 LogicalResourceId?: LogicalResourceId;
1908 /**
1909 * The name or unique identifier associated with the physical instance of the resource.
1910 */
1911 PhysicalResourceId?: PhysicalResourceId;
1912 /**
1913 * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
1914 */
1915 ResourceType?: ResourceType;
1916 /**
1917 * Time the status was updated.
1918 */
1919 Timestamp: Timestamp;
1920 /**
1921 * Current status of the resource.
1922 */
1923 ResourceStatus?: ResourceStatus;
1924 /**
1925 * Success/failure message associated with the resource.
1926 */
1927 ResourceStatusReason?: ResourceStatusReason;
1928 /**
1929 * BLOB of the properties used to create the resource.
1930 */
1931 ResourceProperties?: ResourceProperties;
1932 /**
1933 * The token passed to the operation that generated this event. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
1934 */
1935 ClientRequestToken?: ClientRequestToken;
1936 }
1937 export type StackEvents = StackEvent[];
1938 export type StackId = string;
1939 export interface StackInstance {
1940 /**
1941 * The name or unique ID of the stack set that the stack instance is associated with.
1942 */
1943 StackSetId?: StackSetId;
1944 /**
1945 * The name of the AWS region that the stack instance is associated with.
1946 */
1947 Region?: Region;
1948 /**
1949 * The name of the AWS account that the stack instance is associated with.
1950 */
1951 Account?: Account;
1952 /**
1953 * The ID of the stack instance.
1954 */
1955 StackId?: StackId;
1956 /**
1957 * A list of parameters from the stack set template whose values have been overridden in this stack instance.
1958 */
1959 ParameterOverrides?: Parameters;
1960 /**
1961 * The status of the stack instance, in terms of its synchronization with its associated stack set. INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. OUTDATED: The stack isn't currently up to date with the stack set because: The associated stack failed during a CreateStackSet or UpdateStackSet operation. The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated. CURRENT: The stack is currently up to date with the stack set.
1962 */
1963 Status?: StackInstanceStatus;
1964 /**
1965 * The explanation for the specific status code that is assigned to this stack instance.
1966 */
1967 StatusReason?: Reason;
1968 }
1969 export type StackInstanceStatus = "CURRENT"|"OUTDATED"|"INOPERABLE"|string;
1970 export type StackInstanceSummaries = StackInstanceSummary[];
1971 export interface StackInstanceSummary {
1972 /**
1973 * The name or unique ID of the stack set that the stack instance is associated with.
1974 */
1975 StackSetId?: StackSetId;
1976 /**
1977 * The name of the AWS region that the stack instance is associated with.
1978 */
1979 Region?: Region;
1980 /**
1981 * The name of the AWS account that the stack instance is associated with.
1982 */
1983 Account?: Account;
1984 /**
1985 * The ID of the stack instance.
1986 */
1987 StackId?: StackId;
1988 /**
1989 * The status of the stack instance, in terms of its synchronization with its associated stack set. INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. OUTDATED: The stack isn't currently up to date with the stack set because: The associated stack failed during a CreateStackSet or UpdateStackSet operation. The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated. CURRENT: The stack is currently up to date with the stack set.
1990 */
1991 Status?: StackInstanceStatus;
1992 /**
1993 * The explanation for the specific status code assigned to this stack instance.
1994 */
1995 StatusReason?: Reason;
1996 }
1997 export type StackName = string;
1998 export type StackNameOrId = string;
1999 export type StackPolicyBody = string;
2000 export type StackPolicyDuringUpdateBody = string;
2001 export type StackPolicyDuringUpdateURL = string;
2002 export type StackPolicyURL = string;
2003 export interface StackResource {
2004 /**
2005 * The name associated with the stack.
2006 */
2007 StackName?: StackName;
2008 /**
2009 * Unique identifier of the stack.
2010 */
2011 StackId?: StackId;
2012 /**
2013 * The logical name of the resource specified in the template.
2014 */
2015 LogicalResourceId: LogicalResourceId;
2016 /**
2017 * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
2018 */
2019 PhysicalResourceId?: PhysicalResourceId;
2020 /**
2021 * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
2022 */
2023 ResourceType: ResourceType;
2024 /**
2025 * Time the status was updated.
2026 */
2027 Timestamp: Timestamp;
2028 /**
2029 * Current status of the resource.
2030 */
2031 ResourceStatus: ResourceStatus;
2032 /**
2033 * Success/failure message associated with the resource.
2034 */
2035 ResourceStatusReason?: ResourceStatusReason;
2036 /**
2037 * User defined description associated with the resource.
2038 */
2039 Description?: Description;
2040 /**
2041 * Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
2042 */
2043 DriftInformation?: StackResourceDriftInformation;
2044 }
2045 export interface StackResourceDetail {
2046 /**
2047 * The name associated with the stack.
2048 */
2049 StackName?: StackName;
2050 /**
2051 * Unique identifier of the stack.
2052 */
2053 StackId?: StackId;
2054 /**
2055 * The logical name of the resource specified in the template.
2056 */
2057 LogicalResourceId: LogicalResourceId;
2058 /**
2059 * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
2060 */
2061 PhysicalResourceId?: PhysicalResourceId;
2062 /**
2063 * Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
2064 */
2065 ResourceType: ResourceType;
2066 /**
2067 * Time the status was updated.
2068 */
2069 LastUpdatedTimestamp: Timestamp;
2070 /**
2071 * Current status of the resource.
2072 */
2073 ResourceStatus: ResourceStatus;
2074 /**
2075 * Success/failure message associated with the resource.
2076 */
2077 ResourceStatusReason?: ResourceStatusReason;
2078 /**
2079 * User defined description associated with the resource.
2080 */
2081 Description?: Description;
2082 /**
2083 * The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.
2084 */
2085 Metadata?: Metadata;
2086 /**
2087 * Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
2088 */
2089 DriftInformation?: StackResourceDriftInformation;
2090 }
2091 export interface StackResourceDrift {
2092 /**
2093 * The ID of the stack.
2094 */
2095 StackId: StackId;
2096 /**
2097 * The logical name of the resource specified in the template.
2098 */
2099 LogicalResourceId: LogicalResourceId;
2100 /**
2101 * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
2102 */
2103 PhysicalResourceId?: PhysicalResourceId;
2104 /**
2105 * Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.
2106 */
2107 PhysicalResourceIdContext?: PhysicalResourceIdContext;
2108 /**
2109 * The type of the resource.
2110 */
2111 ResourceType: ResourceType;
2112 /**
2113 * A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters. For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.
2114 */
2115 ExpectedProperties?: Properties;
2116 /**
2117 * A JSON structure containing the actual property values of the stack resource. For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.
2118 */
2119 ActualProperties?: Properties;
2120 /**
2121 * A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.
2122 */
2123 PropertyDifferences?: PropertyDifferences;
2124 /**
2125 * Status of the resource's actual configuration compared to its expected configuration DELETED: The resource differs from its expected template configuration because the resource has been deleted. MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters). IN_SYNC: The resources's actual configuration matches its expected template configuration. NOT_CHECKED: AWS CloudFormation does not currently return this value.
2126 */
2127 StackResourceDriftStatus: StackResourceDriftStatus;
2128 /**
2129 * Time at which AWS CloudFormation performed drift detection on the stack resource.
2130 */
2131 Timestamp: Timestamp;
2132 }
2133 export interface StackResourceDriftInformation {
2134 /**
2135 * Status of the resource's actual configuration compared to its expected configuration DELETED: The resource differs from its expected configuration in that it has been deleted. MODIFIED: The resource differs from its expected configuration. NOT_CHECKED: AWS CloudFormation has not checked if the resource differs from its expected configuration. Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. IN_SYNC: The resources's actual configuration matches its expected configuration.
2136 */
2137 StackResourceDriftStatus: StackResourceDriftStatus;
2138 /**
2139 * When AWS CloudFormation last checked if the resource had drifted from its expected configuration.
2140 */
2141 LastCheckTimestamp?: Timestamp;
2142 }
2143 export interface StackResourceDriftInformationSummary {
2144 /**
2145 * Status of the resource's actual configuration compared to its expected configuration DELETED: The resource differs from its expected configuration in that it has been deleted. MODIFIED: The resource differs from its expected configuration. NOT_CHECKED: AWS CloudFormation has not checked if the resource differs from its expected configuration. Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information on skipping resources during rollback operations, see Continue Rolling Back an Update in the AWS CloudFormation User Guide. IN_SYNC: The resources's actual configuration matches its expected configuration.
2146 */
2147 StackResourceDriftStatus: StackResourceDriftStatus;
2148 /**
2149 * When AWS CloudFormation last checked if the resource had drifted from its expected configuration.
2150 */
2151 LastCheckTimestamp?: Timestamp;
2152 }
2153 export type StackResourceDriftStatus = "IN_SYNC"|"MODIFIED"|"DELETED"|"NOT_CHECKED"|string;
2154 export type StackResourceDriftStatusFilters = StackResourceDriftStatus[];
2155 export type StackResourceDrifts = StackResourceDrift[];
2156 export type StackResourceSummaries = StackResourceSummary[];
2157 export interface StackResourceSummary {
2158 /**
2159 * The logical name of the resource specified in the template.
2160 */
2161 LogicalResourceId: LogicalResourceId;
2162 /**
2163 * The name or unique identifier that corresponds to a physical instance ID of the resource.
2164 */
2165 PhysicalResourceId?: PhysicalResourceId;
2166 /**
2167 * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
2168 */
2169 ResourceType: ResourceType;
2170 /**
2171 * Time the status was updated.
2172 */
2173 LastUpdatedTimestamp: Timestamp;
2174 /**
2175 * Current status of the resource.
2176 */
2177 ResourceStatus: ResourceStatus;
2178 /**
2179 * Success/failure message associated with the resource.
2180 */
2181 ResourceStatusReason?: ResourceStatusReason;
2182 /**
2183 * Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
2184 */
2185 DriftInformation?: StackResourceDriftInformationSummary;
2186 }
2187 export type StackResources = StackResource[];
2188 export interface StackSet {
2189 /**
2190 * The name that's associated with the stack set.
2191 */
2192 StackSetName?: StackSetName;
2193 /**
2194 * The ID of the stack set.
2195 */
2196 StackSetId?: StackSetId;
2197 /**
2198 * A description of the stack set that you specify when the stack set is created or updated.
2199 */
2200 Description?: Description;
2201 /**
2202 * The status of the stack set.
2203 */
2204 Status?: StackSetStatus;
2205 /**
2206 * The structure that contains the body of the template that was used to create or update the stack set.
2207 */
2208 TemplateBody?: TemplateBody;
2209 /**
2210 * A list of input parameters for a stack set.
2211 */
2212 Parameters?: Parameters;
2213 /**
2214 * The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
2215 */
2216 Capabilities?: Capabilities;
2217 /**
2218 * A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
2219 */
2220 Tags?: Tags;
2221 /**
2222 * The Amazon Resource Number (ARN) of the stack set.
2223 */
2224 StackSetARN?: StackSetARN;
2225 /**
2226 * The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
2227 */
2228 AdministrationRoleARN?: RoleARN;
2229 /**
2230 * The name of the IAM execution role used to create or update the stack set. Use customized execution roles to control which stack resources users and groups can include in their stack sets.
2231 */
2232 ExecutionRoleName?: ExecutionRoleName;
2233 }
2234 export type StackSetARN = string;
2235 export type StackSetId = string;
2236 export type StackSetName = string;
2237 export type StackSetNameOrId = string;
2238 export interface StackSetOperation {
2239 /**
2240 * The unique ID of a stack set operation.
2241 */
2242 OperationId?: ClientRequestToken;
2243 /**
2244 * The ID of the stack set.
2245 */
2246 StackSetId?: StackSetId;
2247 /**
2248 * The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.
2249 */
2250 Action?: StackSetOperationAction;
2251 /**
2252 * The status of the operation. FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining regions. RUNNING: The operation is currently being performed. STOPPED: The user has cancelled the operation. STOPPING: The operation is in the process of stopping, at user request. SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
2253 */
2254 Status?: StackSetOperationStatus;
2255 /**
2256 * The preferences for how AWS CloudFormation performs this stack set operation.
2257 */
2258 OperationPreferences?: StackSetOperationPreferences;
2259 /**
2260 * For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add an existing, saved stack to a new stack set.
2261 */
2262 RetainStacks?: RetainStacksNullable;
2263 /**
2264 * The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the AWS CloudFormation User Guide.
2265 */
2266 AdministrationRoleARN?: RoleARN;
2267 /**
2268 * The name of the IAM execution role used to create or update the stack set. Use customized execution roles to control which stack resources users and groups can include in their stack sets.
2269 */
2270 ExecutionRoleName?: ExecutionRoleName;
2271 /**
2272 * The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.
2273 */
2274 CreationTimestamp?: Timestamp;
2275 /**
2276 * The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.
2277 */
2278 EndTimestamp?: Timestamp;
2279 }
2280 export type StackSetOperationAction = "CREATE"|"UPDATE"|"DELETE"|string;
2281 export interface StackSetOperationPreferences {
2282 /**
2283 * The order of the regions in where you want to perform the stack operation.
2284 */
2285 RegionOrder?: RegionList;
2286 /**
2287 * The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).
2288 */
2289 FailureToleranceCount?: FailureToleranceCount;
2290 /**
2291 * The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.
2292 */
2293 FailureTolerancePercentage?: FailureTolerancePercentage;
2294 /**
2295 * The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount . Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
2296 */
2297 MaxConcurrentCount?: MaxConcurrentCount;
2298 /**
2299 * The maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS 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. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
2300 */
2301 MaxConcurrentPercentage?: MaxConcurrentPercentage;
2302 }
2303 export type StackSetOperationResultStatus = "PENDING"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED"|string;
2304 export type StackSetOperationResultSummaries = StackSetOperationResultSummary[];
2305 export interface StackSetOperationResultSummary {
2306 /**
2307 * The name of the AWS account for this operation result.
2308 */
2309 Account?: Account;
2310 /**
2311 * The name of the AWS region for this operation result.
2312 */
2313 Region?: Region;
2314 /**
2315 * The result status of the stack set operation for the given account in the given region. CANCELLED: The operation in the specified account and region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded. FAILED: The operation in the specified account and region failed. If the stack set operation fails in enough accounts within a region, the failure tolerance for the stack set operation as a whole might be exceeded. RUNNING: The operation in the specified account and region is currently in progress. PENDING: The operation in the specified account and region has yet to start. SUCCEEDED: The operation in the specified account and region completed successfully.
2316 */
2317 Status?: StackSetOperationResultStatus;
2318 /**
2319 * The reason for the assigned result status.
2320 */
2321 StatusReason?: Reason;
2322 /**
2323 * The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account
2324 */
2325 AccountGateResult?: AccountGateResult;
2326 }
2327 export type StackSetOperationStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|"STOPPING"|"STOPPED"|string;
2328 export type StackSetOperationSummaries = StackSetOperationSummary[];
2329 export interface StackSetOperationSummary {
2330 /**
2331 * The unique ID of the stack set operation.
2332 */
2333 OperationId?: ClientRequestToken;
2334 /**
2335 * The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself as well as all associated stack set instances.
2336 */
2337 Action?: StackSetOperationAction;
2338 /**
2339 * The overall status of the operation. FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining regions. RUNNING: The operation is currently being performed. STOPPED: The user has cancelled the operation. STOPPING: The operation is in the process of stopping, at user request. SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
2340 */
2341 Status?: StackSetOperationStatus;
2342 /**
2343 * The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.
2344 */
2345 CreationTimestamp?: Timestamp;
2346 /**
2347 * The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.
2348 */
2349 EndTimestamp?: Timestamp;
2350 }
2351 export type StackSetStatus = "ACTIVE"|"DELETED"|string;
2352 export type StackSetSummaries = StackSetSummary[];
2353 export interface StackSetSummary {
2354 /**
2355 * The name of the stack set.
2356 */
2357 StackSetName?: StackSetName;
2358 /**
2359 * The ID of the stack set.
2360 */
2361 StackSetId?: StackSetId;
2362 /**
2363 * A description of the stack set that you specify when the stack set is created or updated.
2364 */
2365 Description?: Description;
2366 /**
2367 * The status of the stack set.
2368 */
2369 Status?: StackSetStatus;
2370 }
2371 export type StackStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATE_COMPLETE"|"ROLLBACK_IN_PROGRESS"|"ROLLBACK_FAILED"|"ROLLBACK_COMPLETE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"UPDATE_IN_PROGRESS"|"UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"|"UPDATE_COMPLETE"|"UPDATE_ROLLBACK_IN_PROGRESS"|"UPDATE_ROLLBACK_FAILED"|"UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"|"UPDATE_ROLLBACK_COMPLETE"|"REVIEW_IN_PROGRESS"|string;
2372 export type StackStatusFilter = StackStatus[];
2373 export type StackStatusReason = string;
2374 export type StackSummaries = StackSummary[];
2375 export interface StackSummary {
2376 /**
2377 * Unique stack identifier.
2378 */
2379 StackId?: StackId;
2380 /**
2381 * The name associated with the stack.
2382 */
2383 StackName: StackName;
2384 /**
2385 * The template description of the template used to create the stack.
2386 */
2387 TemplateDescription?: TemplateDescription;
2388 /**
2389 * The time the stack was created.
2390 */
2391 CreationTime: CreationTime;
2392 /**
2393 * The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
2394 */
2395 LastUpdatedTime?: LastUpdatedTime;
2396 /**
2397 * The time the stack was deleted.
2398 */
2399 DeletionTime?: DeletionTime;
2400 /**
2401 * The current status of the stack.
2402 */
2403 StackStatus: StackStatus;
2404 /**
2405 * Success/Failure message associated with the stack status.
2406 */
2407 StackStatusReason?: StackStatusReason;
2408 /**
2409 * For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
2410 */
2411 ParentId?: StackId;
2412 /**
2413 * For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
2414 */
2415 RootId?: StackId;
2416 /**
2417 * Summarizes information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
2418 */
2419 DriftInformation?: StackDriftInformationSummary;
2420 }
2421 export type Stacks = Stack[];
2422 export type StageList = TemplateStage[];
2423 export interface StopStackSetOperationInput {
2424 /**
2425 * The name or unique ID of the stack set that you want to stop the operation for.
2426 */
2427 StackSetName: StackSetName;
2428 /**
2429 * The ID of the stack operation.
2430 */
2431 OperationId: ClientRequestToken;
2432 }
2433 export interface StopStackSetOperationOutput {
2434 }
2435 export interface Tag {
2436 /**
2437 * Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.
2438 */
2439 Key: TagKey;
2440 /**
2441 * Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
2442 */
2443 Value: TagValue;
2444 }
2445 export type TagKey = string;
2446 export type TagValue = string;
2447 export type Tags = Tag[];
2448 export type TemplateBody = string;
2449 export type TemplateDescription = string;
2450 export interface TemplateParameter {
2451 /**
2452 * The name associated with the parameter.
2453 */
2454 ParameterKey?: ParameterKey;
2455 /**
2456 * The default value associated with the parameter.
2457 */
2458 DefaultValue?: ParameterValue;
2459 /**
2460 * Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
2461 */
2462 NoEcho?: NoEcho;
2463 /**
2464 * User defined description associated with the parameter.
2465 */
2466 Description?: Description;
2467 }
2468 export type TemplateParameters = TemplateParameter[];
2469 export type TemplateStage = "Original"|"Processed"|string;
2470 export type TemplateURL = string;
2471 export type TimeoutMinutes = number;
2472 export type Timestamp = Date;
2473 export type TransformName = string;
2474 export type TransformsList = TransformName[];
2475 export type Type = string;
2476 export interface UpdateStackInput {
2477 /**
2478 * The name or unique stack ID of the stack to update.
2479 */
2480 StackName: StackName;
2481 /**
2482 * Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
2483 */
2484 TemplateBody?: TemplateBody;
2485 /**
2486 * Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
2487 */
2488 TemplateURL?: TemplateURL;
2489 /**
2490 * Reuse the existing template that is associated with the stack that you are updating. Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
2491 */
2492 UsePreviousTemplate?: UsePreviousTemplate;
2493 /**
2494 * Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
2495 */
2496 StackPolicyDuringUpdateBody?: StackPolicyDuringUpdateBody;
2497 /**
2498 * Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
2499 */
2500 StackPolicyDuringUpdateURL?: StackPolicyDuringUpdateURL;
2501 /**
2502 * A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
2503 */
2504 Parameters?: Parameters;
2505 /**
2506 * In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation. Change sets do not currently support nested stacks. If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability. You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs. Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
2507 */
2508 Capabilities?: Capabilities;
2509 /**
2510 * The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
2511 */
2512 ResourceTypes?: ResourceTypes;
2513 /**
2514 * The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
2515 */
2516 RoleARN?: RoleARN;
2517 /**
2518 * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
2519 */
2520 RollbackConfiguration?: RollbackConfiguration;
2521 /**
2522 * Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
2523 */
2524 StackPolicyBody?: StackPolicyBody;
2525 /**
2526 * Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
2527 */
2528 StackPolicyURL?: StackPolicyURL;
2529 /**
2530 * Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
2531 */
2532 NotificationARNs?: NotificationARNs;
2533 /**
2534 * Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags. If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
2535 */
2536 Tags?: Tags;
2537 /**
2538 * A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
2539 */
2540 ClientRequestToken?: ClientRequestToken;
2541 }
2542 export interface UpdateStackInstancesInput {
2543 /**
2544 * The name or unique ID of the stack set associated with the stack instances.
2545 */
2546 StackSetName: StackSetNameOrId;
2547 /**
2548 * The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.
2549 */
2550 Accounts: AccountList;
2551 /**
2552 * The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.
2553 */
2554 Regions: RegionList;
2555 /**
2556 * A list of input parameters whose values you want to update for the specified stack instances. Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations: To override the current value for a parameter, include the parameter and specify its value. To leave a parameter set to its present value, you can do one of the following: Do not include the parameter in the list. Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.) To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters. To leave all parameters set to their present values, do not specify this property at all. During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value. You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
2557 */
2558 ParameterOverrides?: Parameters;
2559 /**
2560 * Preferences for how AWS CloudFormation performs this stack set operation.
2561 */
2562 OperationPreferences?: StackSetOperationPreferences;
2563 /**
2564 * The unique identifier for this stack set operation. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically.
2565 */
2566 OperationId?: ClientRequestToken;
2567 }
2568 export interface UpdateStackInstancesOutput {
2569 /**
2570 * The unique identifier for this stack set operation.
2571 */
2572 OperationId?: ClientRequestToken;
2573 }
2574 export interface UpdateStackOutput {
2575 /**
2576 * Unique identifier of the stack.
2577 */
2578 StackId?: StackId;
2579 }
2580 export interface UpdateStackSetInput {
2581 /**
2582 * The name or unique ID of the stack set that you want to update.
2583 */
2584 StackSetName: StackSetName;
2585 /**
2586 * A brief description of updates that you are making.
2587 */
2588 Description?: Description;
2589 /**
2590 * The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
2591 */
2592 TemplateBody?: TemplateBody;
2593 /**
2594 * The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
2595 */
2596 TemplateURL?: TemplateURL;
2597 /**
2598 * Use the existing template that's associated with the stack set that you're updating. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
2599 */
2600 UsePreviousTemplate?: UsePreviousTemplate;
2601 /**
2602 * A list of input parameters for the stack set template.
2603 */
2604 Parameters?: Parameters;
2605 /**
2606 * In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates. Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
2607 */
2608 Capabilities?: Capabilities;
2609 /**
2610 * The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags. If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means: If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well. If you specify an empty value, AWS CloudFormation removes all currently associated tags. If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
2611 */
2612 Tags?: Tags;
2613 /**
2614 * Preferences for how AWS CloudFormation performs this stack set operation.
2615 */
2616 OperationPreferences?: StackSetOperationPreferences;
2617 /**
2618 * The Amazon Resource Number (ARN) of the IAM role to use to update this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the AWS CloudFormation User Guide. If you specify a customized administrator role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized administrator role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
2619 */
2620 AdministrationRoleARN?: RoleARN;
2621 /**
2622 * The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation. Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
2623 */
2624 ExecutionRoleName?: ExecutionRoleName;
2625 /**
2626 * The unique ID for this stack set operation. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, AWS CloudFormation generates one automatically. Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
2627 */
2628 OperationId?: ClientRequestToken;
2629 /**
2630 * The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances. To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties. If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
2631 */
2632 Accounts?: AccountList;
2633 /**
2634 * The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances. To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties. If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.
2635 */
2636 Regions?: RegionList;
2637 }
2638 export interface UpdateStackSetOutput {
2639 /**
2640 * The unique ID for this stack set operation.
2641 */
2642 OperationId?: ClientRequestToken;
2643 }
2644 export interface UpdateTerminationProtectionInput {
2645 /**
2646 * Whether to enable termination protection on the specified stack.
2647 */
2648 EnableTerminationProtection: EnableTerminationProtection;
2649 /**
2650 * The name or unique ID of the stack for which you want to set termination protection.
2651 */
2652 StackName: StackNameOrId;
2653 }
2654 export interface UpdateTerminationProtectionOutput {
2655 /**
2656 * The unique ID of the stack.
2657 */
2658 StackId?: StackId;
2659 }
2660 export type Url = string;
2661 export type UsePreviousTemplate = boolean;
2662 export type UsePreviousValue = boolean;
2663 export interface ValidateTemplateInput {
2664 /**
2665 * Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
2666 */
2667 TemplateBody?: TemplateBody;
2668 /**
2669 * Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
2670 */
2671 TemplateURL?: TemplateURL;
2672 }
2673 export interface ValidateTemplateOutput {
2674 /**
2675 * A list of TemplateParameter structures.
2676 */
2677 Parameters?: TemplateParameters;
2678 /**
2679 * The description found within the template.
2680 */
2681 Description?: Description;
2682 /**
2683 * The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
2684 */
2685 Capabilities?: Capabilities;
2686 /**
2687 * The list of resources that generated the values in the Capabilities response element.
2688 */
2689 CapabilitiesReason?: CapabilitiesReason;
2690 /**
2691 * A list of the transforms that are declared in the template.
2692 */
2693 DeclaredTransforms?: TransformsList;
2694 }
2695 export type Value = string;
2696 export type Version = string;
2697 /**
2698 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2699 */
2700 export type apiVersion = "2010-05-15"|"latest"|string;
2701 export interface ClientApiVersions {
2702 /**
2703 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2704 */
2705 apiVersion?: apiVersion;
2706 }
2707 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2708 /**
2709 * Contains interfaces for use with the CloudFormation client.
2710 */
2711 export import Types = CloudFormation;
2712}
2713export = CloudFormation;