UNPKG

260 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. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action. 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. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action. 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. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
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. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
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 * Removes a type or type version from active use in the CloudFormation registry. If a type or type version is deregistered, it cannot be used in CloudFormation operations. To deregister a type, you must individually deregister all registered versions of that type. If a type has only a single registered version, deregistering that version results in the type itself being deregistered. You cannot deregister the default version of a type, unless it is the only registered version of that type, in which case the type itself is deregistered as well.
97 */
98 deregisterType(params: CloudFormation.Types.DeregisterTypeInput, callback?: (err: AWSError, data: CloudFormation.Types.DeregisterTypeOutput) => void): Request<CloudFormation.Types.DeregisterTypeOutput, AWSError>;
99 /**
100 * Removes a type or type version from active use in the CloudFormation registry. If a type or type version is deregistered, it cannot be used in CloudFormation operations. To deregister a type, you must individually deregister all registered versions of that type. If a type has only a single registered version, deregistering that version results in the type itself being deregistered. You cannot deregister the default version of a type, unless it is the only registered version of that type, in which case the type itself is deregistered as well.
101 */
102 deregisterType(callback?: (err: AWSError, data: CloudFormation.Types.DeregisterTypeOutput) => void): Request<CloudFormation.Types.DeregisterTypeOutput, AWSError>;
103 /**
104 * Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide.
105 */
106 describeAccountLimits(params: CloudFormation.Types.DescribeAccountLimitsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeAccountLimitsOutput) => void): Request<CloudFormation.Types.DescribeAccountLimitsOutput, AWSError>;
107 /**
108 * Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide.
109 */
110 describeAccountLimits(callback?: (err: AWSError, data: CloudFormation.Types.DescribeAccountLimitsOutput) => void): Request<CloudFormation.Types.DescribeAccountLimitsOutput, AWSError>;
111 /**
112 * 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.
113 */
114 describeChangeSet(params: CloudFormation.Types.DescribeChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
115 /**
116 * 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.
117 */
118 describeChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
119 /**
120 * 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.
121 */
122 describeStackDriftDetectionStatus(params: CloudFormation.Types.DescribeStackDriftDetectionStatusInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackDriftDetectionStatusOutput) => void): Request<CloudFormation.Types.DescribeStackDriftDetectionStatusOutput, AWSError>;
123 /**
124 * 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.
125 */
126 describeStackDriftDetectionStatus(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackDriftDetectionStatusOutput) => void): Request<CloudFormation.Types.DescribeStackDriftDetectionStatusOutput, AWSError>;
127 /**
128 * 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).
129 */
130 describeStackEvents(params: CloudFormation.Types.DescribeStackEventsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackEventsOutput) => void): Request<CloudFormation.Types.DescribeStackEventsOutput, AWSError>;
131 /**
132 * 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).
133 */
134 describeStackEvents(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackEventsOutput) => void): Request<CloudFormation.Types.DescribeStackEventsOutput, AWSError>;
135 /**
136 * 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.
137 */
138 describeStackInstance(params: CloudFormation.Types.DescribeStackInstanceInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackInstanceOutput) => void): Request<CloudFormation.Types.DescribeStackInstanceOutput, AWSError>;
139 /**
140 * 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.
141 */
142 describeStackInstance(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackInstanceOutput) => void): Request<CloudFormation.Types.DescribeStackInstanceOutput, AWSError>;
143 /**
144 * 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.
145 */
146 describeStackResource(params: CloudFormation.Types.DescribeStackResourceInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceOutput) => void): Request<CloudFormation.Types.DescribeStackResourceOutput, AWSError>;
147 /**
148 * 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.
149 */
150 describeStackResource(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceOutput) => void): Request<CloudFormation.Types.DescribeStackResourceOutput, AWSError>;
151 /**
152 * 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.
153 */
154 describeStackResourceDrifts(params: CloudFormation.Types.DescribeStackResourceDriftsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceDriftsOutput) => void): Request<CloudFormation.Types.DescribeStackResourceDriftsOutput, AWSError>;
155 /**
156 * 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.
157 */
158 describeStackResourceDrifts(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceDriftsOutput) => void): Request<CloudFormation.Types.DescribeStackResourceDriftsOutput, AWSError>;
159 /**
160 * 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.
161 */
162 describeStackResources(params: CloudFormation.Types.DescribeStackResourcesInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourcesOutput) => void): Request<CloudFormation.Types.DescribeStackResourcesOutput, AWSError>;
163 /**
164 * 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.
165 */
166 describeStackResources(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourcesOutput) => void): Request<CloudFormation.Types.DescribeStackResourcesOutput, AWSError>;
167 /**
168 * Returns the description of the specified stack set.
169 */
170 describeStackSet(params: CloudFormation.Types.DescribeStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOutput) => void): Request<CloudFormation.Types.DescribeStackSetOutput, AWSError>;
171 /**
172 * Returns the description of the specified stack set.
173 */
174 describeStackSet(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOutput) => void): Request<CloudFormation.Types.DescribeStackSetOutput, AWSError>;
175 /**
176 * Returns the description of the specified stack set operation.
177 */
178 describeStackSetOperation(params: CloudFormation.Types.DescribeStackSetOperationInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOperationOutput) => void): Request<CloudFormation.Types.DescribeStackSetOperationOutput, AWSError>;
179 /**
180 * Returns the description of the specified stack set operation.
181 */
182 describeStackSetOperation(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOperationOutput) => void): Request<CloudFormation.Types.DescribeStackSetOperationOutput, AWSError>;
183 /**
184 * 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.
185 */
186 describeStacks(params: CloudFormation.Types.DescribeStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
187 /**
188 * 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.
189 */
190 describeStacks(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
191 /**
192 * Returns detailed information about a type that has been registered. If you specify a VersionId, DescribeType returns information about that specific type version. Otherwise, it returns information about the default type version.
193 */
194 describeType(params: CloudFormation.Types.DescribeTypeInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeOutput) => void): Request<CloudFormation.Types.DescribeTypeOutput, AWSError>;
195 /**
196 * Returns detailed information about a type that has been registered. If you specify a VersionId, DescribeType returns information about that specific type version. Otherwise, it returns information about the default type version.
197 */
198 describeType(callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeOutput) => void): Request<CloudFormation.Types.DescribeTypeOutput, AWSError>;
199 /**
200 * Returns information about a type's registration, including its current status and type and version identifiers. When you initiate a registration request using RegisterType , you can then use DescribeTypeRegistration to monitor the progress of that registration request. Once the registration request has completed, use DescribeType to return detailed informaiton about a type.
201 */
202 describeTypeRegistration(params: CloudFormation.Types.DescribeTypeRegistrationInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeRegistrationOutput) => void): Request<CloudFormation.Types.DescribeTypeRegistrationOutput, AWSError>;
203 /**
204 * Returns information about a type's registration, including its current status and type and version identifiers. When you initiate a registration request using RegisterType , you can then use DescribeTypeRegistration to monitor the progress of that registration request. Once the registration request has completed, use DescribeType to return detailed informaiton about a type.
205 */
206 describeTypeRegistration(callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeRegistrationOutput) => void): Request<CloudFormation.Types.DescribeTypeRegistrationOutput, AWSError>;
207 /**
208 * 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.
209 */
210 detectStackDrift(params: CloudFormation.Types.DetectStackDriftInput, callback?: (err: AWSError, data: CloudFormation.Types.DetectStackDriftOutput) => void): Request<CloudFormation.Types.DetectStackDriftOutput, AWSError>;
211 /**
212 * 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.
213 */
214 detectStackDrift(callback?: (err: AWSError, data: CloudFormation.Types.DetectStackDriftOutput) => void): Request<CloudFormation.Types.DetectStackDriftOutput, AWSError>;
215 /**
216 * 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.
217 */
218 detectStackResourceDrift(params: CloudFormation.Types.DetectStackResourceDriftInput, callback?: (err: AWSError, data: CloudFormation.Types.DetectStackResourceDriftOutput) => void): Request<CloudFormation.Types.DetectStackResourceDriftOutput, AWSError>;
219 /**
220 * 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.
221 */
222 detectStackResourceDrift(callback?: (err: AWSError, data: CloudFormation.Types.DetectStackResourceDriftOutput) => void): Request<CloudFormation.Types.DetectStackResourceDriftOutput, AWSError>;
223 /**
224 * Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation Performs Drift Detection on a Stack Set. DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, as well as the number of resources included in each stack. Once the operation has completed, use the following actions to return drift information: Use DescribeStackSet to return detailed informaiton about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress is not included.) Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance. Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked. For more information on performing a drift detection operation on a stack set, see Detecting Unmanaged Changes in Stack Sets. You can only run a single drift detection operation on a given stack set at one time. To stop a drift detection stack set operation, use StopStackSetOperation .
225 */
226 detectStackSetDrift(params: CloudFormation.Types.DetectStackSetDriftInput, callback?: (err: AWSError, data: CloudFormation.Types.DetectStackSetDriftOutput) => void): Request<CloudFormation.Types.DetectStackSetDriftOutput, AWSError>;
227 /**
228 * Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation Performs Drift Detection on a Stack Set. DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, as well as the number of resources included in each stack. Once the operation has completed, use the following actions to return drift information: Use DescribeStackSet to return detailed informaiton about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress is not included.) Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance. Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked. For more information on performing a drift detection operation on a stack set, see Detecting Unmanaged Changes in Stack Sets. You can only run a single drift detection operation on a given stack set at one time. To stop a drift detection stack set operation, use StopStackSetOperation .
229 */
230 detectStackSetDrift(callback?: (err: AWSError, data: CloudFormation.Types.DetectStackSetDriftOutput) => void): Request<CloudFormation.Types.DetectStackSetDriftOutput, AWSError>;
231 /**
232 * 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.
233 */
234 estimateTemplateCost(params: CloudFormation.Types.EstimateTemplateCostInput, callback?: (err: AWSError, data: CloudFormation.Types.EstimateTemplateCostOutput) => void): Request<CloudFormation.Types.EstimateTemplateCostOutput, AWSError>;
235 /**
236 * 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.
237 */
238 estimateTemplateCost(callback?: (err: AWSError, data: CloudFormation.Types.EstimateTemplateCostOutput) => void): Request<CloudFormation.Types.EstimateTemplateCostOutput, AWSError>;
239 /**
240 * 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.
241 */
242 executeChangeSet(params: CloudFormation.Types.ExecuteChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.ExecuteChangeSetOutput) => void): Request<CloudFormation.Types.ExecuteChangeSetOutput, AWSError>;
243 /**
244 * 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.
245 */
246 executeChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.ExecuteChangeSetOutput) => void): Request<CloudFormation.Types.ExecuteChangeSetOutput, AWSError>;
247 /**
248 * Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
249 */
250 getStackPolicy(params: CloudFormation.Types.GetStackPolicyInput, callback?: (err: AWSError, data: CloudFormation.Types.GetStackPolicyOutput) => void): Request<CloudFormation.Types.GetStackPolicyOutput, AWSError>;
251 /**
252 * Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
253 */
254 getStackPolicy(callback?: (err: AWSError, data: CloudFormation.Types.GetStackPolicyOutput) => void): Request<CloudFormation.Types.GetStackPolicyOutput, AWSError>;
255 /**
256 * 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.
257 */
258 getTemplate(params: CloudFormation.Types.GetTemplateInput, callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateOutput) => void): Request<CloudFormation.Types.GetTemplateOutput, AWSError>;
259 /**
260 * 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.
261 */
262 getTemplate(callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateOutput) => void): Request<CloudFormation.Types.GetTemplateOutput, AWSError>;
263 /**
264 * 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.
265 */
266 getTemplateSummary(params: CloudFormation.Types.GetTemplateSummaryInput, callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateSummaryOutput) => void): Request<CloudFormation.Types.GetTemplateSummaryOutput, AWSError>;
267 /**
268 * 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.
269 */
270 getTemplateSummary(callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateSummaryOutput) => void): Request<CloudFormation.Types.GetTemplateSummaryOutput, AWSError>;
271 /**
272 * 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.
273 */
274 listChangeSets(params: CloudFormation.Types.ListChangeSetsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListChangeSetsOutput) => void): Request<CloudFormation.Types.ListChangeSetsOutput, AWSError>;
275 /**
276 * 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.
277 */
278 listChangeSets(callback?: (err: AWSError, data: CloudFormation.Types.ListChangeSetsOutput) => void): Request<CloudFormation.Types.ListChangeSetsOutput, AWSError>;
279 /**
280 * 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.
281 */
282 listExports(params: CloudFormation.Types.ListExportsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListExportsOutput) => void): Request<CloudFormation.Types.ListExportsOutput, AWSError>;
283 /**
284 * 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.
285 */
286 listExports(callback?: (err: AWSError, data: CloudFormation.Types.ListExportsOutput) => void): Request<CloudFormation.Types.ListExportsOutput, AWSError>;
287 /**
288 * 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.
289 */
290 listImports(params: CloudFormation.Types.ListImportsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListImportsOutput) => void): Request<CloudFormation.Types.ListImportsOutput, AWSError>;
291 /**
292 * 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.
293 */
294 listImports(callback?: (err: AWSError, data: CloudFormation.Types.ListImportsOutput) => void): Request<CloudFormation.Types.ListImportsOutput, AWSError>;
295 /**
296 * 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.
297 */
298 listStackInstances(params: CloudFormation.Types.ListStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackInstancesOutput) => void): Request<CloudFormation.Types.ListStackInstancesOutput, AWSError>;
299 /**
300 * 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.
301 */
302 listStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.ListStackInstancesOutput) => void): Request<CloudFormation.Types.ListStackInstancesOutput, AWSError>;
303 /**
304 * 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.
305 */
306 listStackResources(params: CloudFormation.Types.ListStackResourcesInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackResourcesOutput) => void): Request<CloudFormation.Types.ListStackResourcesOutput, AWSError>;
307 /**
308 * 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.
309 */
310 listStackResources(callback?: (err: AWSError, data: CloudFormation.Types.ListStackResourcesOutput) => void): Request<CloudFormation.Types.ListStackResourcesOutput, AWSError>;
311 /**
312 * Returns summary information about the results of a stack set operation.
313 */
314 listStackSetOperationResults(params: CloudFormation.Types.ListStackSetOperationResultsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationResultsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationResultsOutput, AWSError>;
315 /**
316 * Returns summary information about the results of a stack set operation.
317 */
318 listStackSetOperationResults(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationResultsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationResultsOutput, AWSError>;
319 /**
320 * Returns summary information about operations performed on a stack set.
321 */
322 listStackSetOperations(params: CloudFormation.Types.ListStackSetOperationsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationsOutput, AWSError>;
323 /**
324 * Returns summary information about operations performed on a stack set.
325 */
326 listStackSetOperations(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationsOutput, AWSError>;
327 /**
328 * Returns summary information about stack sets that are associated with the user.
329 */
330 listStackSets(params: CloudFormation.Types.ListStackSetsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetsOutput) => void): Request<CloudFormation.Types.ListStackSetsOutput, AWSError>;
331 /**
332 * Returns summary information about stack sets that are associated with the user.
333 */
334 listStackSets(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetsOutput) => void): Request<CloudFormation.Types.ListStackSetsOutput, AWSError>;
335 /**
336 * 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).
337 */
338 listStacks(params: CloudFormation.Types.ListStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStacksOutput) => void): Request<CloudFormation.Types.ListStacksOutput, AWSError>;
339 /**
340 * 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).
341 */
342 listStacks(callback?: (err: AWSError, data: CloudFormation.Types.ListStacksOutput) => void): Request<CloudFormation.Types.ListStacksOutput, AWSError>;
343 /**
344 * Returns a list of registration tokens for the specified type(s).
345 */
346 listTypeRegistrations(params: CloudFormation.Types.ListTypeRegistrationsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListTypeRegistrationsOutput) => void): Request<CloudFormation.Types.ListTypeRegistrationsOutput, AWSError>;
347 /**
348 * Returns a list of registration tokens for the specified type(s).
349 */
350 listTypeRegistrations(callback?: (err: AWSError, data: CloudFormation.Types.ListTypeRegistrationsOutput) => void): Request<CloudFormation.Types.ListTypeRegistrationsOutput, AWSError>;
351 /**
352 * Returns summary information about the versions of a type.
353 */
354 listTypeVersions(params: CloudFormation.Types.ListTypeVersionsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListTypeVersionsOutput) => void): Request<CloudFormation.Types.ListTypeVersionsOutput, AWSError>;
355 /**
356 * Returns summary information about the versions of a type.
357 */
358 listTypeVersions(callback?: (err: AWSError, data: CloudFormation.Types.ListTypeVersionsOutput) => void): Request<CloudFormation.Types.ListTypeVersionsOutput, AWSError>;
359 /**
360 * Returns summary information about types that have been registered with CloudFormation.
361 */
362 listTypes(params: CloudFormation.Types.ListTypesInput, callback?: (err: AWSError, data: CloudFormation.Types.ListTypesOutput) => void): Request<CloudFormation.Types.ListTypesOutput, AWSError>;
363 /**
364 * Returns summary information about types that have been registered with CloudFormation.
365 */
366 listTypes(callback?: (err: AWSError, data: CloudFormation.Types.ListTypesOutput) => void): Request<CloudFormation.Types.ListTypesOutput, AWSError>;
367 /**
368 * Reports progress of a resource handler to CloudFormation. Reserved for use by the CloudFormation CLI. Do not use this API in your code.
369 */
370 recordHandlerProgress(params: CloudFormation.Types.RecordHandlerProgressInput, callback?: (err: AWSError, data: CloudFormation.Types.RecordHandlerProgressOutput) => void): Request<CloudFormation.Types.RecordHandlerProgressOutput, AWSError>;
371 /**
372 * Reports progress of a resource handler to CloudFormation. Reserved for use by the CloudFormation CLI. Do not use this API in your code.
373 */
374 recordHandlerProgress(callback?: (err: AWSError, data: CloudFormation.Types.RecordHandlerProgressOutput) => void): Request<CloudFormation.Types.RecordHandlerProgressOutput, AWSError>;
375 /**
376 * Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes: Validating the resource schema Determining which handlers have been specified for the resource Making the resource type available for use in your account For more information on how to develop types and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide. Once you have initiated a registration request using RegisterType , you can use DescribeTypeRegistration to monitor the progress of the registration request.
377 */
378 registerType(params: CloudFormation.Types.RegisterTypeInput, callback?: (err: AWSError, data: CloudFormation.Types.RegisterTypeOutput) => void): Request<CloudFormation.Types.RegisterTypeOutput, AWSError>;
379 /**
380 * Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes: Validating the resource schema Determining which handlers have been specified for the resource Making the resource type available for use in your account For more information on how to develop types and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide. Once you have initiated a registration request using RegisterType , you can use DescribeTypeRegistration to monitor the progress of the registration request.
381 */
382 registerType(callback?: (err: AWSError, data: CloudFormation.Types.RegisterTypeOutput) => void): Request<CloudFormation.Types.RegisterTypeOutput, AWSError>;
383 /**
384 * Sets a stack policy for a specified stack.
385 */
386 setStackPolicy(params: CloudFormation.Types.SetStackPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
387 /**
388 * Sets a stack policy for a specified stack.
389 */
390 setStackPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
391 /**
392 * Specify the default version of a type. The default version of a type will be used in CloudFormation operations.
393 */
394 setTypeDefaultVersion(params: CloudFormation.Types.SetTypeDefaultVersionInput, callback?: (err: AWSError, data: CloudFormation.Types.SetTypeDefaultVersionOutput) => void): Request<CloudFormation.Types.SetTypeDefaultVersionOutput, AWSError>;
395 /**
396 * Specify the default version of a type. The default version of a type will be used in CloudFormation operations.
397 */
398 setTypeDefaultVersion(callback?: (err: AWSError, data: CloudFormation.Types.SetTypeDefaultVersionOutput) => void): Request<CloudFormation.Types.SetTypeDefaultVersionOutput, AWSError>;
399 /**
400 * 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.
401 */
402 signalResource(params: CloudFormation.Types.SignalResourceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
403 /**
404 * 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.
405 */
406 signalResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
407 /**
408 * Stops an in-progress operation on a stack set and its associated stack instances.
409 */
410 stopStackSetOperation(params: CloudFormation.Types.StopStackSetOperationInput, callback?: (err: AWSError, data: CloudFormation.Types.StopStackSetOperationOutput) => void): Request<CloudFormation.Types.StopStackSetOperationOutput, AWSError>;
411 /**
412 * Stops an in-progress operation on a stack set and its associated stack instances.
413 */
414 stopStackSetOperation(callback?: (err: AWSError, data: CloudFormation.Types.StopStackSetOperationOutput) => void): Request<CloudFormation.Types.StopStackSetOperationOutput, AWSError>;
415 /**
416 * 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.
417 */
418 updateStack(params: CloudFormation.Types.UpdateStackInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackOutput) => void): Request<CloudFormation.Types.UpdateStackOutput, AWSError>;
419 /**
420 * 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.
421 */
422 updateStack(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackOutput) => void): Request<CloudFormation.Types.UpdateStackOutput, AWSError>;
423 /**
424 * 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.
425 */
426 updateStackInstances(params: CloudFormation.Types.UpdateStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackInstancesOutput) => void): Request<CloudFormation.Types.UpdateStackInstancesOutput, AWSError>;
427 /**
428 * 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.
429 */
430 updateStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackInstancesOutput) => void): Request<CloudFormation.Types.UpdateStackInstancesOutput, AWSError>;
431 /**
432 * 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.
433 */
434 updateStackSet(params: CloudFormation.Types.UpdateStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackSetOutput) => void): Request<CloudFormation.Types.UpdateStackSetOutput, AWSError>;
435 /**
436 * 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.
437 */
438 updateStackSet(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackSetOutput) => void): Request<CloudFormation.Types.UpdateStackSetOutput, AWSError>;
439 /**
440 * 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.
441 */
442 updateTerminationProtection(params: CloudFormation.Types.UpdateTerminationProtectionInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateTerminationProtectionOutput) => void): Request<CloudFormation.Types.UpdateTerminationProtectionOutput, AWSError>;
443 /**
444 * 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.
445 */
446 updateTerminationProtection(callback?: (err: AWSError, data: CloudFormation.Types.UpdateTerminationProtectionOutput) => void): Request<CloudFormation.Types.UpdateTerminationProtectionOutput, AWSError>;
447 /**
448 * 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.
449 */
450 validateTemplate(params: CloudFormation.Types.ValidateTemplateInput, callback?: (err: AWSError, data: CloudFormation.Types.ValidateTemplateOutput) => void): Request<CloudFormation.Types.ValidateTemplateOutput, AWSError>;
451 /**
452 * 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.
453 */
454 validateTemplate(callback?: (err: AWSError, data: CloudFormation.Types.ValidateTemplateOutput) => void): Request<CloudFormation.Types.ValidateTemplateOutput, AWSError>;
455 /**
456 * Waits for the stackExists state by periodically calling the underlying CloudFormation.describeStacksoperation every 5 seconds (at most 20 times).
457 */
458 waitFor(state: "stackExists", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
459 /**
460 * Waits for the stackExists state by periodically calling the underlying CloudFormation.describeStacksoperation every 5 seconds (at most 20 times).
461 */
462 waitFor(state: "stackExists", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
463 /**
464 * 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.
465 */
466 waitFor(state: "stackCreateComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
467 /**
468 * 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.
469 */
470 waitFor(state: "stackCreateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
471 /**
472 * 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.
473 */
474 waitFor(state: "stackDeleteComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
475 /**
476 * 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.
477 */
478 waitFor(state: "stackDeleteComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
479 /**
480 * 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.
481 */
482 waitFor(state: "stackUpdateComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
483 /**
484 * 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.
485 */
486 waitFor(state: "stackUpdateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
487 /**
488 * Waits for the stackImportComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is IMPORT_COMPLETE.
489 */
490 waitFor(state: "stackImportComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
491 /**
492 * Waits for the stackImportComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is IMPORT_COMPLETE.
493 */
494 waitFor(state: "stackImportComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
495 /**
496 * 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.
497 */
498 waitFor(state: "changeSetCreateComplete", params: CloudFormation.Types.DescribeChangeSetInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
499 /**
500 * 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.
501 */
502 waitFor(state: "changeSetCreateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
503 /**
504 * Waits for the typeRegistrationComplete state by periodically calling the underlying CloudFormation.describeTypeRegistrationoperation every 30 seconds (at most 120 times). Wait until type registration is COMPLETE.
505 */
506 waitFor(state: "typeRegistrationComplete", params: CloudFormation.Types.DescribeTypeRegistrationInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeRegistrationOutput) => void): Request<CloudFormation.Types.DescribeTypeRegistrationOutput, AWSError>;
507 /**
508 * Waits for the typeRegistrationComplete state by periodically calling the underlying CloudFormation.describeTypeRegistrationoperation every 30 seconds (at most 120 times). Wait until type registration is COMPLETE.
509 */
510 waitFor(state: "typeRegistrationComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeRegistrationOutput) => void): Request<CloudFormation.Types.DescribeTypeRegistrationOutput, AWSError>;
511}
512declare namespace CloudFormation {
513 export type Account = string;
514 export interface AccountGateResult {
515 /**
516 * 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.
517 */
518 Status?: AccountGateStatus;
519 /**
520 * The reason for the account gate status assigned to this account and region for the stack set operation.
521 */
522 StatusReason?: AccountGateStatusReason;
523 }
524 export type AccountGateStatus = "SUCCEEDED"|"FAILED"|"SKIPPED"|string;
525 export type AccountGateStatusReason = string;
526 export interface AccountLimit {
527 /**
528 * The name of the account limit. Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit
529 */
530 Name?: LimitName;
531 /**
532 * The value that is associated with the account limit name.
533 */
534 Value?: LimitValue;
535 }
536 export type AccountLimitList = AccountLimit[];
537 export type AccountList = Account[];
538 export type AllowedValue = string;
539 export type AllowedValues = AllowedValue[];
540 export type Arn = string;
541 export interface AutoDeployment {
542 /**
543 * If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.
544 */
545 Enabled?: AutoDeploymentNullable;
546 /**
547 * If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.
548 */
549 RetainStacksOnAccountRemoval?: RetainStacksOnAccountRemovalNullable;
550 }
551 export type AutoDeploymentNullable = boolean;
552 export type BoxedInteger = number;
553 export type BoxedMaxResults = number;
554 export interface CancelUpdateStackInput {
555 /**
556 * The name or the unique stack ID that is associated with the stack.
557 */
558 StackName: StackName;
559 /**
560 * 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.
561 */
562 ClientRequestToken?: ClientRequestToken;
563 }
564 export type Capabilities = Capability[];
565 export type CapabilitiesReason = string;
566 export type Capability = "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"|string;
567 export type CausingEntity = string;
568 export interface Change {
569 /**
570 * The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource.
571 */
572 Type?: ChangeType;
573 /**
574 * A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform.
575 */
576 ResourceChange?: ResourceChange;
577 }
578 export type ChangeAction = "Add"|"Modify"|"Remove"|"Import"|string;
579 export type ChangeSetId = string;
580 export type ChangeSetName = string;
581 export type ChangeSetNameOrId = string;
582 export type ChangeSetStatus = "CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"DELETE_COMPLETE"|"FAILED"|string;
583 export type ChangeSetStatusReason = string;
584 export type ChangeSetSummaries = ChangeSetSummary[];
585 export interface ChangeSetSummary {
586 /**
587 * The ID of the stack with which the change set is associated.
588 */
589 StackId?: StackId;
590 /**
591 * The name of the stack with which the change set is associated.
592 */
593 StackName?: StackName;
594 /**
595 * The ID of the change set.
596 */
597 ChangeSetId?: ChangeSetId;
598 /**
599 * The name of the change set.
600 */
601 ChangeSetName?: ChangeSetName;
602 /**
603 * 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.
604 */
605 ExecutionStatus?: ExecutionStatus;
606 /**
607 * The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
608 */
609 Status?: ChangeSetStatus;
610 /**
611 * 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.
612 */
613 StatusReason?: ChangeSetStatusReason;
614 /**
615 * The start time when the change set was created, in UTC.
616 */
617 CreationTime?: CreationTime;
618 /**
619 * Descriptive information about the change set.
620 */
621 Description?: Description;
622 }
623 export type ChangeSetType = "CREATE"|"UPDATE"|"IMPORT"|string;
624 export type ChangeSource = "ResourceReference"|"ParameterReference"|"ResourceAttribute"|"DirectModification"|"Automatic"|string;
625 export type ChangeType = "Resource"|string;
626 export type Changes = Change[];
627 export type ClientRequestToken = string;
628 export type ClientToken = string;
629 export interface ContinueUpdateRollbackInput {
630 /**
631 * 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).
632 */
633 StackName: StackNameOrId;
634 /**
635 * 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.
636 */
637 RoleARN?: RoleARN;
638 /**
639 * 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.
640 */
641 ResourcesToSkip?: ResourcesToSkip;
642 /**
643 * 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.
644 */
645 ClientRequestToken?: ClientRequestToken;
646 }
647 export interface ContinueUpdateRollbackOutput {
648 }
649 export interface CreateChangeSetInput {
650 /**
651 * 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.
652 */
653 StackName: StackNameOrId;
654 /**
655 * 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.
656 */
657 TemplateBody?: TemplateBody;
658 /**
659 * 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.
660 */
661 TemplateURL?: TemplateURL;
662 /**
663 * Whether to reuse the template that is associated with the stack to create the change set.
664 */
665 UsePreviousTemplate?: UsePreviousTemplate;
666 /**
667 * A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.
668 */
669 Parameters?: Parameters;
670 /**
671 * In some cases, you must explicitly 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.
672 */
673 Capabilities?: Capabilities;
674 /**
675 * 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.
676 */
677 ResourceTypes?: ResourceTypes;
678 /**
679 * 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.
680 */
681 RoleARN?: RoleARN;
682 /**
683 * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
684 */
685 RollbackConfiguration?: RollbackConfiguration;
686 /**
687 * 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.
688 */
689 NotificationARNs?: NotificationARNs;
690 /**
691 * 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.
692 */
693 Tags?: Tags;
694 /**
695 * 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.
696 */
697 ChangeSetName: ChangeSetName;
698 /**
699 * 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.
700 */
701 ClientToken?: ClientToken;
702 /**
703 * A description to help you identify this change set.
704 */
705 Description?: Description;
706 /**
707 * The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT. If you create a change set for a new stack, 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.
708 */
709 ChangeSetType?: ChangeSetType;
710 /**
711 * The resources to import into your stack.
712 */
713 ResourcesToImport?: ResourcesToImport;
714 }
715 export interface CreateChangeSetOutput {
716 /**
717 * The Amazon Resource Name (ARN) of the change set.
718 */
719 Id?: ChangeSetId;
720 /**
721 * The unique ID of the stack.
722 */
723 StackId?: StackId;
724 }
725 export interface CreateStackInput {
726 /**
727 * 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.
728 */
729 StackName: StackName;
730 /**
731 * 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.
732 */
733 TemplateBody?: TemplateBody;
734 /**
735 * 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.
736 */
737 TemplateURL?: TemplateURL;
738 /**
739 * A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
740 */
741 Parameters?: Parameters;
742 /**
743 * 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
744 */
745 DisableRollback?: DisableRollback;
746 /**
747 * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
748 */
749 RollbackConfiguration?: RollbackConfiguration;
750 /**
751 * 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.
752 */
753 TimeoutInMinutes?: TimeoutMinutes;
754 /**
755 * 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).
756 */
757 NotificationARNs?: NotificationARNs;
758 /**
759 * In some cases, you must explicitly 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.
760 */
761 Capabilities?: Capabilities;
762 /**
763 * 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.
764 */
765 ResourceTypes?: ResourceTypes;
766 /**
767 * 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.
768 */
769 RoleARN?: RoleARN;
770 /**
771 * 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
772 */
773 OnFailure?: OnFailure;
774 /**
775 * 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.
776 */
777 StackPolicyBody?: StackPolicyBody;
778 /**
779 * 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.
780 */
781 StackPolicyURL?: StackPolicyURL;
782 /**
783 * 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.
784 */
785 Tags?: Tags;
786 /**
787 * 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.
788 */
789 ClientRequestToken?: ClientRequestToken;
790 /**
791 * 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.
792 */
793 EnableTerminationProtection?: EnableTerminationProtection;
794 }
795 export interface CreateStackInstancesInput {
796 /**
797 * The name or unique ID of the stack set that you want to create stack instances from.
798 */
799 StackSetName: StackSetName;
800 /**
801 * [Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for. You can specify Accounts or DeploymentTargets, but not both.
802 */
803 Accounts?: AccountList;
804 /**
805 * [Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions. You can specify Accounts or DeploymentTargets, but not both.
806 */
807 DeploymentTargets?: DeploymentTargets;
808 /**
809 * The names of one or more regions where you want to create stack instances using the specified AWS account(s).
810 */
811 Regions: RegionList;
812 /**
813 * 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.
814 */
815 ParameterOverrides?: Parameters;
816 /**
817 * Preferences for how AWS CloudFormation performs this stack set operation.
818 */
819 OperationPreferences?: StackSetOperationPreferences;
820 /**
821 * 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.
822 */
823 OperationId?: ClientRequestToken;
824 }
825 export interface CreateStackInstancesOutput {
826 /**
827 * The unique identifier for this stack set operation.
828 */
829 OperationId?: ClientRequestToken;
830 }
831 export interface CreateStackOutput {
832 /**
833 * Unique identifier of the stack.
834 */
835 StackId?: StackId;
836 }
837 export interface CreateStackSetInput {
838 /**
839 * 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.
840 */
841 StackSetName: StackSetName;
842 /**
843 * A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
844 */
845 Description?: Description;
846 /**
847 * 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.
848 */
849 TemplateBody?: TemplateBody;
850 /**
851 * 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.
852 */
853 TemplateURL?: TemplateURL;
854 /**
855 * The input parameters for the stack set template.
856 */
857 Parameters?: Parameters;
858 /**
859 * In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances. 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.
860 */
861 Capabilities?: Capabilities;
862 /**
863 * 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.
864 */
865 Tags?: Tags;
866 /**
867 * 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.
868 */
869 AdministrationRoleARN?: RoleARN;
870 /**
871 * 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.
872 */
873 ExecutionRoleName?: ExecutionRoleName;
874 /**
875 * Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified. With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
876 */
877 PermissionModel?: PermissionModels;
878 /**
879 * Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED. If you specify AutoDeployment, do not specify DeploymentTargets or Regions.
880 */
881 AutoDeployment?: AutoDeployment;
882 /**
883 * 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.
884 */
885 ClientRequestToken?: ClientRequestToken;
886 }
887 export interface CreateStackSetOutput {
888 /**
889 * The ID of the stack set that you're creating.
890 */
891 StackSetId?: StackSetId;
892 }
893 export type CreationTime = Date;
894 export interface DeleteChangeSetInput {
895 /**
896 * The name or Amazon Resource Name (ARN) of the change set that you want to delete.
897 */
898 ChangeSetName: ChangeSetNameOrId;
899 /**
900 * If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it.
901 */
902 StackName?: StackNameOrId;
903 }
904 export interface DeleteChangeSetOutput {
905 }
906 export interface DeleteStackInput {
907 /**
908 * The name or the unique stack ID that is associated with the stack.
909 */
910 StackName: StackName;
911 /**
912 * 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.
913 */
914 RetainResources?: RetainResources;
915 /**
916 * 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.
917 */
918 RoleARN?: RoleARN;
919 /**
920 * 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.
921 */
922 ClientRequestToken?: ClientRequestToken;
923 }
924 export interface DeleteStackInstancesInput {
925 /**
926 * The name or unique ID of the stack set that you want to delete stack instances for.
927 */
928 StackSetName: StackSetName;
929 /**
930 * [Self-managed permissions] The names of the AWS accounts that you want to delete stack instances for. You can specify Accounts or DeploymentTargets, but not both.
931 */
932 Accounts?: AccountList;
933 /**
934 * [Service-managed permissions] The AWS Organizations accounts from which to delete stack instances. You can specify Accounts or DeploymentTargets, but not both.
935 */
936 DeploymentTargets?: DeploymentTargets;
937 /**
938 * The regions where you want to delete stack set instances.
939 */
940 Regions: RegionList;
941 /**
942 * Preferences for how AWS CloudFormation performs this stack set operation.
943 */
944 OperationPreferences?: StackSetOperationPreferences;
945 /**
946 * 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.
947 */
948 RetainStacks: RetainStacks;
949 /**
950 * 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.
951 */
952 OperationId?: ClientRequestToken;
953 }
954 export interface DeleteStackInstancesOutput {
955 /**
956 * The unique identifier for this stack set operation.
957 */
958 OperationId?: ClientRequestToken;
959 }
960 export interface DeleteStackSetInput {
961 /**
962 * The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.
963 */
964 StackSetName: StackSetName;
965 }
966 export interface DeleteStackSetOutput {
967 }
968 export type DeletionTime = Date;
969 export interface DeploymentTargets {
970 /**
971 * The names of one or more AWS accounts for which you want to deploy stack set updates.
972 */
973 Accounts?: AccountList;
974 /**
975 * The organization root ID or organizational unit (OUs) IDs to which StackSets deploys.
976 */
977 OrganizationalUnitIds?: OrganizationalUnitIdList;
978 }
979 export type DeprecatedStatus = "LIVE"|"DEPRECATED"|string;
980 export interface DeregisterTypeInput {
981 /**
982 * The Amazon Resource Name (ARN) of the type. Conditional: You must specify either TypeName and Type, or Arn.
983 */
984 Arn?: PrivateTypeArn;
985 /**
986 * The kind of type. Currently the only valid value is RESOURCE. Conditional: You must specify either TypeName and Type, or Arn.
987 */
988 Type?: RegistryType;
989 /**
990 * The name of the type. Conditional: You must specify either TypeName and Type, or Arn.
991 */
992 TypeName?: TypeName;
993 /**
994 * The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.
995 */
996 VersionId?: TypeVersionId;
997 }
998 export interface DeregisterTypeOutput {
999 }
1000 export interface DescribeAccountLimitsInput {
1001 /**
1002 * A string that identifies the next page of limits that you want to retrieve.
1003 */
1004 NextToken?: NextToken;
1005 }
1006 export interface DescribeAccountLimitsOutput {
1007 /**
1008 * An account limit structure that contain a list of AWS CloudFormation account limits and their values.
1009 */
1010 AccountLimits?: AccountLimitList;
1011 /**
1012 * 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.
1013 */
1014 NextToken?: NextToken;
1015 }
1016 export interface DescribeChangeSetInput {
1017 /**
1018 * The name or Amazon Resource Name (ARN) of the change set that you want to describe.
1019 */
1020 ChangeSetName: ChangeSetNameOrId;
1021 /**
1022 * If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.
1023 */
1024 StackName?: StackNameOrId;
1025 /**
1026 * A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.
1027 */
1028 NextToken?: NextToken;
1029 }
1030 export interface DescribeChangeSetOutput {
1031 /**
1032 * The name of the change set.
1033 */
1034 ChangeSetName?: ChangeSetName;
1035 /**
1036 * The ARN of the change set.
1037 */
1038 ChangeSetId?: ChangeSetId;
1039 /**
1040 * The ARN of the stack that is associated with the change set.
1041 */
1042 StackId?: StackId;
1043 /**
1044 * The name of the stack that is associated with the change set.
1045 */
1046 StackName?: StackName;
1047 /**
1048 * Information about the change set.
1049 */
1050 Description?: Description;
1051 /**
1052 * 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.
1053 */
1054 Parameters?: Parameters;
1055 /**
1056 * The start time when the change set was created, in UTC.
1057 */
1058 CreationTime?: CreationTime;
1059 /**
1060 * 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.
1061 */
1062 ExecutionStatus?: ExecutionStatus;
1063 /**
1064 * The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
1065 */
1066 Status?: ChangeSetStatus;
1067 /**
1068 * 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.
1069 */
1070 StatusReason?: ChangeSetStatusReason;
1071 /**
1072 * The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
1073 */
1074 NotificationARNs?: NotificationARNs;
1075 /**
1076 * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
1077 */
1078 RollbackConfiguration?: RollbackConfiguration;
1079 /**
1080 * If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
1081 */
1082 Capabilities?: Capabilities;
1083 /**
1084 * If you execute the change set, the tags that will be associated with the stack.
1085 */
1086 Tags?: Tags;
1087 /**
1088 * A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set.
1089 */
1090 Changes?: Changes;
1091 /**
1092 * 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.
1093 */
1094 NextToken?: NextToken;
1095 }
1096 export interface DescribeStackDriftDetectionStatusInput {
1097 /**
1098 * 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.
1099 */
1100 StackDriftDetectionId: StackDriftDetectionId;
1101 }
1102 export interface DescribeStackDriftDetectionStatusOutput {
1103 /**
1104 * The ID of the stack.
1105 */
1106 StackId: StackId;
1107 /**
1108 * 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.
1109 */
1110 StackDriftDetectionId: StackDriftDetectionId;
1111 /**
1112 * 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.
1113 */
1114 StackDriftStatus?: StackDriftStatus;
1115 /**
1116 * 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.
1117 */
1118 DetectionStatus: StackDriftDetectionStatus;
1119 /**
1120 * The reason the stack drift detection operation has its current status.
1121 */
1122 DetectionStatusReason?: StackDriftDetectionStatusReason;
1123 /**
1124 * 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.
1125 */
1126 DriftedStackResourceCount?: BoxedInteger;
1127 /**
1128 * Time at which the stack drift detection operation was initiated.
1129 */
1130 Timestamp: Timestamp;
1131 }
1132 export interface DescribeStackEventsInput {
1133 /**
1134 * 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.
1135 */
1136 StackName?: StackName;
1137 /**
1138 * A string that identifies the next page of events that you want to retrieve.
1139 */
1140 NextToken?: NextToken;
1141 }
1142 export interface DescribeStackEventsOutput {
1143 /**
1144 * A list of StackEvents structures.
1145 */
1146 StackEvents?: StackEvents;
1147 /**
1148 * 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.
1149 */
1150 NextToken?: NextToken;
1151 }
1152 export interface DescribeStackInstanceInput {
1153 /**
1154 * The name or the unique stack ID of the stack set that you want to get stack instance information for.
1155 */
1156 StackSetName: StackSetName;
1157 /**
1158 * The ID of an AWS account that's associated with this stack instance.
1159 */
1160 StackInstanceAccount: Account;
1161 /**
1162 * The name of a region that's associated with this stack instance.
1163 */
1164 StackInstanceRegion: Region;
1165 }
1166 export interface DescribeStackInstanceOutput {
1167 /**
1168 * The stack instance that matches the specified request parameters.
1169 */
1170 StackInstance?: StackInstance;
1171 }
1172 export interface DescribeStackResourceDriftsInput {
1173 /**
1174 * The name of the stack for which you want drift information.
1175 */
1176 StackName: StackNameOrId;
1177 /**
1178 * 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.
1179 */
1180 StackResourceDriftStatusFilters?: StackResourceDriftStatusFilters;
1181 /**
1182 * A string that identifies the next page of stack resource drift results.
1183 */
1184 NextToken?: NextToken;
1185 /**
1186 * 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.
1187 */
1188 MaxResults?: BoxedMaxResults;
1189 }
1190 export interface DescribeStackResourceDriftsOutput {
1191 /**
1192 * 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.
1193 */
1194 StackResourceDrifts: StackResourceDrifts;
1195 /**
1196 * 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.
1197 */
1198 NextToken?: NextToken;
1199 }
1200 export interface DescribeStackResourceInput {
1201 /**
1202 * 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.
1203 */
1204 StackName: StackName;
1205 /**
1206 * The logical name of the resource as specified in the template. Default: There is no default value.
1207 */
1208 LogicalResourceId: LogicalResourceId;
1209 }
1210 export interface DescribeStackResourceOutput {
1211 /**
1212 * A StackResourceDetail structure containing the description of the specified resource in the specified stack.
1213 */
1214 StackResourceDetail?: StackResourceDetail;
1215 }
1216 export interface DescribeStackResourcesInput {
1217 /**
1218 * 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.
1219 */
1220 StackName?: StackName;
1221 /**
1222 * The logical name of the resource as specified in the template. Default: There is no default value.
1223 */
1224 LogicalResourceId?: LogicalResourceId;
1225 /**
1226 * 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.
1227 */
1228 PhysicalResourceId?: PhysicalResourceId;
1229 }
1230 export interface DescribeStackResourcesOutput {
1231 /**
1232 * A list of StackResource structures.
1233 */
1234 StackResources?: StackResources;
1235 }
1236 export interface DescribeStackSetInput {
1237 /**
1238 * The name or unique ID of the stack set whose description you want.
1239 */
1240 StackSetName: StackSetName;
1241 }
1242 export interface DescribeStackSetOperationInput {
1243 /**
1244 * The name or the unique stack ID of the stack set for the stack operation.
1245 */
1246 StackSetName: StackSetName;
1247 /**
1248 * The unique ID of the stack set operation.
1249 */
1250 OperationId: ClientRequestToken;
1251 }
1252 export interface DescribeStackSetOperationOutput {
1253 /**
1254 * The specified stack set operation.
1255 */
1256 StackSetOperation?: StackSetOperation;
1257 }
1258 export interface DescribeStackSetOutput {
1259 /**
1260 * The specified stack set.
1261 */
1262 StackSet?: StackSet;
1263 }
1264 export interface DescribeStacksInput {
1265 /**
1266 * 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.
1267 */
1268 StackName?: StackName;
1269 /**
1270 * A string that identifies the next page of stacks that you want to retrieve.
1271 */
1272 NextToken?: NextToken;
1273 }
1274 export interface DescribeStacksOutput {
1275 /**
1276 * A list of stack structures.
1277 */
1278 Stacks?: Stacks;
1279 /**
1280 * 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.
1281 */
1282 NextToken?: NextToken;
1283 }
1284 export interface DescribeTypeInput {
1285 /**
1286 * The kind of type. Currently the only valid value is RESOURCE. Conditional: You must specify either TypeName and Type, or Arn.
1287 */
1288 Type?: RegistryType;
1289 /**
1290 * The name of the type. Conditional: You must specify either TypeName and Type, or Arn.
1291 */
1292 TypeName?: TypeName;
1293 /**
1294 * The Amazon Resource Name (ARN) of the type. Conditional: You must specify either TypeName and Type, or Arn.
1295 */
1296 Arn?: TypeArn;
1297 /**
1298 * The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered. If you specify a VersionId, DescribeType returns information about that specific type version. Otherwise, it returns information about the default type version.
1299 */
1300 VersionId?: TypeVersionId;
1301 }
1302 export interface DescribeTypeOutput {
1303 /**
1304 * The Amazon Resource Name (ARN) of the type.
1305 */
1306 Arn?: TypeArn;
1307 /**
1308 * The kind of type. Currently the only valid value is RESOURCE.
1309 */
1310 Type?: RegistryType;
1311 /**
1312 * The name of the registered type.
1313 */
1314 TypeName?: TypeName;
1315 /**
1316 * The ID of the default version of the type. The default version is used when the type version is not specified. To set the default version of a type, use SetTypeDefaultVersion .
1317 */
1318 DefaultVersionId?: TypeVersionId;
1319 /**
1320 * The description of the registered type.
1321 */
1322 Description?: Description;
1323 /**
1324 * The schema that defines the type. For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
1325 */
1326 Schema?: TypeSchema;
1327 /**
1328 * The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted. Valid values include: FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations. IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations. NON_PROVISIONABLE: The type does not include all of the following handlers, and therefore cannot actually be provisioned. create read delete
1329 */
1330 ProvisioningType?: ProvisioningType;
1331 /**
1332 * The deprecation status of the type. Valid values include: LIVE: The type is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope. DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.
1333 */
1334 DeprecatedStatus?: DeprecatedStatus;
1335 /**
1336 * Contains logging configuration information for a type.
1337 */
1338 LoggingConfig?: LoggingConfig;
1339 /**
1340 * The Amazon Resource Name (ARN) of the IAM execution role used to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
1341 */
1342 ExecutionRoleArn?: RoleArn;
1343 /**
1344 * The scope at which the type is visible and usable in CloudFormation operations. Valid values include: PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE. PUBLIC: The type is publically visible and usable within any Amazon account.
1345 */
1346 Visibility?: Visibility;
1347 /**
1348 * The URL of the source code for the type.
1349 */
1350 SourceUrl?: OptionalSecureUrl;
1351 /**
1352 * The URL of a page providing detailed documentation for this type.
1353 */
1354 DocumentationUrl?: OptionalSecureUrl;
1355 /**
1356 * When the specified type version was registered.
1357 */
1358 LastUpdated?: Timestamp;
1359 /**
1360 * When the specified type version was registered.
1361 */
1362 TimeCreated?: Timestamp;
1363 }
1364 export interface DescribeTypeRegistrationInput {
1365 /**
1366 * The identifier for this registration request. This registration token is generated by CloudFormation when you initiate a registration request using RegisterType .
1367 */
1368 RegistrationToken: RegistrationToken;
1369 }
1370 export interface DescribeTypeRegistrationOutput {
1371 /**
1372 * The current status of the type registration request.
1373 */
1374 ProgressStatus?: RegistrationStatus;
1375 /**
1376 * The description of the type registration request.
1377 */
1378 Description?: Description;
1379 /**
1380 * The Amazon Resource Name (ARN) of the type being registered. For registration requests with a ProgressStatus of other than COMPLETE, this will be null.
1381 */
1382 TypeArn?: TypeArn;
1383 /**
1384 * The Amazon Resource Name (ARN) of this specific version of the type being registered. For registration requests with a ProgressStatus of other than COMPLETE, this will be null.
1385 */
1386 TypeVersionArn?: TypeArn;
1387 }
1388 export type Description = string;
1389 export interface DetectStackDriftInput {
1390 /**
1391 * The name of the stack for which you want to detect drift.
1392 */
1393 StackName: StackNameOrId;
1394 /**
1395 * The logical names of any resources you want to use as filters.
1396 */
1397 LogicalResourceIds?: LogicalResourceIds;
1398 }
1399 export interface DetectStackDriftOutput {
1400 /**
1401 * 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.
1402 */
1403 StackDriftDetectionId: StackDriftDetectionId;
1404 }
1405 export interface DetectStackResourceDriftInput {
1406 /**
1407 * The name of the stack to which the resource belongs.
1408 */
1409 StackName: StackNameOrId;
1410 /**
1411 * The logical name of the resource for which to return drift information.
1412 */
1413 LogicalResourceId: LogicalResourceId;
1414 }
1415 export interface DetectStackResourceDriftOutput {
1416 /**
1417 * 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.
1418 */
1419 StackResourceDrift: StackResourceDrift;
1420 }
1421 export interface DetectStackSetDriftInput {
1422 /**
1423 * The name of the stack set on which to perform the drift detection operation.
1424 */
1425 StackSetName: StackSetNameOrId;
1426 OperationPreferences?: StackSetOperationPreferences;
1427 /**
1428 * The ID of the stack set operation.
1429 */
1430 OperationId?: ClientRequestToken;
1431 }
1432 export interface DetectStackSetDriftOutput {
1433 /**
1434 * The ID of the drift detection stack set operation. you can use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation.
1435 */
1436 OperationId?: ClientRequestToken;
1437 }
1438 export type DifferenceType = "ADD"|"REMOVE"|"NOT_EQUAL"|string;
1439 export type DisableRollback = boolean;
1440 export type DriftedStackInstancesCount = number;
1441 export type EnableTerminationProtection = boolean;
1442 export interface EstimateTemplateCostInput {
1443 /**
1444 * 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.
1445 */
1446 TemplateBody?: TemplateBody;
1447 /**
1448 * 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.
1449 */
1450 TemplateURL?: TemplateURL;
1451 /**
1452 * A list of Parameter structures that specify input parameters.
1453 */
1454 Parameters?: Parameters;
1455 }
1456 export interface EstimateTemplateCostOutput {
1457 /**
1458 * An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
1459 */
1460 Url?: Url;
1461 }
1462 export type EvaluationType = "Static"|"Dynamic"|string;
1463 export type EventId = string;
1464 export interface ExecuteChangeSetInput {
1465 /**
1466 * The name or ARN of the change set that you want use to update the specified stack.
1467 */
1468 ChangeSetName: ChangeSetNameOrId;
1469 /**
1470 * 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.
1471 */
1472 StackName?: StackNameOrId;
1473 /**
1474 * 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.
1475 */
1476 ClientRequestToken?: ClientRequestToken;
1477 }
1478 export interface ExecuteChangeSetOutput {
1479 }
1480 export type ExecutionRoleName = string;
1481 export type ExecutionStatus = "UNAVAILABLE"|"AVAILABLE"|"EXECUTE_IN_PROGRESS"|"EXECUTE_COMPLETE"|"EXECUTE_FAILED"|"OBSOLETE"|string;
1482 export interface Export {
1483 /**
1484 * The stack that contains the exported output name and value.
1485 */
1486 ExportingStackId?: StackId;
1487 /**
1488 * 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.
1489 */
1490 Name?: ExportName;
1491 /**
1492 * 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.
1493 */
1494 Value?: ExportValue;
1495 }
1496 export type ExportName = string;
1497 export type ExportValue = string;
1498 export type Exports = Export[];
1499 export type FailedStackInstancesCount = number;
1500 export type FailureToleranceCount = number;
1501 export type FailureTolerancePercentage = number;
1502 export interface GetStackPolicyInput {
1503 /**
1504 * The name or unique stack ID that is associated with the stack whose policy you want to get.
1505 */
1506 StackName: StackName;
1507 }
1508 export interface GetStackPolicyOutput {
1509 /**
1510 * Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)
1511 */
1512 StackPolicyBody?: StackPolicyBody;
1513 }
1514 export interface GetTemplateInput {
1515 /**
1516 * 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.
1517 */
1518 StackName?: StackName;
1519 /**
1520 * 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.
1521 */
1522 ChangeSetName?: ChangeSetNameOrId;
1523 /**
1524 * 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.
1525 */
1526 TemplateStage?: TemplateStage;
1527 }
1528 export interface GetTemplateOutput {
1529 /**
1530 * 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.
1531 */
1532 TemplateBody?: TemplateBody;
1533 /**
1534 * 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.
1535 */
1536 StagesAvailable?: StageList;
1537 }
1538 export interface GetTemplateSummaryInput {
1539 /**
1540 * 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.
1541 */
1542 TemplateBody?: TemplateBody;
1543 /**
1544 * 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.
1545 */
1546 TemplateURL?: TemplateURL;
1547 /**
1548 * 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.
1549 */
1550 StackName?: StackNameOrId;
1551 /**
1552 * 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.
1553 */
1554 StackSetName?: StackSetNameOrId;
1555 }
1556 export interface GetTemplateSummaryOutput {
1557 /**
1558 * A list of parameter declarations that describe various properties for each parameter.
1559 */
1560 Parameters?: ParameterDeclarations;
1561 /**
1562 * The value that is defined in the Description property of the template.
1563 */
1564 Description?: Description;
1565 /**
1566 * 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.
1567 */
1568 Capabilities?: Capabilities;
1569 /**
1570 * The list of resources that generated the values in the Capabilities response element.
1571 */
1572 CapabilitiesReason?: CapabilitiesReason;
1573 /**
1574 * 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.
1575 */
1576 ResourceTypes?: ResourceTypes;
1577 /**
1578 * The AWS template format version, which identifies the capabilities of the template.
1579 */
1580 Version?: Version;
1581 /**
1582 * The value that is defined for the Metadata property of the template.
1583 */
1584 Metadata?: Metadata;
1585 /**
1586 * A list of the transforms that are declared in the template.
1587 */
1588 DeclaredTransforms?: TransformsList;
1589 /**
1590 * A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.
1591 */
1592 ResourceIdentifierSummaries?: ResourceIdentifierSummaries;
1593 }
1594 export type HandlerErrorCode = "NotUpdatable"|"InvalidRequest"|"AccessDenied"|"InvalidCredentials"|"AlreadyExists"|"NotFound"|"ResourceConflict"|"Throttling"|"ServiceLimitExceeded"|"NotStabilized"|"GeneralServiceException"|"ServiceInternalError"|"NetworkFailure"|"InternalFailure"|string;
1595 export type Imports = StackName[];
1596 export type InProgressStackInstancesCount = number;
1597 export type InSyncStackInstancesCount = number;
1598 export type Key = string;
1599 export type LastUpdatedTime = Date;
1600 export type LimitName = string;
1601 export type LimitValue = number;
1602 export interface ListChangeSetsInput {
1603 /**
1604 * The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
1605 */
1606 StackName: StackNameOrId;
1607 /**
1608 * A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.
1609 */
1610 NextToken?: NextToken;
1611 }
1612 export interface ListChangeSetsOutput {
1613 /**
1614 * A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.
1615 */
1616 Summaries?: ChangeSetSummaries;
1617 /**
1618 * 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.
1619 */
1620 NextToken?: NextToken;
1621 }
1622 export interface ListExportsInput {
1623 /**
1624 * A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve.
1625 */
1626 NextToken?: NextToken;
1627 }
1628 export interface ListExportsOutput {
1629 /**
1630 * The output for the ListExports action.
1631 */
1632 Exports?: Exports;
1633 /**
1634 * 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.
1635 */
1636 NextToken?: NextToken;
1637 }
1638 export interface ListImportsInput {
1639 /**
1640 * The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value.
1641 */
1642 ExportName: ExportName;
1643 /**
1644 * A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.
1645 */
1646 NextToken?: NextToken;
1647 }
1648 export interface ListImportsOutput {
1649 /**
1650 * A list of stack names that are importing the specified exported output value.
1651 */
1652 Imports?: Imports;
1653 /**
1654 * A string that identifies the next page of exports. If there is no additional page, this value is null.
1655 */
1656 NextToken?: NextToken;
1657 }
1658 export interface ListStackInstancesInput {
1659 /**
1660 * The name or unique ID of the stack set that you want to list stack instances for.
1661 */
1662 StackSetName: StackSetName;
1663 /**
1664 * 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.
1665 */
1666 NextToken?: NextToken;
1667 /**
1668 * 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.
1669 */
1670 MaxResults?: MaxResults;
1671 /**
1672 * The name of the AWS account that you want to list stack instances for.
1673 */
1674 StackInstanceAccount?: Account;
1675 /**
1676 * The name of the region where you want to list stack instances.
1677 */
1678 StackInstanceRegion?: Region;
1679 }
1680 export interface ListStackInstancesOutput {
1681 /**
1682 * A list of StackInstanceSummary structures that contain information about the specified stack instances.
1683 */
1684 Summaries?: StackInstanceSummaries;
1685 /**
1686 * 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.
1687 */
1688 NextToken?: NextToken;
1689 }
1690 export interface ListStackResourcesInput {
1691 /**
1692 * 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.
1693 */
1694 StackName: StackName;
1695 /**
1696 * A string that identifies the next page of stack resources that you want to retrieve.
1697 */
1698 NextToken?: NextToken;
1699 }
1700 export interface ListStackResourcesOutput {
1701 /**
1702 * A list of StackResourceSummary structures.
1703 */
1704 StackResourceSummaries?: StackResourceSummaries;
1705 /**
1706 * 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.
1707 */
1708 NextToken?: NextToken;
1709 }
1710 export interface ListStackSetOperationResultsInput {
1711 /**
1712 * The name or unique ID of the stack set that you want to get operation results for.
1713 */
1714 StackSetName: StackSetName;
1715 /**
1716 * The ID of the stack set operation.
1717 */
1718 OperationId: ClientRequestToken;
1719 /**
1720 * 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.
1721 */
1722 NextToken?: NextToken;
1723 /**
1724 * 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.
1725 */
1726 MaxResults?: MaxResults;
1727 }
1728 export interface ListStackSetOperationResultsOutput {
1729 /**
1730 * A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and regions that are included in the operation.
1731 */
1732 Summaries?: StackSetOperationResultSummaries;
1733 /**
1734 * 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.
1735 */
1736 NextToken?: NextToken;
1737 }
1738 export interface ListStackSetOperationsInput {
1739 /**
1740 * The name or unique ID of the stack set that you want to get operation summaries for.
1741 */
1742 StackSetName: StackSetName;
1743 /**
1744 * 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.
1745 */
1746 NextToken?: NextToken;
1747 /**
1748 * 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.
1749 */
1750 MaxResults?: MaxResults;
1751 }
1752 export interface ListStackSetOperationsOutput {
1753 /**
1754 * A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.
1755 */
1756 Summaries?: StackSetOperationSummaries;
1757 /**
1758 * 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.
1759 */
1760 NextToken?: NextToken;
1761 }
1762 export interface ListStackSetsInput {
1763 /**
1764 * 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.
1765 */
1766 NextToken?: NextToken;
1767 /**
1768 * 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.
1769 */
1770 MaxResults?: MaxResults;
1771 /**
1772 * The status of the stack sets that you want to get summary information about.
1773 */
1774 Status?: StackSetStatus;
1775 }
1776 export interface ListStackSetsOutput {
1777 /**
1778 * A list of StackSetSummary structures that contain information about the user's stack sets.
1779 */
1780 Summaries?: StackSetSummaries;
1781 /**
1782 * 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.
1783 */
1784 NextToken?: NextToken;
1785 }
1786 export interface ListStacksInput {
1787 /**
1788 * A string that identifies the next page of stacks that you want to retrieve.
1789 */
1790 NextToken?: NextToken;
1791 /**
1792 * 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.
1793 */
1794 StackStatusFilter?: StackStatusFilter;
1795 }
1796 export interface ListStacksOutput {
1797 /**
1798 * A list of StackSummary structures containing information about the specified stacks.
1799 */
1800 StackSummaries?: StackSummaries;
1801 /**
1802 * 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.
1803 */
1804 NextToken?: NextToken;
1805 }
1806 export interface ListTypeRegistrationsInput {
1807 /**
1808 * The kind of type. Currently the only valid value is RESOURCE. Conditional: You must specify either TypeName and Type, or Arn.
1809 */
1810 Type?: RegistryType;
1811 /**
1812 * The name of the type. Conditional: You must specify either TypeName and Type, or Arn.
1813 */
1814 TypeName?: TypeName;
1815 /**
1816 * The Amazon Resource Name (ARN) of the type. Conditional: You must specify either TypeName and Type, or Arn.
1817 */
1818 TypeArn?: TypeArn;
1819 /**
1820 * The current status of the type registration request. The default is IN_PROGRESS.
1821 */
1822 RegistrationStatusFilter?: RegistrationStatus;
1823 /**
1824 * 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.
1825 */
1826 MaxResults?: MaxResults;
1827 /**
1828 * If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
1829 */
1830 NextToken?: NextToken;
1831 }
1832 export interface ListTypeRegistrationsOutput {
1833 /**
1834 * A list of type registration tokens. Use DescribeTypeRegistration to return detailed information about a type registration request.
1835 */
1836 RegistrationTokenList?: RegistrationTokenList;
1837 /**
1838 * If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
1839 */
1840 NextToken?: NextToken;
1841 }
1842 export interface ListTypeVersionsInput {
1843 /**
1844 * The kind of the type. Currently the only valid value is RESOURCE. Conditional: You must specify either TypeName and Type, or Arn.
1845 */
1846 Type?: RegistryType;
1847 /**
1848 * The name of the type for which you want version summary information. Conditional: You must specify either TypeName and Type, or Arn.
1849 */
1850 TypeName?: TypeName;
1851 /**
1852 * The Amazon Resource Name (ARN) of the type for which you want version summary information. Conditional: You must specify either TypeName and Type, or Arn.
1853 */
1854 Arn?: PrivateTypeArn;
1855 /**
1856 * 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.
1857 */
1858 MaxResults?: MaxResults;
1859 /**
1860 * If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
1861 */
1862 NextToken?: NextToken;
1863 /**
1864 * The deprecation status of the type versions that you want to get summary information about. Valid values include: LIVE: The type version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope. DEPRECATED: The type version has been deregistered and can no longer be used in CloudFormation operations. The default is LIVE.
1865 */
1866 DeprecatedStatus?: DeprecatedStatus;
1867 }
1868 export interface ListTypeVersionsOutput {
1869 /**
1870 * A list of TypeVersionSummary structures that contain information about the specified type's versions.
1871 */
1872 TypeVersionSummaries?: TypeVersionSummaries;
1873 /**
1874 * If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
1875 */
1876 NextToken?: NextToken;
1877 }
1878 export interface ListTypesInput {
1879 /**
1880 * The scope at which the type is visible and usable in CloudFormation operations. Valid values include: PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE. PUBLIC: The type is publically visible and usable within any Amazon account. The default is PRIVATE.
1881 */
1882 Visibility?: Visibility;
1883 /**
1884 * The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted. Valid values include: FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations. IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations. NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.
1885 */
1886 ProvisioningType?: ProvisioningType;
1887 /**
1888 * The deprecation status of the types that you want to get summary information about. Valid values include: LIVE: The type is registered for use in CloudFormation operations. DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.
1889 */
1890 DeprecatedStatus?: DeprecatedStatus;
1891 /**
1892 * 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.
1893 */
1894 MaxResults?: MaxResults;
1895 /**
1896 * If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
1897 */
1898 NextToken?: NextToken;
1899 }
1900 export interface ListTypesOutput {
1901 /**
1902 * A list of TypeSummary structures that contain information about the specified types.
1903 */
1904 TypeSummaries?: TypeSummaries;
1905 /**
1906 * If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
1907 */
1908 NextToken?: NextToken;
1909 }
1910 export type LogGroupName = string;
1911 export interface LoggingConfig {
1912 /**
1913 * The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
1914 */
1915 LogRoleArn: RoleArn;
1916 /**
1917 * The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
1918 */
1919 LogGroupName: LogGroupName;
1920 }
1921 export type LogicalResourceId = string;
1922 export type LogicalResourceIds = LogicalResourceId[];
1923 export type MaxConcurrentCount = number;
1924 export type MaxConcurrentPercentage = number;
1925 export type MaxResults = number;
1926 export type Metadata = string;
1927 export type MonitoringTimeInMinutes = number;
1928 export type NextToken = string;
1929 export type NoEcho = boolean;
1930 export type NotificationARN = string;
1931 export type NotificationARNs = NotificationARN[];
1932 export type OnFailure = "DO_NOTHING"|"ROLLBACK"|"DELETE"|string;
1933 export type OperationStatus = "PENDING"|"IN_PROGRESS"|"SUCCESS"|"FAILED"|string;
1934 export type OptionalSecureUrl = string;
1935 export type OrganizationalUnitId = string;
1936 export type OrganizationalUnitIdList = OrganizationalUnitId[];
1937 export interface Output {
1938 /**
1939 * The key associated with the output.
1940 */
1941 OutputKey?: OutputKey;
1942 /**
1943 * The value associated with the output.
1944 */
1945 OutputValue?: OutputValue;
1946 /**
1947 * User defined description associated with the output.
1948 */
1949 Description?: Description;
1950 /**
1951 * The name of the export associated with the output.
1952 */
1953 ExportName?: ExportName;
1954 }
1955 export type OutputKey = string;
1956 export type OutputValue = string;
1957 export type Outputs = Output[];
1958 export interface Parameter {
1959 /**
1960 * 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.
1961 */
1962 ParameterKey?: ParameterKey;
1963 /**
1964 * The input value associated with the parameter.
1965 */
1966 ParameterValue?: ParameterValue;
1967 /**
1968 * 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.
1969 */
1970 UsePreviousValue?: UsePreviousValue;
1971 /**
1972 * Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.
1973 */
1974 ResolvedValue?: ParameterValue;
1975 }
1976 export interface ParameterConstraints {
1977 /**
1978 * A list of values that are permitted for a parameter.
1979 */
1980 AllowedValues?: AllowedValues;
1981 }
1982 export interface ParameterDeclaration {
1983 /**
1984 * The name that is associated with the parameter.
1985 */
1986 ParameterKey?: ParameterKey;
1987 /**
1988 * The default value of the parameter.
1989 */
1990 DefaultValue?: ParameterValue;
1991 /**
1992 * The type of parameter.
1993 */
1994 ParameterType?: ParameterType;
1995 /**
1996 * Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
1997 */
1998 NoEcho?: NoEcho;
1999 /**
2000 * The description that is associate with the parameter.
2001 */
2002 Description?: Description;
2003 /**
2004 * The criteria that AWS CloudFormation uses to validate parameter values.
2005 */
2006 ParameterConstraints?: ParameterConstraints;
2007 }
2008 export type ParameterDeclarations = ParameterDeclaration[];
2009 export type ParameterKey = string;
2010 export type ParameterType = string;
2011 export type ParameterValue = string;
2012 export type Parameters = Parameter[];
2013 export type PermissionModels = "SERVICE_MANAGED"|"SELF_MANAGED"|string;
2014 export type PhysicalResourceId = string;
2015 export type PhysicalResourceIdContext = PhysicalResourceIdContextKeyValuePair[];
2016 export interface PhysicalResourceIdContextKeyValuePair {
2017 /**
2018 * The resource context key.
2019 */
2020 Key: Key;
2021 /**
2022 * The resource context value.
2023 */
2024 Value: Value;
2025 }
2026 export type PrivateTypeArn = string;
2027 export type Properties = string;
2028 export interface PropertyDifference {
2029 /**
2030 * The fully-qualified path to the resource property.
2031 */
2032 PropertyPath: PropertyPath;
2033 /**
2034 * The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.
2035 */
2036 ExpectedValue: PropertyValue;
2037 /**
2038 * The actual property value of the resource property.
2039 */
2040 ActualValue: PropertyValue;
2041 /**
2042 * 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).
2043 */
2044 DifferenceType: DifferenceType;
2045 }
2046 export type PropertyDifferences = PropertyDifference[];
2047 export type PropertyName = string;
2048 export type PropertyPath = string;
2049 export type PropertyValue = string;
2050 export type ProvisioningType = "NON_PROVISIONABLE"|"IMMUTABLE"|"FULLY_MUTABLE"|string;
2051 export type Reason = string;
2052 export interface RecordHandlerProgressInput {
2053 /**
2054 * Reserved for use by the CloudFormation CLI.
2055 */
2056 BearerToken: ClientToken;
2057 /**
2058 * Reserved for use by the CloudFormation CLI.
2059 */
2060 OperationStatus: OperationStatus;
2061 /**
2062 * Reserved for use by the CloudFormation CLI.
2063 */
2064 CurrentOperationStatus?: OperationStatus;
2065 /**
2066 * Reserved for use by the CloudFormation CLI.
2067 */
2068 StatusMessage?: StatusMessage;
2069 /**
2070 * Reserved for use by the CloudFormation CLI.
2071 */
2072 ErrorCode?: HandlerErrorCode;
2073 /**
2074 * Reserved for use by the CloudFormation CLI.
2075 */
2076 ResourceModel?: ResourceModel;
2077 /**
2078 * Reserved for use by the CloudFormation CLI.
2079 */
2080 ClientRequestToken?: ClientRequestToken;
2081 }
2082 export interface RecordHandlerProgressOutput {
2083 }
2084 export type Region = string;
2085 export type RegionList = Region[];
2086 export interface RegisterTypeInput {
2087 /**
2088 * The kind of type. Currently, the only valid value is RESOURCE.
2089 */
2090 Type?: RegistryType;
2091 /**
2092 * The name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type. The following organization namespaces are reserved and cannot be used in your resource type names: Alexa AMZN Amazon AWS Custom Dev
2093 */
2094 TypeName: TypeName;
2095 /**
2096 * A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register. For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide. As part of registering a resource provider type, CloudFormation must be able to access the S3 bucket which contains the schema handler package for that resource provider. For more information, see IAM Permissions for Registering a Resource Provider in the AWS CloudFormation User Guide.
2097 */
2098 SchemaHandlerPackage: S3Url;
2099 /**
2100 * Specifies logging configuration information for a type.
2101 */
2102 LoggingConfig?: LoggingConfig;
2103 /**
2104 * The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
2105 */
2106 ExecutionRoleArn?: RoleArn;
2107 /**
2108 * A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of a type from the same registeration request, even if the request is submitted multiple times.
2109 */
2110 ClientRequestToken?: RequestToken;
2111 }
2112 export interface RegisterTypeOutput {
2113 /**
2114 * The identifier for this registration request. Use this registration token when calling DescribeTypeRegistration , which returns information about the status and IDs of the type registration.
2115 */
2116 RegistrationToken?: RegistrationToken;
2117 }
2118 export type RegistrationStatus = "COMPLETE"|"IN_PROGRESS"|"FAILED"|string;
2119 export type RegistrationToken = string;
2120 export type RegistrationTokenList = RegistrationToken[];
2121 export type RegistryType = "RESOURCE"|string;
2122 export type Replacement = "True"|"False"|"Conditional"|string;
2123 export type RequestToken = string;
2124 export type RequiresRecreation = "Never"|"Conditionally"|"Always"|string;
2125 export type ResourceAttribute = "Properties"|"Metadata"|"CreationPolicy"|"UpdatePolicy"|"DeletionPolicy"|"Tags"|string;
2126 export interface ResourceChange {
2127 /**
2128 * 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).
2129 */
2130 Action?: ChangeAction;
2131 /**
2132 * The resource's logical ID, which is defined in the stack's template.
2133 */
2134 LogicalResourceId?: LogicalResourceId;
2135 /**
2136 * The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
2137 */
2138 PhysicalResourceId?: PhysicalResourceId;
2139 /**
2140 * The type of AWS CloudFormation resource, such as AWS::S3::Bucket.
2141 */
2142 ResourceType?: ResourceType;
2143 /**
2144 * 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.
2145 */
2146 Replacement?: Replacement;
2147 /**
2148 * 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.
2149 */
2150 Scope?: Scope;
2151 /**
2152 * For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.
2153 */
2154 Details?: ResourceChangeDetails;
2155 }
2156 export interface ResourceChangeDetail {
2157 /**
2158 * A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.
2159 */
2160 Target?: ResourceTargetDefinition;
2161 /**
2162 * 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.
2163 */
2164 Evaluation?: EvaluationType;
2165 /**
2166 * 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.
2167 */
2168 ChangeSource?: ChangeSource;
2169 /**
2170 * 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.
2171 */
2172 CausingEntity?: CausingEntity;
2173 }
2174 export type ResourceChangeDetails = ResourceChangeDetail[];
2175 export type ResourceIdentifierProperties = {[key: string]: ResourceIdentifierPropertyValue};
2176 export type ResourceIdentifierPropertyKey = string;
2177 export type ResourceIdentifierPropertyValue = string;
2178 export type ResourceIdentifierSummaries = ResourceIdentifierSummary[];
2179 export interface ResourceIdentifierSummary {
2180 /**
2181 * The template resource type of the target resources, such as AWS::S3::Bucket.
2182 */
2183 ResourceType?: ResourceType;
2184 /**
2185 * The logical IDs of the target resources of the specified ResourceType, as defined in the import template.
2186 */
2187 LogicalResourceIds?: LogicalResourceIds;
2188 /**
2189 * The resource properties you can provide during the import to identify your target resources. For example, BucketName is a possible identifier property for AWS::S3::Bucket resources.
2190 */
2191 ResourceIdentifiers?: ResourceIdentifiers;
2192 }
2193 export type ResourceIdentifiers = ResourceIdentifierPropertyKey[];
2194 export type ResourceModel = string;
2195 export type ResourceProperties = string;
2196 export type ResourceSignalStatus = "SUCCESS"|"FAILURE"|string;
2197 export type ResourceSignalUniqueId = string;
2198 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"|"IMPORT_FAILED"|"IMPORT_COMPLETE"|"IMPORT_IN_PROGRESS"|"IMPORT_ROLLBACK_IN_PROGRESS"|"IMPORT_ROLLBACK_FAILED"|"IMPORT_ROLLBACK_COMPLETE"|string;
2199 export type ResourceStatusReason = string;
2200 export interface ResourceTargetDefinition {
2201 /**
2202 * Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
2203 */
2204 Attribute?: ResourceAttribute;
2205 /**
2206 * If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.
2207 */
2208 Name?: PropertyName;
2209 /**
2210 * 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.
2211 */
2212 RequiresRecreation?: RequiresRecreation;
2213 }
2214 export interface ResourceToImport {
2215 /**
2216 * The type of resource to import into your stack, such as AWS::S3::Bucket.
2217 */
2218 ResourceType: ResourceType;
2219 /**
2220 * The logical ID of the target resource as specified in the template.
2221 */
2222 LogicalResourceId: LogicalResourceId;
2223 /**
2224 * A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).
2225 */
2226 ResourceIdentifier: ResourceIdentifierProperties;
2227 }
2228 export type ResourceToSkip = string;
2229 export type ResourceType = string;
2230 export type ResourceTypes = ResourceType[];
2231 export type ResourcesToImport = ResourceToImport[];
2232 export type ResourcesToSkip = ResourceToSkip[];
2233 export type RetainResources = LogicalResourceId[];
2234 export type RetainStacks = boolean;
2235 export type RetainStacksNullable = boolean;
2236 export type RetainStacksOnAccountRemovalNullable = boolean;
2237 export type RoleARN = string;
2238 export type RoleArn = string;
2239 export interface RollbackConfiguration {
2240 /**
2241 * 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.
2242 */
2243 RollbackTriggers?: RollbackTriggers;
2244 /**
2245 * 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.
2246 */
2247 MonitoringTimeInMinutes?: MonitoringTimeInMinutes;
2248 }
2249 export interface RollbackTrigger {
2250 /**
2251 * The Amazon Resource Name (ARN) of the rollback trigger. If a specified trigger is missing, the entire stack operation fails and is rolled back.
2252 */
2253 Arn: Arn;
2254 /**
2255 * The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.
2256 */
2257 Type: Type;
2258 }
2259 export type RollbackTriggers = RollbackTrigger[];
2260 export type S3Url = string;
2261 export type Scope = ResourceAttribute[];
2262 export interface SetStackPolicyInput {
2263 /**
2264 * The name or unique stack ID that you want to associate a policy with.
2265 */
2266 StackName: StackName;
2267 /**
2268 * 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.
2269 */
2270 StackPolicyBody?: StackPolicyBody;
2271 /**
2272 * 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.
2273 */
2274 StackPolicyURL?: StackPolicyURL;
2275 }
2276 export interface SetTypeDefaultVersionInput {
2277 /**
2278 * The Amazon Resource Name (ARN) of the type for which you want version summary information. Conditional: You must specify either TypeName and Type, or Arn.
2279 */
2280 Arn?: PrivateTypeArn;
2281 /**
2282 * The kind of type. Conditional: You must specify either TypeName and Type, or Arn.
2283 */
2284 Type?: RegistryType;
2285 /**
2286 * The name of the type. Conditional: You must specify either TypeName and Type, or Arn.
2287 */
2288 TypeName?: TypeName;
2289 /**
2290 * The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.
2291 */
2292 VersionId?: TypeVersionId;
2293 }
2294 export interface SetTypeDefaultVersionOutput {
2295 }
2296 export interface SignalResourceInput {
2297 /**
2298 * The stack name or unique stack ID that includes the resource that you want to signal.
2299 */
2300 StackName: StackNameOrId;
2301 /**
2302 * 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.
2303 */
2304 LogicalResourceId: LogicalResourceId;
2305 /**
2306 * 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.
2307 */
2308 UniqueId: ResourceSignalUniqueId;
2309 /**
2310 * 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.
2311 */
2312 Status: ResourceSignalStatus;
2313 }
2314 export interface Stack {
2315 /**
2316 * Unique identifier of the stack.
2317 */
2318 StackId?: StackId;
2319 /**
2320 * The name associated with the stack.
2321 */
2322 StackName: StackName;
2323 /**
2324 * The unique ID of the change set.
2325 */
2326 ChangeSetId?: ChangeSetId;
2327 /**
2328 * A user-defined description associated with the stack.
2329 */
2330 Description?: Description;
2331 /**
2332 * A list of Parameter structures.
2333 */
2334 Parameters?: Parameters;
2335 /**
2336 * The time at which the stack was created.
2337 */
2338 CreationTime: CreationTime;
2339 /**
2340 * The time the stack was deleted.
2341 */
2342 DeletionTime?: DeletionTime;
2343 /**
2344 * The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
2345 */
2346 LastUpdatedTime?: LastUpdatedTime;
2347 /**
2348 * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
2349 */
2350 RollbackConfiguration?: RollbackConfiguration;
2351 /**
2352 * Current status of the stack.
2353 */
2354 StackStatus: StackStatus;
2355 /**
2356 * Success/failure message associated with the stack status.
2357 */
2358 StackStatusReason?: StackStatusReason;
2359 /**
2360 * Boolean to enable or disable rollback on stack creation failures: true: disable rollback false: enable rollback
2361 */
2362 DisableRollback?: DisableRollback;
2363 /**
2364 * SNS topic ARNs to which stack related events are published.
2365 */
2366 NotificationARNs?: NotificationARNs;
2367 /**
2368 * The amount of time within which stack creation should complete.
2369 */
2370 TimeoutInMinutes?: TimeoutMinutes;
2371 /**
2372 * The capabilities allowed in the stack.
2373 */
2374 Capabilities?: Capabilities;
2375 /**
2376 * A list of output structures.
2377 */
2378 Outputs?: Outputs;
2379 /**
2380 * 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.
2381 */
2382 RoleARN?: RoleARN;
2383 /**
2384 * A list of Tags that specify information about the stack.
2385 */
2386 Tags?: Tags;
2387 /**
2388 * 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.
2389 */
2390 EnableTerminationProtection?: EnableTerminationProtection;
2391 /**
2392 * 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.
2393 */
2394 ParentId?: StackId;
2395 /**
2396 * For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
2397 */
2398 RootId?: StackId;
2399 /**
2400 * 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.
2401 */
2402 DriftInformation?: StackDriftInformation;
2403 }
2404 export type StackDriftDetectionId = string;
2405 export type StackDriftDetectionStatus = "DETECTION_IN_PROGRESS"|"DETECTION_FAILED"|"DETECTION_COMPLETE"|string;
2406 export type StackDriftDetectionStatusReason = string;
2407 export interface StackDriftInformation {
2408 /**
2409 * 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.
2410 */
2411 StackDriftStatus: StackDriftStatus;
2412 /**
2413 * Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
2414 */
2415 LastCheckTimestamp?: Timestamp;
2416 }
2417 export interface StackDriftInformationSummary {
2418 /**
2419 * 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.
2420 */
2421 StackDriftStatus: StackDriftStatus;
2422 /**
2423 * Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
2424 */
2425 LastCheckTimestamp?: Timestamp;
2426 }
2427 export type StackDriftStatus = "DRIFTED"|"IN_SYNC"|"UNKNOWN"|"NOT_CHECKED"|string;
2428 export interface StackEvent {
2429 /**
2430 * The unique ID name of the instance of the stack.
2431 */
2432 StackId: StackId;
2433 /**
2434 * The unique ID of this event.
2435 */
2436 EventId: EventId;
2437 /**
2438 * The name associated with a stack.
2439 */
2440 StackName: StackName;
2441 /**
2442 * The logical name of the resource specified in the template.
2443 */
2444 LogicalResourceId?: LogicalResourceId;
2445 /**
2446 * The name or unique identifier associated with the physical instance of the resource.
2447 */
2448 PhysicalResourceId?: PhysicalResourceId;
2449 /**
2450 * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
2451 */
2452 ResourceType?: ResourceType;
2453 /**
2454 * Time the status was updated.
2455 */
2456 Timestamp: Timestamp;
2457 /**
2458 * Current status of the resource.
2459 */
2460 ResourceStatus?: ResourceStatus;
2461 /**
2462 * Success/failure message associated with the resource.
2463 */
2464 ResourceStatusReason?: ResourceStatusReason;
2465 /**
2466 * BLOB of the properties used to create the resource.
2467 */
2468 ResourceProperties?: ResourceProperties;
2469 /**
2470 * 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.
2471 */
2472 ClientRequestToken?: ClientRequestToken;
2473 }
2474 export type StackEvents = StackEvent[];
2475 export type StackId = string;
2476 export interface StackInstance {
2477 /**
2478 * The name or unique ID of the stack set that the stack instance is associated with.
2479 */
2480 StackSetId?: StackSetId;
2481 /**
2482 * The name of the AWS region that the stack instance is associated with.
2483 */
2484 Region?: Region;
2485 /**
2486 * [Self-managed permissions] The name of the AWS account that the stack instance is associated with.
2487 */
2488 Account?: Account;
2489 /**
2490 * The ID of the stack instance.
2491 */
2492 StackId?: StackId;
2493 /**
2494 * A list of parameters from the stack set template whose values have been overridden in this stack instance.
2495 */
2496 ParameterOverrides?: Parameters;
2497 /**
2498 * 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.
2499 */
2500 Status?: StackInstanceStatus;
2501 /**
2502 * The explanation for the specific status code that is assigned to this stack instance.
2503 */
2504 StatusReason?: Reason;
2505 /**
2506 * [Service-managed permissions] The organization root ID or organizational unit (OU) ID that the stack instance is associated with.
2507 */
2508 OrganizationalUnitId?: OrganizationalUnitId;
2509 /**
2510 * Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack instance differs from its expected stack set configuration. IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration. UNKNOWN: This value is reserved for future use.
2511 */
2512 DriftStatus?: StackDriftStatus;
2513 /**
2514 * Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection has not yet been performed.
2515 */
2516 LastDriftCheckTimestamp?: Timestamp;
2517 }
2518 export type StackInstanceStatus = "CURRENT"|"OUTDATED"|"INOPERABLE"|string;
2519 export type StackInstanceSummaries = StackInstanceSummary[];
2520 export interface StackInstanceSummary {
2521 /**
2522 * The name or unique ID of the stack set that the stack instance is associated with.
2523 */
2524 StackSetId?: StackSetId;
2525 /**
2526 * The name of the AWS region that the stack instance is associated with.
2527 */
2528 Region?: Region;
2529 /**
2530 * [Self-managed permissions] The name of the AWS account that the stack instance is associated with.
2531 */
2532 Account?: Account;
2533 /**
2534 * The ID of the stack instance.
2535 */
2536 StackId?: StackId;
2537 /**
2538 * 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.
2539 */
2540 Status?: StackInstanceStatus;
2541 /**
2542 * The explanation for the specific status code assigned to this stack instance.
2543 */
2544 StatusReason?: Reason;
2545 /**
2546 * [Service-managed permissions] The organization root ID or organizational unit (OU) ID that the stack instance is associated with.
2547 */
2548 OrganizationalUnitId?: OrganizationalUnitId;
2549 /**
2550 * Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack instance differs from its expected stack set configuration. IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration. UNKNOWN: This value is reserved for future use.
2551 */
2552 DriftStatus?: StackDriftStatus;
2553 /**
2554 * Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection has not yet been performed.
2555 */
2556 LastDriftCheckTimestamp?: Timestamp;
2557 }
2558 export type StackName = string;
2559 export type StackNameOrId = string;
2560 export type StackPolicyBody = string;
2561 export type StackPolicyDuringUpdateBody = string;
2562 export type StackPolicyDuringUpdateURL = string;
2563 export type StackPolicyURL = string;
2564 export interface StackResource {
2565 /**
2566 * The name associated with the stack.
2567 */
2568 StackName?: StackName;
2569 /**
2570 * Unique identifier of the stack.
2571 */
2572 StackId?: StackId;
2573 /**
2574 * The logical name of the resource specified in the template.
2575 */
2576 LogicalResourceId: LogicalResourceId;
2577 /**
2578 * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
2579 */
2580 PhysicalResourceId?: PhysicalResourceId;
2581 /**
2582 * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
2583 */
2584 ResourceType: ResourceType;
2585 /**
2586 * Time the status was updated.
2587 */
2588 Timestamp: Timestamp;
2589 /**
2590 * Current status of the resource.
2591 */
2592 ResourceStatus: ResourceStatus;
2593 /**
2594 * Success/failure message associated with the resource.
2595 */
2596 ResourceStatusReason?: ResourceStatusReason;
2597 /**
2598 * User defined description associated with the resource.
2599 */
2600 Description?: Description;
2601 /**
2602 * 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.
2603 */
2604 DriftInformation?: StackResourceDriftInformation;
2605 }
2606 export interface StackResourceDetail {
2607 /**
2608 * The name associated with the stack.
2609 */
2610 StackName?: StackName;
2611 /**
2612 * Unique identifier of the stack.
2613 */
2614 StackId?: StackId;
2615 /**
2616 * The logical name of the resource specified in the template.
2617 */
2618 LogicalResourceId: LogicalResourceId;
2619 /**
2620 * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
2621 */
2622 PhysicalResourceId?: PhysicalResourceId;
2623 /**
2624 * Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
2625 */
2626 ResourceType: ResourceType;
2627 /**
2628 * Time the status was updated.
2629 */
2630 LastUpdatedTimestamp: Timestamp;
2631 /**
2632 * Current status of the resource.
2633 */
2634 ResourceStatus: ResourceStatus;
2635 /**
2636 * Success/failure message associated with the resource.
2637 */
2638 ResourceStatusReason?: ResourceStatusReason;
2639 /**
2640 * User defined description associated with the resource.
2641 */
2642 Description?: Description;
2643 /**
2644 * The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.
2645 */
2646 Metadata?: Metadata;
2647 /**
2648 * 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.
2649 */
2650 DriftInformation?: StackResourceDriftInformation;
2651 }
2652 export interface StackResourceDrift {
2653 /**
2654 * The ID of the stack.
2655 */
2656 StackId: StackId;
2657 /**
2658 * The logical name of the resource specified in the template.
2659 */
2660 LogicalResourceId: LogicalResourceId;
2661 /**
2662 * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
2663 */
2664 PhysicalResourceId?: PhysicalResourceId;
2665 /**
2666 * 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.
2667 */
2668 PhysicalResourceIdContext?: PhysicalResourceIdContext;
2669 /**
2670 * The type of the resource.
2671 */
2672 ResourceType: ResourceType;
2673 /**
2674 * 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.
2675 */
2676 ExpectedProperties?: Properties;
2677 /**
2678 * A JSON structure containing the actual property values of the stack resource. For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.
2679 */
2680 ActualProperties?: Properties;
2681 /**
2682 * 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.
2683 */
2684 PropertyDifferences?: PropertyDifferences;
2685 /**
2686 * 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.
2687 */
2688 StackResourceDriftStatus: StackResourceDriftStatus;
2689 /**
2690 * Time at which AWS CloudFormation performed drift detection on the stack resource.
2691 */
2692 Timestamp: Timestamp;
2693 }
2694 export interface StackResourceDriftInformation {
2695 /**
2696 * 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.
2697 */
2698 StackResourceDriftStatus: StackResourceDriftStatus;
2699 /**
2700 * When AWS CloudFormation last checked if the resource had drifted from its expected configuration.
2701 */
2702 LastCheckTimestamp?: Timestamp;
2703 }
2704 export interface StackResourceDriftInformationSummary {
2705 /**
2706 * 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.
2707 */
2708 StackResourceDriftStatus: StackResourceDriftStatus;
2709 /**
2710 * When AWS CloudFormation last checked if the resource had drifted from its expected configuration.
2711 */
2712 LastCheckTimestamp?: Timestamp;
2713 }
2714 export type StackResourceDriftStatus = "IN_SYNC"|"MODIFIED"|"DELETED"|"NOT_CHECKED"|string;
2715 export type StackResourceDriftStatusFilters = StackResourceDriftStatus[];
2716 export type StackResourceDrifts = StackResourceDrift[];
2717 export type StackResourceSummaries = StackResourceSummary[];
2718 export interface StackResourceSummary {
2719 /**
2720 * The logical name of the resource specified in the template.
2721 */
2722 LogicalResourceId: LogicalResourceId;
2723 /**
2724 * The name or unique identifier that corresponds to a physical instance ID of the resource.
2725 */
2726 PhysicalResourceId?: PhysicalResourceId;
2727 /**
2728 * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
2729 */
2730 ResourceType: ResourceType;
2731 /**
2732 * Time the status was updated.
2733 */
2734 LastUpdatedTimestamp: Timestamp;
2735 /**
2736 * Current status of the resource.
2737 */
2738 ResourceStatus: ResourceStatus;
2739 /**
2740 * Success/failure message associated with the resource.
2741 */
2742 ResourceStatusReason?: ResourceStatusReason;
2743 /**
2744 * 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.
2745 */
2746 DriftInformation?: StackResourceDriftInformationSummary;
2747 }
2748 export type StackResources = StackResource[];
2749 export interface StackSet {
2750 /**
2751 * The name that's associated with the stack set.
2752 */
2753 StackSetName?: StackSetName;
2754 /**
2755 * The ID of the stack set.
2756 */
2757 StackSetId?: StackSetId;
2758 /**
2759 * A description of the stack set that you specify when the stack set is created or updated.
2760 */
2761 Description?: Description;
2762 /**
2763 * The status of the stack set.
2764 */
2765 Status?: StackSetStatus;
2766 /**
2767 * The structure that contains the body of the template that was used to create or update the stack set.
2768 */
2769 TemplateBody?: TemplateBody;
2770 /**
2771 * A list of input parameters for a stack set.
2772 */
2773 Parameters?: Parameters;
2774 /**
2775 * 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.
2776 */
2777 Capabilities?: Capabilities;
2778 /**
2779 * A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
2780 */
2781 Tags?: Tags;
2782 /**
2783 * The Amazon Resource Number (ARN) of the stack set.
2784 */
2785 StackSetARN?: StackSetARN;
2786 /**
2787 * 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.
2788 */
2789 AdministrationRoleARN?: RoleARN;
2790 /**
2791 * 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.
2792 */
2793 ExecutionRoleName?: ExecutionRoleName;
2794 /**
2795 * Detailed information about the drift status of the stack set. For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress is not included.
2796 */
2797 StackSetDriftDetectionDetails?: StackSetDriftDetectionDetails;
2798 /**
2799 * [Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
2800 */
2801 AutoDeployment?: AutoDeployment;
2802 /**
2803 * Describes how the IAM roles required for stack set operations are created. With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
2804 */
2805 PermissionModel?: PermissionModels;
2806 /**
2807 * [Service-managed permissions] The organization root ID or organizational unit (OUs) IDs to which stacks in your stack set have been deployed.
2808 */
2809 OrganizationalUnitIds?: OrganizationalUnitIdList;
2810 }
2811 export type StackSetARN = string;
2812 export interface StackSetDriftDetectionDetails {
2813 /**
2814 * Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration. DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. NOT_CHECKED: AWS CloudFormation has not checked the stack set for drift. IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration.
2815 */
2816 DriftStatus?: StackSetDriftStatus;
2817 /**
2818 * The status of the stack set drift detection operation. COMPLETED: The drift detection operation completed without failing on any stack instances. FAILED: The drift detection operation exceeded the specified failure tolerance. PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation. IN_PROGRESS: The drift detection operation is currently being performed. STOPPED: The user has cancelled the drift detection operation.
2819 */
2820 DriftDetectionStatus?: StackSetDriftDetectionStatus;
2821 /**
2822 * Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection has not yet been performed.
2823 */
2824 LastDriftCheckTimestamp?: Timestamp;
2825 /**
2826 * The total number of stack instances belonging to this stack set. The total number of stack instances is equal to the total of: Stack instances that match the stack set configuration. Stack instances that have drifted from the stack set configuration. Stack instances where the drift detection operation has failed. Stack instances currently being checked for drift.
2827 */
2828 TotalStackInstancesCount?: TotalStackInstancesCount;
2829 /**
2830 * The number of stack instances that have drifted from the expected template and parameter configuration of the stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack do not match their expected configuration.
2831 */
2832 DriftedStackInstancesCount?: DriftedStackInstancesCount;
2833 /**
2834 * The number of stack instances which match the expected template and parameter configuration of the stack set.
2835 */
2836 InSyncStackInstancesCount?: InSyncStackInstancesCount;
2837 /**
2838 * The number of stack instances that are currently being checked for drift.
2839 */
2840 InProgressStackInstancesCount?: InProgressStackInstancesCount;
2841 /**
2842 * The number of stack instances for which the drift detection operation failed.
2843 */
2844 FailedStackInstancesCount?: FailedStackInstancesCount;
2845 }
2846 export type StackSetDriftDetectionStatus = "COMPLETED"|"FAILED"|"PARTIAL_SUCCESS"|"IN_PROGRESS"|"STOPPED"|string;
2847 export type StackSetDriftStatus = "DRIFTED"|"IN_SYNC"|"NOT_CHECKED"|string;
2848 export type StackSetId = string;
2849 export type StackSetName = string;
2850 export type StackSetNameOrId = string;
2851 export interface StackSetOperation {
2852 /**
2853 * The unique ID of a stack set operation.
2854 */
2855 OperationId?: ClientRequestToken;
2856 /**
2857 * The ID of the stack set.
2858 */
2859 StackSetId?: StackSetId;
2860 /**
2861 * 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.
2862 */
2863 Action?: StackSetOperationAction;
2864 /**
2865 * 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. QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations. The operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide. 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.
2866 */
2867 Status?: StackSetOperationStatus;
2868 /**
2869 * The preferences for how AWS CloudFormation performs this stack set operation.
2870 */
2871 OperationPreferences?: StackSetOperationPreferences;
2872 /**
2873 * 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.
2874 */
2875 RetainStacks?: RetainStacksNullable;
2876 /**
2877 * 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.
2878 */
2879 AdministrationRoleARN?: RoleARN;
2880 /**
2881 * 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.
2882 */
2883 ExecutionRoleName?: ExecutionRoleName;
2884 /**
2885 * 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.
2886 */
2887 CreationTimestamp?: Timestamp;
2888 /**
2889 * 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.
2890 */
2891 EndTimestamp?: Timestamp;
2892 /**
2893 * [Service-managed permissions] The AWS Organizations accounts affected by the stack operation.
2894 */
2895 DeploymentTargets?: DeploymentTargets;
2896 /**
2897 * Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set. this information will only be present for stack set operations whose Action type is DETECT_DRIFT. For more information, see Detecting Unmanaged Changes in Stack Sets in the AWS CloudFormation User Guide.
2898 */
2899 StackSetDriftDetectionDetails?: StackSetDriftDetectionDetails;
2900 }
2901 export type StackSetOperationAction = "CREATE"|"UPDATE"|"DELETE"|"DETECT_DRIFT"|string;
2902 export interface StackSetOperationPreferences {
2903 /**
2904 * The order of the regions in where you want to perform the stack operation.
2905 */
2906 RegionOrder?: RegionList;
2907 /**
2908 * 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).
2909 */
2910 FailureToleranceCount?: FailureToleranceCount;
2911 /**
2912 * 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.
2913 */
2914 FailureTolerancePercentage?: FailureTolerancePercentage;
2915 /**
2916 * 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.
2917 */
2918 MaxConcurrentCount?: MaxConcurrentCount;
2919 /**
2920 * 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.
2921 */
2922 MaxConcurrentPercentage?: MaxConcurrentPercentage;
2923 }
2924 export type StackSetOperationResultStatus = "PENDING"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED"|string;
2925 export type StackSetOperationResultSummaries = StackSetOperationResultSummary[];
2926 export interface StackSetOperationResultSummary {
2927 /**
2928 * [Self-managed permissions] The name of the AWS account for this operation result.
2929 */
2930 Account?: Account;
2931 /**
2932 * The name of the AWS region for this operation result.
2933 */
2934 Region?: Region;
2935 /**
2936 * 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.
2937 */
2938 Status?: StackSetOperationResultStatus;
2939 /**
2940 * The reason for the assigned result status.
2941 */
2942 StatusReason?: Reason;
2943 /**
2944 * The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account
2945 */
2946 AccountGateResult?: AccountGateResult;
2947 /**
2948 * [Service-managed permissions] The organization root ID or organizational unit (OU) ID for this operation result.
2949 */
2950 OrganizationalUnitId?: OrganizationalUnitId;
2951 }
2952 export type StackSetOperationStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|"STOPPING"|"STOPPED"|"QUEUED"|string;
2953 export type StackSetOperationSummaries = StackSetOperationSummary[];
2954 export interface StackSetOperationSummary {
2955 /**
2956 * The unique ID of the stack set operation.
2957 */
2958 OperationId?: ClientRequestToken;
2959 /**
2960 * 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.
2961 */
2962 Action?: StackSetOperationAction;
2963 /**
2964 * 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. QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations. The operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide. 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.
2965 */
2966 Status?: StackSetOperationStatus;
2967 /**
2968 * 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.
2969 */
2970 CreationTimestamp?: Timestamp;
2971 /**
2972 * 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.
2973 */
2974 EndTimestamp?: Timestamp;
2975 }
2976 export type StackSetStatus = "ACTIVE"|"DELETED"|string;
2977 export type StackSetSummaries = StackSetSummary[];
2978 export interface StackSetSummary {
2979 /**
2980 * The name of the stack set.
2981 */
2982 StackSetName?: StackSetName;
2983 /**
2984 * The ID of the stack set.
2985 */
2986 StackSetId?: StackSetId;
2987 /**
2988 * A description of the stack set that you specify when the stack set is created or updated.
2989 */
2990 Description?: Description;
2991 /**
2992 * The status of the stack set.
2993 */
2994 Status?: StackSetStatus;
2995 /**
2996 * [Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organizational unit (OU).
2997 */
2998 AutoDeployment?: AutoDeployment;
2999 /**
3000 * Describes how the IAM roles required for stack set operations are created. With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
3001 */
3002 PermissionModel?: PermissionModels;
3003 /**
3004 * Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration. DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. NOT_CHECKED: AWS CloudFormation has not checked the stack set for drift. IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration. UNKNOWN: This value is reserved for future use.
3005 */
3006 DriftStatus?: StackDriftStatus;
3007 /**
3008 * Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection has not yet been performed.
3009 */
3010 LastDriftCheckTimestamp?: Timestamp;
3011 }
3012 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"|"IMPORT_IN_PROGRESS"|"IMPORT_COMPLETE"|"IMPORT_ROLLBACK_IN_PROGRESS"|"IMPORT_ROLLBACK_FAILED"|"IMPORT_ROLLBACK_COMPLETE"|string;
3013 export type StackStatusFilter = StackStatus[];
3014 export type StackStatusReason = string;
3015 export type StackSummaries = StackSummary[];
3016 export interface StackSummary {
3017 /**
3018 * Unique stack identifier.
3019 */
3020 StackId?: StackId;
3021 /**
3022 * The name associated with the stack.
3023 */
3024 StackName: StackName;
3025 /**
3026 * The template description of the template used to create the stack.
3027 */
3028 TemplateDescription?: TemplateDescription;
3029 /**
3030 * The time the stack was created.
3031 */
3032 CreationTime: CreationTime;
3033 /**
3034 * The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
3035 */
3036 LastUpdatedTime?: LastUpdatedTime;
3037 /**
3038 * The time the stack was deleted.
3039 */
3040 DeletionTime?: DeletionTime;
3041 /**
3042 * The current status of the stack.
3043 */
3044 StackStatus: StackStatus;
3045 /**
3046 * Success/Failure message associated with the stack status.
3047 */
3048 StackStatusReason?: StackStatusReason;
3049 /**
3050 * 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.
3051 */
3052 ParentId?: StackId;
3053 /**
3054 * For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
3055 */
3056 RootId?: StackId;
3057 /**
3058 * 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.
3059 */
3060 DriftInformation?: StackDriftInformationSummary;
3061 }
3062 export type Stacks = Stack[];
3063 export type StageList = TemplateStage[];
3064 export type StatusMessage = string;
3065 export interface StopStackSetOperationInput {
3066 /**
3067 * The name or unique ID of the stack set that you want to stop the operation for.
3068 */
3069 StackSetName: StackSetName;
3070 /**
3071 * The ID of the stack operation.
3072 */
3073 OperationId: ClientRequestToken;
3074 }
3075 export interface StopStackSetOperationOutput {
3076 }
3077 export interface Tag {
3078 /**
3079 * 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:.
3080 */
3081 Key: TagKey;
3082 /**
3083 * Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
3084 */
3085 Value: TagValue;
3086 }
3087 export type TagKey = string;
3088 export type TagValue = string;
3089 export type Tags = Tag[];
3090 export type TemplateBody = string;
3091 export type TemplateDescription = string;
3092 export interface TemplateParameter {
3093 /**
3094 * The name associated with the parameter.
3095 */
3096 ParameterKey?: ParameterKey;
3097 /**
3098 * The default value associated with the parameter.
3099 */
3100 DefaultValue?: ParameterValue;
3101 /**
3102 * Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
3103 */
3104 NoEcho?: NoEcho;
3105 /**
3106 * User defined description associated with the parameter.
3107 */
3108 Description?: Description;
3109 }
3110 export type TemplateParameters = TemplateParameter[];
3111 export type TemplateStage = "Original"|"Processed"|string;
3112 export type TemplateURL = string;
3113 export type TimeoutMinutes = number;
3114 export type Timestamp = Date;
3115 export type TotalStackInstancesCount = number;
3116 export type TransformName = string;
3117 export type TransformsList = TransformName[];
3118 export type Type = string;
3119 export type TypeArn = string;
3120 export type TypeName = string;
3121 export type TypeSchema = string;
3122 export type TypeSummaries = TypeSummary[];
3123 export interface TypeSummary {
3124 /**
3125 * The kind of type.
3126 */
3127 Type?: RegistryType;
3128 /**
3129 * The name of the type.
3130 */
3131 TypeName?: TypeName;
3132 /**
3133 * The ID of the default version of the type. The default version is used when the type version is not specified. To set the default version of a type, use SetTypeDefaultVersion .
3134 */
3135 DefaultVersionId?: TypeVersionId;
3136 /**
3137 * The Amazon Resource Name (ARN) of the type.
3138 */
3139 TypeArn?: TypeArn;
3140 /**
3141 * When the current default version of the type was registered.
3142 */
3143 LastUpdated?: Timestamp;
3144 /**
3145 * The description of the type.
3146 */
3147 Description?: Description;
3148 }
3149 export type TypeVersionId = string;
3150 export type TypeVersionSummaries = TypeVersionSummary[];
3151 export interface TypeVersionSummary {
3152 /**
3153 * The kind of type.
3154 */
3155 Type?: RegistryType;
3156 /**
3157 * The name of the type.
3158 */
3159 TypeName?: TypeName;
3160 /**
3161 * The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.
3162 */
3163 VersionId?: TypeVersionId;
3164 /**
3165 * The Amazon Resource Name (ARN) of the type version.
3166 */
3167 Arn?: TypeArn;
3168 /**
3169 * When the version was registered.
3170 */
3171 TimeCreated?: Timestamp;
3172 /**
3173 * The description of the type version.
3174 */
3175 Description?: Description;
3176 }
3177 export interface UpdateStackInput {
3178 /**
3179 * The name or unique stack ID of the stack to update.
3180 */
3181 StackName: StackName;
3182 /**
3183 * 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.
3184 */
3185 TemplateBody?: TemplateBody;
3186 /**
3187 * 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.
3188 */
3189 TemplateURL?: TemplateURL;
3190 /**
3191 * 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.
3192 */
3193 UsePreviousTemplate?: UsePreviousTemplate;
3194 /**
3195 * 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.
3196 */
3197 StackPolicyDuringUpdateBody?: StackPolicyDuringUpdateBody;
3198 /**
3199 * 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.
3200 */
3201 StackPolicyDuringUpdateURL?: StackPolicyDuringUpdateURL;
3202 /**
3203 * A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
3204 */
3205 Parameters?: Parameters;
3206 /**
3207 * In some cases, you must explicitly 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.
3208 */
3209 Capabilities?: Capabilities;
3210 /**
3211 * 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.
3212 */
3213 ResourceTypes?: ResourceTypes;
3214 /**
3215 * 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.
3216 */
3217 RoleARN?: RoleARN;
3218 /**
3219 * The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
3220 */
3221 RollbackConfiguration?: RollbackConfiguration;
3222 /**
3223 * 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.
3224 */
3225 StackPolicyBody?: StackPolicyBody;
3226 /**
3227 * 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.
3228 */
3229 StackPolicyURL?: StackPolicyURL;
3230 /**
3231 * 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.
3232 */
3233 NotificationARNs?: NotificationARNs;
3234 /**
3235 * 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.
3236 */
3237 Tags?: Tags;
3238 /**
3239 * 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.
3240 */
3241 ClientRequestToken?: ClientRequestToken;
3242 }
3243 export interface UpdateStackInstancesInput {
3244 /**
3245 * The name or unique ID of the stack set associated with the stack instances.
3246 */
3247 StackSetName: StackSetNameOrId;
3248 /**
3249 * [Self-managed permissions] The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions. You can specify Accounts or DeploymentTargets, but not both.
3250 */
3251 Accounts?: AccountList;
3252 /**
3253 * [Service-managed permissions] The AWS Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values. You can specify Accounts or DeploymentTargets, but not both.
3254 */
3255 DeploymentTargets?: DeploymentTargets;
3256 /**
3257 * 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.
3258 */
3259 Regions: RegionList;
3260 /**
3261 * 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.
3262 */
3263 ParameterOverrides?: Parameters;
3264 /**
3265 * Preferences for how AWS CloudFormation performs this stack set operation.
3266 */
3267 OperationPreferences?: StackSetOperationPreferences;
3268 /**
3269 * 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.
3270 */
3271 OperationId?: ClientRequestToken;
3272 }
3273 export interface UpdateStackInstancesOutput {
3274 /**
3275 * The unique identifier for this stack set operation.
3276 */
3277 OperationId?: ClientRequestToken;
3278 }
3279 export interface UpdateStackOutput {
3280 /**
3281 * Unique identifier of the stack.
3282 */
3283 StackId?: StackId;
3284 }
3285 export interface UpdateStackSetInput {
3286 /**
3287 * The name or unique ID of the stack set that you want to update.
3288 */
3289 StackSetName: StackSetName;
3290 /**
3291 * A brief description of updates that you are making.
3292 */
3293 Description?: Description;
3294 /**
3295 * 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.
3296 */
3297 TemplateBody?: TemplateBody;
3298 /**
3299 * 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.
3300 */
3301 TemplateURL?: TemplateURL;
3302 /**
3303 * 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.
3304 */
3305 UsePreviousTemplate?: UsePreviousTemplate;
3306 /**
3307 * A list of input parameters for the stack set template.
3308 */
3309 Parameters?: Parameters;
3310 /**
3311 * In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances. 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.
3312 */
3313 Capabilities?: Capabilities;
3314 /**
3315 * 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.
3316 */
3317 Tags?: Tags;
3318 /**
3319 * Preferences for how AWS CloudFormation performs this stack set operation.
3320 */
3321 OperationPreferences?: StackSetOperationPreferences;
3322 /**
3323 * 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 Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide. If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
3324 */
3325 AdministrationRoleARN?: RoleARN;
3326 /**
3327 * 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.
3328 */
3329 ExecutionRoleName?: ExecutionRoleName;
3330 /**
3331 * [Service-managed permissions] The AWS Organizations accounts in which to update associated stack instances. To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions. If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
3332 */
3333 DeploymentTargets?: DeploymentTargets;
3334 /**
3335 * Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set. With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
3336 */
3337 PermissionModel?: PermissionModels;
3338 /**
3339 * [Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). If you specify AutoDeployment, do not specify DeploymentTargets or Regions.
3340 */
3341 AutoDeployment?: AutoDeployment;
3342 /**
3343 * 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.
3344 */
3345 OperationId?: ClientRequestToken;
3346 /**
3347 * [Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances. 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.
3348 */
3349 Accounts?: AccountList;
3350 /**
3351 * 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.
3352 */
3353 Regions?: RegionList;
3354 }
3355 export interface UpdateStackSetOutput {
3356 /**
3357 * The unique ID for this stack set operation.
3358 */
3359 OperationId?: ClientRequestToken;
3360 }
3361 export interface UpdateTerminationProtectionInput {
3362 /**
3363 * Whether to enable termination protection on the specified stack.
3364 */
3365 EnableTerminationProtection: EnableTerminationProtection;
3366 /**
3367 * The name or unique ID of the stack for which you want to set termination protection.
3368 */
3369 StackName: StackNameOrId;
3370 }
3371 export interface UpdateTerminationProtectionOutput {
3372 /**
3373 * The unique ID of the stack.
3374 */
3375 StackId?: StackId;
3376 }
3377 export type Url = string;
3378 export type UsePreviousTemplate = boolean;
3379 export type UsePreviousValue = boolean;
3380 export interface ValidateTemplateInput {
3381 /**
3382 * 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.
3383 */
3384 TemplateBody?: TemplateBody;
3385 /**
3386 * 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.
3387 */
3388 TemplateURL?: TemplateURL;
3389 }
3390 export interface ValidateTemplateOutput {
3391 /**
3392 * A list of TemplateParameter structures.
3393 */
3394 Parameters?: TemplateParameters;
3395 /**
3396 * The description found within the template.
3397 */
3398 Description?: Description;
3399 /**
3400 * 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.
3401 */
3402 Capabilities?: Capabilities;
3403 /**
3404 * The list of resources that generated the values in the Capabilities response element.
3405 */
3406 CapabilitiesReason?: CapabilitiesReason;
3407 /**
3408 * A list of the transforms that are declared in the template.
3409 */
3410 DeclaredTransforms?: TransformsList;
3411 }
3412 export type Value = string;
3413 export type Version = string;
3414 export type Visibility = "PUBLIC"|"PRIVATE"|string;
3415 /**
3416 * 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.
3417 */
3418 export type apiVersion = "2010-05-15"|"latest"|string;
3419 export interface ClientApiVersions {
3420 /**
3421 * 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.
3422 */
3423 apiVersion?: apiVersion;
3424 }
3425 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
3426 /**
3427 * Contains interfaces for use with the CloudFormation client.
3428 */
3429 export import Types = CloudFormation;
3430}
3431export = CloudFormation;