AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and 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 applications without worrying about creating and configuring the underlying AWS infrastructure.
With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources 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 information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.
", "operations":{ "CancelUpdateStack":{ "name":"CancelUpdateStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CancelUpdateStackInput", "documentation":"The input for the CancelUpdateStack action.
" }, "documentation":"Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
The input for CreateStack action.
" }, "output":{ "shape":"CreateStackOutput", "documentation":"The output for a CreateStack action.
", "resultWrapper":"CreateStackResult" }, "errors":[ { "shape":"LimitExceededException", "error":{ "code":"LimitExceededException", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Quota for the resource has already been reached.
" }, { "shape":"AlreadyExistsException", "error":{ "code":"AlreadyExistsException", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Resource with the name requested already exists.
" }, { "shape":"InsufficientCapabilitiesException", "error":{ "code":"InsufficientCapabilitiesException", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"The template contains resources with capabilities that were not specified in the Capabilities parameter.
" } ], "documentation":"Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
" }, "DeleteStack":{ "name":"DeleteStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteStackInput", "documentation":"The input for DeleteStack action.
" }, "documentation":"Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
" }, "DescribeAccountLimits":{ "name":"DescribeAccountLimits", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeAccountLimitsInput", "documentation":"The input for the DescribeAccountLimits action.
" }, "output":{ "shape":"DescribeAccountLimitsOutput", "documentation":"The output for the DescribeAccountLimits action.
", "resultWrapper":"DescribeAccountLimitsResult" }, "documentation":"Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
" }, "DescribeStackEvents":{ "name":"DescribeStackEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeStackEventsInput", "documentation":"The input for DescribeStackEvents action.
" }, "output":{ "shape":"DescribeStackEventsOutput", "documentation":"The output for a DescribeStackEvents action.
", "resultWrapper":"DescribeStackEventsResult" }, "documentation":"Returns 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.
The input for DescribeStackResource action.
" }, "output":{ "shape":"DescribeStackResourceOutput", "documentation":"The output for a DescribeStackResource action.
", "resultWrapper":"DescribeStackResourceResult" }, "documentation":"Returns a description of the specified resource in the specified stack.
For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
" }, "DescribeStackResources":{ "name":"DescribeStackResources", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeStackResourcesInput", "documentation":"The input for DescribeStackResources action.
" }, "output":{ "shape":"DescribeStackResourcesOutput", "documentation":"The output for a DescribeStackResources action.
", "resultWrapper":"DescribeStackResourcesResult" }, "documentation":"Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.
ListStackResources instead.For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.
ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.The input for DescribeStacks action.
" }, "output":{ "shape":"DescribeStacksOutput", "documentation":"The output for a DescribeStacks action.
", "resultWrapper":"DescribeStacksResult" }, "documentation":"Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
" }, "EstimateTemplateCost":{ "name":"EstimateTemplateCost", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EstimateTemplateCostInput"}, "output":{ "shape":"EstimateTemplateCostOutput", "documentation":"The output for a EstimateTemplateCost action.
", "resultWrapper":"EstimateTemplateCostResult" }, "documentation":"Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
" }, "GetStackPolicy":{ "name":"GetStackPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"GetStackPolicyInput", "documentation":"The input for the GetStackPolicy action.
" }, "output":{ "shape":"GetStackPolicyOutput", "documentation":"The output for the GetStackPolicy action.
", "resultWrapper":"GetStackPolicyResult" }, "documentation":"Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
" }, "GetTemplate":{ "name":"GetTemplate", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"GetTemplateInput", "documentation":"The input for a GetTemplate action.
" }, "output":{ "shape":"GetTemplateOutput", "documentation":"The output for GetTemplate action.
", "resultWrapper":"GetTemplateResult" }, "documentation":"Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
ValidationError is returned. The input for the GetTemplateSummary action.
" }, "output":{ "shape":"GetTemplateSummaryOutput", "documentation":"The output for the GetTemplateSummary action.
", "resultWrapper":"GetTemplateSummaryResult" }, "documentation":"Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack.
You can use the GetTemplateSummary action when you submit a template, or you can get template information for a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
The input for the ListStackResource action.
" }, "output":{ "shape":"ListStackResourcesOutput", "documentation":"The output for a ListStackResources action.
", "resultWrapper":"ListStackResourcesResult" }, "documentation":"Returns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
" }, "ListStacks":{ "name":"ListStacks", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListStacksInput", "documentation":"The input for ListStacks action.
" }, "output":{ "shape":"ListStacksOutput", "documentation":"The output for ListStacks action.
", "resultWrapper":"ListStacksResult" }, "documentation":"Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
" }, "SetStackPolicy":{ "name":"SetStackPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"SetStackPolicyInput", "documentation":"The input for the SetStackPolicy action.
" }, "documentation":"Sets a stack policy for a specified stack.
" }, "SignalResource":{ "name":"SignalResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"SignalResourceInput", "documentation":"The input for the SignalResource action.
" }, "documentation":"Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
" }, "UpdateStack":{ "name":"UpdateStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateStackInput", "documentation":"The input for UpdateStack action.
" }, "output":{ "shape":"UpdateStackOutput", "documentation":"The output for a UpdateStack action.
", "resultWrapper":"UpdateStackResult" }, "errors":[ { "shape":"InsufficientCapabilitiesException", "error":{ "code":"InsufficientCapabilitiesException", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"The template contains resources with capabilities that were not specified in the Capabilities parameter.
" } ], "documentation":"Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
Tags that were associated with this stack during creation time will still be associated with the stack after an UpdateStack operation.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
" }, "ValidateTemplate":{ "name":"ValidateTemplate", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ValidateTemplateInput", "documentation":"The input for ValidateTemplate action.
" }, "output":{ "shape":"ValidateTemplateOutput", "documentation":"The output for ValidateTemplate action.
", "resultWrapper":"ValidateTemplateResult" }, "documentation":"Validates a specified template.
" } }, "shapes":{ "AccountLimit":{ "type":"structure", "members":{ "Name":{ "shape":"LimitName", "documentation":"The name of the account limit. Currently, the only account limit is StackLimit.
The value that is associated with the account limit name.
" } }, "documentation":"The AccountLimit data type.
" }, "AccountLimitList":{ "type":"list", "member":{"shape":"AccountLimit"} }, "AllowedValue":{"type":"string"}, "AllowedValues":{ "type":"list", "member":{"shape":"AllowedValue"} }, "AlreadyExistsException":{ "type":"structure", "members":{ }, "error":{ "code":"AlreadyExistsException", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Resource with the name requested already exists.
" }, "CancelUpdateStackInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"The name or the unique stack ID that is associated with the stack.
" } }, "documentation":"The input for the CancelUpdateStack action.
" }, "Capabilities":{ "type":"list", "member":{"shape":"Capability"} }, "CapabilitiesReason":{"type":"string"}, "Capability":{ "type":"string", "enum":["CAPABILITY_IAM"] }, "CreateStackInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
A list of Parameter structures that specify input parameters for the stack.
Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.
Default: false
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.
The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).
" }, "Capabilities":{ "shape":"Capabilities", "documentation":"A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. 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::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an InsufficientCapabilities error.
The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all AWS resource), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular AWS service), and AWS::service_name::resource_logical_ID (for a specific AWS resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
" }, "OnFailure":{ "shape":"OnFailure", "documentation":"Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.
Default: ROLLBACK
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags defined for the stack are propagated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.
The input for CreateStack action.
" }, "CreateStackOutput":{ "type":"structure", "members":{ "StackId":{ "shape":"StackId", "documentation":"Unique identifier of the stack.
" } }, "documentation":"The output for a CreateStack action.
" }, "CreationTime":{"type":"timestamp"}, "DeleteStackInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"The name or the unique stack ID that is associated with the stack.
" } }, "documentation":"The input for DeleteStack action.
" }, "DeletionTime":{"type":"timestamp"}, "DescribeAccountLimitsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"A string that identifies the next page of limits that you want to retrieve.
" } }, "documentation":"The input for the DescribeAccountLimits action.
" }, "DescribeAccountLimitsOutput":{ "type":"structure", "members":{ "AccountLimits":{ "shape":"AccountLimitList", "documentation":"An account limit structure that contain a list of AWS CloudFormation account limits and their values.
" }, "NextToken":{ "shape":"NextToken", "documentation":"A string that identifies the next page of limits. If no additional page exists, this value is null.
" } }, "documentation":"The output for the DescribeAccountLimits action.
" }, "DescribeStackEventsInput":{ "type":"structure", "members":{ "StackName":{ "shape":"StackName", "documentation":"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
" }, "NextToken":{ "shape":"NextToken", "documentation":"String that identifies the start of the next list of events, if there is one.
Default: There is no default value.
" } }, "documentation":"The input for DescribeStackEvents action.
" }, "DescribeStackEventsOutput":{ "type":"structure", "members":{ "StackEvents":{ "shape":"StackEvents", "documentation":"A list of StackEvents structures.
String that identifies the start of the next list of events, if there is one.
" } }, "documentation":"The output for a DescribeStackEvents action.
" }, "DescribeStackResourceInput":{ "type":"structure", "required":[ "StackName", "LogicalResourceId" ], "members":{ "StackName":{ "shape":"StackName", "documentation":"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"The logical name of the resource as specified in the template.
Default: There is no default value.
" } }, "documentation":"The input for DescribeStackResource action.
" }, "DescribeStackResourceOutput":{ "type":"structure", "members":{ "StackResourceDetail":{ "shape":"StackResourceDetail", "documentation":"A StackResourceDetail structure containing the description of the specified resource in the specified stack.
The output for a DescribeStackResource action.
" }, "DescribeStackResourcesInput":{ "type":"structure", "members":{ "StackName":{ "shape":"StackName", "documentation":"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.
The logical name of the resource as specified in the template.
Default: There is no default value.
" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.
Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.
Default: There is no default value.
" } }, "documentation":"The input for DescribeStackResources action.
" }, "DescribeStackResourcesOutput":{ "type":"structure", "members":{ "StackResources":{ "shape":"StackResources", "documentation":"A list of StackResource structures.
The output for a DescribeStackResources action.
" }, "DescribeStacksInput":{ "type":"structure", "members":{ "StackName":{ "shape":"StackName", "documentation":"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
" }, "NextToken":{ "shape":"NextToken", "documentation":"String that identifies the start of the next list of stacks, if there is one." } }, "documentation":"The input for DescribeStacks action.
" }, "DescribeStacksOutput":{ "type":"structure", "members":{ "Stacks":{ "shape":"Stacks", "documentation":"A list of stack structures.
" }, "NextToken":{ "shape":"NextToken", "documentation":"String that identifies the start of the next list of stacks, if there is one." } }, "documentation":"The output for a DescribeStacks action.
" }, "Description":{"type":"string"}, "DisableRollback":{"type":"boolean"}, "EstimateTemplateCostInput":{ "type":"structure", "members":{ "TemplateBody":{ "shape":"TemplateBody", "documentation":"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
A list of Parameter structures that specify input parameters.
An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
" } }, "documentation":"The output for a EstimateTemplateCost action.
" }, "EventId":{"type":"string"}, "GetStackPolicyInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"The name or unique stack ID that is associated with the stack whose policy you want to get.
" } }, "documentation":"The input for the GetStackPolicy action.
" }, "GetStackPolicyOutput":{ "type":"structure", "members":{ "StackPolicyBody":{ "shape":"StackPolicyBody", "documentation":"Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)
" } }, "documentation":"The output for the GetStackPolicy action.
" }, "GetTemplateInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
" } }, "documentation":"The input for a GetTemplate action.
" }, "GetTemplateOutput":{ "type":"structure", "members":{ "TemplateBody":{ "shape":"TemplateBody", "documentation":"Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
" } }, "documentation":"The output for GetTemplate action.
" }, "GetTemplateSummaryInput":{ "type":"structure", "members":{ "TemplateBody":{ "shape":"TemplateBody", "documentation":"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.
The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.
Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.
The input for the GetTemplateSummary action.
" }, "GetTemplateSummaryOutput":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParameterDeclarations", "documentation":"A list of parameter declarations that describe various properties for each parameter.
" }, "Description":{ "shape":"Description", "documentation":"The value that is defined in the Description property of the template.
The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
" }, "CapabilitiesReason":{ "shape":"CapabilitiesReason", "documentation":"The list of resources that generated the values in the Capabilities response element.
A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all AWS resources), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular AWS service), and AWS::service_name::resource_logical_ID (for a specific AWS resource).
The AWS template format version, which identifies the capabilities of the template.
" }, "Metadata":{ "shape":"Metadata", "documentation":"The value that is defined for the Metadata property of the template.
The output for the GetTemplateSummary action.
" }, "InsufficientCapabilitiesException":{ "type":"structure", "members":{ }, "error":{ "code":"InsufficientCapabilitiesException", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"The template contains resources with capabilities that were not specified in the Capabilities parameter.
" }, "LastUpdatedTime":{"type":"timestamp"}, "LimitExceededException":{ "type":"structure", "members":{ }, "error":{ "code":"LimitExceededException", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Quota for the resource has already been reached.
" }, "LimitName":{"type":"string"}, "LimitValue":{"type":"integer"}, "ListStackResourcesInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
" }, "NextToken":{ "shape":"NextToken", "documentation":"String that identifies the start of the next list of stack resource summaries, if there is one.
Default: There is no default value.
" } }, "documentation":"The input for the ListStackResource action.
" }, "ListStackResourcesOutput":{ "type":"structure", "members":{ "StackResourceSummaries":{ "shape":"StackResourceSummaries", "documentation":"A list of StackResourceSummary structures.
String that identifies the start of the next list of stack resources, if there is one.
" } }, "documentation":"The output for a ListStackResources action.
" }, "ListStacksInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"String that identifies the start of the next list of stacks, if there is one.
Default: There is no default value.
" }, "StackStatusFilter":{ "shape":"StackStatusFilter", "documentation":"Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.
The input for ListStacks action.
" }, "ListStacksOutput":{ "type":"structure", "members":{ "StackSummaries":{ "shape":"StackSummaries", "documentation":"A list of StackSummary structures containing information about the specified stacks.
String that identifies the start of the next list of stacks, if there is one.
" } }, "documentation":"The output for ListStacks action.
" }, "LogicalResourceId":{"type":"string"}, "Metadata":{"type":"string"}, "NextToken":{ "type":"string", "min":1, "max":1024 }, "NoEcho":{"type":"boolean"}, "NotificationARN":{"type":"string"}, "NotificationARNs":{ "type":"list", "member":{"shape":"NotificationARN"}, "max":5 }, "OnFailure":{ "type":"string", "enum":[ "DO_NOTHING", "ROLLBACK", "DELETE" ] }, "Output":{ "type":"structure", "members":{ "OutputKey":{ "shape":"OutputKey", "documentation":"The key associated with the output.
" }, "OutputValue":{ "shape":"OutputValue", "documentation":"The value associated with the output.
" }, "Description":{ "shape":"Description", "documentation":"User defined description associated with the output.
" } }, "documentation":"The Output data type.
" }, "OutputKey":{"type":"string"}, "OutputValue":{"type":"string"}, "Outputs":{ "type":"list", "member":{"shape":"Output"} }, "Parameter":{ "type":"structure", "members":{ "ParameterKey":{ "shape":"ParameterKey", "documentation":"The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
" }, "ParameterValue":{ "shape":"ParameterValue", "documentation":"The value associated with the parameter.
" }, "UsePreviousValue":{ "shape":"UsePreviousValue", "documentation":"During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.
The Parameter data type.
" }, "ParameterConstraints":{ "type":"structure", "members":{ "AllowedValues":{ "shape":"AllowedValues", "documentation":"A list of values that are permitted for a parameter.
" } }, "documentation":"A set of criteria that AWS CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, AWS CloudFormation returns only the AllowedValues property.
The name that is associated with the parameter.
" }, "DefaultValue":{ "shape":"ParameterValue", "documentation":"The default value of the parameter.
" }, "ParameterType":{ "shape":"ParameterType", "documentation":"The type of parameter.
" }, "NoEcho":{ "shape":"NoEcho", "documentation":"Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
" }, "Description":{ "shape":"Description", "documentation":"The description that is associate with the parameter.
" }, "ParameterConstraints":{ "shape":"ParameterConstraints", "documentation":"The criteria that AWS CloudFormation uses to validate parameter values.
" } }, "documentation":"The ParameterDeclaration data type.
" }, "ParameterDeclarations":{ "type":"list", "member":{"shape":"ParameterDeclaration"} }, "ParameterKey":{"type":"string"}, "ParameterType":{"type":"string"}, "ParameterValue":{"type":"string"}, "Parameters":{ "type":"list", "member":{"shape":"Parameter"} }, "PhysicalResourceId":{"type":"string"}, "ResourceProperties":{"type":"string"}, "ResourceSignalStatus":{ "type":"string", "enum":[ "SUCCESS", "FAILURE" ] }, "ResourceSignalUniqueId":{ "type":"string", "min":1, "max":64 }, "ResourceStatus":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE" ] }, "ResourceStatusReason":{"type":"string"}, "ResourceType":{"type":"string"}, "ResourceTypes":{ "type":"list", "member":{"shape":"ResourceType"} }, "SetStackPolicyInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"The name or unique stack ID that you want to associate a policy with.
" }, "StackPolicyBody":{ "shape":"StackPolicyBody", "documentation":"Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
The input for the SetStackPolicy action.
" }, "SignalResourceInput":{ "type":"structure", "required":[ "StackName", "LogicalResourceId", "UniqueId", "Status" ], "members":{ "StackName":{ "shape":"StackNameOrId", "documentation":"The stack name or unique stack ID that includes the resource that you want to signal.
" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.
" }, "UniqueId":{ "shape":"ResourceSignalUniqueId", "documentation":"A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.
" }, "Status":{ "shape":"ResourceSignalStatus", "documentation":"The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.
" } }, "documentation":"The input for the SignalResource action.
" }, "Stack":{ "type":"structure", "required":[ "StackName", "CreationTime", "StackStatus" ], "members":{ "StackId":{ "shape":"StackId", "documentation":"Unique identifier of the stack.
" }, "StackName":{ "shape":"StackName", "documentation":"The name associated with the stack.
" }, "Description":{ "shape":"Description", "documentation":"A user-defined description associated with the stack.
" }, "Parameters":{ "shape":"Parameters", "documentation":"A list of Parameter structures.
The time at which the stack was created.
" }, "LastUpdatedTime":{ "shape":"LastUpdatedTime", "documentation":"The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
" }, "StackStatus":{ "shape":"StackStatus", "documentation":"Current status of the stack.
" }, "StackStatusReason":{ "shape":"StackStatusReason", "documentation":"Success/failure message associated with the stack status.
" }, "DisableRollback":{ "shape":"DisableRollback", "documentation":"Boolean to enable or disable rollback on stack creation failures:
true: disable rollbackfalse: enable rollbackSNS topic ARNs to which stack related events are published.
" }, "TimeoutInMinutes":{ "shape":"TimeoutMinutes", "documentation":"The amount of time within which stack creation should complete.
" }, "Capabilities":{ "shape":"Capabilities", "documentation":"The capabilities allowed in the stack.
" }, "Outputs":{ "shape":"Outputs", "documentation":"A list of output structures.
" }, "Tags":{ "shape":"Tags", "documentation":"A list of Tags that specify cost allocation information for the stack.
The Stack data type.
" }, "StackEvent":{ "type":"structure", "required":[ "StackId", "EventId", "StackName", "Timestamp" ], "members":{ "StackId":{ "shape":"StackId", "documentation":"The unique ID name of the instance of the stack.
" }, "EventId":{ "shape":"EventId", "documentation":"The unique ID of this event.
" }, "StackName":{ "shape":"StackName", "documentation":"The name associated with a stack.
" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"The logical name of the resource specified in the template.
" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"The name or unique identifier associated with the physical instance of the resource.
" }, "ResourceType":{ "shape":"ResourceType", "documentation":"Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
" }, "Timestamp":{ "shape":"Timestamp", "documentation":"Time the status was updated.
" }, "ResourceStatus":{ "shape":"ResourceStatus", "documentation":"Current status of the resource.
" }, "ResourceStatusReason":{ "shape":"ResourceStatusReason", "documentation":"Success/failure message associated with the resource.
" }, "ResourceProperties":{ "shape":"ResourceProperties", "documentation":"BLOB of the properties used to create the resource.
" } }, "documentation":"The StackEvent data type.
" }, "StackEvents":{ "type":"list", "member":{"shape":"StackEvent"} }, "StackId":{"type":"string"}, "StackName":{"type":"string"}, "StackNameOrId":{ "type":"string", "min":1, "pattern":"([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)" }, "StackPolicyBody":{ "type":"string", "min":1, "max":16384 }, "StackPolicyDuringUpdateBody":{ "type":"string", "min":1, "max":16384 }, "StackPolicyDuringUpdateURL":{ "type":"string", "min":1, "max":1350 }, "StackPolicyURL":{ "type":"string", "min":1, "max":1350 }, "StackResource":{ "type":"structure", "required":[ "LogicalResourceId", "ResourceType", "Timestamp", "ResourceStatus" ], "members":{ "StackName":{ "shape":"StackName", "documentation":"The name associated with the stack.
" }, "StackId":{ "shape":"StackId", "documentation":"Unique identifier of the stack.
" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"The logical name of the resource specified in the template.
" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
" }, "ResourceType":{ "shape":"ResourceType", "documentation":"Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
" }, "Timestamp":{ "shape":"Timestamp", "documentation":"Time the status was updated.
" }, "ResourceStatus":{ "shape":"ResourceStatus", "documentation":"Current status of the resource.
" }, "ResourceStatusReason":{ "shape":"ResourceStatusReason", "documentation":"Success/failure message associated with the resource.
" }, "Description":{ "shape":"Description", "documentation":"User defined description associated with the resource.
" } }, "documentation":"The StackResource data type.
" }, "StackResourceDetail":{ "type":"structure", "required":[ "LogicalResourceId", "ResourceType", "LastUpdatedTimestamp", "ResourceStatus" ], "members":{ "StackName":{ "shape":"StackName", "documentation":"The name associated with the stack.
" }, "StackId":{ "shape":"StackId", "documentation":"Unique identifier of the stack.
" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"The logical name of the resource specified in the template.
" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
" }, "ResourceType":{ "shape":"ResourceType", "documentation":"Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
" }, "LastUpdatedTimestamp":{ "shape":"Timestamp", "documentation":"Time the status was updated.
" }, "ResourceStatus":{ "shape":"ResourceStatus", "documentation":"Current status of the resource.
" }, "ResourceStatusReason":{ "shape":"ResourceStatusReason", "documentation":"Success/failure message associated with the resource.
" }, "Description":{ "shape":"Description", "documentation":"User defined description associated with the resource.
" }, "Metadata":{ "shape":"Metadata", "documentation":"The JSON format content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.
Contains detailed information about the specified stack resource.
" }, "StackResourceSummaries":{ "type":"list", "member":{"shape":"StackResourceSummary"} }, "StackResourceSummary":{ "type":"structure", "required":[ "LogicalResourceId", "ResourceType", "LastUpdatedTimestamp", "ResourceStatus" ], "members":{ "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"The logical name of the resource specified in the template.
" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"The name or unique identifier that corresponds to a physical instance ID of the resource.
" }, "ResourceType":{ "shape":"ResourceType", "documentation":"Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
" }, "LastUpdatedTimestamp":{ "shape":"Timestamp", "documentation":"Time the status was updated.
" }, "ResourceStatus":{ "shape":"ResourceStatus", "documentation":"Current status of the resource.
" }, "ResourceStatusReason":{ "shape":"ResourceStatusReason", "documentation":"Success/failure message associated with the resource.
" } }, "documentation":"Contains high-level information about the specified stack resource.
" }, "StackResources":{ "type":"list", "member":{"shape":"StackResource"} }, "StackStatus":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_FAILED", "ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE" ] }, "StackStatusFilter":{ "type":"list", "member":{"shape":"StackStatus"} }, "StackStatusReason":{"type":"string"}, "StackSummaries":{ "type":"list", "member":{"shape":"StackSummary"} }, "StackSummary":{ "type":"structure", "required":[ "StackName", "CreationTime", "StackStatus" ], "members":{ "StackId":{ "shape":"StackId", "documentation":"Unique stack identifier.
" }, "StackName":{ "shape":"StackName", "documentation":"The name associated with the stack.
" }, "TemplateDescription":{ "shape":"TemplateDescription", "documentation":"The template description of the template used to create the stack.
" }, "CreationTime":{ "shape":"CreationTime", "documentation":"The time the stack was created.
" }, "LastUpdatedTime":{ "shape":"LastUpdatedTime", "documentation":"The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
" }, "DeletionTime":{ "shape":"DeletionTime", "documentation":"The time the stack was deleted.
" }, "StackStatus":{ "shape":"StackStatus", "documentation":"The current status of the stack.
" }, "StackStatusReason":{ "shape":"StackStatusReason", "documentation":"Success/Failure message associated with the stack status.
" } }, "documentation":"The StackSummary Data Type
" }, "Stacks":{ "type":"list", "member":{"shape":"Stack"} }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.
Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
" } }, "documentation":"The Tag type is used by CreateStack in the Tags parameter. It allows you to specify a key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation stack.
The name associated with the parameter.
" }, "DefaultValue":{ "shape":"ParameterValue", "documentation":"The default value associated with the parameter.
" }, "NoEcho":{ "shape":"NoEcho", "documentation":"Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
" }, "Description":{ "shape":"Description", "documentation":"User defined description associated with the parameter.
" } }, "documentation":"The TemplateParameter data type.
" }, "TemplateParameters":{ "type":"list", "member":{"shape":"TemplateParameter"} }, "TemplateURL":{ "type":"string", "min":1, "max":1024 }, "TimeoutMinutes":{ "type":"integer", "min":1 }, "Timestamp":{"type":"timestamp"}, "UpdateStackInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"The name or unique stack ID of the stack to update.
" }, "TemplateBody":{ "shape":"TemplateBody", "documentation":"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
Reuse the existing template that is associated with the stack that you are updating.
" }, "StackPolicyDuringUpdateBody":{ "shape":"StackPolicyDuringUpdateBody", "documentation":"Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
" }, "StackPolicyDuringUpdateURL":{ "shape":"StackPolicyDuringUpdateURL", "documentation":"Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
" }, "Parameters":{ "shape":"Parameters", "documentation":"A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. 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::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an InsufficientCapabilities error.
The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management
" }, "StackPolicyBody":{ "shape":"StackPolicyBody", "documentation":"Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
" }, "StackPolicyURL":{ "shape":"StackPolicyURL", "documentation":"Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
" }, "NotificationARNs":{ "shape":"NotificationARNs", "documentation":"Update the ARNs for the Amazon SNS topics that are associated with the stack.
" } }, "documentation":"The input for UpdateStack action.
" }, "UpdateStackOutput":{ "type":"structure", "members":{ "StackId":{ "shape":"StackId", "documentation":"Unique identifier of the stack.
" } }, "documentation":"The output for a UpdateStack action.
" }, "Url":{"type":"string"}, "UsePreviousTemplate":{"type":"boolean"}, "UsePreviousValue":{"type":"boolean"}, "ValidateTemplateInput":{ "type":"structure", "members":{ "TemplateBody":{ "shape":"TemplateBody", "documentation":"Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
The input for ValidateTemplate action.
" }, "ValidateTemplateOutput":{ "type":"structure", "members":{ "Parameters":{ "shape":"TemplateParameters", "documentation":"A list of TemplateParameter structures.
The description found within the template.
" }, "Capabilities":{ "shape":"Capabilities", "documentation":"The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
" }, "CapabilitiesReason":{ "shape":"CapabilitiesReason", "documentation":"The list of resources that generated the values in the Capabilities response element.
The output for ValidateTemplate action.
" }, "Version":{"type":"string"} }, "examples":{ } }