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

#include <UpdateStackInstancesRequest.h>

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

Public Member Functions

 UpdateStackInstancesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetStackSetName () const
 
bool StackSetNameHasBeenSet () const
 
void SetStackSetName (const Aws::String &value)
 
void SetStackSetName (Aws::String &&value)
 
void SetStackSetName (const char *value)
 
UpdateStackInstancesRequestWithStackSetName (const Aws::String &value)
 
UpdateStackInstancesRequestWithStackSetName (Aws::String &&value)
 
UpdateStackInstancesRequestWithStackSetName (const char *value)
 
const Aws::Vector< Aws::String > & GetAccounts () const
 
bool AccountsHasBeenSet () const
 
void SetAccounts (const Aws::Vector< Aws::String > &value)
 
void SetAccounts (Aws::Vector< Aws::String > &&value)
 
UpdateStackInstancesRequestWithAccounts (const Aws::Vector< Aws::String > &value)
 
UpdateStackInstancesRequestWithAccounts (Aws::Vector< Aws::String > &&value)
 
UpdateStackInstancesRequestAddAccounts (const Aws::String &value)
 
UpdateStackInstancesRequestAddAccounts (Aws::String &&value)
 
UpdateStackInstancesRequestAddAccounts (const char *value)
 
const DeploymentTargetsGetDeploymentTargets () const
 
bool DeploymentTargetsHasBeenSet () const
 
void SetDeploymentTargets (const DeploymentTargets &value)
 
void SetDeploymentTargets (DeploymentTargets &&value)
 
UpdateStackInstancesRequestWithDeploymentTargets (const DeploymentTargets &value)
 
UpdateStackInstancesRequestWithDeploymentTargets (DeploymentTargets &&value)
 
const Aws::Vector< Aws::String > & GetRegions () const
 
bool RegionsHasBeenSet () const
 
void SetRegions (const Aws::Vector< Aws::String > &value)
 
void SetRegions (Aws::Vector< Aws::String > &&value)
 
UpdateStackInstancesRequestWithRegions (const Aws::Vector< Aws::String > &value)
 
UpdateStackInstancesRequestWithRegions (Aws::Vector< Aws::String > &&value)
 
UpdateStackInstancesRequestAddRegions (const Aws::String &value)
 
UpdateStackInstancesRequestAddRegions (Aws::String &&value)
 
UpdateStackInstancesRequestAddRegions (const char *value)
 
const Aws::Vector< Parameter > & GetParameterOverrides () const
 
bool ParameterOverridesHasBeenSet () const
 
void SetParameterOverrides (const Aws::Vector< Parameter > &value)
 
void SetParameterOverrides (Aws::Vector< Parameter > &&value)
 
UpdateStackInstancesRequestWithParameterOverrides (const Aws::Vector< Parameter > &value)
 
UpdateStackInstancesRequestWithParameterOverrides (Aws::Vector< Parameter > &&value)
 
UpdateStackInstancesRequestAddParameterOverrides (const Parameter &value)
 
UpdateStackInstancesRequestAddParameterOverrides (Parameter &&value)
 
const StackSetOperationPreferencesGetOperationPreferences () const
 
bool OperationPreferencesHasBeenSet () const
 
void SetOperationPreferences (const StackSetOperationPreferences &value)
 
void SetOperationPreferences (StackSetOperationPreferences &&value)
 
UpdateStackInstancesRequestWithOperationPreferences (const StackSetOperationPreferences &value)
 
UpdateStackInstancesRequestWithOperationPreferences (StackSetOperationPreferences &&value)
 
const Aws::StringGetOperationId () const
 
bool OperationIdHasBeenSet () const
 
void SetOperationId (const Aws::String &value)
 
void SetOperationId (Aws::String &&value)
 
void SetOperationId (const char *value)
 
UpdateStackInstancesRequestWithOperationId (const Aws::String &value)
 
UpdateStackInstancesRequestWithOperationId (Aws::String &&value)
 
UpdateStackInstancesRequestWithOperationId (const char *value)
 
const CallAsGetCallAs () const
 
bool CallAsHasBeenSet () const
 
void SetCallAs (const CallAs &value)
 
void SetCallAs (CallAs &&value)
 
UpdateStackInstancesRequestWithCallAs (const CallAs &value)
 
UpdateStackInstancesRequestWithCallAs (CallAs &&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

Definition at line 27 of file UpdateStackInstancesRequest.h.

Constructor & Destructor Documentation

◆ UpdateStackInstancesRequest()

Aws::CloudFormation::Model::UpdateStackInstancesRequest::UpdateStackInstancesRequest ( )

Member Function Documentation

◆ AccountsHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackInstancesRequest::AccountsHasBeenSet ( ) const
inline

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 110 of file UpdateStackInstancesRequest.h.

◆ AddAccounts() [1/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::AddAccounts ( Aws::String &&  value)
inline

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 164 of file UpdateStackInstancesRequest.h.

◆ AddAccounts() [2/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::AddAccounts ( const Aws::String value)
inline

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 155 of file UpdateStackInstancesRequest.h.

◆ AddAccounts() [3/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::AddAccounts ( const char *  value)
inline

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 173 of file UpdateStackInstancesRequest.h.

◆ AddParameterOverrides() [1/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::AddParameterOverrides ( const Parameter value)
inline

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.

  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Definition at line 495 of file UpdateStackInstancesRequest.h.

◆ AddParameterOverrides() [2/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::AddParameterOverrides ( Parameter &&  value)
inline

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.

  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Definition at line 523 of file UpdateStackInstancesRequest.h.

◆ AddRegions() [1/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::AddRegions ( Aws::String &&  value)
inline

The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

Definition at line 291 of file UpdateStackInstancesRequest.h.

◆ AddRegions() [2/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::AddRegions ( const Aws::String value)
inline

The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

Definition at line 284 of file UpdateStackInstancesRequest.h.

◆ AddRegions() [3/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::AddRegions ( const char *  value)
inline

The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

Definition at line 298 of file UpdateStackInstancesRequest.h.

◆ CallAsHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackInstancesRequest::CallAsHasBeenSet ( ) const
inline

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Definition at line 668 of file UpdateStackInstancesRequest.h.

◆ DeploymentTargetsHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackInstancesRequest::DeploymentTargetsHasBeenSet ( ) const
inline

[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 194 of file UpdateStackInstancesRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::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.

◆ GetAccounts()

const Aws::Vector<Aws::String>& Aws::CloudFormation::Model::UpdateStackInstancesRequest::GetAccounts ( ) const
inline

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 101 of file UpdateStackInstancesRequest.h.

◆ GetCallAs()

const CallAs& Aws::CloudFormation::Model::UpdateStackInstancesRequest::GetCallAs ( ) const
inline

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Definition at line 652 of file UpdateStackInstancesRequest.h.

◆ GetDeploymentTargets()

const DeploymentTargets& Aws::CloudFormation::Model::UpdateStackInstancesRequest::GetDeploymentTargets ( ) const
inline

[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 184 of file UpdateStackInstancesRequest.h.

◆ GetOperationId()

const Aws::String& Aws::CloudFormation::Model::UpdateStackInstancesRequest::GetOperationId ( ) const
inline

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Definition at line 565 of file UpdateStackInstancesRequest.h.

◆ GetOperationPreferences()

const StackSetOperationPreferences& Aws::CloudFormation::Model::UpdateStackInstancesRequest::GetOperationPreferences ( ) const
inline

Preferences for how CloudFormation performs this stack set operation.

Definition at line 529 of file UpdateStackInstancesRequest.h.

◆ GetParameterOverrides()

const Aws::Vector<Parameter>& Aws::CloudFormation::Model::UpdateStackInstancesRequest::GetParameterOverrides ( ) const
inline

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.

  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Definition at line 327 of file UpdateStackInstancesRequest.h.

◆ GetRegions()

const Aws::Vector<Aws::String>& Aws::CloudFormation::Model::UpdateStackInstancesRequest::GetRegions ( ) const
inline

The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

Definition at line 242 of file UpdateStackInstancesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file UpdateStackInstancesRequest.h.

◆ GetStackSetName()

const Aws::String& Aws::CloudFormation::Model::UpdateStackInstancesRequest::GetStackSetName ( ) const
inline

The name or unique ID of the stack set associated with the stack instances.

Definition at line 49 of file UpdateStackInstancesRequest.h.

◆ OperationIdHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackInstancesRequest::OperationIdHasBeenSet ( ) const
inline

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Definition at line 575 of file UpdateStackInstancesRequest.h.

◆ OperationPreferencesHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackInstancesRequest::OperationPreferencesHasBeenSet ( ) const
inline

Preferences for how CloudFormation performs this stack set operation.

Definition at line 534 of file UpdateStackInstancesRequest.h.

◆ ParameterOverridesHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackInstancesRequest::ParameterOverridesHasBeenSet ( ) const
inline

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.

  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Definition at line 355 of file UpdateStackInstancesRequest.h.

◆ RegionsHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackInstancesRequest::RegionsHasBeenSet ( ) const
inline

The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

Definition at line 249 of file UpdateStackInstancesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccounts() [1/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetAccounts ( Aws::Vector< Aws::String > &&  value)
inline

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 128 of file UpdateStackInstancesRequest.h.

◆ SetAccounts() [2/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetAccounts ( const Aws::Vector< Aws::String > &  value)
inline

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 119 of file UpdateStackInstancesRequest.h.

◆ SetCallAs() [1/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetCallAs ( CallAs &&  value)
inline

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Definition at line 700 of file UpdateStackInstancesRequest.h.

◆ SetCallAs() [2/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetCallAs ( const CallAs value)
inline

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Definition at line 684 of file UpdateStackInstancesRequest.h.

◆ SetDeploymentTargets() [1/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetDeploymentTargets ( const DeploymentTargets value)
inline

[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 204 of file UpdateStackInstancesRequest.h.

◆ SetDeploymentTargets() [2/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetDeploymentTargets ( DeploymentTargets &&  value)
inline

[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 214 of file UpdateStackInstancesRequest.h.

◆ SetOperationId() [1/3]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetOperationId ( Aws::String &&  value)
inline

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Definition at line 595 of file UpdateStackInstancesRequest.h.

◆ SetOperationId() [2/3]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetOperationId ( const Aws::String value)
inline

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Definition at line 585 of file UpdateStackInstancesRequest.h.

◆ SetOperationId() [3/3]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetOperationId ( const char *  value)
inline

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Definition at line 605 of file UpdateStackInstancesRequest.h.

◆ SetOperationPreferences() [1/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetOperationPreferences ( const StackSetOperationPreferences value)
inline

Preferences for how CloudFormation performs this stack set operation.

Definition at line 539 of file UpdateStackInstancesRequest.h.

◆ SetOperationPreferences() [2/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetOperationPreferences ( StackSetOperationPreferences &&  value)
inline

Preferences for how CloudFormation performs this stack set operation.

Definition at line 544 of file UpdateStackInstancesRequest.h.

◆ SetParameterOverrides() [1/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetParameterOverrides ( Aws::Vector< Parameter > &&  value)
inline

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.

  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Definition at line 411 of file UpdateStackInstancesRequest.h.

◆ SetParameterOverrides() [2/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetParameterOverrides ( const Aws::Vector< Parameter > &  value)
inline

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.

  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Definition at line 383 of file UpdateStackInstancesRequest.h.

◆ SetRegions() [1/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetRegions ( Aws::Vector< Aws::String > &&  value)
inline

The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

Definition at line 263 of file UpdateStackInstancesRequest.h.

◆ SetRegions() [2/2]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetRegions ( const Aws::Vector< Aws::String > &  value)
inline

The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

Definition at line 256 of file UpdateStackInstancesRequest.h.

◆ SetStackSetName() [1/3]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetStackSetName ( Aws::String &&  value)
inline

The name or unique ID of the stack set associated with the stack instances.

Definition at line 67 of file UpdateStackInstancesRequest.h.

◆ SetStackSetName() [2/3]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetStackSetName ( const Aws::String value)
inline

The name or unique ID of the stack set associated with the stack instances.

Definition at line 61 of file UpdateStackInstancesRequest.h.

◆ SetStackSetName() [3/3]

void Aws::CloudFormation::Model::UpdateStackInstancesRequest::SetStackSetName ( const char *  value)
inline

The name or unique ID of the stack set associated with the stack instances.

Definition at line 73 of file UpdateStackInstancesRequest.h.

◆ StackSetNameHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackInstancesRequest::StackSetNameHasBeenSet ( ) const
inline

The name or unique ID of the stack set associated with the stack instances.

Definition at line 55 of file UpdateStackInstancesRequest.h.

◆ WithAccounts() [1/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithAccounts ( Aws::Vector< Aws::String > &&  value)
inline

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 146 of file UpdateStackInstancesRequest.h.

◆ WithAccounts() [2/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithAccounts ( const Aws::Vector< Aws::String > &  value)
inline

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 137 of file UpdateStackInstancesRequest.h.

◆ WithCallAs() [1/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithCallAs ( CallAs &&  value)
inline

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Definition at line 732 of file UpdateStackInstancesRequest.h.

◆ WithCallAs() [2/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithCallAs ( const CallAs value)
inline

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Definition at line 716 of file UpdateStackInstancesRequest.h.

◆ WithDeploymentTargets() [1/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithDeploymentTargets ( const DeploymentTargets value)
inline

[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 224 of file UpdateStackInstancesRequest.h.

◆ WithDeploymentTargets() [2/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithDeploymentTargets ( DeploymentTargets &&  value)
inline

[Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 234 of file UpdateStackInstancesRequest.h.

◆ WithOperationId() [1/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithOperationId ( Aws::String &&  value)
inline

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Definition at line 625 of file UpdateStackInstancesRequest.h.

◆ WithOperationId() [2/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithOperationId ( const Aws::String value)
inline

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Definition at line 615 of file UpdateStackInstancesRequest.h.

◆ WithOperationId() [3/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithOperationId ( const char *  value)
inline

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Definition at line 635 of file UpdateStackInstancesRequest.h.

◆ WithOperationPreferences() [1/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithOperationPreferences ( const StackSetOperationPreferences value)
inline

Preferences for how CloudFormation performs this stack set operation.

Definition at line 549 of file UpdateStackInstancesRequest.h.

◆ WithOperationPreferences() [2/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithOperationPreferences ( StackSetOperationPreferences &&  value)
inline

Preferences for how CloudFormation performs this stack set operation.

Definition at line 554 of file UpdateStackInstancesRequest.h.

◆ WithParameterOverrides() [1/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithParameterOverrides ( Aws::Vector< Parameter > &&  value)
inline

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.

  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Definition at line 467 of file UpdateStackInstancesRequest.h.

◆ WithParameterOverrides() [2/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithParameterOverrides ( const Aws::Vector< Parameter > &  value)
inline

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.

  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Definition at line 439 of file UpdateStackInstancesRequest.h.

◆ WithRegions() [1/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithRegions ( Aws::Vector< Aws::String > &&  value)
inline

The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

Definition at line 277 of file UpdateStackInstancesRequest.h.

◆ WithRegions() [2/2]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithRegions ( const Aws::Vector< Aws::String > &  value)
inline

The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.

Definition at line 270 of file UpdateStackInstancesRequest.h.

◆ WithStackSetName() [1/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithStackSetName ( Aws::String &&  value)
inline

The name or unique ID of the stack set associated with the stack instances.

Definition at line 85 of file UpdateStackInstancesRequest.h.

◆ WithStackSetName() [2/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithStackSetName ( const Aws::String value)
inline

The name or unique ID of the stack set associated with the stack instances.

Definition at line 79 of file UpdateStackInstancesRequest.h.

◆ WithStackSetName() [3/3]

UpdateStackInstancesRequest& Aws::CloudFormation::Model::UpdateStackInstancesRequest::WithStackSetName ( const char *  value)
inline

The name or unique ID of the stack set associated with the stack instances.

Definition at line 91 of file UpdateStackInstancesRequest.h.


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