AWS SDK for C++  1.9.105
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::CloudFormation::Model::UpdateStackRequest Class Reference

#include <UpdateStackRequest.h>

+ Inheritance diagram for Aws::CloudFormation::Model::UpdateStackRequest:

Public Member Functions

 UpdateStackRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetStackName () const
 
bool StackNameHasBeenSet () const
 
void SetStackName (const Aws::String &value)
 
void SetStackName (Aws::String &&value)
 
void SetStackName (const char *value)
 
UpdateStackRequestWithStackName (const Aws::String &value)
 
UpdateStackRequestWithStackName (Aws::String &&value)
 
UpdateStackRequestWithStackName (const char *value)
 
const Aws::StringGetTemplateBody () const
 
bool TemplateBodyHasBeenSet () const
 
void SetTemplateBody (const Aws::String &value)
 
void SetTemplateBody (Aws::String &&value)
 
void SetTemplateBody (const char *value)
 
UpdateStackRequestWithTemplateBody (const Aws::String &value)
 
UpdateStackRequestWithTemplateBody (Aws::String &&value)
 
UpdateStackRequestWithTemplateBody (const char *value)
 
const Aws::StringGetTemplateURL () const
 
bool TemplateURLHasBeenSet () const
 
void SetTemplateURL (const Aws::String &value)
 
void SetTemplateURL (Aws::String &&value)
 
void SetTemplateURL (const char *value)
 
UpdateStackRequestWithTemplateURL (const Aws::String &value)
 
UpdateStackRequestWithTemplateURL (Aws::String &&value)
 
UpdateStackRequestWithTemplateURL (const char *value)
 
bool GetUsePreviousTemplate () const
 
bool UsePreviousTemplateHasBeenSet () const
 
void SetUsePreviousTemplate (bool value)
 
UpdateStackRequestWithUsePreviousTemplate (bool value)
 
const Aws::StringGetStackPolicyDuringUpdateBody () const
 
bool StackPolicyDuringUpdateBodyHasBeenSet () const
 
void SetStackPolicyDuringUpdateBody (const Aws::String &value)
 
void SetStackPolicyDuringUpdateBody (Aws::String &&value)
 
void SetStackPolicyDuringUpdateBody (const char *value)
 
UpdateStackRequestWithStackPolicyDuringUpdateBody (const Aws::String &value)
 
UpdateStackRequestWithStackPolicyDuringUpdateBody (Aws::String &&value)
 
UpdateStackRequestWithStackPolicyDuringUpdateBody (const char *value)
 
const Aws::StringGetStackPolicyDuringUpdateURL () const
 
bool StackPolicyDuringUpdateURLHasBeenSet () const
 
void SetStackPolicyDuringUpdateURL (const Aws::String &value)
 
void SetStackPolicyDuringUpdateURL (Aws::String &&value)
 
void SetStackPolicyDuringUpdateURL (const char *value)
 
UpdateStackRequestWithStackPolicyDuringUpdateURL (const Aws::String &value)
 
UpdateStackRequestWithStackPolicyDuringUpdateURL (Aws::String &&value)
 
UpdateStackRequestWithStackPolicyDuringUpdateURL (const char *value)
 
const Aws::Vector< Parameter > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Vector< Parameter > &value)
 
void SetParameters (Aws::Vector< Parameter > &&value)
 
UpdateStackRequestWithParameters (const Aws::Vector< Parameter > &value)
 
UpdateStackRequestWithParameters (Aws::Vector< Parameter > &&value)
 
UpdateStackRequestAddParameters (const Parameter &value)
 
UpdateStackRequestAddParameters (Parameter &&value)
 
const Aws::Vector< Capability > & GetCapabilities () const
 
bool CapabilitiesHasBeenSet () const
 
void SetCapabilities (const Aws::Vector< Capability > &value)
 
void SetCapabilities (Aws::Vector< Capability > &&value)
 
UpdateStackRequestWithCapabilities (const Aws::Vector< Capability > &value)
 
UpdateStackRequestWithCapabilities (Aws::Vector< Capability > &&value)
 
UpdateStackRequestAddCapabilities (const Capability &value)
 
UpdateStackRequestAddCapabilities (Capability &&value)
 
const Aws::Vector< Aws::String > & GetResourceTypes () const
 
bool ResourceTypesHasBeenSet () const
 
void SetResourceTypes (const Aws::Vector< Aws::String > &value)
 
void SetResourceTypes (Aws::Vector< Aws::String > &&value)
 
UpdateStackRequestWithResourceTypes (const Aws::Vector< Aws::String > &value)
 
UpdateStackRequestWithResourceTypes (Aws::Vector< Aws::String > &&value)
 
UpdateStackRequestAddResourceTypes (const Aws::String &value)
 
UpdateStackRequestAddResourceTypes (Aws::String &&value)
 
UpdateStackRequestAddResourceTypes (const char *value)
 
const Aws::StringGetRoleARN () const
 
bool RoleARNHasBeenSet () const
 
void SetRoleARN (const Aws::String &value)
 
void SetRoleARN (Aws::String &&value)
 
void SetRoleARN (const char *value)
 
UpdateStackRequestWithRoleARN (const Aws::String &value)
 
UpdateStackRequestWithRoleARN (Aws::String &&value)
 
UpdateStackRequestWithRoleARN (const char *value)
 
const RollbackConfigurationGetRollbackConfiguration () const
 
bool RollbackConfigurationHasBeenSet () const
 
void SetRollbackConfiguration (const RollbackConfiguration &value)
 
void SetRollbackConfiguration (RollbackConfiguration &&value)
 
UpdateStackRequestWithRollbackConfiguration (const RollbackConfiguration &value)
 
UpdateStackRequestWithRollbackConfiguration (RollbackConfiguration &&value)
 
const Aws::StringGetStackPolicyBody () const
 
bool StackPolicyBodyHasBeenSet () const
 
void SetStackPolicyBody (const Aws::String &value)
 
void SetStackPolicyBody (Aws::String &&value)
 
void SetStackPolicyBody (const char *value)
 
UpdateStackRequestWithStackPolicyBody (const Aws::String &value)
 
UpdateStackRequestWithStackPolicyBody (Aws::String &&value)
 
UpdateStackRequestWithStackPolicyBody (const char *value)
 
const Aws::StringGetStackPolicyURL () const
 
bool StackPolicyURLHasBeenSet () const
 
void SetStackPolicyURL (const Aws::String &value)
 
void SetStackPolicyURL (Aws::String &&value)
 
void SetStackPolicyURL (const char *value)
 
UpdateStackRequestWithStackPolicyURL (const Aws::String &value)
 
UpdateStackRequestWithStackPolicyURL (Aws::String &&value)
 
UpdateStackRequestWithStackPolicyURL (const char *value)
 
const Aws::Vector< Aws::String > & GetNotificationARNs () const
 
bool NotificationARNsHasBeenSet () const
 
void SetNotificationARNs (const Aws::Vector< Aws::String > &value)
 
void SetNotificationARNs (Aws::Vector< Aws::String > &&value)
 
UpdateStackRequestWithNotificationARNs (const Aws::Vector< Aws::String > &value)
 
UpdateStackRequestWithNotificationARNs (Aws::Vector< Aws::String > &&value)
 
UpdateStackRequestAddNotificationARNs (const Aws::String &value)
 
UpdateStackRequestAddNotificationARNs (Aws::String &&value)
 
UpdateStackRequestAddNotificationARNs (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
UpdateStackRequestWithTags (const Aws::Vector< Tag > &value)
 
UpdateStackRequestWithTags (Aws::Vector< Tag > &&value)
 
UpdateStackRequestAddTags (const Tag &value)
 
UpdateStackRequestAddTags (Tag &&value)
 
bool GetDisableRollback () const
 
bool DisableRollbackHasBeenSet () const
 
void SetDisableRollback (bool value)
 
UpdateStackRequestWithDisableRollback (bool value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
UpdateStackRequestWithClientRequestToken (const Aws::String &value)
 
UpdateStackRequestWithClientRequestToken (Aws::String &&value)
 
UpdateStackRequestWithClientRequestToken (const char *value)
 
- Public Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual ~CloudFormationRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

The input for an UpdateStack action.

See Also:

AWS API Reference

Definition at line 29 of file UpdateStackRequest.h.

Constructor & Destructor Documentation

◆ UpdateStackRequest()

Aws::CloudFormation::Model::UpdateStackRequest::UpdateStackRequest ( )

Member Function Documentation

◆ AddCapabilities() [1/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddCapabilities ( Capability &&  value)
inline

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

    You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

    For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

Definition at line 1044 of file UpdateStackRequest.h.

◆ AddCapabilities() [2/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddCapabilities ( const Capability value)
inline

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

    You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

    For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

Definition at line 982 of file UpdateStackRequest.h.

◆ AddNotificationARNs() [1/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddNotificationARNs ( Aws::String &&  value)
inline

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

Definition at line 1540 of file UpdateStackRequest.h.

◆ AddNotificationARNs() [2/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddNotificationARNs ( const Aws::String value)
inline

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

Definition at line 1533 of file UpdateStackRequest.h.

◆ AddNotificationARNs() [3/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddNotificationARNs ( const char *  value)
inline

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

Definition at line 1547 of file UpdateStackRequest.h.

◆ AddParameters() [1/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddParameters ( const Parameter value)
inline

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

Definition at line 539 of file UpdateStackRequest.h.

◆ AddParameters() [2/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddParameters ( Parameter &&  value)
inline

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

Definition at line 547 of file UpdateStackRequest.h.

◆ AddResourceTypes() [1/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddResourceTypes ( Aws::String &&  value)
inline

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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

Definition at line 1157 of file UpdateStackRequest.h.

◆ AddResourceTypes() [2/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddResourceTypes ( const Aws::String value)
inline

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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

Definition at line 1143 of file UpdateStackRequest.h.

◆ AddResourceTypes() [3/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddResourceTypes ( const char *  value)
inline

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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

Definition at line 1171 of file UpdateStackRequest.h.

◆ AddTags() [1/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddTags ( const Tag value)
inline

Key-value pairs to associate with this stack. 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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

Definition at line 1611 of file UpdateStackRequest.h.

◆ AddTags() [2/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::AddTags ( Tag &&  value)
inline

Key-value pairs to associate with this stack. 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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

Definition at line 1620 of file UpdateStackRequest.h.

◆ CapabilitiesHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::CapabilitiesHasBeenSet ( ) const
inline

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

    You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

    For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

Definition at line 672 of file UpdateStackRequest.h.

◆ ClientRequestTokenHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::ClientRequestTokenHasBeenSet ( ) const
inline

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that 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.

Definition at line 1686 of file UpdateStackRequest.h.

◆ DisableRollbackHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::DisableRollbackHasBeenSet ( ) const
inline

Preserve the state of previously provisioned resources when an operation fails.

Default: False

Definition at line 1633 of file UpdateStackRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudFormation::Model::UpdateStackRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetCapabilities()

const Aws::Vector<Capability>& Aws::CloudFormation::Model::UpdateStackRequest::GetCapabilities ( ) const
inline

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

    You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

    For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

Definition at line 610 of file UpdateStackRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::CloudFormation::Model::UpdateStackRequest::GetClientRequestToken ( ) const
inline

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that 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.

Definition at line 1666 of file UpdateStackRequest.h.

◆ GetDisableRollback()

bool Aws::CloudFormation::Model::UpdateStackRequest::GetDisableRollback ( ) const
inline

Preserve the state of previously provisioned resources when an operation fails.

Default: False

Definition at line 1627 of file UpdateStackRequest.h.

◆ GetNotificationARNs()

const Aws::Vector<Aws::String>& Aws::CloudFormation::Model::UpdateStackRequest::GetNotificationARNs ( ) const
inline

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

Definition at line 1491 of file UpdateStackRequest.h.

◆ GetParameters()

const Aws::Vector<Parameter>& Aws::CloudFormation::Model::UpdateStackRequest::GetParameters ( ) const
inline

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

Definition at line 491 of file UpdateStackRequest.h.

◆ GetResourceTypes()

const Aws::Vector<Aws::String>& Aws::CloudFormation::Model::UpdateStackRequest::GetResourceTypes ( ) const
inline

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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

Definition at line 1059 of file UpdateStackRequest.h.

◆ GetRoleARN()

const Aws::String& Aws::CloudFormation::Model::UpdateStackRequest::GetRoleARN ( ) const
inline

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1185 of file UpdateStackRequest.h.

◆ GetRollbackConfiguration()

const RollbackConfiguration& Aws::CloudFormation::Model::UpdateStackRequest::GetRollbackConfiguration ( ) const
inline

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

Definition at line 1283 of file UpdateStackRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudFormation::Model::UpdateStackRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file UpdateStackRequest.h.

◆ GetStackName()

const Aws::String& Aws::CloudFormation::Model::UpdateStackRequest::GetStackName ( ) const
inline

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

Definition at line 50 of file UpdateStackRequest.h.

◆ GetStackPolicyBody()

const Aws::String& Aws::CloudFormation::Model::UpdateStackRequest::GetStackPolicyBody ( ) const
inline

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.

Definition at line 1324 of file UpdateStackRequest.h.

◆ GetStackPolicyDuringUpdateBody()

const Aws::String& Aws::CloudFormation::Model::UpdateStackRequest::GetStackPolicyDuringUpdateBody ( ) const
inline

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.

Definition at line 315 of file UpdateStackRequest.h.

◆ GetStackPolicyDuringUpdateURL()

const Aws::String& Aws::CloudFormation::Model::UpdateStackRequest::GetStackPolicyDuringUpdateURL ( ) const
inline

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.

Definition at line 398 of file UpdateStackRequest.h.

◆ GetStackPolicyURL()

const Aws::String& Aws::CloudFormation::Model::UpdateStackRequest::GetStackPolicyURL ( ) const
inline

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.

Definition at line 1406 of file UpdateStackRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::CloudFormation::Model::UpdateStackRequest::GetTags ( ) const
inline

Key-value pairs to associate with this stack. 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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

Definition at line 1557 of file UpdateStackRequest.h.

◆ GetTemplateBody()

const Aws::String& Aws::CloudFormation::Model::UpdateStackRequest::GetTemplateBody ( ) const
inline

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 CloudFormation User Guide.)

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

Definition at line 97 of file UpdateStackRequest.h.

◆ GetTemplateURL()

const Aws::String& Aws::CloudFormation::Model::UpdateStackRequest::GetTemplateURL ( ) const
inline

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

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

Definition at line 187 of file UpdateStackRequest.h.

◆ GetUsePreviousTemplate()

bool Aws::CloudFormation::Model::UpdateStackRequest::GetUsePreviousTemplate ( ) const
inline

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.

Definition at line 280 of file UpdateStackRequest.h.

◆ NotificationARNsHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::NotificationARNsHasBeenSet ( ) const
inline

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

Definition at line 1498 of file UpdateStackRequest.h.

◆ ParametersHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::ParametersHasBeenSet ( ) const
inline

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

Definition at line 499 of file UpdateStackRequest.h.

◆ ResourceTypesHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::ResourceTypesHasBeenSet ( ) const
inline

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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

Definition at line 1073 of file UpdateStackRequest.h.

◆ RoleARNHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::RoleARNHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1198 of file UpdateStackRequest.h.

◆ RollbackConfigurationHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::RollbackConfigurationHasBeenSet ( ) const
inline

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

Definition at line 1289 of file UpdateStackRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudFormation::Model::UpdateStackRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCapabilities() [1/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetCapabilities ( Aws::Vector< Capability > &&  value)
inline

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

    You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

    For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

Definition at line 796 of file UpdateStackRequest.h.

◆ SetCapabilities() [2/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetCapabilities ( const Aws::Vector< Capability > &  value)
inline

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

    You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

    For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

Definition at line 734 of file UpdateStackRequest.h.

◆ SetClientRequestToken() [1/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetClientRequestToken ( Aws::String &&  value)
inline

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that 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.

Definition at line 1726 of file UpdateStackRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetClientRequestToken ( const Aws::String value)
inline

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that 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.

Definition at line 1706 of file UpdateStackRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetClientRequestToken ( const char *  value)
inline

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that 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.

Definition at line 1746 of file UpdateStackRequest.h.

◆ SetDisableRollback()

void Aws::CloudFormation::Model::UpdateStackRequest::SetDisableRollback ( bool  value)
inline

Preserve the state of previously provisioned resources when an operation fails.

Default: False

Definition at line 1639 of file UpdateStackRequest.h.

◆ SetNotificationARNs() [1/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetNotificationARNs ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 1512 of file UpdateStackRequest.h.

◆ SetNotificationARNs() [2/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetNotificationARNs ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 1505 of file UpdateStackRequest.h.

◆ SetParameters() [1/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetParameters ( Aws::Vector< Parameter > &&  value)
inline

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

Definition at line 515 of file UpdateStackRequest.h.

◆ SetParameters() [2/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetParameters ( const Aws::Vector< Parameter > &  value)
inline

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

Definition at line 507 of file UpdateStackRequest.h.

◆ SetResourceTypes() [1/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetResourceTypes ( Aws::Vector< Aws::String > &&  value)
inline

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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

Definition at line 1101 of file UpdateStackRequest.h.

◆ SetResourceTypes() [2/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetResourceTypes ( const Aws::Vector< Aws::String > &  value)
inline

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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

Definition at line 1087 of file UpdateStackRequest.h.

◆ SetRoleARN() [1/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetRoleARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1224 of file UpdateStackRequest.h.

◆ SetRoleARN() [2/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetRoleARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1211 of file UpdateStackRequest.h.

◆ SetRoleARN() [3/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetRoleARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1237 of file UpdateStackRequest.h.

◆ SetRollbackConfiguration() [1/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetRollbackConfiguration ( const RollbackConfiguration value)
inline

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

Definition at line 1295 of file UpdateStackRequest.h.

◆ SetRollbackConfiguration() [2/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetRollbackConfiguration ( RollbackConfiguration &&  value)
inline

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

Definition at line 1301 of file UpdateStackRequest.h.

◆ SetStackName() [1/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackName ( Aws::String &&  value)
inline

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

Definition at line 65 of file UpdateStackRequest.h.

◆ SetStackName() [2/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackName ( const Aws::String value)
inline

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

Definition at line 60 of file UpdateStackRequest.h.

◆ SetStackName() [3/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackName ( const char *  value)
inline

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

Definition at line 70 of file UpdateStackRequest.h.

◆ SetStackPolicyBody() [1/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyBody ( Aws::String &&  value)
inline

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.

Definition at line 1354 of file UpdateStackRequest.h.

◆ SetStackPolicyBody() [2/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyBody ( const Aws::String value)
inline

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.

Definition at line 1344 of file UpdateStackRequest.h.

◆ SetStackPolicyBody() [3/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyBody ( const char *  value)
inline

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.

Definition at line 1364 of file UpdateStackRequest.h.

◆ SetStackPolicyDuringUpdateBody() [1/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyDuringUpdateBody ( Aws::String &&  value)
inline

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.

Definition at line 345 of file UpdateStackRequest.h.

◆ SetStackPolicyDuringUpdateBody() [2/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyDuringUpdateBody ( const Aws::String value)
inline

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.

Definition at line 335 of file UpdateStackRequest.h.

◆ SetStackPolicyDuringUpdateBody() [3/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyDuringUpdateBody ( const char *  value)
inline

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.

Definition at line 355 of file UpdateStackRequest.h.

◆ SetStackPolicyDuringUpdateURL() [1/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyDuringUpdateURL ( Aws::String &&  value)
inline

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.

Definition at line 434 of file UpdateStackRequest.h.

◆ SetStackPolicyDuringUpdateURL() [2/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyDuringUpdateURL ( const Aws::String value)
inline

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.

Definition at line 422 of file UpdateStackRequest.h.

◆ SetStackPolicyDuringUpdateURL() [3/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyDuringUpdateURL ( const char *  value)
inline

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.

Definition at line 446 of file UpdateStackRequest.h.

◆ SetStackPolicyURL() [1/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyURL ( Aws::String &&  value)
inline

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.

Definition at line 1439 of file UpdateStackRequest.h.

◆ SetStackPolicyURL() [2/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyURL ( const Aws::String value)
inline

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.

Definition at line 1428 of file UpdateStackRequest.h.

◆ SetStackPolicyURL() [3/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetStackPolicyURL ( const char *  value)
inline

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.

Definition at line 1450 of file UpdateStackRequest.h.

◆ SetTags() [1/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Key-value pairs to associate with this stack. 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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

Definition at line 1584 of file UpdateStackRequest.h.

◆ SetTags() [2/2]

void Aws::CloudFormation::Model::UpdateStackRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Key-value pairs to associate with this stack. 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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

Definition at line 1575 of file UpdateStackRequest.h.

◆ SetTemplateBody() [1/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetTemplateBody ( Aws::String &&  value)
inline

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 CloudFormation User Guide.)

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

Definition at line 130 of file UpdateStackRequest.h.

◆ SetTemplateBody() [2/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetTemplateBody ( const Aws::String value)
inline

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 CloudFormation User Guide.)

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

Definition at line 119 of file UpdateStackRequest.h.

◆ SetTemplateBody() [3/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetTemplateBody ( const char *  value)
inline

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 CloudFormation User Guide.)

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

Definition at line 141 of file UpdateStackRequest.h.

◆ SetTemplateURL() [1/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetTemplateURL ( Aws::String &&  value)
inline

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

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

Definition at line 223 of file UpdateStackRequest.h.

◆ SetTemplateURL() [2/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetTemplateURL ( const Aws::String value)
inline

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

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

Definition at line 211 of file UpdateStackRequest.h.

◆ SetTemplateURL() [3/3]

void Aws::CloudFormation::Model::UpdateStackRequest::SetTemplateURL ( const char *  value)
inline

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

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

Definition at line 235 of file UpdateStackRequest.h.

◆ SetUsePreviousTemplate()

void Aws::CloudFormation::Model::UpdateStackRequest::SetUsePreviousTemplate ( bool  value)
inline

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.

Definition at line 296 of file UpdateStackRequest.h.

◆ StackNameHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::StackNameHasBeenSet ( ) const
inline

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

Definition at line 55 of file UpdateStackRequest.h.

◆ StackPolicyBodyHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::StackPolicyBodyHasBeenSet ( ) const
inline

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.

Definition at line 1334 of file UpdateStackRequest.h.

◆ StackPolicyDuringUpdateBodyHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::StackPolicyDuringUpdateBodyHasBeenSet ( ) const
inline

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.

Definition at line 325 of file UpdateStackRequest.h.

◆ StackPolicyDuringUpdateURLHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::StackPolicyDuringUpdateURLHasBeenSet ( ) const
inline

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.

Definition at line 410 of file UpdateStackRequest.h.

◆ StackPolicyURLHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::StackPolicyURLHasBeenSet ( ) const
inline

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.

Definition at line 1417 of file UpdateStackRequest.h.

◆ TagsHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::TagsHasBeenSet ( ) const
inline

Key-value pairs to associate with this stack. 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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

Definition at line 1566 of file UpdateStackRequest.h.

◆ TemplateBodyHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::TemplateBodyHasBeenSet ( ) const
inline

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 CloudFormation User Guide.)

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

Definition at line 108 of file UpdateStackRequest.h.

◆ TemplateURLHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::TemplateURLHasBeenSet ( ) const
inline

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

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

Definition at line 199 of file UpdateStackRequest.h.

◆ UsePreviousTemplateHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackRequest::UsePreviousTemplateHasBeenSet ( ) const
inline

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.

Definition at line 288 of file UpdateStackRequest.h.

◆ WithCapabilities() [1/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithCapabilities ( Aws::Vector< Capability > &&  value)
inline

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

    You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

    For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

Definition at line 920 of file UpdateStackRequest.h.

◆ WithCapabilities() [2/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithCapabilities ( const Aws::Vector< Capability > &  value)
inline

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • 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 either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

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

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

    You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

    For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

Definition at line 858 of file UpdateStackRequest.h.

◆ WithClientRequestToken() [1/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithClientRequestToken ( Aws::String &&  value)
inline

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that 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.

Definition at line 1786 of file UpdateStackRequest.h.

◆ WithClientRequestToken() [2/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithClientRequestToken ( const Aws::String value)
inline

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that 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.

Definition at line 1766 of file UpdateStackRequest.h.

◆ WithClientRequestToken() [3/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithClientRequestToken ( const char *  value)
inline

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that 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.

Definition at line 1806 of file UpdateStackRequest.h.

◆ WithDisableRollback()

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithDisableRollback ( bool  value)
inline

Preserve the state of previously provisioned resources when an operation fails.

Default: False

Definition at line 1645 of file UpdateStackRequest.h.

◆ WithNotificationARNs() [1/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithNotificationARNs ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 1526 of file UpdateStackRequest.h.

◆ WithNotificationARNs() [2/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithNotificationARNs ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 1519 of file UpdateStackRequest.h.

◆ WithParameters() [1/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithParameters ( Aws::Vector< Parameter > &&  value)
inline

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

Definition at line 531 of file UpdateStackRequest.h.

◆ WithParameters() [2/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithParameters ( const Aws::Vector< Parameter > &  value)
inline

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

Definition at line 523 of file UpdateStackRequest.h.

◆ WithResourceTypes() [1/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithResourceTypes ( Aws::Vector< Aws::String > &&  value)
inline

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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

Definition at line 1129 of file UpdateStackRequest.h.

◆ WithResourceTypes() [2/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithResourceTypes ( const Aws::Vector< Aws::String > &  value)
inline

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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

Definition at line 1115 of file UpdateStackRequest.h.

◆ WithRoleARN() [1/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithRoleARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1263 of file UpdateStackRequest.h.

◆ WithRoleARN() [2/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithRoleARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1250 of file UpdateStackRequest.h.

◆ WithRoleARN() [3/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithRoleARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1276 of file UpdateStackRequest.h.

◆ WithRollbackConfiguration() [1/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithRollbackConfiguration ( const RollbackConfiguration value)
inline

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

Definition at line 1307 of file UpdateStackRequest.h.

◆ WithRollbackConfiguration() [2/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithRollbackConfiguration ( RollbackConfiguration &&  value)
inline

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

Definition at line 1313 of file UpdateStackRequest.h.

◆ WithStackName() [1/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackName ( Aws::String &&  value)
inline

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

Definition at line 80 of file UpdateStackRequest.h.

◆ WithStackName() [2/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackName ( const Aws::String value)
inline

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

Definition at line 75 of file UpdateStackRequest.h.

◆ WithStackName() [3/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackName ( const char *  value)
inline

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

Definition at line 85 of file UpdateStackRequest.h.

◆ WithStackPolicyBody() [1/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyBody ( Aws::String &&  value)
inline

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.

Definition at line 1384 of file UpdateStackRequest.h.

◆ WithStackPolicyBody() [2/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyBody ( const Aws::String value)
inline

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.

Definition at line 1374 of file UpdateStackRequest.h.

◆ WithStackPolicyBody() [3/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyBody ( const char *  value)
inline

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.

Definition at line 1394 of file UpdateStackRequest.h.

◆ WithStackPolicyDuringUpdateBody() [1/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyDuringUpdateBody ( Aws::String &&  value)
inline

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.

Definition at line 375 of file UpdateStackRequest.h.

◆ WithStackPolicyDuringUpdateBody() [2/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyDuringUpdateBody ( const Aws::String value)
inline

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.

Definition at line 365 of file UpdateStackRequest.h.

◆ WithStackPolicyDuringUpdateBody() [3/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyDuringUpdateBody ( const char *  value)
inline

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.

Definition at line 385 of file UpdateStackRequest.h.

◆ WithStackPolicyDuringUpdateURL() [1/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyDuringUpdateURL ( Aws::String &&  value)
inline

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.

Definition at line 470 of file UpdateStackRequest.h.

◆ WithStackPolicyDuringUpdateURL() [2/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyDuringUpdateURL ( const Aws::String value)
inline

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.

Definition at line 458 of file UpdateStackRequest.h.

◆ WithStackPolicyDuringUpdateURL() [3/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyDuringUpdateURL ( const char *  value)
inline

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.

Definition at line 482 of file UpdateStackRequest.h.

◆ WithStackPolicyURL() [1/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyURL ( Aws::String &&  value)
inline

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.

Definition at line 1472 of file UpdateStackRequest.h.

◆ WithStackPolicyURL() [2/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyURL ( const Aws::String value)
inline

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.

Definition at line 1461 of file UpdateStackRequest.h.

◆ WithStackPolicyURL() [3/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithStackPolicyURL ( const char *  value)
inline

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.

Definition at line 1483 of file UpdateStackRequest.h.

◆ WithTags() [1/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Key-value pairs to associate with this stack. 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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

Definition at line 1602 of file UpdateStackRequest.h.

◆ WithTags() [2/2]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Key-value pairs to associate with this stack. 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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.

Definition at line 1593 of file UpdateStackRequest.h.

◆ WithTemplateBody() [1/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithTemplateBody ( Aws::String &&  value)
inline

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 CloudFormation User Guide.)

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

Definition at line 163 of file UpdateStackRequest.h.

◆ WithTemplateBody() [2/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithTemplateBody ( const Aws::String value)
inline

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 CloudFormation User Guide.)

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

Definition at line 152 of file UpdateStackRequest.h.

◆ WithTemplateBody() [3/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithTemplateBody ( const char *  value)
inline

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 CloudFormation User Guide.)

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

Definition at line 174 of file UpdateStackRequest.h.

◆ WithTemplateURL() [1/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithTemplateURL ( Aws::String &&  value)
inline

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

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

Definition at line 259 of file UpdateStackRequest.h.

◆ WithTemplateURL() [2/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithTemplateURL ( const Aws::String value)
inline

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

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

Definition at line 247 of file UpdateStackRequest.h.

◆ WithTemplateURL() [3/3]

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithTemplateURL ( const char *  value)
inline

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.

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

Definition at line 271 of file UpdateStackRequest.h.

◆ WithUsePreviousTemplate()

UpdateStackRequest& Aws::CloudFormation::Model::UpdateStackRequest::WithUsePreviousTemplate ( bool  value)
inline

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.

Definition at line 304 of file UpdateStackRequest.h.


The documentation for this class was generated from the following file: