AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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://docs.aws.amazon.com/documentation/.
Namespace: Amazon.CloudFormation
Assembly: AWSSDK.dll
Version: (assembly version)
public interface IAmazonCloudFormation IDisposable
The IAmazonCloudFormation type exposes the following members
Name | Description | |
---|---|---|
BeginCancelUpdateStack(CancelUpdateStackRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CancelUpdateStack operation. | |
BeginContinueUpdateRollback(ContinueUpdateRollbackRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ContinueUpdateRollback operation. | |
BeginCreateStack(CreateStackRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateStack operation. | |
BeginDeleteStack(DeleteStackRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteStack operation. | |
BeginDescribeAccountLimits(DescribeAccountLimitsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeAccountLimits operation. | |
BeginDescribeStackEvents(DescribeStackEventsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeStackEvents operation. | |
BeginDescribeStackResource(DescribeStackResourceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeStackResource operation. | |
BeginDescribeStackResources(DescribeStackResourcesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeStackResources operation. | |
BeginDescribeStacks(DescribeStacksRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeStacks operation. | |
BeginEstimateTemplateCost(EstimateTemplateCostRequest, AsyncCallback, object) | Initiates the asynchronous execution of the EstimateTemplateCost operation. | |
BeginGetStackPolicy(GetStackPolicyRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetStackPolicy operation. | |
BeginGetTemplate(GetTemplateRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetTemplate operation. | |
BeginGetTemplateSummary(GetTemplateSummaryRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetTemplateSummary operation. | |
BeginListStackResources(ListStackResourcesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListStackResources operation. | |
BeginListStacks(ListStacksRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListStacks operation. | |
BeginSetStackPolicy(SetStackPolicyRequest, AsyncCallback, object) | Initiates the asynchronous execution of the SetStackPolicy operation. | |
BeginSignalResource(SignalResourceRequest, AsyncCallback, object) | Initiates the asynchronous execution of the SignalResource operation. | |
BeginUpdateStack(UpdateStackRequest, AsyncCallback, object) | Initiates the asynchronous execution of the UpdateStack operation. | |
BeginValidateTemplate(ValidateTemplateRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ValidateTemplate operation. | |
CancelUpdateStack(CancelUpdateStackRequest) |
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.
|
|
ContinueUpdateRollback(ContinueUpdateRollbackRequest) |
For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues
rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the
cause of the failure, you can manually
fix the error and continue the rollback. By continuing the rollback, you can return
your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and
then try to update the stack again.
A stack goes into the |
|
CreateStack(CreateStackRequest) | 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(DeleteStackRequest) | 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(DescribeAccountLimitsRequest) | Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. | |
DescribeStackEvents(DescribeStackEventsRequest) |
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.
|
|
DescribeStackResource(DescribeStackResourceRequest) |
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(DescribeStackResourcesRequest) |
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,
You must specify either ValidationError is returned if you specify both StackName
and PhysicalResourceId in the same request. |
|
DescribeStacks() | Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. | |
DescribeStacks(DescribeStacksRequest) | Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. | |
EndCancelUpdateStack(IAsyncResult) | Finishes the asynchronous execution of the CancelUpdateStack operation. | |
EndContinueUpdateRollback(IAsyncResult) | Finishes the asynchronous execution of the ContinueUpdateRollback operation. | |
EndCreateStack(IAsyncResult) | Finishes the asynchronous execution of the CreateStack operation. | |
EndDeleteStack(IAsyncResult) | Finishes the asynchronous execution of the DeleteStack operation. | |
EndDescribeAccountLimits(IAsyncResult) | Finishes the asynchronous execution of the DescribeAccountLimits operation. | |
EndDescribeStackEvents(IAsyncResult) | Finishes the asynchronous execution of the DescribeStackEvents operation. | |
EndDescribeStackResource(IAsyncResult) | Finishes the asynchronous execution of the DescribeStackResource operation. | |
EndDescribeStackResources(IAsyncResult) | Finishes the asynchronous execution of the DescribeStackResources operation. | |
EndDescribeStacks(IAsyncResult) | Finishes the asynchronous execution of the DescribeStacks operation. | |
EndEstimateTemplateCost(IAsyncResult) | Finishes the asynchronous execution of the EstimateTemplateCost operation. | |
EndGetStackPolicy(IAsyncResult) | Finishes the asynchronous execution of the GetStackPolicy operation. | |
EndGetTemplate(IAsyncResult) | Finishes the asynchronous execution of the GetTemplate operation. | |
EndGetTemplateSummary(IAsyncResult) | Finishes the asynchronous execution of the GetTemplateSummary operation. | |
EndListStackResources(IAsyncResult) | Finishes the asynchronous execution of the ListStackResources operation. | |
EndListStacks(IAsyncResult) | Finishes the asynchronous execution of the ListStacks operation. | |
EndSetStackPolicy(IAsyncResult) | Finishes the asynchronous execution of the SetStackPolicy operation. | |
EndSignalResource(IAsyncResult) | Finishes the asynchronous execution of the SignalResource operation. | |
EndUpdateStack(IAsyncResult) | Finishes the asynchronous execution of the UpdateStack operation. | |
EndValidateTemplate(IAsyncResult) | Finishes the asynchronous execution of the ValidateTemplate operation. | |
EstimateTemplateCost(EstimateTemplateCostRequest) | 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(GetStackPolicyRequest) | Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. | |
GetTemplate(GetTemplateRequest) |
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.
|
|
GetTemplateSummary(GetTemplateSummaryRequest) |
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
For deleted stacks, |
|
ListStackResources(ListStackResourcesRequest) |
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() | 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). | |
ListStacks(ListStacksRequest) | 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(SetStackPolicyRequest) | Sets a stack policy for a specified stack. | |
SignalResource(SignalResourceRequest) | 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(UpdateStackRequest) |
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. |
|
ValidateTemplate() | Validates a specified template. | |
ValidateTemplate(ValidateTemplateRequest) | Validates a specified template. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1