{
"api_version": "2010-05-15",
"type": "query",
"result_wrapped": true,
"signature_version": "v4",
"service_full_name": "AWS CloudFormation",
"endpoint_prefix": "cloudformation",
"xmlnamespace": "http://cloudformation.amazonaws.com/doc/2010-05-15/",
"documentation": "\n
AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly.\n AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling\n to build highly-reliable, highly scalable, cost effective applications without worrying about creating and\n configuring the underlying AWS infrastructure.
\nWith AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template\n defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all\n member resources of the stack together and manages all dependencies between the resources for you.
\nFor more information about this product, go to the CloudFormation Product Page.
\nAmazon CloudFormation makes use of other AWS products. If you need additional technical information about a\n specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.
\n\n ", "operations": { "CancelUpdateStack": { "name": "CancelUpdateStack", "input": { "shape_name": "CancelUpdateStackInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\nThe name or the unique identifier associated with the stack.
\n ", "required": true } }, "documentation": "\nThe input for CancelUpdateStack action.
\n " }, "output": null, "errors": [], "documentation": "\nCancels an update on the specified stack. If the call completes successfully, the stack will roll back the\n update and revert to the previous stack configuration.
\nThe name associated with the stack. The name must be unique within your AWS account.
\nStructure 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.
\nConditional: 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: 307,200 bytes)\n located in an S3 bucket in the same region as the stack. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody
or the TemplateURL
parameter, but not both.
The key associated with the parameter.
\n " }, "ParameterValue": { "shape_name": "ParameterValue", "type": "string", "documentation": "\nThe value associated with the parameter.
\n " }, "UsePreviousValue": { "shape_name": "UsePreviousValue", "type": "boolean", "documentation": "\nDuring a stack update, use the existing parameter value that is being used for the stack.
\n " } }, "documentation": "\nThe Parameter data type.
\n " }, "documentation": "\nA 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\n DisableRollback
or OnFailure
, but not both.
Default: false
\n
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
\n 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\n ARNs using the SNS console or your Command Line Interface\n (CLI).
\n " }, "Capabilities": { "shape_name": "Capabilities", "type": "list", "members": { "shape_name": "Capability", "type": "string", "enum": [ "CAPABILITY_IAM" ], "documentation": null }, "documentation": "\nThe list of capabilities that you want to allow in the stack. If your template contains certain resources, you\n must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an\n InsufficientCapabilities error. The following resources require you to specify the capabilities parameter: 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.
\n " }, "OnFailure": { "shape_name": "OnFailure", "type": "string", "enum": [ "DO_NOTHING", "ROLLBACK", "DELETE" ], "documentation": "\nDetermines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or\n DELETE. You can specify either OnFailure
or DisableRollback
, but not both.
Default: ROLLBACK
Structure containing the stack policy body. For more information, go to \n Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.\n 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.\n You can specify either the StackPolicyBody
or the StackPolicyURL
parameter, but not both.
Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key.\n 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\n tag value.
\n " } }, "documentation": "\nThe Tag type is used by CreateStack
in the Tags
parameter. It allows you to specify a\n key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation\n stack.
A set of user-defined Tags
to associate with this stack, represented by key/value pairs. Tags\n defined for the stack are propagated to EC2 resources that are created as part of the stack. A maximum number of\n 10 tags can be specified.
The input for CreateStack action.
\n " }, "output": { "shape_name": "CreateStackOutput", "type": "structure", "members": { "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\nUnique identifier of the stack.
\n " } }, "documentation": "\nThe output for a CreateStack action.
\n " }, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nQuota for the resource has already been reached.
\n " }, { "shape_name": "AlreadyExistsException", "type": "structure", "members": {}, "documentation": "\nResource with the name requested already exists.
\n " }, { "shape_name": "InsufficientCapabilitiesException", "type": "structure", "members": {}, "documentation": "\nThe template contains resources with capabilities that were not specified in the Capabilities parameter.
\n " } ], "documentation": "\nCreates a stack as specified in the template. After the call completes successfully, the stack creation\n starts. You can check the status of the stack via the DescribeStacks API.
\nThe name or the unique identifier associated with the stack.
\n ", "required": true } }, "documentation": "\nThe input for DeleteStack action.
\n " }, "output": null, "errors": [], "documentation": "\nDeletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not\n show up in the DescribeStacks API if the deletion has been completed successfully.
\nThe name or the unique identifier associated with the stack, which are not always interchangeable:
\nDefault: There is no default value.
\n ", "required": true }, "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\nString that identifies the start of the next list of events, if there is one.
\nDefault: There is no default value.
\n " } }, "documentation": "\nThe input for DescribeStackEvents action.
\n " }, "output": { "shape_name": "DescribeStackEventsOutput", "type": "structure", "members": { "StackEvents": { "shape_name": "StackEvents", "type": "list", "members": { "shape_name": "StackEvent", "type": "structure", "members": { "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\nThe unique ID name of the instance of the stack.
\n ", "required": true }, "EventId": { "shape_name": "EventId", "type": "string", "documentation": "\nThe unique ID of this event.
\n ", "required": true }, "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\nThe name associated with a stack.
\n ", "required": true }, "LogicalResourceId": { "shape_name": "LogicalResourceId", "type": "string", "documentation": "\nThe logical name of the resource specified in the template.
\n " }, "PhysicalResourceId": { "shape_name": "PhysicalResourceId", "type": "string", "documentation": "\nThe name or unique identifier associated with the physical instance of the resource.
\n " }, "ResourceType": { "shape_name": "ResourceType", "type": "string", "documentation": "\nType of resource. (For more information, go to \n AWS Resource Types Reference in the AWS CloudFormation User Guide.)
\n " }, "Timestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\nTime the status was updated.
\n ", "required": true }, "ResourceStatus": { "shape_name": "ResourceStatus", "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE" ], "documentation": "\nCurrent status of the resource.
\n " }, "ResourceStatusReason": { "shape_name": "ResourceStatusReason", "type": "string", "documentation": "\nSuccess/failure message associated with the resource.
\n " }, "ResourceProperties": { "shape_name": "ResourceProperties", "type": "string", "documentation": "\nBLOB of the properties used to create the resource.
\n " } }, "documentation": "\nThe StackEvent data type.
\n " }, "documentation": "\nA list of StackEvents
structures.
String that identifies the start of the next list of events, if there is one.
\n " } }, "documentation": "\nThe output for a DescribeStackEvents action.
\n " }, "errors": [], "documentation": "\nReturns 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.
\nThe name or the unique identifier associated with the stack, which are not always interchangeable:
\nDefault: There is no default value.
\n ", "required": true }, "LogicalResourceId": { "shape_name": "LogicalResourceId", "type": "string", "documentation": "\nThe logical name of the resource as specified in the template.
\nDefault: There is no default value.
\n ", "required": true } }, "documentation": "\nThe input for DescribeStackResource action.
\n " }, "output": { "shape_name": "DescribeStackResourceOutput", "type": "structure", "members": { "StackResourceDetail": { "shape_name": "StackResourceDetail", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\nThe name associated with the stack.
\n " }, "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\nUnique identifier of the stack.
\n " }, "LogicalResourceId": { "shape_name": "LogicalResourceId", "type": "string", "documentation": "\nThe logical name of the resource specified in the template.
\n ", "required": true }, "PhysicalResourceId": { "shape_name": "PhysicalResourceId", "type": "string", "documentation": "\nThe name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS\n CloudFormation.
\n " }, "ResourceType": { "shape_name": "ResourceType", "type": "string", "documentation": "\nType of resource. ((For more information, go to \n AWS Resource Types Reference in the AWS CloudFormation User Guide.)
\n ", "required": true }, "LastUpdatedTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\nTime the status was updated.
\n ", "required": true }, "ResourceStatus": { "shape_name": "ResourceStatus", "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE" ], "documentation": "\nCurrent status of the resource.
\n ", "required": true }, "ResourceStatusReason": { "shape_name": "ResourceStatusReason", "type": "string", "documentation": "\nSuccess/failure message associated with the resource.
\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\nUser defined description associated with the resource.
\n " }, "Metadata": { "shape_name": "Metadata", "type": "string", "documentation": "\nThe JSON format content of the Metadata
attribute declared for the resource. For more\n information, see Metadata Attribute in the AWS CloudFormation User Guide.
A StackResourceDetail
structure containing the description of the specified resource in the\n specified stack.
The output for a DescribeStackResource action.
\n " }, "errors": [], "documentation": "\nReturns a description of the specified resource in the specified stack.
\nFor deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has\n been deleted.
\n\nThe name or the unique identifier associated with the stack, which are not always interchangeable:
\nDefault: There is no default value.
\nRequired: Conditional. If you do not specify StackName
, you must specify\n PhysicalResourceId
.
The logical name of the resource as specified in the template.
\nDefault: There is no default value.
\n " }, "PhysicalResourceId": { "shape_name": "PhysicalResourceId", "type": "string", "documentation": "\nThe name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS\n CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId
corresponds to\n the InstanceId
. You can pass the EC2 InstanceId
to\n DescribeStackResources
to find which stack the instance belongs to and what other resources are\n part of the stack.
Required: Conditional. If you do not specify PhysicalResourceId
, you must specify\n StackName
.
Default: There is no default value.
\n " } }, "documentation": "\nThe input for DescribeStackResources action.
\n " }, "output": { "shape_name": "DescribeStackResourcesOutput", "type": "structure", "members": { "StackResources": { "shape_name": "StackResources", "type": "list", "members": { "shape_name": "StackResource", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\nThe name associated with the stack.
\n " }, "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\nUnique identifier of the stack.
\n " }, "LogicalResourceId": { "shape_name": "LogicalResourceId", "type": "string", "documentation": "\nThe logical name of the resource specified in the template.
\n ", "required": true }, "PhysicalResourceId": { "shape_name": "PhysicalResourceId", "type": "string", "documentation": "\nThe name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS\n CloudFormation.
\n " }, "ResourceType": { "shape_name": "ResourceType", "type": "string", "documentation": "\nType of resource. (For more information, go to \n AWS Resource Types Reference in the AWS CloudFormation User Guide.)
\n ", "required": true }, "Timestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\nTime the status was updated.
\n ", "required": true }, "ResourceStatus": { "shape_name": "ResourceStatus", "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE" ], "documentation": "\nCurrent status of the resource.
\n ", "required": true }, "ResourceStatusReason": { "shape_name": "ResourceStatusReason", "type": "string", "documentation": "\nSuccess/failure message associated with the resource.
\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\nUser defined description associated with the resource.
\n " } }, "documentation": "\nThe StackResource data type.
\n " }, "documentation": "\nA list of StackResource
structures.
The output for a DescribeStackResources action.
\n " }, "errors": [], "documentation": "\nReturns AWS resource descriptions for running and deleted stacks. If StackName
is specified, all\n the associated resources that are part of the stack are returned. If PhysicalResourceId
is\n 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\n the stack has been deleted.
You must specify either StackName
or PhysicalResourceId
, but not both. In addition,\n you can specify LogicalResourceId
to filter the returned result. For more information about\n resources, the LogicalResourceId
and PhysicalResourceId
, go to the AWS CloudFormation User Guide.
ValidationError
is returned if you specify both StackName
and\n PhysicalResourceId
in the same request.The name or the unique identifier associated with the stack, which are not always interchangeable:
\nDefault: There is no default value.
\n " }, "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "String that identifies the start of the next list of stacks, if there is one." } }, "documentation": "\nThe input for DescribeStacks action.
\n " }, "output": { "shape_name": "DescribeStacksOutput", "type": "structure", "members": { "Stacks": { "shape_name": "Stacks", "type": "list", "members": { "shape_name": "Stack", "type": "structure", "members": { "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\nUnique identifier of the stack.
\n " }, "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\nThe name associated with the stack.
\n ", "required": true }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\nUser defined description associated with the stack.
\n " }, "Parameters": { "shape_name": "Parameters", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterKey": { "shape_name": "ParameterKey", "type": "string", "documentation": "\nThe key associated with the parameter.
\n " }, "ParameterValue": { "shape_name": "ParameterValue", "type": "string", "documentation": "\nThe value associated with the parameter.
\n " }, "UsePreviousValue": { "shape_name": "UsePreviousValue", "type": "boolean", "documentation": "\nDuring a stack update, use the existing parameter value that is being used for the stack.
\n " } }, "documentation": "\nThe Parameter data type.
\n " }, "documentation": "\nA list of Parameter
structures.
Time at which the stack was created.
\n ", "required": true }, "LastUpdatedTime": { "shape_name": "LastUpdatedTime", "type": "timestamp", "documentation": "\nThe time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.
\n " }, "StackStatus": { "shape_name": "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" ], "documentation": "\nCurrent status of the stack.
\n ", "required": true }, "StackStatusReason": { "shape_name": "StackStatusReason", "type": "string", "documentation": "\nSuccess/failure message associated with the stack status.
\n " }, "DisableRollback": { "shape_name": "DisableRollback", "type": "boolean", "documentation": "\nBoolean to enable or disable rollback on stack creation failures:
\n\n
true
: disable rollbackfalse
: enable rollbackSNS topic ARNs to which stack related events are published.
\n " }, "TimeoutInMinutes": { "shape_name": "TimeoutMinutes", "type": "integer", "min_length": 1, "documentation": "\nThe amount of time within which stack creation should complete.
\n " }, "Capabilities": { "shape_name": "Capabilities", "type": "list", "members": { "shape_name": "Capability", "type": "string", "enum": [ "CAPABILITY_IAM" ], "documentation": null }, "documentation": "\nThe capabilities allowed in the stack.
\n " }, "Outputs": { "shape_name": "Outputs", "type": "list", "members": { "shape_name": "Output", "type": "structure", "members": { "OutputKey": { "shape_name": "OutputKey", "type": "string", "documentation": "\nThe key associated with the output.
\n " }, "OutputValue": { "shape_name": "OutputValue", "type": "string", "documentation": "\nThe value associated with the output.
\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\nUser defined description associated with the output.
\n " } }, "documentation": "\nThe Output data type.
\n " }, "documentation": "\nA list of output structures.
\n " }, "Tags": { "shape_name": "Tags", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "TagKey", "type": "string", "documentation": "\nRequired. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key.\n 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\n tag value.
\n " } }, "documentation": "\nThe Tag type is used by CreateStack
in the Tags
parameter. It allows you to specify a\n key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation\n stack.
A list of Tag
s that specify cost allocation information for the stack.
The Stack data type.
\n " }, "documentation": "\nA list of stack structures.
\n " }, "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "String that identifies the start of the next list of stacks, if there is one." } }, "documentation": "\nThe output for a DescribeStacks action.
\n " }, "errors": [], "documentation": "\nReturns the description for the specified stack; if no stack name was specified, then it returns the\n description for all the stacks created.
\nStructure 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\n in the AWS CloudFormation User Guide.)
\nConditional: You must pass TemplateBody
or TemplateURL
. If both are passed, only\n TemplateBody
is used.
Location of file containing the template body. The URL must point to a template located in an S3 bucket in the\n same region as the stack. For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.
\nConditional: You must pass TemplateURL
or TemplateBody
. If both are passed, only\n TemplateBody
is used.
The key associated with the parameter.
\n " }, "ParameterValue": { "shape_name": "ParameterValue", "type": "string", "documentation": "\nThe value associated with the parameter.
\n " }, "UsePreviousValue": { "shape_name": "UsePreviousValue", "type": "boolean", "documentation": "\nDuring a stack update, use the existing parameter value that is being used for the stack.
\n " } }, "documentation": "\nThe Parameter data type.
\n " }, "documentation": "\nA 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\n template.
\n " } }, "documentation": "\nThe output for a EstimateTemplateCost action.
\n " }, "errors": [], "documentation": "\nReturns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with\n a query string that describes the resources required to run the template.
\nThe name or stack ID that is associated with the stack whose policy you want to get.
\n ", "required": true } }, "documentation": "\nThe input for the GetStackPolicy action.
\n " }, "output": { "shape_name": "GetStackPolicyOutput", "type": "structure", "members": { "StackPolicyBody": { "shape_name": "StackPolicyBody", "type": "string", "min_length": 1, "max_length": 16384, "documentation": "\nStructure containing the stack policy body. (For more information, go to \n Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)
\n " } }, "documentation": "\nThe output for the GetStackPolicy action.
\n " }, "errors": [], "documentation": "\nReturns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
\nThe name or the unique identifier associated with the stack, which are not always interchangeable:
\nDefault: There is no default value.
\n ", "required": true } }, "documentation": "\nThe input for a GetTemplate action.
\n " }, "output": { "shape_name": "GetTemplateOutput", "type": "structure", "members": { "TemplateBody": { "shape_name": "TemplateBody", "type": "string", "min_length": 1, "documentation": "\nStructure containing the template body. (For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.)
\n " } }, "documentation": "\nThe output for GetTemplate action.
\n " }, "errors": [], "documentation": "\nReturns the template body for a specified stack. You can get the template for running or deleted\n stacks.
\nFor deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
\nValidationError
is returned. The name or the unique identifier associated with the stack, which are not always interchangeable:
\nDefault: There is no default value.
\n ", "required": true }, "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\nString that identifies the start of the next list of stack resource summaries, if there is one.
\nDefault: There is no default value.
\n " } }, "documentation": "\nThe input for ListStackResource action.
\n " }, "output": { "shape_name": "ListStackResourcesOutput", "type": "structure", "members": { "StackResourceSummaries": { "shape_name": "StackResourceSummaries", "type": "list", "members": { "shape_name": "StackResourceSummary", "type": "structure", "members": { "LogicalResourceId": { "shape_name": "LogicalResourceId", "type": "string", "documentation": "\nThe logical name of the resource specified in the template.
\n ", "required": true }, "PhysicalResourceId": { "shape_name": "PhysicalResourceId", "type": "string", "documentation": "\nThe name or unique identifier that corresponds to a physical instance ID of the resource.
\n " }, "ResourceType": { "shape_name": "ResourceType", "type": "string", "documentation": "\nType of resource. (For more information, go to \n AWS Resource Types Reference in the AWS CloudFormation User Guide.)
\n ", "required": true }, "LastUpdatedTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\nTime the status was updated.
\n ", "required": true }, "ResourceStatus": { "shape_name": "ResourceStatus", "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE" ], "documentation": "\nCurrent status of the resource.
\n ", "required": true }, "ResourceStatusReason": { "shape_name": "ResourceStatusReason", "type": "string", "documentation": "\nSuccess/failure message associated with the resource.
\n " } }, "documentation": "\nContains high-level information about the specified stack resource.
\n " }, "documentation": "\nA list of StackResourceSummary
structures.
String that identifies the start of the next list of stack resources, if there is one.
\n " } }, "documentation": "\nThe output for a ListStackResources action.
\n " }, "errors": [], "documentation": "\nReturns descriptions of all resources of the specified stack.
\nFor deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been\n deleted.
\n\nString that identifies the start of the next list of stacks, if there is one.
\nDefault: There is no default value.
\n " }, "StackStatusFilter": { "shape_name": "StackStatusFilter", "type": "list", "members": { "shape_name": "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" ], "documentation": null }, "documentation": "\nStack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified\n status codes. For a complete list of stack status codes, see the StackStatus
parameter of the\n Stack data type.
The input for ListStacks action.
\n " }, "output": { "shape_name": "ListStacksOutput", "type": "structure", "members": { "StackSummaries": { "shape_name": "StackSummaries", "type": "list", "members": { "shape_name": "StackSummary", "type": "structure", "members": { "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\nUnique stack identifier.
\n " }, "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\nThe name associated with the stack.
\n ", "required": true }, "TemplateDescription": { "shape_name": "TemplateDescription", "type": "string", "documentation": "\nThe template description of the template used to create the stack.
\n " }, "CreationTime": { "shape_name": "CreationTime", "type": "timestamp", "documentation": "\nThe time the stack was created.
\n ", "required": true }, "LastUpdatedTime": { "shape_name": "LastUpdatedTime", "type": "timestamp", "documentation": "\nThe time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.
\n " }, "DeletionTime": { "shape_name": "DeletionTime", "type": "timestamp", "documentation": "\nThe time the stack was deleted.
\n " }, "StackStatus": { "shape_name": "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" ], "documentation": "\nThe current status of the stack.
\n ", "required": true }, "StackStatusReason": { "shape_name": "StackStatusReason", "type": "string", "documentation": "\nSuccess/Failure message associated with the stack status.
\n " } }, "documentation": "\nThe StackSummary Data Type
\n " }, "documentation": "\nA 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.
\n " } }, "documentation": "\nThe output for ListStacks action.
\n " }, "errors": [], "documentation": "\nReturns the summary information for stacks whose status matches the specified StackStatusFilter. Summary\n information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no\n StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and\n stacks that have been deleted).
\nThe name or stack ID that you want to associate a policy with.
\n ", "required": true }, "StackPolicyBody": { "shape_name": "StackPolicyBody", "type": "string", "min_length": 1, "max_length": 16384, "documentation": "\nStructure containing the stack policy body. For more information, go to \n Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.\n 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.\n You can specify either the StackPolicyBody
or the StackPolicyURL
parameter, but not both.
The input for the SetStackPolicy action.
\n " }, "output": null, "errors": [], "documentation": "\nSets a stack policy for a specified stack.
\nThe name or stack ID of the stack to update.
\nStructure 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\n in the AWS CloudFormation User Guide.)
\nConditional: 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 located in an S3 bucket in the\n same region as the stack. For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.
\nConditional: 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.
\n " }, "StackPolicyDuringUpdateBody": { "shape_name": "StackPolicyDuringUpdateBody", "type": "string", "min_length": 1, "max_length": 16384, "documentation": "\nStructure 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.
\n " }, "StackPolicyDuringUpdateURL": { "shape_name": "StackPolicyDuringUpdateURL", "type": "string", "min_length": 1, "max_length": 1350, "documentation": "\nLocation 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.\n 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.
\n " }, "Parameters": { "shape_name": "Parameters", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterKey": { "shape_name": "ParameterKey", "type": "string", "documentation": "\nThe key associated with the parameter.
\n " }, "ParameterValue": { "shape_name": "ParameterValue", "type": "string", "documentation": "\nThe value associated with the parameter.
\n " }, "UsePreviousValue": { "shape_name": "UsePreviousValue", "type": "boolean", "documentation": "\nDuring a stack update, use the existing parameter value that is being used for the stack.
\n " } }, "documentation": "\nThe Parameter data type.
\n " }, "documentation": "\nA list of Parameter
structures that specify input parameters for the stack.
The list of capabilities that you want to allow in the stack. If your stack contains IAM resources, you must\n specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities\n error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.
\n " }, "StackPolicyBody": { "shape_name": "StackPolicyBody", "type": "string", "min_length": 1, "max_length": 16384, "documentation": "\nStructure 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.
\n " }, "StackPolicyURL": { "shape_name": "StackPolicyURL", "type": "string", "min_length": 1, "max_length": 1350, "documentation": "\nLocation 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.\n 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.
\n ", "no_paramfile": true }, "NotificationARNs": { "shape_name": "NotificationARNs", "type": "list", "members": { "shape_name": "NotificationARN", "type": "string", "documentation": null }, "max_length": 5, "documentation": "\nUpdate the ARNs for the Amazon SNS topics that are associated with the stack.
\n " } }, "documentation": "\nThe input for UpdateStack action.
\n " }, "output": { "shape_name": "UpdateStackOutput", "type": "structure", "members": { "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\nUnique identifier of the stack.
\n " } }, "documentation": "\nThe output for a UpdateStack action.
\n " }, "errors": [ { "shape_name": "InsufficientCapabilitiesException", "type": "structure", "members": {}, "documentation": "\nThe template contains resources with capabilities that were not specified in the Capabilities parameter.
\n " } ], "documentation": "\nUpdates a stack as specified in the template. After the call completes successfully, the stack update starts.\n You can check the status of the stack via the DescribeStacks action.
\nTo get a copy of the template for an existing stack, you can use the GetTemplate action.
\nTags that were associated with this stack during creation time will still be associated with the stack after an\n UpdateStack
operation.
For more information about creating an update template, updating a stack, and monitoring the progress of the\n update, see Updating a Stack.
\n\nStructure 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\n in the AWS CloudFormation User Guide.
\nConditional: You must pass TemplateURL
or TemplateBody
. If both are passed, only\n TemplateBody
is used.
Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes)\n located in an S3 bucket in the same region as the stack. For more information, go to Template Anatomy\n in the AWS CloudFormation User Guide.
\nConditional: You must pass TemplateURL
or TemplateBody
. If both are passed, only\n TemplateBody
is used.
The input for ValidateTemplate action.
\n " }, "output": { "shape_name": "ValidateTemplateOutput", "type": "structure", "members": { "Parameters": { "shape_name": "TemplateParameters", "type": "list", "members": { "shape_name": "TemplateParameter", "type": "structure", "members": { "ParameterKey": { "shape_name": "ParameterKey", "type": "string", "documentation": "\nThe name associated with the parameter.
\n " }, "DefaultValue": { "shape_name": "ParameterValue", "type": "string", "documentation": "\nThe default value associated with the parameter.
\n " }, "NoEcho": { "shape_name": "NoEcho", "type": "boolean", "documentation": "\nFlag indicating whether the parameter should be displayed as plain text in logs and UIs.
\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\nUser defined description associated with the parameter.
\n " } }, "documentation": "\nThe TemplateParameter data type.
\n " }, "documentation": "\nA list of TemplateParameter
structures.
The description found within the template.
\n " }, "Capabilities": { "shape_name": "Capabilities", "type": "list", "members": { "shape_name": "Capability", "type": "string", "enum": [ "CAPABILITY_IAM" ], "documentation": null }, "documentation": "\nThe capabilities found within the template. Currently, CAPABILITY_IAM is the only capability detected. If\n your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use\n the CreateStack or UpdateStack actions with your template; otherwise, those actions return an\n InsufficientCapabilities error.
\n " }, "CapabilitiesReason": { "shape_name": "CapabilitiesReason", "type": "string", "documentation": "\nThe capabilities reason found within the template.
\n " } }, "documentation": "\nThe output for ValidateTemplate action.
\n " }, "errors": [], "documentation": "\nValidates a specified template.
\n\n