AWS CloudFormation API Referenceawsdocs.s3.amazonaws.com/AWSCloudFormation/latest/cfn-api.pdf ·...
Transcript of AWS CloudFormation API Referenceawsdocs.s3.amazonaws.com/AWSCloudFormation/latest/cfn-api.pdf ·...
AWS CloudFormationAPI Reference
API Version 2010-05-15
AWS CloudFormation: API ReferenceCopyright © 2014 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
The following are trademarks of Amazon Web Services, Inc.: Amazon, Amazon Web Services Design, AWS, Amazon CloudFront,Cloudfront, CloudTrail, Amazon DevPay, DynamoDB, ElastiCache, Amazon EC2, Amazon Elastic Compute Cloud, Amazon Glacier,Kinesis, Kindle, Kindle Fire, AWS Marketplace Design, Mechanical Turk, Amazon Redshift, Amazon Route 53, Amazon S3, AmazonVPC. In addition, Amazon.com graphics, logos, page headers, button icons, scripts, and service names are trademarks, or trade dressof Amazon in the U.S. and/or other countries. Amazon's trademarks and trade dress may not be used in connection with any productor service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparagesor discredits Amazon.
All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connectedto, or sponsored by Amazon.
AWS CloudFormation API Reference
Table of ContentsWelcome ..................................................................................................................................... 1Actions ........................................................................................................................................ 2
CancelUpdateStack ............................................................................................................... 3Description ................................................................................................................... 3Request Parameters ...................................................................................................... 3Examples ..................................................................................................................... 3
CreateStack ......................................................................................................................... 4Description ................................................................................................................... 4Request Parameters ...................................................................................................... 4Response Elements ....................................................................................................... 6Errors .......................................................................................................................... 6Examples ..................................................................................................................... 6
DeleteStack .......................................................................................................................... 8Description ................................................................................................................... 8Request Parameters ...................................................................................................... 8Examples ..................................................................................................................... 8
DescribeStackEvents ............................................................................................................. 9Description ................................................................................................................... 9Request Parameters ...................................................................................................... 9Response Elements ....................................................................................................... 9Examples ................................................................................................................... 10
DescribeStackResource ........................................................................................................ 12Description ................................................................................................................. 12Request Parameters .................................................................................................... 12Response Elements ..................................................................................................... 12Examples ................................................................................................................... 12
DescribeStackResources ...................................................................................................... 14Description ................................................................................................................. 14Request Parameters .................................................................................................... 14Response Elements ..................................................................................................... 15Examples ................................................................................................................... 15
DescribeStacks ................................................................................................................... 17Description ................................................................................................................. 17Request Parameters .................................................................................................... 17Response Elements ..................................................................................................... 17Examples ................................................................................................................... 17
EstimateTemplateCost .......................................................................................................... 19Description ................................................................................................................. 19Request Parameters .................................................................................................... 19Response Elements ..................................................................................................... 19Examples ................................................................................................................... 20
GetStackPolicy .................................................................................................................... 21Description ................................................................................................................. 21Request Parameters .................................................................................................... 21Response Elements ..................................................................................................... 21Examples ................................................................................................................... 21
GetTemplate ....................................................................................................................... 23Description ................................................................................................................. 23Request Parameters .................................................................................................... 23Response Elements ..................................................................................................... 23Examples ................................................................................................................... 23
GetTemplateSummary .......................................................................................................... 25Description ................................................................................................................. 25Request Parameters .................................................................................................... 25Response Elements ..................................................................................................... 26
API Version 2010-05-15iii
AWS CloudFormation API Reference
Examples ................................................................................................................... 26ListStackResources ............................................................................................................. 28
Description ................................................................................................................. 28Request Parameters .................................................................................................... 28Response Elements ..................................................................................................... 28Examples ................................................................................................................... 29
ListStacks .......................................................................................................................... 31Description ................................................................................................................. 31Request Parameters .................................................................................................... 31Response Elements ..................................................................................................... 31Examples ................................................................................................................... 32
SetStackPolicy .................................................................................................................... 33Description ................................................................................................................. 33Request Parameters .................................................................................................... 33Examples ................................................................................................................... 33
SignalResource ................................................................................................................... 35Description ................................................................................................................. 35Request Parameters .................................................................................................... 35Examples ................................................................................................................... 36
UpdateStack ....................................................................................................................... 37Description ................................................................................................................. 37Request Parameters .................................................................................................... 37Response Elements ..................................................................................................... 39Errors ........................................................................................................................ 39Examples ................................................................................................................... 39
ValidateTemplate ................................................................................................................. 41Description ................................................................................................................. 41Request Parameters .................................................................................................... 41Response Elements ..................................................................................................... 41Examples ................................................................................................................... 42
Data Types ................................................................................................................................. 44CreateStackResult ............................................................................................................... 45
Description ................................................................................................................. 45Contents .................................................................................................................... 45
DescribeStackEventsResult ................................................................................................... 45Description ................................................................................................................. 45Contents .................................................................................................................... 45
DescribeStackResourceResult ............................................................................................... 45Description ................................................................................................................. 45Contents .................................................................................................................... 45
DescribeStackResourcesResult ............................................................................................. 46Description ................................................................................................................. 46Contents .................................................................................................................... 46
DescribeStacksResult .......................................................................................................... 46Description ................................................................................................................. 46Contents .................................................................................................................... 46
EstimateTemplateCostResult ................................................................................................. 46Description ................................................................................................................. 46Contents .................................................................................................................... 47
GetStackPolicyResult ........................................................................................................... 47Description ................................................................................................................. 47Contents .................................................................................................................... 47
GetTemplateResult .............................................................................................................. 47Description ................................................................................................................. 47Contents .................................................................................................................... 47
GetTemplateSummaryResult ................................................................................................. 48Description ................................................................................................................. 48Contents .................................................................................................................... 48
API Version 2010-05-15iv
AWS CloudFormation API Reference
ListStackResourcesResult ..................................................................................................... 48Description ................................................................................................................. 48Contents .................................................................................................................... 49
ListStacksResult .................................................................................................................. 49Description ................................................................................................................. 49Contents .................................................................................................................... 49
Output ............................................................................................................................... 49Description ................................................................................................................. 49Contents .................................................................................................................... 49
Parameter .......................................................................................................................... 50Description ................................................................................................................. 50Contents .................................................................................................................... 50
ParameterDeclaration ........................................................................................................... 50Description ................................................................................................................. 50Contents .................................................................................................................... 51
Stack ................................................................................................................................. 51Description ................................................................................................................. 51Contents .................................................................................................................... 51
StackEvent ......................................................................................................................... 53Description ................................................................................................................. 53Contents .................................................................................................................... 53
StackResource .................................................................................................................... 54Description ................................................................................................................. 54Contents .................................................................................................................... 55
StackResourceDetail ............................................................................................................ 56Description ................................................................................................................. 56Contents .................................................................................................................... 56
StackResourceSummary ...................................................................................................... 57Description ................................................................................................................. 57Contents .................................................................................................................... 57
StackSummary .................................................................................................................... 58Description ................................................................................................................. 58Contents .................................................................................................................... 58
Tag ................................................................................................................................... 59Description ................................................................................................................. 59Contents .................................................................................................................... 59
TemplateParameter .............................................................................................................. 60Description ................................................................................................................. 60Contents .................................................................................................................... 60
UpdateStackResult .............................................................................................................. 60Description ................................................................................................................. 60Contents .................................................................................................................... 60
ValidateTemplateResult ........................................................................................................ 61Description ................................................................................................................. 61Contents .................................................................................................................... 61
Common Parameters ................................................................................................................... 62......................................................................................................................................... 62
Common Errors ........................................................................................................................... 64......................................................................................................................................... 64
API Version 2010-05-15v
AWS CloudFormation API Reference
Welcome
AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictablyand repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS,Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applicationswithout worrying about creating and configuring the underlying AWS infrastructure.
With AWS CloudFormation, you declare all of your resources and dependencies in a template file. Thetemplate defines a collection of resources as a single unit called a stack. AWS CloudFormation createsand deletes all member resources of the stack together and manages all dependencies between the re-sources for you.
For more information about this product, go to the CloudFormation Product Page.
Amazon CloudFormation makes use of other AWS products. If you need additional technical informationabout a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.
This document was last updated on November 19, 2014.
API Version 2010-05-151
AWS CloudFormation API Reference
Actions
The following actions are supported:
• CancelUpdateStack (p. 3)
• CreateStack (p. 4)
• DeleteStack (p. 8)
• DescribeStackEvents (p. 9)
• DescribeStackResource (p. 12)
• DescribeStackResources (p. 14)
• DescribeStacks (p. 17)
• EstimateTemplateCost (p. 19)
• GetStackPolicy (p. 21)
• GetTemplate (p. 23)
• GetTemplateSummary (p. 25)
• ListStackResources (p. 28)
• ListStacks (p. 31)
• SetStackPolicy (p. 33)
• SignalResource (p. 35)
• UpdateStack (p. 37)
• ValidateTemplate (p. 41)
API Version 2010-05-152
AWS CloudFormation API Reference
CancelUpdateStack
DescriptionCancels an update on the specified stack. If the call completes successfully, the stack will roll back theupdate and revert to the previous stack configuration.
NoteOnly stacks that are in the UPDATE_IN_PROGRESS state can be canceled.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
StackNameThe name or the unique stack ID that is associated with the stack.
Type: String
Required:Yes
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=CancelUpdateStack &StackName=MyStack &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<CancelUpdateStackResult/>
API Version 2010-05-153
AWS CloudFormation API ReferenceCancelUpdateStack
CreateStack
DescriptionCreates a stack as specified in the template. After the call completes successfully, the stack creationstarts.You can check the status of the stack via the DescribeStacks (p. 17) API.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
Capabilities.member.NA list of capabilities that you must specify before AWS CloudFormation can create or update certainstacks. Some stack templates might include resources that can affect permissions in your AWS ac-count. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is CAPABILITY_IAM, which is required for the following resources:AWS::CloudFormation::Stack, AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile,AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. Ifyour stack template contains these resources, we recommend that you review any permissions as-sociated with them. If you don't specify this parameter, this action returns an InsufficientCapab-ilities error.
Type: String list
Valid Values: CAPABILITY_IAM
Required: No
DisableRollbackSet to true to disable rollback of the stack if stack creation failed.You can specify either DisableR-ollback or OnFailure, but not both.
Default: false
Type: Boolean
Required: No
NotificationARNs.member.NThe Simple Notification Service (SNS) topic ARNs to publish stack related events.You can find yourSNS topic ARNs using the SNS console or your Command Line Interface (CLI).
Type: String list
Length constraints: Minimum of 0 item(s) in the list. Maximum of 5 item(s) in the list.
Required: No
OnFailureDetermines 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
Type: String
Valid Values: DO_NOTHING | ROLLBACK | DELETE
Required: No
API Version 2010-05-154
AWS CloudFormation API ReferenceCreateStack
Parameters.member.NA list of Parameter structures that specify input parameters for the stack.
Type: Parameter (p. 50) list
Required: No
StackNameThe name that is associated with the stack. The name must be unique in the region in which you arecreating the stack.
NoteA stack name can contain only alphanumeric characters (case sensitive) and hyphens. Itmust start with an alphabetic character and cannot be longer than 255 characters.
Type: String
Required:Yes
StackPolicyBodyStructure containing the stack policy body. For more information, go to Prevent Updates to StackResources in the AWS CloudFormation User Guide.You can specify either the StackPolicyBodyor the StackPolicyURL parameter, but not both.
Type: String
Length constraints: Minimum length of 1. Maximum length of 16384.
Required: No
StackPolicyURLLocation of a file containing the stack policy.The URL must point to a policy (max size: 16KB) locatedin an S3 bucket in the same region as the stack.You can specify either the StackPolicyBody orthe StackPolicyURL parameter, but not both.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1350.
Required: No
Tags.member.NA set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags definedfor the stack are propagated to EC2 resources that are created as part of the stack. A maximumnumber of 10 tags can be specified.
Type: Tag (p. 59) list
Required: No
TemplateBodyStructure containing the template body with a minimum length of 1 byte and a maximum length of51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation UserGuide.
Conditional:You must specify either the TemplateBody or the TemplateURL parameter, but notboth.
Type: String
Length constraints: Minimum length of 1.
Required: No
API Version 2010-05-155
AWS CloudFormation API ReferenceRequest Parameters
TemplateURLLocation of file containing the template body. The URL must point to a template (max size: 307,200bytes) located in an S3 bucket in the same region as the stack. For more information, go to theTemplate Anatomy in the AWS CloudFormation User Guide.
Conditional:You must specify either the TemplateBody or the TemplateURL parameter, but notboth.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
TimeoutInMinutesThe amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableR-ollback is not set or is set to false, the stack will be rolled back.
Type: Integer
Required: No
Response ElementsThe following element is returned in a structure named CreateStackResult.
StackIdUnique identifier of the stack.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 64).
AlreadyExistsResource with the name requested already exists.
HTTP Status Code: 400
InsufficientCapabilitiesThe template contains resources with capabilities that were not specified in the Capabilities parameter.
HTTP Status Code: 400
LimitExceededQuota for the resource has already been reached.
HTTP Status Code: 400
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/
API Version 2010-05-156
AWS CloudFormation API ReferenceResponse Elements
?Action=CreateStack &StackName=MyStack &TemplateBody=[Template Document] &NotificationARNs.member.1=arn:aws:sns:us-east-1:1234567890:my-topic &Parameters.member.1.ParameterKey=AvailabilityZone &Parameters.member.1.ParameterValue=us-east-1a &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<CreateStackResult> <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId></CreateStackResult>
API Version 2010-05-157
AWS CloudFormation API ReferenceExamples
DeleteStack
DescriptionDeletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks donot show up in the DescribeStacks (p. 17) API if the deletion has been completed successfully.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
StackNameThe name or the unique stack ID that is associated with the stack.
Type: String
Required:Yes
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=DeleteStack &StackName=MyStack &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<DeleteStackResult/>
API Version 2010-05-158
AWS CloudFormation API ReferenceDeleteStack
DescribeStackEvents
DescriptionReturns all stack related events for a specified stack. For more information about a stack's event history,go to Stacks in the AWS CloudFormation User Guide.
NoteYou can list events for stacks that have failed to create or have been deleted by specifying theunique stack identifier (stack ID).
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
NextTokenString that identifies the start of the next list of events, if there is one.
Default: There is no default value.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
StackNameThe name or the unique stack ID that is associated with the stack, which are not always interchange-able:
• 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.
Type: String
Required: No
Response ElementsThe following elements are returned in a structure named DescribeStackEventsResult.
NextTokenString that identifies the start of the next list of events, if there is one.
Type: String
StackEventsA list of StackEvents structures.
Type: StackEvent (p. 53) list
API Version 2010-05-159
AWS CloudFormation API ReferenceDescribeStackEvents
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=DescribeStackEvents &StackName=MyStack &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<DescribeStackEventsResult> <StackEvents> <member> <EventId>Event-1-Id</EventId> <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId> <StackName>MyStack</StackName> <LogicalResourceId>MyStack</LogicalResourceId> <PhysicalResourceId>MyStack_One</PhysicalResourceId> <ResourceType>AWS::CloudFormation::Stack</ResourceType> <Timestamp>2010-07-27T22:26:28Z</Timestamp> <ResourceStatus>CREATE_IN_PROGRESS</ResourceStatus> <ResourceStatusReason>User initiated</ ResourceStatusReason> </member> <member> <EventId>Event-2-Id</EventId> <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId> <StackName>MyStack</StackName> <LogicalResourceId>MyDBInstance</LogicalResourceId> <PhysicalResourceId>MyStack_DB1</PhysicalResourceId> <ResourceType>AWS::SecurityGroup</ResourceType> <Timestamp>2010-07-27T22:27:28Z</Timestamp> <ResourceStatus>CREATE_IN_PROGRESS</ResourceStatus> <ResourceProperties>{"GroupDescription":...}</ResourceProperties> </member> <member> <EventId>Event-3-Id</EventId> <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId> <StackName>MyStack</StackName> <LogicalResourceId>MySG1</LogicalResourceId> <PhysicalResourceId>MyStack_SG1</PhysicalResourceId> <ResourceType>AWS:: SecurityGroup</ResourceType> <Timestamp>2010-07-27T22:28:28Z</Timestamp> <ResourceStatus>CREATE_COMPLETE</ResourceStatus> </member>
API Version 2010-05-1510
AWS CloudFormation API ReferenceExamples
</StackEvents></DescribeStackEventsResult>
API Version 2010-05-1511
AWS CloudFormation API ReferenceExamples
DescribeStackResource
DescriptionReturns a description of the specified resource in the specified stack.
For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stackhas been deleted.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
LogicalResourceIdThe logical name of the resource as specified in the template.
Default: There is no default value.
Type: String
Required:Yes
StackNameThe name or the unique stack ID that is associated with the stack, which are not always interchange-able:
• 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.
Type: String
Required:Yes
Response ElementsThe following element is returned in a structure named DescribeStackResourceResult.
StackResourceDetailA StackResourceDetail structure containing the description of the specified resource in the spe-cified stack.
Type: StackResourceDetail (p. 56)
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=DescribeStackResource &StackName=MyStack
API Version 2010-05-1512
AWS CloudFormation API ReferenceDescribeStackResource
&LogicalResourceId=MyDBInstance &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2011-07-08T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<DescribeStackResourceResponse> <DescribeStackResourceResult> <StackResourceDetail> <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId> <StackName>MyStack</StackName> <LogicalResourceId>MyDBInstance</LogicalResourceId> <PhysicalResourceId>MyStack_DB1</PhysicalResourceId> <ResourceType>AWS::RDS::DBInstance</ResourceType> <LastUpdatedTimestamp>2011-07-07T22:27:28Z</LastUpdatedTimestamp> <ResourceStatus>CREATE_COMPLETE</ResourceStatus> </StackResourceDetail> </DescribeStackResourceResult></DescribeStackResourceResponse>
API Version 2010-05-1513
AWS CloudFormation API ReferenceExamples
DescribeStackResources
DescriptionReturns AWS resource descriptions for running and deleted stacks. If StackName is specified, all theassociated resources that are part of the stack are returned. If PhysicalResourceId is specified, theassociated resources of the stack that the resource belongs to are returned.
NoteOnly the first 100 resources will be returned. If your stack has more resources than this, youshould use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after thestack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specifyLogicalResourceId to filter the returned result. For more information about resources, the LogicalRe-sourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.
NoteA ValidationError is returned if you specify both StackName and PhysicalResourceIdin the same request.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
LogicalResourceIdThe logical name of the resource as specified in the template.
Default: There is no default value.
Type: String
Required: No
PhysicalResourceIdThe name or unique identifier that corresponds to a physical instance ID of a resource supported byAWS CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corres-ponds to the InstanceId.You can pass the EC2 InstanceId to DescribeStackResources tofind 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.
Type: String
Required: No
StackNameThe name or the unique stack ID that is associated with the stack, which are not always interchange-able:
• 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.
API Version 2010-05-1514
AWS CloudFormation API ReferenceDescribeStackResources
Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.
Type: String
Required: No
Response ElementsThe following element is returned in a structure named DescribeStackResourcesResult.
StackResourcesA list of StackResource structures.
Type: StackResource (p. 54) list
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=DescribeStackResources &StackName=MyStack &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<DescribeStackResourcesResult> <StackResources> <member> <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId> <StackName>MyStack</StackName> <LogicalResourceId>MyDBInstance</LogicalResourceId> <PhysicalResourceId>MyStack_DB1</PhysicalResourceId> <ResourceType>AWS::DBInstance</ResourceType> <Timestamp>2010-07-27T22:27:28Z</Timestamp> <ResourceStatus>CREATE_COMPLETE</ResourceStatus> </member> <member> <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId> <StackName>MyStack</StackName> <LogicalResourceId>MyAutoScalingGroup</LogicalResourceId> <PhysicalResourceId>MyStack_ASG1</PhysicalResourceId> <ResourceType>AWS::AutoScalingGroup</ResourceType> <Timestamp>2010-07-27T22:28:28Z</Timestamp> <ResourceStatus>CREATE_IN_PROGRESS</ResourceStatus>
API Version 2010-05-1515
AWS CloudFormation API ReferenceResponse Elements
</member> </StackResources></DescribeStackResourcesResult>
API Version 2010-05-1516
AWS CloudFormation API ReferenceExamples
DescribeStacks
DescriptionReturns the description for the specified stack; if no stack name was specified, then it returns the descriptionfor all the stacks created.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
NextTokenString that identifies the start of the next list of stacks, if there is one.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
StackNameThe name or the unique stack ID that is associated with the stack, which are not always interchange-able:
• 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.
Type: String
Required: No
Response ElementsThe following elements are returned in a structure named DescribeStacksResult.
NextTokenString that identifies the start of the next list of stacks, if there is one.
Type: String
StacksA list of stack structures.
Type: Stack (p. 51) list
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=DescribeStacks
API Version 2010-05-1517
AWS CloudFormation API ReferenceDescribeStacks
&StackName=MyStack &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<DescribeStacksResult> <Stacks> <member> <StackName>MyStack</StackName> <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId> <CreationTime>2010-07-27T22:28:28Z</CreationTime> <StackStatus>CREATE_COMPLETE</StackStatus> <DisableRollback>false</DisableRollback> <Outputs> <member> <OutputKey>StartPage</OutputKey> <OutputValue>http://my-load-balancer.amazonaws.com:80/index.html</Out putValue> </member> </Outputs> </member> </Stacks></DescribeStacksResult>
API Version 2010-05-1518
AWS CloudFormation API ReferenceExamples
EstimateTemplateCost
DescriptionReturns the estimated monthly cost of a template.The return value is an AWS Simple Monthly CalculatorURL with a query string that describes the resources required to run the template.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
Parameters.member.NA list of Parameter structures that specify input parameters.
Type: Parameter (p. 50) list
Required: No
TemplateBodyStructure containing the template body with a minimum length of 1 byte and a maximum length of51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation UserGuide.)
Conditional:You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBodyis used.
Type: String
Length constraints: Minimum length of 1.
Required: No
TemplateURLLocation of file containing the template body. The URL must point to a template located in an S3bucket in the same region as the stack. For more information, go to Template Anatomy in the AWSCloudFormation User Guide.
Conditional:You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBodyis used.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
Response ElementsThe following element is returned in a structure named EstimateTemplateCostResult.
UrlAn AWS Simple Monthly Calculator URL with a query string that describes the resources requiredto run the template.
Type: String
API Version 2010-05-1519
AWS CloudFormation API ReferenceEstimateTemplateCost
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=EstimateTemplateCost &TemplateURL= https://s3.amazonaws.com/cloudformation-samples-us-east-1/Drupal_Simple.template &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2011-12-04T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<EstimateTemplateCostResult> <Url>http://calculator.s3.amazonaws.com/calc5.html?key=cf-2e351785-e821-450c-9d58-625e1e1ebfb6</Url></EstimateTemplateCostResult>
API Version 2010-05-1520
AWS CloudFormation API ReferenceExamples
GetStackPolicy
DescriptionReturns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
StackNameThe name or unique stack ID that is associated with the stack whose policy you want to get.
Type: String
Required:Yes
Response ElementsThe following element is returned in a structure named GetStackPolicyResult.
StackPolicyBodyStructure containing the stack policy body. (For more information, go to Prevent Updates to StackResources in the AWS CloudFormation User Guide.)
Type: String
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=GetStackPolicy &StackName=MyStack &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<GetStackPolicyResult> <StackPolicyBody>"{ "Statement" : [ { "Effect" : "Deny", "Action" : "Update:*",
API Version 2010-05-1521
AWS CloudFormation API ReferenceGetStackPolicy
"Principal" : "*", "Resource" : "LogicalResourceId/ProductionDatabase" }, { "Effect" : "Allow", "Action" : "Update:*", "Principal" : "*", "Resource" : "*" } ] }</StackPolicyBody></GetStackPolicyResult>
API Version 2010-05-1522
AWS CloudFormation API ReferenceExamples
GetTemplate
DescriptionReturns 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.
NoteIf the template does not exist, a ValidationError is returned.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
StackNameThe name or the unique stack ID that is associated with the stack, which are not always interchange-able:
• 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.
Type: String
Required:Yes
Response ElementsThe following element is returned in a structure named GetTemplateResult.
TemplateBodyStructure containing the template body. (For more information, go to Template Anatomy in the AWSCloudFormation User Guide.)
Type: String
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=GetTemplate &StackName=MyStack &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
API Version 2010-05-1523
AWS CloudFormation API ReferenceGetTemplate
Sample Response
<GetTemplateResult> <TemplateBody>"{ "AWSTemplateFormatVersion" : "2010-09-09", "Description" : "Simple example", "Resources" : { "MySQS" : { "Type" : "AWS::SQS::Queue", "Properties" : { } } }}</TemplateBody></GetTemplateResult>
API Version 2010-05-1524
AWS CloudFormation API ReferenceExamples
GetTemplateSummary
DescriptionReturns information about a new or existing template. The GetTemplateSummary action is useful forviewing parameter information, such as default parameter values and parameter types, before you createor update a stack.
You can use the GetTemplateSummary action when you submit a template, or you can get templateinformation for a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after thestack has been deleted. If the template does not exist, a ValidationError is returned.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
StackNameThe 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.
Type: String
Length constraints: Minimum length of 1.
Required: No
TemplateBodyStructure containing the template body with a minimum length of 1 byte and a maximum length of51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudForm-ation User Guide.
Conditional:You must specify only one of the following parameters: StackName, TemplateBody,or TemplateURL.
Type: String
Length constraints: Minimum length of 1.
Required: No
TemplateURLLocation of file containing the template body. The URL must point to a template (max size: 307,200bytes) located in an Amazon S3 bucket. For more information about templates, see Template Anatomyin the AWS CloudFormation User Guide.
Conditional:You must specify only one of the following parameters: StackName, TemplateBody,or TemplateURL.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
API Version 2010-05-1525
AWS CloudFormation API ReferenceGetTemplateSummary
Required: No
Response ElementsThe following elements are returned in a structure named GetTemplateSummaryResult.
CapabilitiesThe capabilities found within the template. Currently, AWS CloudFormation supports only the CAP-ABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABIL-ITY_IAM value for this parameter when you use the CreateStack (p. 4) or UpdateStack (p. 37) actionswith your template; otherwise, those actions return an InsufficientCapabilities error.
Type: String list
Valid Values: CAPABILITY_IAM
CapabilitiesReasonThe capabilities reason found within the template.
Type: String
DescriptionThe value that is defined in the Description property of the template.
Type: String
ParametersA list of parameter declarations that describe various properties for each parameter.
Type: ParameterDeclaration (p. 50) list
VersionThe AWS template format version, which identifies the capabilities of the template.
Type: String
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=GetTemplateSummary &TemplateURL=https%3A%2F%2Fs3-us-east-1.amazonaws.com%2Fsamplebucket name%2Fsampletemplate.template &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<GetTemplateSummaryResult> <Description>A sample template description.</Description>
API Version 2010-05-1526
AWS CloudFormation API ReferenceResponse Elements
<Parameters> <member> <NoEcho>false</NoEcho> <ParameterKey>KeyName</ParameterKey> <Description>Name of an existing EC2 KeyPair to enable SSH access to the instance</Description> <ParameterType>AWS::EC2::KeyPair::KeyName</ParameterType> </member> </Parameters> <Version>2010-09-09</Version></GetTemplateSummaryResult>
API Version 2010-05-1527
AWS CloudFormation API ReferenceExamples
ListStackResources
DescriptionReturns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stackhas been deleted.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
NextTokenString that identifies the start of the next list of stack resource summaries, if there is one.
Default: There is no default value.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
StackNameThe name or the unique stack ID that is associated with the stack, which are not always interchange-able:
• 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.
Type: String
Required:Yes
Response ElementsThe following elements are returned in a structure named ListStackResourcesResult.
NextTokenString that identifies the start of the next list of stack resources, if there is one.
Type: String
StackResourceSummariesA list of StackResourceSummary structures.
Type: StackResourceSummary (p. 57) list
API Version 2010-05-1528
AWS CloudFormation API ReferenceListStackResources
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=ListStackResources &StackName=MyStack &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2011-07-08T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<ListStackResourcesResponse> <ListStackResourcesResult> <StackResourceSummaries> <member> <ResourceStatus>CREATE_COMPLETE</ResourceStatus> <LogicalResourceId>DBSecurityGroup</LogicalResourceId> <LastUpdatedTimestamp>2011-06-21T20:15:58Z</LastUpdatedTimestamp> <PhysicalResourceId>gmarcteststack-dbsecuritygroup-1s5m0ez5lkk6w</PhysicalResourceId> <ResourceType>AWS::RDS::DBSecurityGroup</ResourceType> </member> <member> <ResourceStatus>CREATE_COMPLETE</ResourceStatus> <LogicalResourceId>SampleDB</LogicalResourceId> <LastUpdatedTimestamp>2011-06-21T20:25:57Z</LastUpdatedTimestamp> <PhysicalResourceId>MyStack-sampledb-ycwhk1v830lx</PhysicalResourceId> <ResourceType>AWS::RDS::DBInstance</ResourceType> </member> <member> <ResourceStatus>CREATE_COMPLETE</ResourceStatus> <LogicalResourceId>SampleApplication</LogicalResourceId> <LastUpdatedTimestamp>2011-06-21T20:26:12Z</LastUpdatedTimestamp> <PhysicalResourceId>MyStack-SampleApplication-1MKNASYR3RBQL</PhysicalResourceId> <ResourceType>AWS::ElasticBeanstalk::Application</ResourceType> </member> <member> <ResourceStatus>CREATE_COMPLETE</ResourceStatus> <LogicalResourceId>SampleEnvironment</LogicalResourceId> <LastUpdatedTimestamp>2011-06-21T20:28:48Z</LastUpdatedTimestamp> <PhysicalResourceId>myst-Samp-1AGU6ERZX6M3Q</PhysicalResourceId> <ResourceType>AWS::ElasticBeanstalk::Environment</ResourceType> </member> <member> <ResourceStatus>CREATE_COMPLETE</ResourceStatus> <LogicalResourceId>AlarmTopic</LogicalResourceId>
API Version 2010-05-1529
AWS CloudFormation API ReferenceExamples
<LastUpdatedTimestamp>2011-06-21T20:29:06Z</LastUpdatedTimestamp> <PhysicalResourceId>arn:aws:sns:us-east-1:803981987763:MyStack-AlarmTopic-SW4IQELG7RPJ</PhysicalResourceId> <ResourceType>AWS::SNS::Topic</ResourceType> </member> <member> <ResourceStatus>CREATE_COMPLETE</ResourceStatus> <LogicalResourceId>CPUAlarmHigh</LogicalResourceId> <LastUpdatedTimestamp>2011-06-21T20:29:23Z</LastUpdatedTimestamp> <PhysicalResourceId>MyStack-CPUAlarmHigh-POBWQPDJA81F</PhysicalResourceId> <ResourceType>AWS::CloudWatch::Alarm</ResourceType> </member> </StackResourceSummaries> </ListStackResourcesResult> <ResponseMetadata> <RequestId>2d06e36c-ac1d-11e0-a958-f9382b6eb86b</RequestId> </ResponseMetadata></ListStackResourcesResponse>
API Version 2010-05-1530
AWS CloudFormation API ReferenceExamples
ListStacks
DescriptionReturns 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. Ifno StackStatusFilter is specified, summary information for all stacks is returned (including existing stacksand stacks that have been deleted).
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
NextTokenString that identifies the start of the next list of stacks, if there is one.
Default: There is no default value.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
StackStatusFilter.member.NStack status to use as a filter. Specify one or more stack status codes to list only stacks with thespecified status codes. For a complete list of stack status codes, see the StackStatus parameterof the Stack (p. 51) data type.
Type: String list
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLL-BACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS| DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COM-PLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS| UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS |UPDATE_ROLLBACK_COMPLETE
Required: No
Response ElementsThe following elements are returned in a structure named ListStacksResult.
NextTokenString that identifies the start of the next list of stacks, if there is one.
Type: String
StackSummariesA list of StackSummary structures containing information about the specified stacks.
Type: StackSummary (p. 58) list
API Version 2010-05-1531
AWS CloudFormation API ReferenceListStacks
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=ListStacks &StackStatusFilter.member.1=CREATE_IN_PROGRESS &StackStatusFilter.member.2=DELETE_COMPLETE &Version=2010-05-15 &SignatureVersion=2 &SignatureMethod=HmacSHA256 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<ListStacksResponse> <ListStacksResult> <StackSummaries> <member> <StackId> arn:aws:cloudformation:us-east-1:1234567:stack/TestCreate1/aaaaa </StackId> <StackStatus>CREATE_IN_PROGRESS</StackStatus> <StackName>vpc1</StackName> <CreationTime>2011-05-23T15:47:44Z</CreationTime> <TemplateDescription> Creates one EC2 instance and a load balancer. </TemplateDescription> </member> <member> <StackId> arn:aws:cloudformation:us-east-1:1234567:stack/TestDelete2/bbbbb </StackId> <StackStatus>DELETE_COMPLETE</StackStatus> <DeletionTime>2011-03-10T16:20:51Z</DeletionTime> <StackName>WP1</StackName> <CreationTime>2011-03-05T19:57:58Z</CreationTime> <TemplateDescription> A simple basic Cloudformation Template. </TemplateDescription> </member> </StackSummaries> </ListStacksResult></ListStacksResponse>
API Version 2010-05-1532
AWS CloudFormation API ReferenceExamples
SetStackPolicy
DescriptionSets a stack policy for a specified stack.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
StackNameThe name or unique stack ID that you want to associate a policy with.
Type: String
Required:Yes
StackPolicyBodyStructure containing the stack policy body. For more information, go to Prevent Updates to StackResources in the AWS CloudFormation User Guide.You can specify either the StackPolicyBodyor the StackPolicyURL parameter, but not both.
Type: String
Length constraints: Minimum length of 1. Maximum length of 16384.
Required: No
StackPolicyURLLocation of a file containing the stack policy.The URL must point to a policy (max size: 16KB) locatedin an S3 bucket in the same region as the stack.You can specify either the StackPolicyBody orthe StackPolicyURL parameter, but not both.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1350.
Required: No
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=SetStackPolicy &StackName=MyStack &StackPolicyBody=[Stack Policy Document] &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
API Version 2010-05-1533
AWS CloudFormation API ReferenceSetStackPolicy
Sample Response
<SetStackPolicyResponse/>
API Version 2010-05-1534
AWS CloudFormation API ReferenceExamples
SignalResource
DescriptionSends a signal to the specified resource with a success or failure status.You can use the SignalResourceAPI in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with astack creation or update until resources receive the required number of signals or the timeout period isexceeded. The SignalResource API is useful in cases where you want to send signals from anywhereother than an Amazon EC2 instance.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
LogicalResourceIdThe logical ID of the resource that you want to signal. The logical ID is the name of the resource thatgiven in the template.
Type: String
Required:Yes
StackNameThe stack name or unique stack ID that includes the resource that you want to signal.
Type: String
Length constraints: Minimum length of 1.
Required:Yes
StatusThe status of the signal, which is either success or failure. A failure signal causes AWS CloudForm-ation to immediately fail the stack creation or update.
Type: String
Valid Values: SUCCESS | FAILURE
Required:Yes
UniqueIdA unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specifythe 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.
Type: String
Length constraints: Minimum length of 1. Maximum length of 64.
API Version 2010-05-1535
AWS CloudFormation API ReferenceSignalResource
Required:Yes
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=SignalResource &LogicalResourceId=MyWaitCondition &StackName=AWaitingTestStack &Status=SUCCESS &UniqueId=test-signal &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<SignalResourceResponse/>
API Version 2010-05-1536
AWS CloudFormation API ReferenceExamples
UpdateStack
DescriptionUpdates a stack as specified in the template. After the call completes successfully, the stack updatestarts.You can check the status of the stack via the DescribeStacks (p. 17) action.
To get a copy of the template for an existing stack, you can use the GetTemplate (p. 23) action.
Tags that were associated with this stack during creation time will still be associated with the stack afteran UpdateStack operation.
For more information about creating an update template, updating a stack, and monitoring the progressof the update, see Updating a Stack.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
Capabilities.member.NA list of capabilities that you must specify before AWS CloudFormation can create or update certainstacks. Some stack templates might include resources that can affect permissions in your AWS ac-count. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.Currently, the only valid value is CAPABILITY_IAM, which is required for the following resources:AWS::CloudFormation::Stack, AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile,AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. Ifyour stack template contains these resources, we recommend that you review any permissions as-sociated with them. If you don't specify this parameter, this action returns an InsufficientCapabilitieserror.
Type: String list
Valid Values: CAPABILITY_IAM
Required: No
NotificationARNs.member.NUpdate the ARNs for the Amazon SNS topics that are associated with the stack.
Type: String list
Length constraints: Minimum of 0 item(s) in the list. Maximum of 5 item(s) in the list.
Required: No
Parameters.member.NA list of Parameter structures that specify input parameters for the stack.
Type: Parameter (p. 50) list
Required: No
StackNameThe name or unique stack ID of the stack to update.
Type: String
Required:Yes
API Version 2010-05-1537
AWS CloudFormation API ReferenceUpdateStack
StackPolicyBodyStructure containing a new stack policy body.You can specify either the StackPolicyBody or theStackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you createdduring a stack update. If you do not specify a stack policy, the current policy that is associated withthe stack is unchanged.
Type: String
Length constraints: Minimum length of 1. Maximum length of 16384.
Required: No
StackPolicyDuringUpdateBodyStructure containing the temporary overriding stack policy body.You can specify either the Stack-PolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during thisupdate. If you do not specify a stack policy, the current policy that is associated with the stack willbe used.
Type: String
Length constraints: Minimum length of 1. Maximum length of 16384.
Required: No
StackPolicyDuringUpdateURLLocation 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 eitherthe StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but notboth.
If you want to update protected resources, specify a temporary overriding stack policy during thisupdate. If you do not specify a stack policy, the current policy that is associated with the stack willbe used.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1350.
Required: No
StackPolicyURLLocation 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 Stack-PolicyBody or the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you createdduring a stack update. If you do not specify a stack policy, the current policy that is associated withthe stack is unchanged.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1350.
Required: No
TemplateBodyStructure containing the template body with a minimum length of 1 byte and a maximum length of51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation UserGuide.)
API Version 2010-05-1538
AWS CloudFormation API ReferenceRequest Parameters
Conditional:You must specify either the TemplateBody or the TemplateURL parameter, but notboth.
Type: String
Length constraints: Minimum length of 1.
Required: No
TemplateURLLocation of file containing the template body. The URL must point to a template located in an S3bucket in the same region as the stack. For more information, go to Template Anatomy in the AWSCloudFormation User Guide.
Conditional:You must specify either the TemplateBody or the TemplateURL parameter, but notboth.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
UsePreviousTemplateReuse the existing template that is associated with the stack that you are updating.
Type: Boolean
Required: No
Response ElementsThe following element is returned in a structure named UpdateStackResult.
StackIdUnique identifier of the stack.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 64).
InsufficientCapabilitiesThe template contains resources with capabilities that were not specified in the Capabilities parameter.
HTTP Status Code: 400
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=UpdateStack
API Version 2010-05-1539
AWS CloudFormation API ReferenceResponse Elements
&StackName=MyStack &TemplateBody=[Template Document] &Parameters.member.1.ParameterKey=AvailabilityZone &Parameters.member.1.ParameterValue=us-east-1a &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<UpdateStackResult> <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId></UpdateStackResult>
API Version 2010-05-1540
AWS CloudFormation API ReferenceExamples
ValidateTemplate
DescriptionValidates a specified template.
Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 62).
TemplateBodyStructure containing the template body with a minimum length of 1 byte and a maximum length of51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation UserGuide.
Conditional:You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBodyis used.
Type: String
Length constraints: Minimum length of 1.
Required: No
TemplateURLLocation of file containing the template body. The URL must point to a template (max size: 307,200bytes) located in an S3 bucket in the same region as the stack. For more information, go to TemplateAnatomy in the AWS CloudFormation User Guide.
Conditional:You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBodyis used.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
Response ElementsThe following elements are returned in a structure named ValidateTemplateResult.
CapabilitiesThe capabilities found within the template. Currently, AWS CloudFormation supports only the CAP-ABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABIL-ITY_IAM value for this parameter when you use the CreateStack (p. 4) or UpdateStack (p. 37) actionswith your template; otherwise, those actions return an InsufficientCapabilities error.
Type: String list
Valid Values: CAPABILITY_IAM
CapabilitiesReasonThe capabilities reason found within the template.
Type: String
API Version 2010-05-1541
AWS CloudFormation API ReferenceValidateTemplate
DescriptionThe description found within the template.
Type: String
ParametersA list of TemplateParameter structures.
Type: TemplateParameter (p. 60) list
Examples
Sample Request
https://cloudformation.us-east-1.amazonaws.com/ ?Action=ValidateTemplate &TemplateBody=http://myTemplateRepository/TemplateOne.template &Version=2010-05-15 &SignatureVersion=2 &Timestamp=2010-07-27T22%3A26%3A28.000Z &AWSAccessKeyId=[AWS Access KeyID] &Signature=[Signature]
Sample Response
<ValidateTemplateResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/"> <ValidateTemplateResult> <Description></Description> <Parameters> <member> <NoEcho>false</NoEcho> <ParameterKey>InstanceType</ParameterKey> <Description>Type of instance to launch</Description> <DefaultValue>m1.small</DefaultValue> </member> <member> <NoEcho>false</NoEcho> <ParameterKey>WebServerPort</ParameterKey> <Description>The TCP port for the Web Server</Description> <DefaultValue>8888</DefaultValue> </member> <member> <NoEcho>false</NoEcho> <ParameterKey>KeyName</ParameterKey> <Description>Name of an existing EC2 KeyPair to enable SSH access into the server</Description> </member> </Parameters> </ValidateTemplateResult> <ResponseMetadata> <RequestId>0be7b6e8-e4a0-11e0-a5bd-9f8d5a7dbc91</RequestId>
API Version 2010-05-1542
AWS CloudFormation API ReferenceExamples
</ResponseMetadata></ValidateTemplateResponse>
API Version 2010-05-1543
AWS CloudFormation API ReferenceExamples
Data Types
The AWS CloudFormation API contains several data types that various actions use.This section describeseach data type in detail.
NoteThe order of each element in the response is not guaranteed. Applications should not assumea particular order.
The following data types are supported:
• CreateStackResult (p. 45)
• DescribeStackEventsResult (p. 45)
• DescribeStackResourceResult (p. 45)
• DescribeStackResourcesResult (p. 46)
• DescribeStacksResult (p. 46)
• EstimateTemplateCostResult (p. 46)
• GetStackPolicyResult (p. 47)
• GetTemplateResult (p. 47)
• GetTemplateSummaryResult (p. 48)
• ListStackResourcesResult (p. 48)
• ListStacksResult (p. 49)
• Output (p. 49)
• Parameter (p. 50)
• ParameterDeclaration (p. 50)
• Stack (p. 51)
• StackEvent (p. 53)
• StackResource (p. 54)
• StackResourceDetail (p. 56)
• StackResourceSummary (p. 57)
• StackSummary (p. 58)
• Tag (p. 59)
• TemplateParameter (p. 60)
• UpdateStackResult (p. 60)
• ValidateTemplateResult (p. 61)
API Version 2010-05-1544
AWS CloudFormation API Reference
CreateStackResult
DescriptionThe output for a CreateStack (p. 4) action.
ContentsStackId
Unique identifier of the stack.
Type: String
Required: No
DescribeStackEventsResult
DescriptionThe output for a DescribeStackEvents (p. 9) action.
ContentsNextToken
String that identifies the start of the next list of events, if there is one.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
StackEventsA list of StackEvents structures.
Type: StackEvent (p. 53) list
Required: No
DescribeStackResourceResult
DescriptionThe output for a DescribeStackResource (p. 12) action.
ContentsStackResourceDetail
A StackResourceDetail structure containing the description of the specified resource in the spe-cified stack.
API Version 2010-05-1545
AWS CloudFormation API ReferenceCreateStackResult
Type: StackResourceDetail (p. 56)
Required: No
DescribeStackResourcesResult
DescriptionThe output for a DescribeStackResources (p. 14) action.
ContentsStackResources
A list of StackResource structures.
Type: StackResource (p. 54) list
Required: No
DescribeStacksResult
DescriptionThe output for a DescribeStacks (p. 17) action.
ContentsNextToken
String that identifies the start of the next list of stacks, if there is one.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
StacksA list of stack structures.
Type: Stack (p. 51) list
Required: No
EstimateTemplateCostResult
DescriptionThe output for a EstimateTemplateCost (p. 19) action.
API Version 2010-05-1546
AWS CloudFormation API ReferenceDescribeStackResourcesResult
ContentsUrl
An AWS Simple Monthly Calculator URL with a query string that describes the resources requiredto run the template.
Type: String
Required: No
GetStackPolicyResult
DescriptionThe output for the GetStackPolicy (p. 21) action.
ContentsStackPolicyBody
Structure containing the stack policy body. (For more information, go to Prevent Updates to StackResources in the AWS CloudFormation User Guide.)
Type: String
Length constraints: Minimum length of 1. Maximum length of 16384.
Required: No
GetTemplateResult
DescriptionThe output for GetTemplate (p. 23) action.
ContentsTemplateBody
Structure containing the template body. (For more information, go to Template Anatomy in the AWSCloudFormation User Guide.)
Type: String
Length constraints: Minimum length of 1.
Required: No
API Version 2010-05-1547
AWS CloudFormation API ReferenceContents
GetTemplateSummaryResult
DescriptionThe output for the GetTemplateSummary (p. 25) action.
ContentsCapabilities
The capabilities found within the template. Currently, AWS CloudFormation supports only the CAP-ABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABIL-ITY_IAM value for this parameter when you use the CreateStack (p. 4) or UpdateStack (p. 37) actionswith your template; otherwise, those actions return an InsufficientCapabilities error.
Type: String list
Valid Values: CAPABILITY_IAM
Required: No
CapabilitiesReasonThe capabilities reason found within the template.
Type: String
Required: No
DescriptionThe value that is defined in the Description property of the template.
Type: String
Required: No
ParametersA list of parameter declarations that describe various properties for each parameter.
Type: ParameterDeclaration (p. 50) list
Required: No
VersionThe AWS template format version, which identifies the capabilities of the template.
Type: String
Required: No
ListStackResourcesResult
DescriptionThe output for a ListStackResources (p. 28) action.
API Version 2010-05-1548
AWS CloudFormation API ReferenceGetTemplateSummaryResult
ContentsNextToken
String that identifies the start of the next list of stack resources, if there is one.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
StackResourceSummariesA list of StackResourceSummary structures.
Type: StackResourceSummary (p. 57) list
Required: No
ListStacksResult
DescriptionThe output for ListStacks (p. 31) action.
ContentsNextToken
String that identifies the start of the next list of stacks, if there is one.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1024.
Required: No
StackSummariesA list of StackSummary structures containing information about the specified stacks.
Type: StackSummary (p. 58) list
Required: No
Output
DescriptionThe Output data type.
ContentsDescription
User defined description associated with the output.
API Version 2010-05-1549
AWS CloudFormation API ReferenceContents
Type: String
Required: No
OutputKeyThe key associated with the output.
Type: String
Required: No
OutputValueThe value associated with the output.
Type: String
Required: No
Parameter
DescriptionThe Parameter data type.
ContentsParameterKey
The key associated with the parameter.
Type: String
Required: No
ParameterValueThe value associated with the parameter.
Type: String
Required: No
UsePreviousValueDuring a stack update, use the existing parameter value that is being used for the stack.
Type: Boolean
Required: No
ParameterDeclaration
DescriptionThe ParameterDeclaration data type.
API Version 2010-05-1550
AWS CloudFormation API ReferenceParameter
ContentsDefaultValue
The default value of the parameter.
Type: String
Required: No
DescriptionThe description that is associate with the parameter.
Type: String
Required: No
NoEchoFlag that indicates whether the parameter value is shown as plain text in logs and in the AWS Man-agement Console.
Type: Boolean
Required: No
ParameterKeyThe name that is associated with the parameter.
Type: String
Required: No
ParameterTypeThe type of parameter.
Type: String
Required: No
Stack
DescriptionThe Stack data type.
ContentsCapabilities
The capabilities allowed in the stack.
Type: String list
Valid Values: CAPABILITY_IAM
Required: No
CreationTimeTime at which the stack was created.
Type: DateTime
API Version 2010-05-1551
AWS CloudFormation API ReferenceContents
Required:Yes
DescriptionUser defined description associated with the stack.
Type: String
Required: No
DisableRollbackBoolean to enable or disable rollback on stack creation failures:
• true: disable rollback
• false: enable rollback
Type: Boolean
Required: No
LastUpdatedTimeThe time the stack was last updated. This field will only be returned if the stack has been updatedat least once.
Type: DateTime
Required: No
NotificationARNsSNS topic ARNs to which stack related events are published.
Type: String list
Length constraints: Minimum of 0 item(s) in the list. Maximum of 5 item(s) in the list.
Required: No
OutputsA list of output structures.
Type: Output (p. 49) list
Required: No
ParametersA list of Parameter structures.
Type: Parameter (p. 50) list
Required: No
StackIdUnique identifier of the stack.
Type: String
Required: No
StackNameThe name associated with the stack.
Type: String
Required:Yes
StackStatusCurrent status of the stack.
API Version 2010-05-1552
AWS CloudFormation API ReferenceContents
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLL-BACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS| DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COM-PLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS| UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS |UPDATE_ROLLBACK_COMPLETE
Required:Yes
StackStatusReasonSuccess/failure message associated with the stack status.
Type: String
Required: No
TagsA list of Tags that specify cost allocation information for the stack.
Type: Tag (p. 59) list
Required: No
TimeoutInMinutesThe amount of time within which stack creation should complete.
Type: Integer
Required: No
StackEvent
DescriptionThe StackEvent data type.
ContentsEventId
The unique ID of this event.
Type: String
Required:Yes
LogicalResourceIdThe logical name of the resource specified in the template.
Type: String
Required: No
PhysicalResourceIdThe name or unique identifier associated with the physical instance of the resource.
Type: String
Required: No
API Version 2010-05-1553
AWS CloudFormation API ReferenceStackEvent
ResourcePropertiesBLOB of the properties used to create the resource.
Type: String
Required: No
ResourceStatusCurrent status of the resource.
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DE-LETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | DELETE_SKIPPED | UP-DATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_COMPLETE
Required: No
ResourceStatusReasonSuccess/failure message associated with the resource.
Type: String
Required: No
ResourceTypeType of resource. (For more information, go to AWS Resource Types Reference in the AWSCloudFormation User Guide.)
Type: String
Required: No
StackIdThe unique ID name of the instance of the stack.
Type: String
Required:Yes
StackNameThe name associated with a stack.
Type: String
Required:Yes
TimestampTime the status was updated.
Type: DateTime
Required:Yes
StackResource
DescriptionThe StackResource data type.
API Version 2010-05-1554
AWS CloudFormation API ReferenceStackResource
ContentsDescription
User defined description associated with the resource.
Type: String
Required: No
LogicalResourceIdThe logical name of the resource specified in the template.
Type: String
Required:Yes
PhysicalResourceIdThe name or unique identifier that corresponds to a physical instance ID of a resource supported byAWS CloudFormation.
Type: String
Required: No
ResourceStatusCurrent status of the resource.
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DE-LETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | DELETE_SKIPPED | UP-DATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_COMPLETE
Required:Yes
ResourceStatusReasonSuccess/failure message associated with the resource.
Type: String
Required: No
ResourceTypeType of resource. (For more information, go to AWS Resource Types Reference in the AWSCloudFormation User Guide.)
Type: String
Required:Yes
StackIdUnique identifier of the stack.
Type: String
Required: No
StackNameThe name associated with the stack.
Type: String
Required: No
TimestampTime the status was updated.
API Version 2010-05-1555
AWS CloudFormation API ReferenceContents
Type: DateTime
Required:Yes
StackResourceDetail
DescriptionContains detailed information about the specified stack resource.
ContentsDescription
User defined description associated with the resource.
Type: String
Required: No
LastUpdatedTimestampTime the status was updated.
Type: DateTime
Required:Yes
LogicalResourceIdThe logical name of the resource specified in the template.
Type: String
Required:Yes
MetadataThe JSON format content of the Metadata attribute declared for the resource. For more information,see Metadata Attribute in the AWS CloudFormation User Guide.
Type: String
Required: No
PhysicalResourceIdThe name or unique identifier that corresponds to a physical instance ID of a resource supported byAWS CloudFormation.
Type: String
Required: No
ResourceStatusCurrent status of the resource.
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DE-LETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | DELETE_SKIPPED | UP-DATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_COMPLETE
Required:Yes
API Version 2010-05-1556
AWS CloudFormation API ReferenceStackResourceDetail
ResourceStatusReasonSuccess/failure message associated with the resource.
Type: String
Required: No
ResourceTypeType of resource. ((For more information, go to AWS Resource Types Reference in the AWSCloudFormation User Guide.)
Type: String
Required:Yes
StackIdUnique identifier of the stack.
Type: String
Required: No
StackNameThe name associated with the stack.
Type: String
Required: No
StackResourceSummary
DescriptionContains high-level information about the specified stack resource.
ContentsLastUpdatedTimestamp
Time the status was updated.
Type: DateTime
Required:Yes
LogicalResourceIdThe logical name of the resource specified in the template.
Type: String
Required:Yes
PhysicalResourceIdThe name or unique identifier that corresponds to a physical instance ID of the resource.
Type: String
Required: No
ResourceStatusCurrent status of the resource.
API Version 2010-05-1557
AWS CloudFormation API ReferenceStackResourceSummary
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DE-LETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | DELETE_SKIPPED | UP-DATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_COMPLETE
Required:Yes
ResourceStatusReasonSuccess/failure message associated with the resource.
Type: String
Required: No
ResourceTypeType of resource. (For more information, go to AWS Resource Types Reference in the AWSCloudFormation User Guide.)
Type: String
Required:Yes
StackSummary
DescriptionThe StackSummary Data Type
ContentsCreationTime
The time the stack was created.
Type: DateTime
Required:Yes
DeletionTimeThe time the stack was deleted.
Type: DateTime
Required: No
LastUpdatedTimeThe time the stack was last updated. This field will only be returned if the stack has been updatedat least once.
Type: DateTime
Required: No
StackIdUnique stack identifier.
Type: String
Required: No
API Version 2010-05-1558
AWS CloudFormation API ReferenceStackSummary
StackNameThe name associated with the stack.
Type: String
Required:Yes
StackStatusThe current status of the stack.
Type: String
Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLL-BACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS| DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COM-PLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS| UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS |UPDATE_ROLLBACK_COMPLETE
Required:Yes
StackStatusReasonSuccess/Failure message associated with the stack status.
Type: String
Required: No
TemplateDescriptionThe template description of the template used to create the stack.
Type: String
Required: No
Tag
DescriptionThe Tag type is used by CreateStack in the Tags parameter. It allows you to specify a key/value pairthat can be used to store information related to cost allocation for an AWS CloudFormation stack.
ContentsKey
Required. A string used to identify this tag.You can specify a maximum of 128 characters for a tagkey. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.
Type: String
Required: No
ValueRequired. A string containing the value for this tag.You can specify a maximum of 256 charactersfor a tag value.
Type: String
Required: No
API Version 2010-05-1559
AWS CloudFormation API ReferenceTag
TemplateParameter
DescriptionThe TemplateParameter data type.
ContentsDefaultValue
The default value associated with the parameter.
Type: String
Required: No
DescriptionUser defined description associated with the parameter.
Type: String
Required: No
NoEchoFlag indicating whether the parameter should be displayed as plain text in logs and UIs.
Type: Boolean
Required: No
ParameterKeyThe name associated with the parameter.
Type: String
Required: No
UpdateStackResult
DescriptionThe output for a UpdateStack (p. 37) action.
ContentsStackId
Unique identifier of the stack.
Type: String
Required: No
API Version 2010-05-1560
AWS CloudFormation API ReferenceTemplateParameter
ValidateTemplateResult
DescriptionThe output for ValidateTemplate (p. 41) action.
ContentsCapabilities
The capabilities found within the template. Currently, AWS CloudFormation supports only the CAP-ABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABIL-ITY_IAM value for this parameter when you use the CreateStack (p. 4) or UpdateStack (p. 37) actionswith your template; otherwise, those actions return an InsufficientCapabilities error.
Type: String list
Valid Values: CAPABILITY_IAM
Required: No
CapabilitiesReasonThe capabilities reason found within the template.
Type: String
Required: No
DescriptionThe description found within the template.
Type: String
Required: No
ParametersA list of TemplateParameter structures.
Type: TemplateParameter (p. 60) list
Required: No
API Version 2010-05-1561
AWS CloudFormation API ReferenceValidateTemplateResult
Common Parameters
This section lists the request parameters that all actions use. Any action-specific parameters are listedin the topic for the action.
ActionThe action to be performed.
Default: None
Type: string
Required:Yes
AuthParamsThe parameters that are required to authenticate a Conditional request. Contains:
• AWSAccessKeyID
• SignatureVersion
• Timestamp
• Signature
Default: None
Required: Conditional
AWSAccessKeyIdThe access key ID that corresponds to the secret access key that you used to sign the request.
Default: None
Type: string
Required:Yes
ExpiresThe date and time when the request signature expires, expressed in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard.
Condition: Requests must include either Timestamp or Expires, but not both.
Default: None
Type: string
API Version 2010-05-1562
AWS CloudFormation API Reference
Required: Conditional
SecurityTokenThe temporary security token that was obtained through a call to AWS Security Token Service. Fora list of services that support AWS Security Token Service, go to Using Temporary Security Credentialsto Access AWS in Using Temporary Security Credentials.
Default: None
Type: string
Required: No
SignatureThe digital signature that you created for the request. For information about generating a signature,go to the service's developer documentation.
Default: None
Type: string
Required:Yes
SignatureMethodThe hash algorithm that you used to create the request signature.
Default: None
Type: string
Valid Values: HmacSHA256 | HmacSHA1
Required:Yes
SignatureVersionThe signature version you use to sign the request. Set this to the value that is recommended for yourservice.
Default: None
Type: string
Required:Yes
TimestampThe date and time when the request was signed, expressed in the format YYYY-MM-DDThh:mm:ssZ,as specified in the ISO 8601 standard.
Condition: Requests must include either Timestamp or Expires, but not both.
Default: None
Type: string
Required: Conditional
VersionThe API version that the request is written for, expressed in the format YYYY-MM-DD.
Default: None
Type: string
Required:Yes
API Version 2010-05-1563
AWS CloudFormation API Reference
Common Errors
This section lists the common errors that all actions return. Any action-specific errors are listed in thetopic for the action.
IncompleteSignatureThe request signature does not conform to AWS standards.
HTTP Status Code: 400
InternalFailureThe request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
InvalidActionThe action or operation requested is invalid. Verify that the action is typed correctly.
HTTP Status Code: 400
InvalidClientTokenIdThe X.509 certificate or AWS access key ID provided does not exist in our records.
HTTP Status Code: 403
InvalidParameterCombinationParameters that must not be used together were used together.
HTTP Status Code: 400
InvalidParameterValueAn invalid or out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
InvalidQueryParameterThe AWS query string is malformed or does not adhere to AWS standards.
HTTP Status Code: 400
MalformedQueryStringThe query string contains a syntax error.
HTTP Status Code: 404
MissingActionThe request is missing an action or a required parameter.
API Version 2010-05-1564
AWS CloudFormation API Reference
HTTP Status Code: 400
MissingAuthenticationTokenThe request must contain either a valid (registered) AWS access key ID or X.509 certificate.
HTTP Status Code: 403
MissingParameterA required parameter for the specified action is not supplied.
HTTP Status Code: 400
OptInRequiredThe AWS access key ID needs a subscription for the service.
HTTP Status Code: 403
RequestExpiredThe request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.
HTTP Status Code: 400
ServiceUnavailableThe request has failed due to a temporary failure of the server.
HTTP Status Code: 503
ThrottlingThe request was denied due to request throttling.
HTTP Status Code: 400
ValidationErrorThe input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
API Version 2010-05-1565
AWS CloudFormation API Reference