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.

The input for UpdateStack action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudFormation.AmazonCloudFormationRequest
      Amazon.CloudFormation.Model.UpdateStackRequest

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

Syntax

C#
public class UpdateStackRequest : AmazonCloudFormationRequest
         IAmazonWebServiceRequest

The UpdateStackRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateStackRequest()

Default Constructor

Properties

NameTypeDescription
Public Property Capabilities System.Collections.Generic.List<System.String>

Gets and sets the property Capabilities.

A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: 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 all permissions associated with them and edit their permissions if necessary.

If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Public Property ClientRequestToken System.String

Gets and sets the property ClientRequestToken.

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS CloudFormation successfully received them.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

Public Property NotificationARNs System.Collections.Generic.List<System.String>

Gets and sets the property NotificationARNs.

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.

Public Property Parameters System.Collections.Generic.List<Amazon.CloudFormation.Model.Parameter>

Gets and sets the property Parameters.

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

Public Property ResourceTypes System.Collections.Generic.List<System.String>

Gets and sets the property ResourceTypes.

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.

Public Property RoleARN System.String

Gets and sets the property RoleARN.

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

Public Property RollbackConfiguration Amazon.CloudFormation.Model.RollbackConfiguration

Gets and sets the property RollbackConfiguration.

The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Public Property StackName System.String

Gets and sets the property StackName.

The name or unique stack ID of the stack to update.

Public Property StackPolicyBody System.String

Gets and sets the property StackPolicyBody.

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.

Public Property StackPolicyDuringUpdateBody System.String

Gets and sets the property StackPolicyDuringUpdateBody.

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.

Public Property StackPolicyDuringUpdateURL System.String

Gets and sets the property StackPolicyDuringUpdateURL.

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.

Public Property StackPolicyURL System.String

Gets and sets the property StackPolicyURL.

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.

Public Property Tags System.Collections.Generic.List<Amazon.CloudFormation.Model.Tag>

Gets and sets the property Tags.

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.

If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.

Public Property TemplateBody System.String

Gets and sets the property TemplateBody.

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 only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

Public Property TemplateURL System.String

Gets and sets the property TemplateURL.

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 only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

Public Property UsePreviousTemplate System.Boolean

Gets and sets the property UsePreviousTemplate.

Reuse the existing template that is associated with the stack that you are updating.

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

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 Standard:
Supported in: 1.3

.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