cloudformation.d.ts (99408B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class CloudFormation extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: CloudFormation.Types.ClientConfiguration) 13 config: Config & CloudFormation.Types.ClientConfiguration; 14 /** 15 * 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. 16 */ 17 cancelUpdateStack(params: CloudFormation.Types.CancelUpdateStackInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 18 /** 19 * 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. 20 */ 21 cancelUpdateStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 22 /** 23 * 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. 24 */ 25 continueUpdateRollback(params: CloudFormation.Types.ContinueUpdateRollbackInput, callback?: (err: AWSError, data: CloudFormation.Types.ContinueUpdateRollbackOutput) => void): Request<CloudFormation.Types.ContinueUpdateRollbackOutput, AWSError>; 26 /** 27 * 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. 28 */ 29 continueUpdateRollback(callback?: (err: AWSError, data: CloudFormation.Types.ContinueUpdateRollbackOutput) => void): Request<CloudFormation.Types.ContinueUpdateRollbackOutput, AWSError>; 30 /** 31 * Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the template's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change, and how it will change them, before you update your stack. Change sets allow you to check before making a change to avoid deleting or replacing critical resources. AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the ExecuteChangeSet action. After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the DescribeChangeSet action. 32 */ 33 createChangeSet(params: CloudFormation.Types.CreateChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateChangeSetOutput) => void): Request<CloudFormation.Types.CreateChangeSetOutput, AWSError>; 34 /** 35 * Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the template's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change, and how it will change them, before you update your stack. Change sets allow you to check before making a change to avoid deleting or replacing critical resources. AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the ExecuteChangeSet action. After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the DescribeChangeSet action. 36 */ 37 createChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.CreateChangeSetOutput) => void): Request<CloudFormation.Types.CreateChangeSetOutput, AWSError>; 38 /** 39 * 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. 40 */ 41 createStack(params: CloudFormation.Types.CreateStackInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateStackOutput) => void): Request<CloudFormation.Types.CreateStackOutput, AWSError>; 42 /** 43 * 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. 44 */ 45 createStack(callback?: (err: AWSError, data: CloudFormation.Types.CreateStackOutput) => void): Request<CloudFormation.Types.CreateStackOutput, AWSError>; 46 /** 47 * 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. 48 */ 49 deleteChangeSet(params: CloudFormation.Types.DeleteChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DeleteChangeSetOutput) => void): Request<CloudFormation.Types.DeleteChangeSetOutput, AWSError>; 50 /** 51 * 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. 52 */ 53 deleteChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.DeleteChangeSetOutput) => void): Request<CloudFormation.Types.DeleteChangeSetOutput, AWSError>; 54 /** 55 * 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. 56 */ 57 deleteStack(params: CloudFormation.Types.DeleteStackInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 58 /** 59 * 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. 60 */ 61 deleteStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 62 /** 63 * Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. 64 */ 65 describeAccountLimits(params: CloudFormation.Types.DescribeAccountLimitsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeAccountLimitsOutput) => void): Request<CloudFormation.Types.DescribeAccountLimitsOutput, AWSError>; 66 /** 67 * Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. 68 */ 69 describeAccountLimits(callback?: (err: AWSError, data: CloudFormation.Types.DescribeAccountLimitsOutput) => void): Request<CloudFormation.Types.DescribeAccountLimitsOutput, AWSError>; 70 /** 71 * 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. 72 */ 73 describeChangeSet(params: CloudFormation.Types.DescribeChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>; 74 /** 75 * 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. 76 */ 77 describeChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>; 78 /** 79 * 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). 80 */ 81 describeStackEvents(params: CloudFormation.Types.DescribeStackEventsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackEventsOutput) => void): Request<CloudFormation.Types.DescribeStackEventsOutput, AWSError>; 82 /** 83 * 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). 84 */ 85 describeStackEvents(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackEventsOutput) => void): Request<CloudFormation.Types.DescribeStackEventsOutput, AWSError>; 86 /** 87 * 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. 88 */ 89 describeStackResource(params: CloudFormation.Types.DescribeStackResourceInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceOutput) => void): Request<CloudFormation.Types.DescribeStackResourceOutput, AWSError>; 90 /** 91 * 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. 92 */ 93 describeStackResource(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceOutput) => void): Request<CloudFormation.Types.DescribeStackResourceOutput, AWSError>; 94 /** 95 * 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. 96 */ 97 describeStackResources(params: CloudFormation.Types.DescribeStackResourcesInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourcesOutput) => void): Request<CloudFormation.Types.DescribeStackResourcesOutput, AWSError>; 98 /** 99 * 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. 100 */ 101 describeStackResources(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourcesOutput) => void): Request<CloudFormation.Types.DescribeStackResourcesOutput, AWSError>; 102 /** 103 * 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. 104 */ 105 describeStacks(params: CloudFormation.Types.DescribeStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>; 106 /** 107 * 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. 108 */ 109 describeStacks(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>; 110 /** 111 * 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. 112 */ 113 estimateTemplateCost(params: CloudFormation.Types.EstimateTemplateCostInput, callback?: (err: AWSError, data: CloudFormation.Types.EstimateTemplateCostOutput) => void): Request<CloudFormation.Types.EstimateTemplateCostOutput, AWSError>; 114 /** 115 * 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. 116 */ 117 estimateTemplateCost(callback?: (err: AWSError, data: CloudFormation.Types.EstimateTemplateCostOutput) => void): Request<CloudFormation.Types.EstimateTemplateCostOutput, AWSError>; 118 /** 119 * 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. 120 */ 121 executeChangeSet(params: CloudFormation.Types.ExecuteChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.ExecuteChangeSetOutput) => void): Request<CloudFormation.Types.ExecuteChangeSetOutput, AWSError>; 122 /** 123 * 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. 124 */ 125 executeChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.ExecuteChangeSetOutput) => void): Request<CloudFormation.Types.ExecuteChangeSetOutput, AWSError>; 126 /** 127 * Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. 128 */ 129 getStackPolicy(params: CloudFormation.Types.GetStackPolicyInput, callback?: (err: AWSError, data: CloudFormation.Types.GetStackPolicyOutput) => void): Request<CloudFormation.Types.GetStackPolicyOutput, AWSError>; 130 /** 131 * Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. 132 */ 133 getStackPolicy(callback?: (err: AWSError, data: CloudFormation.Types.GetStackPolicyOutput) => void): Request<CloudFormation.Types.GetStackPolicyOutput, AWSError>; 134 /** 135 * 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. 136 */ 137 getTemplate(params: CloudFormation.Types.GetTemplateInput, callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateOutput) => void): Request<CloudFormation.Types.GetTemplateOutput, AWSError>; 138 /** 139 * 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. 140 */ 141 getTemplate(callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateOutput) => void): Request<CloudFormation.Types.GetTemplateOutput, AWSError>; 142 /** 143 * 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. You can use the GetTemplateSummary action when you submit a template, or you can get template information for 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. 144 */ 145 getTemplateSummary(params: CloudFormation.Types.GetTemplateSummaryInput, callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateSummaryOutput) => void): Request<CloudFormation.Types.GetTemplateSummaryOutput, AWSError>; 146 /** 147 * 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. You can use the GetTemplateSummary action when you submit a template, or you can get template information for 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. 148 */ 149 getTemplateSummary(callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateSummaryOutput) => void): Request<CloudFormation.Types.GetTemplateSummaryOutput, AWSError>; 150 /** 151 * 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. 152 */ 153 listChangeSets(params: CloudFormation.Types.ListChangeSetsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListChangeSetsOutput) => void): Request<CloudFormation.Types.ListChangeSetsOutput, AWSError>; 154 /** 155 * 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. 156 */ 157 listChangeSets(callback?: (err: AWSError, data: CloudFormation.Types.ListChangeSetsOutput) => void): Request<CloudFormation.Types.ListChangeSetsOutput, AWSError>; 158 /** 159 * 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. 160 */ 161 listExports(params: CloudFormation.Types.ListExportsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListExportsOutput) => void): Request<CloudFormation.Types.ListExportsOutput, AWSError>; 162 /** 163 * 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. 164 */ 165 listExports(callback?: (err: AWSError, data: CloudFormation.Types.ListExportsOutput) => void): Request<CloudFormation.Types.ListExportsOutput, AWSError>; 166 /** 167 * 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. 168 */ 169 listImports(params: CloudFormation.Types.ListImportsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListImportsOutput) => void): Request<CloudFormation.Types.ListImportsOutput, AWSError>; 170 /** 171 * 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. 172 */ 173 listImports(callback?: (err: AWSError, data: CloudFormation.Types.ListImportsOutput) => void): Request<CloudFormation.Types.ListImportsOutput, AWSError>; 174 /** 175 * 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. 176 */ 177 listStackResources(params: CloudFormation.Types.ListStackResourcesInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackResourcesOutput) => void): Request<CloudFormation.Types.ListStackResourcesOutput, AWSError>; 178 /** 179 * 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. 180 */ 181 listStackResources(callback?: (err: AWSError, data: CloudFormation.Types.ListStackResourcesOutput) => void): Request<CloudFormation.Types.ListStackResourcesOutput, AWSError>; 182 /** 183 * 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). 184 */ 185 listStacks(params: CloudFormation.Types.ListStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStacksOutput) => void): Request<CloudFormation.Types.ListStacksOutput, AWSError>; 186 /** 187 * 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). 188 */ 189 listStacks(callback?: (err: AWSError, data: CloudFormation.Types.ListStacksOutput) => void): Request<CloudFormation.Types.ListStacksOutput, AWSError>; 190 /** 191 * Sets a stack policy for a specified stack. 192 */ 193 setStackPolicy(params: CloudFormation.Types.SetStackPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 194 /** 195 * Sets a stack policy for a specified stack. 196 */ 197 setStackPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 198 /** 199 * 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. 200 */ 201 signalResource(params: CloudFormation.Types.SignalResourceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 202 /** 203 * 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. 204 */ 205 signalResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 206 /** 207 * 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. 208 */ 209 updateStack(params: CloudFormation.Types.UpdateStackInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackOutput) => void): Request<CloudFormation.Types.UpdateStackOutput, AWSError>; 210 /** 211 * 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. 212 */ 213 updateStack(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackOutput) => void): Request<CloudFormation.Types.UpdateStackOutput, AWSError>; 214 /** 215 * 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. 216 */ 217 validateTemplate(params: CloudFormation.Types.ValidateTemplateInput, callback?: (err: AWSError, data: CloudFormation.Types.ValidateTemplateOutput) => void): Request<CloudFormation.Types.ValidateTemplateOutput, AWSError>; 218 /** 219 * 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. 220 */ 221 validateTemplate(callback?: (err: AWSError, data: CloudFormation.Types.ValidateTemplateOutput) => void): Request<CloudFormation.Types.ValidateTemplateOutput, AWSError>; 222 /** 223 * Waits for the stackExists state by periodically calling the underlying CloudFormation.describeStacksoperation every 5 seconds (at most 20 times). 224 */ 225 waitFor(state: "stackExists", params: CloudFormation.Types.DescribeStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>; 226 /** 227 * Waits for the stackExists state by periodically calling the underlying CloudFormation.describeStacksoperation every 5 seconds (at most 20 times). 228 */ 229 waitFor(state: "stackExists", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>; 230 /** 231 * 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. 232 */ 233 waitFor(state: "stackCreateComplete", params: CloudFormation.Types.DescribeStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>; 234 /** 235 * 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. 236 */ 237 waitFor(state: "stackCreateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>; 238 /** 239 * 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. 240 */ 241 waitFor(state: "stackDeleteComplete", params: CloudFormation.Types.DescribeStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>; 242 /** 243 * 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. 244 */ 245 waitFor(state: "stackDeleteComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>; 246 /** 247 * 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. 248 */ 249 waitFor(state: "stackUpdateComplete", params: CloudFormation.Types.DescribeStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>; 250 /** 251 * 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. 252 */ 253 waitFor(state: "stackUpdateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>; 254 } 255 declare namespace CloudFormation.Types { 256 export interface AccountLimit { 257 /** 258 * The name of the account limit. Currently, the only account limit is StackLimit. 259 */ 260 Name?: LimitName; 261 /** 262 * The value that is associated with the account limit name. 263 */ 264 Value?: LimitValue; 265 } 266 export type AccountLimitList = AccountLimit[]; 267 export type AllowedValue = string; 268 export type AllowedValues = AllowedValue[]; 269 export interface CancelUpdateStackInput { 270 /** 271 * The name or the unique stack ID that is associated with the stack. 272 */ 273 StackName: StackName; 274 } 275 export type Capabilities = Capability[]; 276 export type CapabilitiesReason = string; 277 export type Capability = "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|string; 278 export type CausingEntity = string; 279 export interface Change { 280 /** 281 * The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource. 282 */ 283 Type?: ChangeType; 284 /** 285 * A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform. 286 */ 287 ResourceChange?: ResourceChange; 288 } 289 export type ChangeAction = "Add"|"Modify"|"Remove"|string; 290 export type ChangeSetId = string; 291 export type ChangeSetName = string; 292 export type ChangeSetNameOrId = string; 293 export type ChangeSetStatus = "CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"DELETE_COMPLETE"|"FAILED"|string; 294 export type ChangeSetStatusReason = string; 295 export type ChangeSetSummaries = ChangeSetSummary[]; 296 export interface ChangeSetSummary { 297 /** 298 * The ID of the stack with which the change set is associated. 299 */ 300 StackId?: StackId; 301 /** 302 * The name of the stack with which the change set is associated. 303 */ 304 StackName?: StackName; 305 /** 306 * The ID of the change set. 307 */ 308 ChangeSetId?: ChangeSetId; 309 /** 310 * The name of the change set. 311 */ 312 ChangeSetName?: ChangeSetName; 313 /** 314 * 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. 315 */ 316 ExecutionStatus?: ExecutionStatus; 317 /** 318 * The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED. 319 */ 320 Status?: ChangeSetStatus; 321 /** 322 * 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. 323 */ 324 StatusReason?: ChangeSetStatusReason; 325 /** 326 * The start time when the change set was created, in UTC. 327 */ 328 CreationTime?: CreationTime; 329 /** 330 * Descriptive information about the change set. 331 */ 332 Description?: Description; 333 } 334 export type ChangeSetType = "CREATE"|"UPDATE"|string; 335 export type ChangeSource = "ResourceReference"|"ParameterReference"|"ResourceAttribute"|"DirectModification"|"Automatic"|string; 336 export type ChangeType = "Resource"|string; 337 export type Changes = Change[]; 338 export type ClientToken = string; 339 export interface ContinueUpdateRollbackInput { 340 /** 341 * 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). 342 */ 343 StackName: StackNameOrId; 344 /** 345 * 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. 346 */ 347 RoleARN?: RoleARN; 348 /** 349 * 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 canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason. Specify this property to skip rolling back resources that 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 specify resources in a nested stack, use the following format: NestedStackName.ResourceLogicalID. You can specify a nested stack resource (the logical ID of an AWS::CloudFormation::Stack resource) only if it's in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED. 350 */ 351 ResourcesToSkip?: ResourcesToSkip; 352 } 353 export interface ContinueUpdateRollbackOutput { 354 } 355 export interface CreateChangeSetInput { 356 /** 357 * 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. 358 */ 359 StackName: StackNameOrId; 360 /** 361 * 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. 362 */ 363 TemplateBody?: TemplateBody; 364 /** 365 * 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. 366 */ 367 TemplateURL?: TemplateURL; 368 /** 369 * Whether to reuse the template that is associated with the stack to create the change set. 370 */ 371 UsePreviousTemplate?: UsePreviousTemplate; 372 /** 373 * A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type. 374 */ 375 Parameters?: Parameters; 376 /** 377 * A list of values that you must specify before AWS CloudFormation can update certain stacks. 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 their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. 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 this parameter, this action returns an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. 378 */ 379 Capabilities?: Capabilities; 380 /** 381 * 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. 382 */ 383 ResourceTypes?: ResourceTypes; 384 /** 385 * 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. 386 */ 387 RoleARN?: RoleARN; 388 /** 389 * 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. 390 */ 391 NotificationARNs?: NotificationARNs; 392 /** 393 * 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 10 tags. 394 */ 395 Tags?: Tags; 396 /** 397 * 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. 398 */ 399 ChangeSetName: ChangeSetName; 400 /** 401 * 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. 402 */ 403 ClientToken?: ClientToken; 404 /** 405 * A description to help you identify this change set. 406 */ 407 Description?: Description; 408 /** 409 * The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set. By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack. 410 */ 411 ChangeSetType?: ChangeSetType; 412 } 413 export interface CreateChangeSetOutput { 414 /** 415 * The Amazon Resource Name (ARN) of the change set. 416 */ 417 Id?: ChangeSetId; 418 /** 419 * The unique ID of the stack. 420 */ 421 StackId?: StackId; 422 } 423 export interface CreateStackInput { 424 /** 425 * 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. 426 */ 427 StackName: StackName; 428 /** 429 * 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. 430 */ 431 TemplateBody?: TemplateBody; 432 /** 433 * 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. 434 */ 435 TemplateURL?: TemplateURL; 436 /** 437 * A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type. 438 */ 439 Parameters?: Parameters; 440 /** 441 * 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 442 */ 443 DisableRollback?: DisableRollback; 444 /** 445 * 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. 446 */ 447 TimeoutInMinutes?: TimeoutMinutes; 448 /** 449 * 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). 450 */ 451 NotificationARNs?: NotificationARNs; 452 /** 453 * A list of values that you must specify before AWS CloudFormation can create certain stacks. 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 their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. 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 this parameter, this action returns an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. 454 */ 455 Capabilities?: Capabilities; 456 /** 457 * 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. 458 */ 459 ResourceTypes?: ResourceTypes; 460 /** 461 * 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. 462 */ 463 RoleARN?: RoleARN; 464 /** 465 * 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 466 */ 467 OnFailure?: OnFailure; 468 /** 469 * 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. 470 */ 471 StackPolicyBody?: StackPolicyBody; 472 /** 473 * 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. 474 */ 475 StackPolicyURL?: StackPolicyURL; 476 /** 477 * 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 10 tags can be specified. 478 */ 479 Tags?: Tags; 480 } 481 export interface CreateStackOutput { 482 /** 483 * Unique identifier of the stack. 484 */ 485 StackId?: StackId; 486 } 487 export type CreationTime = Date; 488 export interface DeleteChangeSetInput { 489 /** 490 * The name or Amazon Resource Name (ARN) of the change set that you want to delete. 491 */ 492 ChangeSetName: ChangeSetNameOrId; 493 /** 494 * If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it. 495 */ 496 StackName?: StackNameOrId; 497 } 498 export interface DeleteChangeSetOutput { 499 } 500 export interface DeleteStackInput { 501 /** 502 * The name or the unique stack ID that is associated with the stack. 503 */ 504 StackName: StackName; 505 /** 506 * 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. 507 */ 508 RetainResources?: RetainResources; 509 /** 510 * 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. 511 */ 512 RoleARN?: RoleARN; 513 } 514 export type DeletionTime = Date; 515 export interface DescribeAccountLimitsInput { 516 /** 517 * A string that identifies the next page of limits that you want to retrieve. 518 */ 519 NextToken?: NextToken; 520 } 521 export interface DescribeAccountLimitsOutput { 522 /** 523 * An account limit structure that contain a list of AWS CloudFormation account limits and their values. 524 */ 525 AccountLimits?: AccountLimitList; 526 /** 527 * 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. 528 */ 529 NextToken?: NextToken; 530 } 531 export interface DescribeChangeSetInput { 532 /** 533 * The name or Amazon Resource Name (ARN) of the change set that you want to describe. 534 */ 535 ChangeSetName: ChangeSetNameOrId; 536 /** 537 * If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe. 538 */ 539 StackName?: StackNameOrId; 540 /** 541 * A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve. 542 */ 543 NextToken?: NextToken; 544 } 545 export interface DescribeChangeSetOutput { 546 /** 547 * The name of the change set. 548 */ 549 ChangeSetName?: ChangeSetName; 550 /** 551 * The ARN of the change set. 552 */ 553 ChangeSetId?: ChangeSetId; 554 /** 555 * The ARN of the stack that is associated with the change set. 556 */ 557 StackId?: StackId; 558 /** 559 * The name of the stack that is associated with the change set. 560 */ 561 StackName?: StackName; 562 /** 563 * Information about the change set. 564 */ 565 Description?: Description; 566 /** 567 * 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. 568 */ 569 Parameters?: Parameters; 570 /** 571 * The start time when the change set was created, in UTC. 572 */ 573 CreationTime?: CreationTime; 574 /** 575 * 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. 576 */ 577 ExecutionStatus?: ExecutionStatus; 578 /** 579 * The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED. 580 */ 581 Status?: ChangeSetStatus; 582 /** 583 * 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. 584 */ 585 StatusReason?: ChangeSetStatusReason; 586 /** 587 * The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set. 588 */ 589 NotificationARNs?: NotificationARNs; 590 /** 591 * If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created. 592 */ 593 Capabilities?: Capabilities; 594 /** 595 * If you execute the change set, the tags that will be associated with the stack. 596 */ 597 Tags?: Tags; 598 /** 599 * A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set. 600 */ 601 Changes?: Changes; 602 /** 603 * 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. 604 */ 605 NextToken?: NextToken; 606 } 607 export interface DescribeStackEventsInput { 608 /** 609 * 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. 610 */ 611 StackName?: StackName; 612 /** 613 * A string that identifies the next page of events that you want to retrieve. 614 */ 615 NextToken?: NextToken; 616 } 617 export interface DescribeStackEventsOutput { 618 /** 619 * A list of StackEvents structures. 620 */ 621 StackEvents?: StackEvents; 622 /** 623 * 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. 624 */ 625 NextToken?: NextToken; 626 } 627 export interface DescribeStackResourceInput { 628 /** 629 * 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. 630 */ 631 StackName: StackName; 632 /** 633 * The logical name of the resource as specified in the template. Default: There is no default value. 634 */ 635 LogicalResourceId: LogicalResourceId; 636 } 637 export interface DescribeStackResourceOutput { 638 /** 639 * A StackResourceDetail structure containing the description of the specified resource in the specified stack. 640 */ 641 StackResourceDetail?: StackResourceDetail; 642 } 643 export interface DescribeStackResourcesInput { 644 /** 645 * 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. 646 */ 647 StackName?: StackName; 648 /** 649 * The logical name of the resource as specified in the template. Default: There is no default value. 650 */ 651 LogicalResourceId?: LogicalResourceId; 652 /** 653 * 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. 654 */ 655 PhysicalResourceId?: PhysicalResourceId; 656 } 657 export interface DescribeStackResourcesOutput { 658 /** 659 * A list of StackResource structures. 660 */ 661 StackResources?: StackResources; 662 } 663 export interface DescribeStacksInput { 664 /** 665 * 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. 666 */ 667 StackName?: StackName; 668 /** 669 * A string that identifies the next page of stacks that you want to retrieve. 670 */ 671 NextToken?: NextToken; 672 } 673 export interface DescribeStacksOutput { 674 /** 675 * A list of stack structures. 676 */ 677 Stacks?: Stacks; 678 /** 679 * 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. 680 */ 681 NextToken?: NextToken; 682 } 683 export type Description = string; 684 export type DisableRollback = boolean; 685 export interface EstimateTemplateCostInput { 686 /** 687 * 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. 688 */ 689 TemplateBody?: TemplateBody; 690 /** 691 * 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. 692 */ 693 TemplateURL?: TemplateURL; 694 /** 695 * A list of Parameter structures that specify input parameters. 696 */ 697 Parameters?: Parameters; 698 } 699 export interface EstimateTemplateCostOutput { 700 /** 701 * An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. 702 */ 703 Url?: Url; 704 } 705 export type EvaluationType = "Static"|"Dynamic"|string; 706 export type EventId = string; 707 export interface ExecuteChangeSetInput { 708 /** 709 * The name or ARN of the change set that you want use to update the specified stack. 710 */ 711 ChangeSetName: ChangeSetNameOrId; 712 /** 713 * 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. 714 */ 715 StackName?: StackNameOrId; 716 } 717 export interface ExecuteChangeSetOutput { 718 } 719 export type ExecutionStatus = "UNAVAILABLE"|"AVAILABLE"|"EXECUTE_IN_PROGRESS"|"EXECUTE_COMPLETE"|"EXECUTE_FAILED"|"OBSOLETE"|string; 720 export interface Export { 721 /** 722 * The stack that contains the exported output name and value. 723 */ 724 ExportingStackId?: StackId; 725 /** 726 * 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. 727 */ 728 Name?: ExportName; 729 /** 730 * 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. 731 */ 732 Value?: ExportValue; 733 } 734 export type ExportName = string; 735 export type ExportValue = string; 736 export type Exports = Export[]; 737 export interface GetStackPolicyInput { 738 /** 739 * The name or unique stack ID that is associated with the stack whose policy you want to get. 740 */ 741 StackName: StackName; 742 } 743 export interface GetStackPolicyOutput { 744 /** 745 * Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.) 746 */ 747 StackPolicyBody?: StackPolicyBody; 748 } 749 export interface GetTemplateInput { 750 /** 751 * 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. 752 */ 753 StackName?: StackName; 754 /** 755 * 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. 756 */ 757 ChangeSetName?: ChangeSetNameOrId; 758 /** 759 * 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. 760 */ 761 TemplateStage?: TemplateStage; 762 } 763 export interface GetTemplateOutput { 764 /** 765 * 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. 766 */ 767 TemplateBody?: TemplateBody; 768 /** 769 * 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. 770 */ 771 StagesAvailable?: StageList; 772 } 773 export interface GetTemplateSummaryInput { 774 /** 775 * 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, TemplateBody, or TemplateURL. 776 */ 777 TemplateBody?: TemplateBody; 778 /** 779 * 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, TemplateBody, or TemplateURL. 780 */ 781 TemplateURL?: TemplateURL; 782 /** 783 * 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, TemplateBody, or TemplateURL. 784 */ 785 StackName?: StackNameOrId; 786 } 787 export interface GetTemplateSummaryOutput { 788 /** 789 * A list of parameter declarations that describe various properties for each parameter. 790 */ 791 Parameters?: ParameterDeclarations; 792 /** 793 * The value that is defined in the Description property of the template. 794 */ 795 Description?: Description; 796 /** 797 * 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. 798 */ 799 Capabilities?: Capabilities; 800 /** 801 * The list of resources that generated the values in the Capabilities response element. 802 */ 803 CapabilitiesReason?: CapabilitiesReason; 804 /** 805 * 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. 806 */ 807 ResourceTypes?: ResourceTypes; 808 /** 809 * The AWS template format version, which identifies the capabilities of the template. 810 */ 811 Version?: Version; 812 /** 813 * The value that is defined for the Metadata property of the template. 814 */ 815 Metadata?: Metadata; 816 /** 817 * A list of the transforms that are declared in the template. 818 */ 819 DeclaredTransforms?: TransformsList; 820 } 821 export type Imports = StackName[]; 822 export type LastUpdatedTime = Date; 823 export type LimitName = string; 824 export type LimitValue = number; 825 export interface ListChangeSetsInput { 826 /** 827 * The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets. 828 */ 829 StackName: StackNameOrId; 830 /** 831 * A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve. 832 */ 833 NextToken?: NextToken; 834 } 835 export interface ListChangeSetsOutput { 836 /** 837 * A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack. 838 */ 839 Summaries?: ChangeSetSummaries; 840 /** 841 * 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. 842 */ 843 NextToken?: NextToken; 844 } 845 export interface ListExportsInput { 846 /** 847 * A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve. 848 */ 849 NextToken?: NextToken; 850 } 851 export interface ListExportsOutput { 852 /** 853 * The output for the ListExports action. 854 */ 855 Exports?: Exports; 856 /** 857 * 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. 858 */ 859 NextToken?: NextToken; 860 } 861 export interface ListImportsInput { 862 /** 863 * The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value. 864 */ 865 ExportName: ExportName; 866 /** 867 * A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value. 868 */ 869 NextToken?: NextToken; 870 } 871 export interface ListImportsOutput { 872 /** 873 * A list of stack names that are importing the specified exported output value. 874 */ 875 Imports?: Imports; 876 /** 877 * A string that identifies the next page of exports. If there is no additional page, this value is null. 878 */ 879 NextToken?: NextToken; 880 } 881 export interface ListStackResourcesInput { 882 /** 883 * 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. 884 */ 885 StackName: StackName; 886 /** 887 * A string that identifies the next page of stack resources that you want to retrieve. 888 */ 889 NextToken?: NextToken; 890 } 891 export interface ListStackResourcesOutput { 892 /** 893 * A list of StackResourceSummary structures. 894 */ 895 StackResourceSummaries?: StackResourceSummaries; 896 /** 897 * 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. 898 */ 899 NextToken?: NextToken; 900 } 901 export interface ListStacksInput { 902 /** 903 * A string that identifies the next page of stacks that you want to retrieve. 904 */ 905 NextToken?: NextToken; 906 /** 907 * 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. 908 */ 909 StackStatusFilter?: StackStatusFilter; 910 } 911 export interface ListStacksOutput { 912 /** 913 * A list of StackSummary structures containing information about the specified stacks. 914 */ 915 StackSummaries?: StackSummaries; 916 /** 917 * 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. 918 */ 919 NextToken?: NextToken; 920 } 921 export type LogicalResourceId = string; 922 export type Metadata = string; 923 export type NextToken = string; 924 export type NoEcho = boolean; 925 export type NotificationARN = string; 926 export type NotificationARNs = NotificationARN[]; 927 export type OnFailure = "DO_NOTHING"|"ROLLBACK"|"DELETE"|string; 928 export interface Output { 929 /** 930 * The key associated with the output. 931 */ 932 OutputKey?: OutputKey; 933 /** 934 * The value associated with the output. 935 */ 936 OutputValue?: OutputValue; 937 /** 938 * User defined description associated with the output. 939 */ 940 Description?: Description; 941 } 942 export type OutputKey = string; 943 export type OutputValue = string; 944 export type Outputs = Output[]; 945 export interface Parameter { 946 /** 947 * 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. 948 */ 949 ParameterKey?: ParameterKey; 950 /** 951 * The value associated with the parameter. 952 */ 953 ParameterValue?: ParameterValue; 954 /** 955 * 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. 956 */ 957 UsePreviousValue?: UsePreviousValue; 958 } 959 export interface ParameterConstraints { 960 /** 961 * A list of values that are permitted for a parameter. 962 */ 963 AllowedValues?: AllowedValues; 964 } 965 export interface ParameterDeclaration { 966 /** 967 * The name that is associated with the parameter. 968 */ 969 ParameterKey?: ParameterKey; 970 /** 971 * The default value of the parameter. 972 */ 973 DefaultValue?: ParameterValue; 974 /** 975 * The type of parameter. 976 */ 977 ParameterType?: ParameterType; 978 /** 979 * Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console. 980 */ 981 NoEcho?: NoEcho; 982 /** 983 * The description that is associate with the parameter. 984 */ 985 Description?: Description; 986 /** 987 * The criteria that AWS CloudFormation uses to validate parameter values. 988 */ 989 ParameterConstraints?: ParameterConstraints; 990 } 991 export type ParameterDeclarations = ParameterDeclaration[]; 992 export type ParameterKey = string; 993 export type ParameterType = string; 994 export type ParameterValue = string; 995 export type Parameters = Parameter[]; 996 export type PhysicalResourceId = string; 997 export type PropertyName = string; 998 export type Replacement = "True"|"False"|"Conditional"|string; 999 export type RequiresRecreation = "Never"|"Conditionally"|"Always"|string; 1000 export type ResourceAttribute = "Properties"|"Metadata"|"CreationPolicy"|"UpdatePolicy"|"DeletionPolicy"|"Tags"|string; 1001 export interface ResourceChange { 1002 /** 1003 * 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). 1004 */ 1005 Action?: ChangeAction; 1006 /** 1007 * The resource's logical ID, which is defined in the stack's template. 1008 */ 1009 LogicalResourceId?: LogicalResourceId; 1010 /** 1011 * The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created. 1012 */ 1013 PhysicalResourceId?: PhysicalResourceId; 1014 /** 1015 * The type of AWS CloudFormation resource, such as AWS::S3::Bucket. 1016 */ 1017 ResourceType?: ResourceType; 1018 /** 1019 * 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. 1020 */ 1021 Replacement?: Replacement; 1022 /** 1023 * 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. 1024 */ 1025 Scope?: Scope; 1026 /** 1027 * For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource. 1028 */ 1029 Details?: ResourceChangeDetails; 1030 } 1031 export interface ResourceChangeDetail { 1032 /** 1033 * A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated. 1034 */ 1035 Target?: ResourceTargetDefinition; 1036 /** 1037 * 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. 1038 */ 1039 Evaluation?: EvaluationType; 1040 /** 1041 * 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. 1042 */ 1043 ChangeSource?: ChangeSource; 1044 /** 1045 * 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. 1046 */ 1047 CausingEntity?: CausingEntity; 1048 } 1049 export type ResourceChangeDetails = ResourceChangeDetail[]; 1050 export type ResourceProperties = string; 1051 export type ResourceSignalStatus = "SUCCESS"|"FAILURE"|string; 1052 export type ResourceSignalUniqueId = string; 1053 export type ResourceStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATE_COMPLETE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"DELETE_SKIPPED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|"UPDATE_COMPLETE"|string; 1054 export type ResourceStatusReason = string; 1055 export interface ResourceTargetDefinition { 1056 /** 1057 * Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags. 1058 */ 1059 Attribute?: ResourceAttribute; 1060 /** 1061 * If the Attribute value is Properties, the name of the property. For all other attributes, the value is null. 1062 */ 1063 Name?: PropertyName; 1064 /** 1065 * 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. 1066 */ 1067 RequiresRecreation?: RequiresRecreation; 1068 } 1069 export type ResourceToSkip = string; 1070 export type ResourceType = string; 1071 export type ResourceTypes = ResourceType[]; 1072 export type ResourcesToSkip = ResourceToSkip[]; 1073 export type RetainResources = LogicalResourceId[]; 1074 export type RoleARN = string; 1075 export type Scope = ResourceAttribute[]; 1076 export interface SetStackPolicyInput { 1077 /** 1078 * The name or unique stack ID that you want to associate a policy with. 1079 */ 1080 StackName: StackName; 1081 /** 1082 * 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. 1083 */ 1084 StackPolicyBody?: StackPolicyBody; 1085 /** 1086 * 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. 1087 */ 1088 StackPolicyURL?: StackPolicyURL; 1089 } 1090 export interface SignalResourceInput { 1091 /** 1092 * The stack name or unique stack ID that includes the resource that you want to signal. 1093 */ 1094 StackName: StackNameOrId; 1095 /** 1096 * 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. 1097 */ 1098 LogicalResourceId: LogicalResourceId; 1099 /** 1100 * 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. 1101 */ 1102 UniqueId: ResourceSignalUniqueId; 1103 /** 1104 * 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. 1105 */ 1106 Status: ResourceSignalStatus; 1107 } 1108 export interface Stack { 1109 /** 1110 * Unique identifier of the stack. 1111 */ 1112 StackId?: StackId; 1113 /** 1114 * The name associated with the stack. 1115 */ 1116 StackName: StackName; 1117 /** 1118 * The unique ID of the change set. 1119 */ 1120 ChangeSetId?: ChangeSetId; 1121 /** 1122 * A user-defined description associated with the stack. 1123 */ 1124 Description?: Description; 1125 /** 1126 * A list of Parameter structures. 1127 */ 1128 Parameters?: Parameters; 1129 /** 1130 * The time at which the stack was created. 1131 */ 1132 CreationTime: CreationTime; 1133 /** 1134 * The time the stack was last updated. This field will only be returned if the stack has been updated at least once. 1135 */ 1136 LastUpdatedTime?: LastUpdatedTime; 1137 /** 1138 * Current status of the stack. 1139 */ 1140 StackStatus: StackStatus; 1141 /** 1142 * Success/failure message associated with the stack status. 1143 */ 1144 StackStatusReason?: StackStatusReason; 1145 /** 1146 * Boolean to enable or disable rollback on stack creation failures: true: disable rollback false: enable rollback 1147 */ 1148 DisableRollback?: DisableRollback; 1149 /** 1150 * SNS topic ARNs to which stack related events are published. 1151 */ 1152 NotificationARNs?: NotificationARNs; 1153 /** 1154 * The amount of time within which stack creation should complete. 1155 */ 1156 TimeoutInMinutes?: TimeoutMinutes; 1157 /** 1158 * The capabilities allowed in the stack. 1159 */ 1160 Capabilities?: Capabilities; 1161 /** 1162 * A list of output structures. 1163 */ 1164 Outputs?: Outputs; 1165 /** 1166 * 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. 1167 */ 1168 RoleARN?: RoleARN; 1169 /** 1170 * A list of Tags that specify information about the stack. 1171 */ 1172 Tags?: Tags; 1173 } 1174 export interface StackEvent { 1175 /** 1176 * The unique ID name of the instance of the stack. 1177 */ 1178 StackId: StackId; 1179 /** 1180 * The unique ID of this event. 1181 */ 1182 EventId: EventId; 1183 /** 1184 * The name associated with a stack. 1185 */ 1186 StackName: StackName; 1187 /** 1188 * The logical name of the resource specified in the template. 1189 */ 1190 LogicalResourceId?: LogicalResourceId; 1191 /** 1192 * The name or unique identifier associated with the physical instance of the resource. 1193 */ 1194 PhysicalResourceId?: PhysicalResourceId; 1195 /** 1196 * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.) 1197 */ 1198 ResourceType?: ResourceType; 1199 /** 1200 * Time the status was updated. 1201 */ 1202 Timestamp: Timestamp; 1203 /** 1204 * Current status of the resource. 1205 */ 1206 ResourceStatus?: ResourceStatus; 1207 /** 1208 * Success/failure message associated with the resource. 1209 */ 1210 ResourceStatusReason?: ResourceStatusReason; 1211 /** 1212 * BLOB of the properties used to create the resource. 1213 */ 1214 ResourceProperties?: ResourceProperties; 1215 } 1216 export type StackEvents = StackEvent[]; 1217 export type StackId = string; 1218 export type StackName = string; 1219 export type StackNameOrId = string; 1220 export type StackPolicyBody = string; 1221 export type StackPolicyDuringUpdateBody = string; 1222 export type StackPolicyDuringUpdateURL = string; 1223 export type StackPolicyURL = string; 1224 export interface StackResource { 1225 /** 1226 * The name associated with the stack. 1227 */ 1228 StackName?: StackName; 1229 /** 1230 * Unique identifier of the stack. 1231 */ 1232 StackId?: StackId; 1233 /** 1234 * The logical name of the resource specified in the template. 1235 */ 1236 LogicalResourceId: LogicalResourceId; 1237 /** 1238 * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. 1239 */ 1240 PhysicalResourceId?: PhysicalResourceId; 1241 /** 1242 * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.) 1243 */ 1244 ResourceType: ResourceType; 1245 /** 1246 * Time the status was updated. 1247 */ 1248 Timestamp: Timestamp; 1249 /** 1250 * Current status of the resource. 1251 */ 1252 ResourceStatus: ResourceStatus; 1253 /** 1254 * Success/failure message associated with the resource. 1255 */ 1256 ResourceStatusReason?: ResourceStatusReason; 1257 /** 1258 * User defined description associated with the resource. 1259 */ 1260 Description?: Description; 1261 } 1262 export interface StackResourceDetail { 1263 /** 1264 * The name associated with the stack. 1265 */ 1266 StackName?: StackName; 1267 /** 1268 * Unique identifier of the stack. 1269 */ 1270 StackId?: StackId; 1271 /** 1272 * The logical name of the resource specified in the template. 1273 */ 1274 LogicalResourceId: LogicalResourceId; 1275 /** 1276 * The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. 1277 */ 1278 PhysicalResourceId?: PhysicalResourceId; 1279 /** 1280 * Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.) 1281 */ 1282 ResourceType: ResourceType; 1283 /** 1284 * Time the status was updated. 1285 */ 1286 LastUpdatedTimestamp: Timestamp; 1287 /** 1288 * Current status of the resource. 1289 */ 1290 ResourceStatus: ResourceStatus; 1291 /** 1292 * Success/failure message associated with the resource. 1293 */ 1294 ResourceStatusReason?: ResourceStatusReason; 1295 /** 1296 * User defined description associated with the resource. 1297 */ 1298 Description?: Description; 1299 /** 1300 * The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide. 1301 */ 1302 Metadata?: Metadata; 1303 } 1304 export type StackResourceSummaries = StackResourceSummary[]; 1305 export interface StackResourceSummary { 1306 /** 1307 * The logical name of the resource specified in the template. 1308 */ 1309 LogicalResourceId: LogicalResourceId; 1310 /** 1311 * The name or unique identifier that corresponds to a physical instance ID of the resource. 1312 */ 1313 PhysicalResourceId?: PhysicalResourceId; 1314 /** 1315 * Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.) 1316 */ 1317 ResourceType: ResourceType; 1318 /** 1319 * Time the status was updated. 1320 */ 1321 LastUpdatedTimestamp: Timestamp; 1322 /** 1323 * Current status of the resource. 1324 */ 1325 ResourceStatus: ResourceStatus; 1326 /** 1327 * Success/failure message associated with the resource. 1328 */ 1329 ResourceStatusReason?: ResourceStatusReason; 1330 } 1331 export type StackResources = StackResource[]; 1332 export type StackStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATE_COMPLETE"|"ROLLBACK_IN_PROGRESS"|"ROLLBACK_FAILED"|"ROLLBACK_COMPLETE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"UPDATE_IN_PROGRESS"|"UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"|"UPDATE_COMPLETE"|"UPDATE_ROLLBACK_IN_PROGRESS"|"UPDATE_ROLLBACK_FAILED"|"UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"|"UPDATE_ROLLBACK_COMPLETE"|"REVIEW_IN_PROGRESS"|string; 1333 export type StackStatusFilter = StackStatus[]; 1334 export type StackStatusReason = string; 1335 export type StackSummaries = StackSummary[]; 1336 export interface StackSummary { 1337 /** 1338 * Unique stack identifier. 1339 */ 1340 StackId?: StackId; 1341 /** 1342 * The name associated with the stack. 1343 */ 1344 StackName: StackName; 1345 /** 1346 * The template description of the template used to create the stack. 1347 */ 1348 TemplateDescription?: TemplateDescription; 1349 /** 1350 * The time the stack was created. 1351 */ 1352 CreationTime: CreationTime; 1353 /** 1354 * The time the stack was last updated. This field will only be returned if the stack has been updated at least once. 1355 */ 1356 LastUpdatedTime?: LastUpdatedTime; 1357 /** 1358 * The time the stack was deleted. 1359 */ 1360 DeletionTime?: DeletionTime; 1361 /** 1362 * The current status of the stack. 1363 */ 1364 StackStatus: StackStatus; 1365 /** 1366 * Success/Failure message associated with the stack status. 1367 */ 1368 StackStatusReason?: StackStatusReason; 1369 } 1370 export type Stacks = Stack[]; 1371 export type StageList = TemplateStage[]; 1372 export interface Tag { 1373 /** 1374 * 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:. 1375 */ 1376 Key?: TagKey; 1377 /** 1378 * Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value. 1379 */ 1380 Value?: TagValue; 1381 } 1382 export type TagKey = string; 1383 export type TagValue = string; 1384 export type Tags = Tag[]; 1385 export type TemplateBody = string; 1386 export type TemplateDescription = string; 1387 export interface TemplateParameter { 1388 /** 1389 * The name associated with the parameter. 1390 */ 1391 ParameterKey?: ParameterKey; 1392 /** 1393 * The default value associated with the parameter. 1394 */ 1395 DefaultValue?: ParameterValue; 1396 /** 1397 * Flag indicating whether the parameter should be displayed as plain text in logs and UIs. 1398 */ 1399 NoEcho?: NoEcho; 1400 /** 1401 * User defined description associated with the parameter. 1402 */ 1403 Description?: Description; 1404 } 1405 export type TemplateParameters = TemplateParameter[]; 1406 export type TemplateStage = "Original"|"Processed"|string; 1407 export type TemplateURL = string; 1408 export type TimeoutMinutes = number; 1409 export type Timestamp = Date; 1410 export type TransformName = string; 1411 export type TransformsList = TransformName[]; 1412 export interface UpdateStackInput { 1413 /** 1414 * The name or unique stack ID of the stack to update. 1415 */ 1416 StackName: StackName; 1417 /** 1418 * 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. 1419 */ 1420 TemplateBody?: TemplateBody; 1421 /** 1422 * 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 either the TemplateBody or the TemplateURL parameter, but not both. 1423 */ 1424 TemplateURL?: TemplateURL; 1425 /** 1426 * Reuse the existing template that is associated with the stack that you are updating. 1427 */ 1428 UsePreviousTemplate?: UsePreviousTemplate; 1429 /** 1430 * 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. 1431 */ 1432 StackPolicyDuringUpdateBody?: StackPolicyDuringUpdateBody; 1433 /** 1434 * 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. 1435 */ 1436 StackPolicyDuringUpdateURL?: StackPolicyDuringUpdateURL; 1437 /** 1438 * A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type. 1439 */ 1440 Parameters?: Parameters; 1441 /** 1442 * A list of values that you must specify before AWS CloudFormation can update certain stacks. 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 their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. 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 this parameter, this action returns an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. 1443 */ 1444 Capabilities?: Capabilities; 1445 /** 1446 * 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. 1447 */ 1448 ResourceTypes?: ResourceTypes; 1449 /** 1450 * 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. 1451 */ 1452 RoleARN?: RoleARN; 1453 /** 1454 * 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. 1455 */ 1456 StackPolicyBody?: StackPolicyBody; 1457 /** 1458 * 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. 1459 */ 1460 StackPolicyURL?: StackPolicyURL; 1461 /** 1462 * 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. 1463 */ 1464 NotificationARNs?: NotificationARNs; 1465 /** 1466 * 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 10 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. 1467 */ 1468 Tags?: Tags; 1469 } 1470 export interface UpdateStackOutput { 1471 /** 1472 * Unique identifier of the stack. 1473 */ 1474 StackId?: StackId; 1475 } 1476 export type Url = string; 1477 export type UsePreviousTemplate = boolean; 1478 export type UsePreviousValue = boolean; 1479 export interface ValidateTemplateInput { 1480 /** 1481 * 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. 1482 */ 1483 TemplateBody?: TemplateBody; 1484 /** 1485 * 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. 1486 */ 1487 TemplateURL?: TemplateURL; 1488 } 1489 export interface ValidateTemplateOutput { 1490 /** 1491 * A list of TemplateParameter structures. 1492 */ 1493 Parameters?: TemplateParameters; 1494 /** 1495 * The description found within the template. 1496 */ 1497 Description?: Description; 1498 /** 1499 * 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. 1500 */ 1501 Capabilities?: Capabilities; 1502 /** 1503 * The list of resources that generated the values in the Capabilities response element. 1504 */ 1505 CapabilitiesReason?: CapabilitiesReason; 1506 /** 1507 * A list of the transforms that are declared in the template. 1508 */ 1509 DeclaredTransforms?: TransformsList; 1510 } 1511 export type Version = string; 1512 /** 1513 * 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. 1514 */ 1515 export type apiVersion = "2010-05-15"|"latest"|string; 1516 export interface ClientApiVersions { 1517 /** 1518 * 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. 1519 */ 1520 apiVersion?: apiVersion; 1521 } 1522 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1523 } 1524 export = CloudFormation;