Types

      
 All Types  Classes  
 NameDescription
AlreadyExistsException
AmazonCloudFormation exception
CreateStackRequest
Container for the parameters to the CreateStack operation.

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.

NOTE: Currently, the limit for stacks is 20 stacks per account per region.

CreateStackResponse
Returns information about the CreateStackResult response and response metadata.
CreateStackResult

The output for a CreateStack action.

DeleteStackRequest
Container for the parameters to the DeleteStack operation.

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.

DeleteStackResponse
Returns information about the DeleteStack response metadata. The DeleteStack operation has a void result type.
DescribeStackEventsRequest
Container for the parameters to the DescribeStackEvents operation.

Returns all the stack related events for the AWS account. If StackName is specified, returns events related to all the stacks with the given name. If StackName is not specified, returns all the events for the account. For more information about a stack's event history, go to the AWS CloudFormation User Guide.

NOTE:Events are returned, even if the stack never existed or has been successfully deleted.

DescribeStackEventsResponse
Returns information about the DescribeStackEventsResult response and response metadata.
DescribeStackEventsResult

The output for a DescribeStackEvents action.

DescribeStackResourceRequest
Container for the parameters to the DescribeStackResource operation.

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.

DescribeStackResourceResponse
Returns information about the DescribeStackResourceResult response and response metadata.
DescribeStackResourceResult

The output for a DescribeStackResource action.

DescribeStackResourcesRequest
Container for the parameters to the DescribeStackResources operation.

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, all the associated resources of the stack the resource belongs to are returned.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

You must specify StackName or PhysicalResourceId. 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.

NOTE: A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

DescribeStackResourcesResponse
Returns information about the DescribeStackResourcesResult response and response metadata.
DescribeStackResourcesResult

The output for a DescribeStackResources action.

DescribeStacksRequest
Container for the parameters to the DescribeStacks operation.

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

DescribeStacksResponse
Returns information about the DescribeStacksResult response and response metadata.
DescribeStacksResult

The output for a DescribeStacks action.

EstimateTemplateCostRequest
Container for the parameters to the EstimateTemplateCost operation.

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.

EstimateTemplateCostResponse
Returns information about the EstimateTemplateCostResult response and response metadata.
EstimateTemplateCostResult

The output for a EstimateTemplateCost action.

GetTemplateRequest
Container for the parameters to the GetTemplate operation.

Returns the template body for a specified stack name. 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.

NOTE: If the template does not exist, a ValidationError is returned.

GetTemplateResponse
Returns information about the GetTemplateResult response and response metadata.
GetTemplateResult

The output for GetTemplate action.

InsufficientCapabilitiesException
AmazonCloudFormation exception
LimitExceededException
AmazonCloudFormation exception
ListStackResourcesRequest
Container for the parameters to the ListStackResources operation.

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.

ListStackResourcesResponse
Returns information about the ListStackResourcesResult response and response metadata.
ListStackResourcesResult

The output for a ListStackResources action.

ListStacksRequest
Container for the parameters to the ListStacks operation.

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).

ListStacksResponse
Returns information about the ListStacksResult response and response metadata.
ListStacksResult

The output for ListStacks action.

Output

The Output data type.

Parameter

The Parameter data type.

Stack

The Stack data type.

StackEvent

The StackEvent data type.

StackResource

The StackResource data type.

StackResourceDetail

Contains detailed information about the specified stack resource.

StackResourceSummary

Contains high-level information about the specified stack resource.

StackSummary

The StackSummary Data Type

TemplateParameter

The TemplateParameter data type.

UpdateStackRequest
Container for the parameters to the UpdateStack operation.

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.

To get a copy of the template for an existing stack, you can use the GetTemplate action.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.

UpdateStackResponse
Returns information about the UpdateStackResult response and response metadata.
UpdateStackResult

The output for a UpdateStack action.

ValidateTemplateRequest
Container for the parameters to the ValidateTemplate operation.

Validates a specified template.

ValidateTemplateResponse
Returns information about the ValidateTemplateResult response and response metadata.
ValidateTemplateResult

The output for ValidateTemplate action.