AWS SDK Version 3 for .NET
API Reference

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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to UpdateStackAsync.

Namespace: Amazon.CloudFormation
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z

Syntax

C#
public virtual UpdateStackResponse UpdateStack(
         UpdateStackRequest request
)
Parameters
request
Type: Amazon.CloudFormation.Model.UpdateStackRequest

Container for the necessary parameters to execute the UpdateStack service method.

Return Value
The response from the UpdateStack service method, as returned by CloudFormation.

Exceptions

ExceptionCondition
InsufficientCapabilitiesException The template contains resources with capabilities that weren't specified in the Capabilities parameter.
TokenAlreadyExistsException A client request token already exists.

Examples

This example updates the template and input parameters for the specified stack.

To update an AWS CloudFormation stack


var response = client.UpdateStack(new UpdateStackRequest 
{
    NotificationARNs = new List {
                    
    },
    Parameters = new List {
        new Parameter {
            ParameterKey = "KeyPairName",
            ParameterValue = "ExampleKeyPair"
        },
        new Parameter {
            ParameterKey = "SubnetIDs",
            ParameterValue = "ExampleSubnetID1, ExampleSubnetID2"
        }
    },
    ResourceTypes = new List {
                    
    },
    StackName = "MyStack",
    Tags = new List {
                    
    },
    TemplateURL = "https://s3.amazonaws.com/example/updated.template"
});

string stackId = response.StackId;

            

This example updates only the the specified parameter value for the specified stack. If you don't specify a parameter value, AWS CloudFormation uses the default value from the template.

To update an AWS CloudFormation stack


var response = client.UpdateStack(new UpdateStackRequest 
{
    NotificationARNs = new List {
                    
    },
    Parameters = new List {
        new Parameter {
            ParameterKey = "KeyPairName",
            ParameterValue = "ExampleKeyPair"
        },
        new Parameter {
            ParameterKey = "SubnetIDs",
            ParameterValue = "ExampleSubnetID1, ExampleSubnetID2"
        }
    },
    ResourceTypes = new List {
                    
    },
    StackName = "MyStack",
    Tags = new List {
                    
    },
    TemplateURL = "https://s3.amazonaws.com/example/updated.template"
});

string stackId = response.StackId;

            

This example adds two stack notification topics to the specified stack.

To update an AWS CloudFormation stack


var response = client.UpdateStack(new UpdateStackRequest 
{
    NotificationARNs = new List {
                    
    },
    Parameters = new List {
        new Parameter {
            ParameterKey = "KeyPairName",
            ParameterValue = "ExampleKeyPair"
        },
        new Parameter {
            ParameterKey = "SubnetIDs",
            ParameterValue = "ExampleSubnetID1, ExampleSubnetID2"
        }
    },
    ResourceTypes = new List {
                    
    },
    StackName = "MyStack",
    Tags = new List {
                    
    },
    TemplateURL = "https://s3.amazonaws.com/example/updated.template"
});

string stackId = response.StackId;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also