AWS CloudFormation API Reference API Version 2010-05-15 AWS CloudFormation API Reference AWS CloudFormation: API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS CloudFormation API Reference Table of Contents Welcome........................................................................................................................................... 1 Actions............................................................................................................................................. 3 ActivateType.............................................................................................................................. 5 Request Parameters............................................................................................................ 5 Response Elements............................................................................................................. 7 Errors............................................................................................................................... 7 See Also............................................................................................................................ 7 BatchDescribeTypeConfigurations................................................................................................. 9 Request Parameters............................................................................................................ 9 Response Elements............................................................................................................. 9 Errors............................................................................................................................... 9 See Also.......................................................................................................................... 10 CancelUpdateStack................................................................................................................... 11 Request Parameters.......................................................................................................... 11 Errors.............................................................................................................................. 11 Examples......................................................................................................................... 12 See Also.......................................................................................................................... 12 ContinueUpdateRollback........................................................................................................... 13 Request Parameters.......................................................................................................... 13 Errors.............................................................................................................................. 14 Examples......................................................................................................................... 15 See Also.......................................................................................................................... 15 CreateChangeSet...................................................................................................................... 16 Request Parameters.......................................................................................................... 16 Response Elements........................................................................................................... 20 Errors.............................................................................................................................. 20 Examples......................................................................................................................... 21 See Also.......................................................................................................................... 22 CreateStack............................................................................................................................. 23 Request Parameters.......................................................................................................... 23 Response Elements........................................................................................................... 27 Errors.............................................................................................................................. 27 Examples......................................................................................................................... 28 See Also.......................................................................................................................... 28 CreateStackInstances................................................................................................................ 30 Request Parameters.......................................................................................................... 30 Response Elements........................................................................................................... 32 Errors.............................................................................................................................. 32 Examples......................................................................................................................... 33 See Also.......................................................................................................................... 33 CreateStackSet......................................................................................................................... 35 Request Parameters.......................................................................................................... 35 Response Elements........................................................................................................... 39 Errors.............................................................................................................................. 39 Examples......................................................................................................................... 39 See Also.......................................................................................................................... 40 DeactivateType......................................................................................................................... 41 Request Parameters.......................................................................................................... 41 Errors.............................................................................................................................. 41 See Also.......................................................................................................................... 42 DeleteChangeSet...................................................................................................................... 43 Request Parameters.......................................................................................................... 43 Errors.............................................................................................................................. 43 Examples......................................................................................................................... 43 API Version 2010-05-15 iii AWS CloudFormation API Reference See Also.......................................................................................................................... 44 DeleteStack............................................................................................................................. 45 Request Parameters.......................................................................................................... 45 Errors.............................................................................................................................. 46 Examples......................................................................................................................... 46 See Also.......................................................................................................................... 46 DeleteStackInstances................................................................................................................ 48 Request Parameters.......................................................................................................... 48 Response Elements........................................................................................................... 49 Errors.............................................................................................................................. 50 Examples......................................................................................................................... 50 See Also.......................................................................................................................... 51 DeleteStackSet......................................................................................................................... 52 Request Parameters.......................................................................................................... 52 Errors.............................................................................................................................. 52 Examples......................................................................................................................... 53 See Also.......................................................................................................................... 53 DeregisterType......................................................................................................................... 54 Request Parameters.......................................................................................................... 54 Errors.............................................................................................................................. 55 Examples......................................................................................................................... 55 See Also.......................................................................................................................... 56 DescribeAccountLimits.............................................................................................................. 57 Request Parameters.......................................................................................................... 57 Response Elements........................................................................................................... 57 Errors.............................................................................................................................. 57 Examples......................................................................................................................... 57 See Also.......................................................................................................................... 58 DescribeChangeSet................................................................................................................... 59 Request Parameters.......................................................................................................... 59 Response Elements........................................................................................................... 59 Errors.............................................................................................................................. 62 Examples......................................................................................................................... 62 See Also.......................................................................................................................... 63 DescribeChangeSetHooks.......................................................................................................... 65 Request Parameters.......................................................................................................... 65 Response Elements........................................................................................................... 65 Errors.............................................................................................................................. 66 See Also.......................................................................................................................... 67 DescribePublisher..................................................................................................................... 68 Request Parameters.......................................................................................................... 68 Response Elements........................................................................................................... 68 Errors.............................................................................................................................. 69 See Also.......................................................................................................................... 69 DescribeStackDriftDetectionStatus.............................................................................................. 70 Request Parameters.......................................................................................................... 70 Response Elements........................................................................................................... 70 Errors.............................................................................................................................. 71 Examples......................................................................................................................... 71 See Also.......................................................................................................................... 72 DescribeStackEvents................................................................................................................. 73 Request Parameters.......................................................................................................... 73 Response Elements........................................................................................................... 73 Errors.............................................................................................................................. 73 Examples......................................................................................................................... 74 See Also.......................................................................................................................... 75 DescribeStackInstance............................................................................................................... 76 API Version 2010-05-15 iv AWS CloudFormation API Reference Request Parameters.......................................................................................................... 76 Response Elements........................................................................................................... 76 Errors.............................................................................................................................. 77 Examples......................................................................................................................... 77 See Also.......................................................................................................................... 78 DescribeStackResource.............................................................................................................. 79 Request Parameters.......................................................................................................... 79 Response Elements........................................................................................................... 79 Errors.............................................................................................................................. 79 Examples......................................................................................................................... 79 See Also.......................................................................................................................... 80 DescribeStackResourceDrifts...................................................................................................... 81 Request Parameters.......................................................................................................... 81 Response Elements........................................................................................................... 82 Errors.............................................................................................................................. 82 Examples......................................................................................................................... 82 See Also.......................................................................................................................... 84 DescribeStackResources............................................................................................................. 85 Request Parameters.......................................................................................................... 85 Response Elements........................................................................................................... 86 Errors.............................................................................................................................. 86 Examples......................................................................................................................... 86 See Also.......................................................................................................................... 87 DescribeStacks......................................................................................................................... 88 Request Parameters.......................................................................................................... 88 Response Elements........................................................................................................... 88 Errors.............................................................................................................................. 88 Examples......................................................................................................................... 89 See Also.......................................................................................................................... 89 DescribeStackSet...................................................................................................................... 91 Request Parameters.......................................................................................................... 91 Response Elements........................................................................................................... 91 Errors.............................................................................................................................. 91 Examples......................................................................................................................... 92 See Also.......................................................................................................................... 93 DescribeStackSetOperation........................................................................................................ 94 Request Parameters.......................................................................................................... 94 Response Elements........................................................................................................... 94 Errors.............................................................................................................................. 95 Examples......................................................................................................................... 95 See Also.......................................................................................................................... 96 DescribeType........................................................................................................................... 98 Request Parameters.......................................................................................................... 98 Response Elements........................................................................................................... 99 Errors............................................................................................................................ 104 Examples....................................................................................................................... 105 See Also........................................................................................................................ 105 DescribeTypeRegistration......................................................................................................... 107 Request Parameters........................................................................................................ 107 Response Elements......................................................................................................... 107 Errors............................................................................................................................ 108 Examples....................................................................................................................... 108 See Also........................................................................................................................ 109 DetectStackDrift..................................................................................................................... 110 Request Parameters........................................................................................................ 110 Response Elements......................................................................................................... 110 Errors............................................................................................................................ 111 API Version 2010-05-15 v AWS CloudFormation API Reference Examples....................................................................................................................... 111 See Also........................................................................................................................ 111 DetectStackResourceDrift......................................................................................................... 113 Request Parameters........................................................................................................ 113 Response Elements......................................................................................................... 113 Errors............................................................................................................................ 113 Examples....................................................................................................................... 114 See Also........................................................................................................................ 115 DetectStackSetDrift................................................................................................................ 116 Request Parameters........................................................................................................ 116 Response Elements......................................................................................................... 117 Errors............................................................................................................................ 117 Examples....................................................................................................................... 118 See Also........................................................................................................................ 118 EstimateTemplateCost............................................................................................................. 119 Request Parameters........................................................................................................ 119 Response Elements......................................................................................................... 119 Errors............................................................................................................................ 120 Examples....................................................................................................................... 120 See Also........................................................................................................................ 120 ExecuteChangeSet.................................................................................................................. 121 Request Parameters........................................................................................................ 121 Errors............................................................................................................................ 122 Examples....................................................................................................................... 122 See Also........................................................................................................................ 123 GetStackPolicy....................................................................................................................... 124 Request Parameters........................................................................................................ 124 Response Elements......................................................................................................... 124 Errors............................................................................................................................ 124 Examples....................................................................................................................... 124 See Also........................................................................................................................ 125 GetTemplate.......................................................................................................................... 126 Request Parameters........................................................................................................ 126 Response Elements......................................................................................................... 126 Errors............................................................................................................................ 127 Examples....................................................................................................................... 127 See Also........................................................................................................................ 128 GetTemplateSummary............................................................................................................. 129 Request Parameters........................................................................................................ 129 Response Elements......................................................................................................... 130 Errors............................................................................................................................ 131 Examples....................................................................................................................... 131 See Also........................................................................................................................ 132 ImportStacksToStackSet.......................................................................................................... 133 Request Parameters........................................................................................................ 133 Response Elements......................................................................................................... 134 Errors............................................................................................................................ 134 See Also........................................................................................................................ 135 ListChangeSets....................................................................................................................... 136 Request Parameters........................................................................................................ 136 Response Elements......................................................................................................... 136 Errors............................................................................................................................ 136 Examples....................................................................................................................... 137 See Also........................................................................................................................ 138 ListExports............................................................................................................................. 139 Request Parameters........................................................................................................ 139 Response Elements......................................................................................................... 139 API Version 2010-05-15 vi AWS CloudFormation API Reference Errors............................................................................................................................ 139 Examples....................................................................................................................... 139 See Also........................................................................................................................ 140 ListImports............................................................................................................................ 142 Request Parameters........................................................................................................ 142 Response Elements......................................................................................................... 142 Errors............................................................................................................................ 142 Examples....................................................................................................................... 143 See Also........................................................................................................................ 143 ListStackInstances................................................................................................................... 144 Request Parameters........................................................................................................ 144 Response Elements......................................................................................................... 145 Errors............................................................................................................................ 145 Examples....................................................................................................................... 146 See Also........................................................................................................................ 147 ListStackResources.................................................................................................................. 148 Request Parameters........................................................................................................ 148 Response Elements......................................................................................................... 148 Errors............................................................................................................................ 148 Examples....................................................................................................................... 149 See Also........................................................................................................................ 150 ListStacks.............................................................................................................................. 151 Request Parameters........................................................................................................ 151 Response Elements......................................................................................................... 151 Errors............................................................................................................................ 152 Examples....................................................................................................................... 152 See Also........................................................................................................................ 153 ListStackSetOperationResults................................................................................................... 154 Request Parameters........................................................................................................ 154 Response Elements......................................................................................................... 155 Errors............................................................................................................................ 155 Examples....................................................................................................................... 156 See Also........................................................................................................................ 157 ListStackSetOperations............................................................................................................ 159 Request Parameters........................................................................................................ 159 Response Elements......................................................................................................... 160 Errors............................................................................................................................ 160 Examples....................................................................................................................... 160 See Also........................................................................................................................ 161 ListStackSets.......................................................................................................................... 162 Request Parameters........................................................................................................ 162 Response Elements......................................................................................................... 163 Errors............................................................................................................................ 163 Examples....................................................................................................................... 163 See Also........................................................................................................................ 164 ListTypeRegistrations.............................................................................................................. 165 Request Parameters........................................................................................................ 165 Response Elements......................................................................................................... 166 Errors............................................................................................................................ 166 Examples....................................................................................................................... 167 See Also........................................................................................................................ 167 ListTypes............................................................................................................................... 168 Request Parameters........................................................................................................ 168 Response Elements......................................................................................................... 169 Errors............................................................................................................................ 170 Examples....................................................................................................................... 170 See Also........................................................................................................................ 171 API Version 2010-05-15 vii AWS CloudFormation API Reference ListTypeVersions..................................................................................................................... 172 Request Parameters........................................................................................................ 172 Response Elements......................................................................................................... 173 Errors............................................................................................................................ 174 Examples....................................................................................................................... 174 See Also........................................................................................................................ 175 PublishType........................................................................................................................... 176 Request Parameters........................................................................................................ 176 Response Elements......................................................................................................... 177 Errors............................................................................................................................ 177 See Also........................................................................................................................ 177 RecordHandlerProgress............................................................................................................ 179 Request Parameters........................................................................................................ 179 Errors............................................................................................................................ 180 See Also........................................................................................................................ 180 RegisterPublisher.................................................................................................................... 181 Request Parameters........................................................................................................ 181 Response Elements......................................................................................................... 181 Errors............................................................................................................................ 182 See Also........................................................................................................................ 182 RegisterType.......................................................................................................................... 183 Request Parameters........................................................................................................ 183 Response Elements......................................................................................................... 185 Errors............................................................................................................................ 185 Examples....................................................................................................................... 185 See Also........................................................................................................................ 186 RollbackStack......................................................................................................................... 187 Request Parameters........................................................................................................ 187 Response Elements......................................................................................................... 188 Errors............................................................................................................................ 188 See Also........................................................................................................................ 188 SetStackPolicy........................................................................................................................ 189 Request Parameters........................................................................................................ 189 Errors............................................................................................................................ 189 Examples....................................................................................................................... 189 See Also........................................................................................................................ 190 SetTypeConfiguration.............................................................................................................. 191 Request Parameters........................................................................................................ 191 Response Elements......................................................................................................... 192 Errors............................................................................................................................ 192 See Also........................................................................................................................ 193 SetTypeDefaultVersion............................................................................................................ 194 Request Parameters........................................................................................................ 194 Errors............................................................................................................................ 195 Examples....................................................................................................................... 195 See Also........................................................................................................................ 195 SignalResource....................................................................................................................... 197 Request Parameters........................................................................................................ 197 Errors............................................................................................................................ 197 Examples....................................................................................................................... 198 See Also........................................................................................................................ 198 StopStackSetOperation........................................................................................................... 199 Request Parameters........................................................................................................ 199 Errors............................................................................................................................ 199 Examples....................................................................................................................... 200 See Also........................................................................................................................ 200 TestType................................................................................................................................ 202 API Version 2010-05-15 viii AWS CloudFormation API Reference Request Parameters........................................................................................................ 202 Response Elements......................................................................................................... 203 Errors............................................................................................................................ 204 See Also........................................................................................................................ 204 UpdateStack.......................................................................................................................... 205 Request Parameters........................................................................................................ 205 Response Elements......................................................................................................... 209 Errors............................................................................................................................ 210 Examples....................................................................................................................... 210 See Also........................................................................................................................ 210 UpdateStackInstances............................................................................................................. 212 Request Parameters........................................................................................................ 212 Response Elements......................................................................................................... 214 Errors............................................................................................................................ 214 See Also........................................................................................................................ 215 UpdateStackSet...................................................................................................................... 216 Request Parameters........................................................................................................ 216 Response Elements......................................................................................................... 221 Errors............................................................................................................................ 221 Examples....................................................................................................................... 222 See Also........................................................................................................................ 223 UpdateTerminationProtection................................................................................................... 224 Request Parameters........................................................................................................ 224 Response Elements......................................................................................................... 224 Errors............................................................................................................................ 224 See Also........................................................................................................................ 224 ValidateTemplate.................................................................................................................... 226 Request Parameters........................................................................................................ 226 Response Elements......................................................................................................... 226 Errors............................................................................................................................ 227 Examples....................................................................................................................... 227 See Also........................................................................................................................ 228 Data Types.................................................................................................................................... 229 AccountGateResult.................................................................................................................. 231 Contents........................................................................................................................ 231 See Also........................................................................................................................ 231 AccountLimit.......................................................................................................................... 233 Contents........................................................................................................................ 233 See Also........................................................................................................................ 233 AutoDeployment.................................................................................................................... 234 Contents........................................................................................................................ 234 See Also........................................................................................................................ 234 BatchDescribeTypeConfigurationsError...................................................................................... 235 Contents........................................................................................................................ 235 See Also........................................................................................................................ 235 Change.................................................................................................................................. 236 Contents........................................................................................................................ 236 See Also........................................................................................................................ 236 ChangeSetHook...................................................................................................................... 237 Contents........................................................................................................................ 237 See Also........................................................................................................................ 238 ChangeSetHookResourceTargetDetails....................................................................................... 239 Contents........................................................................................................................ 239 See Also........................................................................................................................ 239 ChangeSetHookTargetDetails................................................................................................... 240 Contents........................................................................................................................ 240 See Also........................................................................................................................ 240 API Version 2010-05-15 ix AWS CloudFormation API Reference ChangeSetSummary................................................................................................................ 241 Contents........................................................................................................................ 241 See Also........................................................................................................................ 243 DeploymentTargets................................................................................................................. 244 Contents........................................................................................................................ 244 See Also........................................................................................................................ 245 Export................................................................................................................................... 246 Contents........................................................................................................................ 246 See Also........................................................................................................................ 246 LoggingConfig........................................................................................................................ 247 Contents........................................................................................................................ 247 See Also........................................................................................................................ 247 ManagedExecution.................................................................................................................. 248 Contents........................................................................................................................ 248 See Also........................................................................................................................ 248 ModuleInfo............................................................................................................................ 249 Contents........................................................................................................................ 249 See Also........................................................................................................................ 249 OperationResultFilter.............................................................................................................. 250 Contents........................................................................................................................ 250 See Also........................................................................................................................ 250 Output.................................................................................................................................. 251 Contents........................................................................................................................ 251 See Also........................................................................................................................ 251 Parameter.............................................................................................................................. 252 Contents........................................................................................................................ 252 See Also........................................................................................................................ 252 ParameterConstraints.............................................................................................................. 253 Contents........................................................................................................................ 253 See Also........................................................................................................................ 253 ParameterDeclaration.............................................................................................................. 254 Contents........................................................................................................................ 254 See Also........................................................................................................................ 254 PhysicalResourceIdContextKeyValuePair..................................................................................... 256 Contents........................................................................................................................ 256 See Also........................................................................................................................ 256 PropertyDifference.................................................................................................................. 257 Contents........................................................................................................................ 257 See Also........................................................................................................................ 257 RequiredActivatedType............................................................................................................ 258 Contents........................................................................................................................ 258 See Also........................................................................................................................ 259 ResourceChange..................................................................................................................... 260 Contents........................................................................................................................ 260 See Also........................................................................................................................ 261 ResourceChangeDetail ............................................................................................................. 262 Contents........................................................................................................................ 262 See Also........................................................................................................................ 263 ResourceIdentifierSummary...................................................................................................... 264 Contents........................................................................................................................ 264 See Also........................................................................................................................ 264 ResourceTargetDefinition......................................................................................................... 265 Contents........................................................................................................................ 265 See Also........................................................................................................................ 265 ResourceToImport................................................................................................................... 266 Contents........................................................................................................................ 266 See Also........................................................................................................................ 266 API Version 2010-05-15 x
Description: