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

#include <UpdateStackSetRequest.h>

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

Public Member Functions

 UpdateStackSetRequest ()
 
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)
 
UpdateStackSetRequestWithStackSetName (const Aws::String &value)
 
UpdateStackSetRequestWithStackSetName (Aws::String &&value)
 
UpdateStackSetRequestWithStackSetName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UpdateStackSetRequestWithDescription (const Aws::String &value)
 
UpdateStackSetRequestWithDescription (Aws::String &&value)
 
UpdateStackSetRequestWithDescription (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)
 
UpdateStackSetRequestWithTemplateBody (const Aws::String &value)
 
UpdateStackSetRequestWithTemplateBody (Aws::String &&value)
 
UpdateStackSetRequestWithTemplateBody (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)
 
UpdateStackSetRequestWithTemplateURL (const Aws::String &value)
 
UpdateStackSetRequestWithTemplateURL (Aws::String &&value)
 
UpdateStackSetRequestWithTemplateURL (const char *value)
 
bool GetUsePreviousTemplate () const
 
bool UsePreviousTemplateHasBeenSet () const
 
void SetUsePreviousTemplate (bool value)
 
UpdateStackSetRequestWithUsePreviousTemplate (bool value)
 
const Aws::Vector< Parameter > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Vector< Parameter > &value)
 
void SetParameters (Aws::Vector< Parameter > &&value)
 
UpdateStackSetRequestWithParameters (const Aws::Vector< Parameter > &value)
 
UpdateStackSetRequestWithParameters (Aws::Vector< Parameter > &&value)
 
UpdateStackSetRequestAddParameters (const Parameter &value)
 
UpdateStackSetRequestAddParameters (Parameter &&value)
 
const Aws::Vector< Capability > & GetCapabilities () const
 
bool CapabilitiesHasBeenSet () const
 
void SetCapabilities (const Aws::Vector< Capability > &value)
 
void SetCapabilities (Aws::Vector< Capability > &&value)
 
UpdateStackSetRequestWithCapabilities (const Aws::Vector< Capability > &value)
 
UpdateStackSetRequestWithCapabilities (Aws::Vector< Capability > &&value)
 
UpdateStackSetRequestAddCapabilities (const Capability &value)
 
UpdateStackSetRequestAddCapabilities (Capability &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
UpdateStackSetRequestWithTags (const Aws::Vector< Tag > &value)
 
UpdateStackSetRequestWithTags (Aws::Vector< Tag > &&value)
 
UpdateStackSetRequestAddTags (const Tag &value)
 
UpdateStackSetRequestAddTags (Tag &&value)
 
const StackSetOperationPreferencesGetOperationPreferences () const
 
bool OperationPreferencesHasBeenSet () const
 
void SetOperationPreferences (const StackSetOperationPreferences &value)
 
void SetOperationPreferences (StackSetOperationPreferences &&value)
 
UpdateStackSetRequestWithOperationPreferences (const StackSetOperationPreferences &value)
 
UpdateStackSetRequestWithOperationPreferences (StackSetOperationPreferences &&value)
 
const Aws::StringGetAdministrationRoleARN () const
 
bool AdministrationRoleARNHasBeenSet () const
 
void SetAdministrationRoleARN (const Aws::String &value)
 
void SetAdministrationRoleARN (Aws::String &&value)
 
void SetAdministrationRoleARN (const char *value)
 
UpdateStackSetRequestWithAdministrationRoleARN (const Aws::String &value)
 
UpdateStackSetRequestWithAdministrationRoleARN (Aws::String &&value)
 
UpdateStackSetRequestWithAdministrationRoleARN (const char *value)
 
const Aws::StringGetExecutionRoleName () const
 
bool ExecutionRoleNameHasBeenSet () const
 
void SetExecutionRoleName (const Aws::String &value)
 
void SetExecutionRoleName (Aws::String &&value)
 
void SetExecutionRoleName (const char *value)
 
UpdateStackSetRequestWithExecutionRoleName (const Aws::String &value)
 
UpdateStackSetRequestWithExecutionRoleName (Aws::String &&value)
 
UpdateStackSetRequestWithExecutionRoleName (const char *value)
 
const DeploymentTargetsGetDeploymentTargets () const
 
bool DeploymentTargetsHasBeenSet () const
 
void SetDeploymentTargets (const DeploymentTargets &value)
 
void SetDeploymentTargets (DeploymentTargets &&value)
 
UpdateStackSetRequestWithDeploymentTargets (const DeploymentTargets &value)
 
UpdateStackSetRequestWithDeploymentTargets (DeploymentTargets &&value)
 
const PermissionModelsGetPermissionModel () const
 
bool PermissionModelHasBeenSet () const
 
void SetPermissionModel (const PermissionModels &value)
 
void SetPermissionModel (PermissionModels &&value)
 
UpdateStackSetRequestWithPermissionModel (const PermissionModels &value)
 
UpdateStackSetRequestWithPermissionModel (PermissionModels &&value)
 
const AutoDeploymentGetAutoDeployment () const
 
bool AutoDeploymentHasBeenSet () const
 
void SetAutoDeployment (const AutoDeployment &value)
 
void SetAutoDeployment (AutoDeployment &&value)
 
UpdateStackSetRequestWithAutoDeployment (const AutoDeployment &value)
 
UpdateStackSetRequestWithAutoDeployment (AutoDeployment &&value)
 
const Aws::StringGetOperationId () const
 
bool OperationIdHasBeenSet () const
 
void SetOperationId (const Aws::String &value)
 
void SetOperationId (Aws::String &&value)
 
void SetOperationId (const char *value)
 
UpdateStackSetRequestWithOperationId (const Aws::String &value)
 
UpdateStackSetRequestWithOperationId (Aws::String &&value)
 
UpdateStackSetRequestWithOperationId (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)
 
UpdateStackSetRequestWithAccounts (const Aws::Vector< Aws::String > &value)
 
UpdateStackSetRequestWithAccounts (Aws::Vector< Aws::String > &&value)
 
UpdateStackSetRequestAddAccounts (const Aws::String &value)
 
UpdateStackSetRequestAddAccounts (Aws::String &&value)
 
UpdateStackSetRequestAddAccounts (const char *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)
 
UpdateStackSetRequestWithRegions (const Aws::Vector< Aws::String > &value)
 
UpdateStackSetRequestWithRegions (Aws::Vector< Aws::String > &&value)
 
UpdateStackSetRequestAddRegions (const Aws::String &value)
 
UpdateStackSetRequestAddRegions (Aws::String &&value)
 
UpdateStackSetRequestAddRegions (const char *value)
 
const CallAsGetCallAs () const
 
bool CallAsHasBeenSet () const
 
void SetCallAs (const CallAs &value)
 
void SetCallAs (CallAs &&value)
 
UpdateStackSetRequestWithCallAs (const CallAs &value)
 
UpdateStackSetRequestWithCallAs (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 31 of file UpdateStackSetRequest.h.

Constructor & Destructor Documentation

◆ UpdateStackSetRequest()

Aws::CloudFormation::Model::UpdateStackSetRequest::UpdateStackSetRequest ( )

Member Function Documentation

◆ AccountsHasBeenSet()

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

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1640 of file UpdateStackSetRequest.h.

◆ AddAccounts() [1/3]

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

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1742 of file UpdateStackSetRequest.h.

◆ AddAccounts() [2/3]

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

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1725 of file UpdateStackSetRequest.h.

◆ AddAccounts() [3/3]

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

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1759 of file UpdateStackSetRequest.h.

◆ AddCapabilities() [1/2]

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

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, 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, AWS 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 AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

Definition at line 813 of file UpdateStackSetRequest.h.

◆ AddCapabilities() [2/2]

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

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, 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, AWS 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 AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

Definition at line 758 of file UpdateStackSetRequest.h.

◆ AddParameters() [1/2]

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

A list of input parameters for the stack set template.

Definition at line 367 of file UpdateStackSetRequest.h.

◆ AddParameters() [2/2]

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

A list of input parameters for the stack set template.

Definition at line 372 of file UpdateStackSetRequest.h.

◆ AddRegions() [1/3]

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

The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1896 of file UpdateStackSetRequest.h.

◆ AddRegions() [2/3]

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

The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1879 of file UpdateStackSetRequest.h.

◆ AddRegions() [3/3]

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

The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1913 of file UpdateStackSetRequest.h.

◆ AddTags() [1/2]

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

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

  • If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.

  • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

  • If you specify an empty value, AWS CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

Definition at line 989 of file UpdateStackSetRequest.h.

◆ AddTags() [2/2]

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

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

  • If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.

  • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

  • If you specify an empty value, AWS CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

Definition at line 1014 of file UpdateStackSetRequest.h.

◆ AdministrationRoleARNHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackSetRequest::AdministrationRoleARNHasBeenSet ( ) const
inline

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

Definition at line 1074 of file UpdateStackSetRequest.h.

◆ AutoDeploymentHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackSetRequest::AutoDeploymentHasBeenSet ( ) const
inline

[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

If you specify AutoDeployment, do not specify DeploymentTargets or Regions.

Definition at line 1476 of file UpdateStackSetRequest.h.

◆ CallAsHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackSetRequest::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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

Definition at line 1946 of file UpdateStackSetRequest.h.

◆ CapabilitiesHasBeenSet()

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

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, 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, AWS 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 AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

Definition at line 483 of file UpdateStackSetRequest.h.

◆ DeploymentTargetsHasBeenSet()

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

[Service-managed permissions] The AWS Organizations accounts in which to update associated stack instances.

To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1302 of file UpdateStackSetRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackSetRequest::DescriptionHasBeenSet ( ) const
inline

A brief description of updates that you are making.

Definition at line 98 of file UpdateStackSetRequest.h.

◆ DumpBodyToUrl()

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

◆ ExecutionRoleNameHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackSetRequest::ExecutionRoleNameHasBeenSet ( ) const
inline

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

Definition at line 1187 of file UpdateStackSetRequest.h.

◆ GetAccounts()

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

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1623 of file UpdateStackSetRequest.h.

◆ GetAdministrationRoleARN()

const Aws::String& Aws::CloudFormation::Model::UpdateStackSetRequest::GetAdministrationRoleARN ( ) const
inline

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

Definition at line 1060 of file UpdateStackSetRequest.h.

◆ GetAutoDeployment()

const AutoDeployment& Aws::CloudFormation::Model::UpdateStackSetRequest::GetAutoDeployment ( ) const
inline

[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

If you specify AutoDeployment, do not specify DeploymentTargets or Regions.

Definition at line 1468 of file UpdateStackSetRequest.h.

◆ GetCallAs()

const CallAs& Aws::CloudFormation::Model::UpdateStackSetRequest::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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

Definition at line 1930 of file UpdateStackSetRequest.h.

◆ GetCapabilities()

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

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, 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, AWS 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 AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

Definition at line 428 of file UpdateStackSetRequest.h.

◆ GetDeploymentTargets()

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

[Service-managed permissions] The AWS Organizations accounts in which to update associated stack instances.

To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1287 of file UpdateStackSetRequest.h.

◆ GetDescription()

const Aws::String& Aws::CloudFormation::Model::UpdateStackSetRequest::GetDescription ( ) const
inline

A brief description of updates that you are making.

Definition at line 93 of file UpdateStackSetRequest.h.

◆ GetExecutionRoleName()

const Aws::String& Aws::CloudFormation::Model::UpdateStackSetRequest::GetExecutionRoleName ( ) const
inline

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

Definition at line 1173 of file UpdateStackSetRequest.h.

◆ GetOperationId()

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

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS 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 AWS CloudFormation successfully received them.

If you don't specify an operation ID, AWS CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

Definition at line 1521 of file UpdateStackSetRequest.h.

◆ GetOperationPreferences()

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 1020 of file UpdateStackSetRequest.h.

◆ GetParameters()

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

A list of input parameters for the stack set template.

Definition at line 337 of file UpdateStackSetRequest.h.

◆ GetPermissionModel()

const PermissionModels& Aws::CloudFormation::Model::UpdateStackSetRequest::GetPermissionModel ( ) const
inline

Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

Definition at line 1379 of file UpdateStackSetRequest.h.

◆ GetRegions()

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

The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1777 of file UpdateStackSetRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file UpdateStackSetRequest.h.

◆ GetStackSetName()

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

The name or unique ID of the stack set that you want to update.

Definition at line 52 of file UpdateStackSetRequest.h.

◆ GetTags()

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

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

  • If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.

  • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

  • If you specify an empty value, AWS CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

Definition at line 839 of file UpdateStackSetRequest.h.

◆ GetTemplateBody()

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

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 139 of file UpdateStackSetRequest.h.

◆ GetTemplateURL()

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

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 221 of file UpdateStackSetRequest.h.

◆ GetUsePreviousTemplate()

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

Use the existing template that's associated with the stack set that you're updating.

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

Definition at line 307 of file UpdateStackSetRequest.h.

◆ OperationIdHasBeenSet()

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

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS 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 AWS CloudFormation successfully received them.

If you don't specify an operation ID, AWS CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

Definition at line 1533 of file UpdateStackSetRequest.h.

◆ OperationPreferencesHasBeenSet()

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 1025 of file UpdateStackSetRequest.h.

◆ ParametersHasBeenSet()

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

A list of input parameters for the stack set template.

Definition at line 342 of file UpdateStackSetRequest.h.

◆ PermissionModelHasBeenSet()

bool Aws::CloudFormation::Model::UpdateStackSetRequest::PermissionModelHasBeenSet ( ) const
inline

Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

Definition at line 1395 of file UpdateStackSetRequest.h.

◆ RegionsHasBeenSet()

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

The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1794 of file UpdateStackSetRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccounts() [1/2]

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

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1674 of file UpdateStackSetRequest.h.

◆ SetAccounts() [2/2]

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

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1657 of file UpdateStackSetRequest.h.

◆ SetAdministrationRoleARN() [1/3]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetAdministrationRoleARN ( Aws::String &&  value)
inline

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

Definition at line 1102 of file UpdateStackSetRequest.h.

◆ SetAdministrationRoleARN() [2/3]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetAdministrationRoleARN ( const Aws::String value)
inline

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

Definition at line 1088 of file UpdateStackSetRequest.h.

◆ SetAdministrationRoleARN() [3/3]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetAdministrationRoleARN ( const char *  value)
inline

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

Definition at line 1116 of file UpdateStackSetRequest.h.

◆ SetAutoDeployment() [1/2]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetAutoDeployment ( AutoDeployment &&  value)
inline

[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

If you specify AutoDeployment, do not specify DeploymentTargets or Regions.

Definition at line 1492 of file UpdateStackSetRequest.h.

◆ SetAutoDeployment() [2/2]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetAutoDeployment ( const AutoDeployment value)
inline

[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

If you specify AutoDeployment, do not specify DeploymentTargets or Regions.

Definition at line 1484 of file UpdateStackSetRequest.h.

◆ SetCallAs() [1/2]

void Aws::CloudFormation::Model::UpdateStackSetRequest::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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

Definition at line 1978 of file UpdateStackSetRequest.h.

◆ SetCallAs() [2/2]

void Aws::CloudFormation::Model::UpdateStackSetRequest::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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

Definition at line 1962 of file UpdateStackSetRequest.h.

◆ SetCapabilities() [1/2]

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

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, 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, AWS 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 AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

Definition at line 593 of file UpdateStackSetRequest.h.

◆ SetCapabilities() [2/2]

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

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, 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, AWS 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 AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

Definition at line 538 of file UpdateStackSetRequest.h.

◆ SetDeploymentTargets() [1/2]

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

[Service-managed permissions] The AWS Organizations accounts in which to update associated stack instances.

To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1317 of file UpdateStackSetRequest.h.

◆ SetDeploymentTargets() [2/2]

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

[Service-managed permissions] The AWS Organizations accounts in which to update associated stack instances.

To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1332 of file UpdateStackSetRequest.h.

◆ SetDescription() [1/3]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetDescription ( Aws::String &&  value)
inline

A brief description of updates that you are making.

Definition at line 108 of file UpdateStackSetRequest.h.

◆ SetDescription() [2/3]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetDescription ( const Aws::String value)
inline

A brief description of updates that you are making.

Definition at line 103 of file UpdateStackSetRequest.h.

◆ SetDescription() [3/3]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetDescription ( const char *  value)
inline

A brief description of updates that you are making.

Definition at line 113 of file UpdateStackSetRequest.h.

◆ SetExecutionRoleName() [1/3]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetExecutionRoleName ( Aws::String &&  value)
inline

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

Definition at line 1215 of file UpdateStackSetRequest.h.

◆ SetExecutionRoleName() [2/3]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetExecutionRoleName ( const Aws::String value)
inline

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

Definition at line 1201 of file UpdateStackSetRequest.h.

◆ SetExecutionRoleName() [3/3]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetExecutionRoleName ( const char *  value)
inline

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

Definition at line 1229 of file UpdateStackSetRequest.h.

◆ SetOperationId() [1/3]

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

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS 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 AWS CloudFormation successfully received them.

If you don't specify an operation ID, AWS CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

Definition at line 1557 of file UpdateStackSetRequest.h.

◆ SetOperationId() [2/3]

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

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS 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 AWS CloudFormation successfully received them.

If you don't specify an operation ID, AWS CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

Definition at line 1545 of file UpdateStackSetRequest.h.

◆ SetOperationId() [3/3]

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

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS 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 AWS CloudFormation successfully received them.

If you don't specify an operation ID, AWS CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

Definition at line 1569 of file UpdateStackSetRequest.h.

◆ SetOperationPreferences() [1/2]

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 1030 of file UpdateStackSetRequest.h.

◆ SetOperationPreferences() [2/2]

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 1035 of file UpdateStackSetRequest.h.

◆ SetParameters() [1/2]

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

A list of input parameters for the stack set template.

Definition at line 352 of file UpdateStackSetRequest.h.

◆ SetParameters() [2/2]

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

A list of input parameters for the stack set template.

Definition at line 347 of file UpdateStackSetRequest.h.

◆ SetPermissionModel() [1/2]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetPermissionModel ( const PermissionModels value)
inline

Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

Definition at line 1411 of file UpdateStackSetRequest.h.

◆ SetPermissionModel() [2/2]

void Aws::CloudFormation::Model::UpdateStackSetRequest::SetPermissionModel ( PermissionModels &&  value)
inline

Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

Definition at line 1427 of file UpdateStackSetRequest.h.

◆ SetRegions() [1/2]

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

The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1828 of file UpdateStackSetRequest.h.

◆ SetRegions() [2/2]

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

The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1811 of file UpdateStackSetRequest.h.

◆ SetStackSetName() [1/3]

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

The name or unique ID of the stack set that you want to update.

Definition at line 67 of file UpdateStackSetRequest.h.

◆ SetStackSetName() [2/3]

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

The name or unique ID of the stack set that you want to update.

Definition at line 62 of file UpdateStackSetRequest.h.

◆ SetStackSetName() [3/3]

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

The name or unique ID of the stack set that you want to update.

Definition at line 72 of file UpdateStackSetRequest.h.

◆ SetTags() [1/2]

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

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

  • If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.

  • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

  • If you specify an empty value, AWS CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

Definition at line 914 of file UpdateStackSetRequest.h.

◆ SetTags() [2/2]

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

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

  • If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.

  • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

  • If you specify an empty value, AWS CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

Definition at line 889 of file UpdateStackSetRequest.h.

◆ SetTemplateBody() [1/3]

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

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 169 of file UpdateStackSetRequest.h.

◆ SetTemplateBody() [2/3]

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

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 159 of file UpdateStackSetRequest.h.

◆ SetTemplateBody() [3/3]

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

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 179 of file UpdateStackSetRequest.h.

◆ SetTemplateURL() [1/3]

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

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 254 of file UpdateStackSetRequest.h.

◆ SetTemplateURL() [2/3]

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

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 243 of file UpdateStackSetRequest.h.

◆ SetTemplateURL() [3/3]

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

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 265 of file UpdateStackSetRequest.h.

◆ SetUsePreviousTemplate()

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

Use the existing template that's associated with the stack set that you're updating.

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

Definition at line 323 of file UpdateStackSetRequest.h.

◆ StackSetNameHasBeenSet()

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

The name or unique ID of the stack set that you want to update.

Definition at line 57 of file UpdateStackSetRequest.h.

◆ TagsHasBeenSet()

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

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

  • If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.

  • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

  • If you specify an empty value, AWS CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

Definition at line 864 of file UpdateStackSetRequest.h.

◆ TemplateBodyHasBeenSet()

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

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 149 of file UpdateStackSetRequest.h.

◆ TemplateURLHasBeenSet()

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

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 232 of file UpdateStackSetRequest.h.

◆ UsePreviousTemplateHasBeenSet()

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

Use the existing template that's associated with the stack set that you're updating.

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

Definition at line 315 of file UpdateStackSetRequest.h.

◆ WithAccounts() [1/2]

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

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1708 of file UpdateStackSetRequest.h.

◆ WithAccounts() [2/2]

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

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1691 of file UpdateStackSetRequest.h.

◆ WithAdministrationRoleARN() [1/3]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithAdministrationRoleARN ( Aws::String &&  value)
inline

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

Definition at line 1144 of file UpdateStackSetRequest.h.

◆ WithAdministrationRoleARN() [2/3]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithAdministrationRoleARN ( const Aws::String value)
inline

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

Definition at line 1130 of file UpdateStackSetRequest.h.

◆ WithAdministrationRoleARN() [3/3]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithAdministrationRoleARN ( const char *  value)
inline

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

Definition at line 1158 of file UpdateStackSetRequest.h.

◆ WithAutoDeployment() [1/2]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithAutoDeployment ( AutoDeployment &&  value)
inline

[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

If you specify AutoDeployment, do not specify DeploymentTargets or Regions.

Definition at line 1508 of file UpdateStackSetRequest.h.

◆ WithAutoDeployment() [2/2]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithAutoDeployment ( const AutoDeployment value)
inline

[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

If you specify AutoDeployment, do not specify DeploymentTargets or Regions.

Definition at line 1500 of file UpdateStackSetRequest.h.

◆ WithCallAs() [1/2]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

Definition at line 2010 of file UpdateStackSetRequest.h.

◆ WithCallAs() [2/2]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

Definition at line 1994 of file UpdateStackSetRequest.h.

◆ WithCapabilities() [1/2]

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

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, 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, AWS 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 AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

Definition at line 703 of file UpdateStackSetRequest.h.

◆ WithCapabilities() [2/2]

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

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, 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, AWS 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 AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

Definition at line 648 of file UpdateStackSetRequest.h.

◆ WithDeploymentTargets() [1/2]

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

[Service-managed permissions] The AWS Organizations accounts in which to update associated stack instances.

To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1347 of file UpdateStackSetRequest.h.

◆ WithDeploymentTargets() [2/2]

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

[Service-managed permissions] The AWS Organizations accounts in which to update associated stack instances.

To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1362 of file UpdateStackSetRequest.h.

◆ WithDescription() [1/3]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithDescription ( Aws::String &&  value)
inline

A brief description of updates that you are making.

Definition at line 123 of file UpdateStackSetRequest.h.

◆ WithDescription() [2/3]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithDescription ( const Aws::String value)
inline

A brief description of updates that you are making.

Definition at line 118 of file UpdateStackSetRequest.h.

◆ WithDescription() [3/3]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithDescription ( const char *  value)
inline

A brief description of updates that you are making.

Definition at line 128 of file UpdateStackSetRequest.h.

◆ WithExecutionRoleName() [1/3]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithExecutionRoleName ( Aws::String &&  value)
inline

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

Definition at line 1257 of file UpdateStackSetRequest.h.

◆ WithExecutionRoleName() [2/3]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithExecutionRoleName ( const Aws::String value)
inline

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

Definition at line 1243 of file UpdateStackSetRequest.h.

◆ WithExecutionRoleName() [3/3]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithExecutionRoleName ( const char *  value)
inline

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

Definition at line 1271 of file UpdateStackSetRequest.h.

◆ WithOperationId() [1/3]

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

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS 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 AWS CloudFormation successfully received them.

If you don't specify an operation ID, AWS CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

Definition at line 1593 of file UpdateStackSetRequest.h.

◆ WithOperationId() [2/3]

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

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS 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 AWS CloudFormation successfully received them.

If you don't specify an operation ID, AWS CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

Definition at line 1581 of file UpdateStackSetRequest.h.

◆ WithOperationId() [3/3]

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

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS 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 AWS CloudFormation successfully received them.

If you don't specify an operation ID, AWS CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

Definition at line 1605 of file UpdateStackSetRequest.h.

◆ WithOperationPreferences() [1/2]

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 1040 of file UpdateStackSetRequest.h.

◆ WithOperationPreferences() [2/2]

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 1045 of file UpdateStackSetRequest.h.

◆ WithParameters() [1/2]

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

A list of input parameters for the stack set template.

Definition at line 362 of file UpdateStackSetRequest.h.

◆ WithParameters() [2/2]

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

A list of input parameters for the stack set template.

Definition at line 357 of file UpdateStackSetRequest.h.

◆ WithPermissionModel() [1/2]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithPermissionModel ( const PermissionModels value)
inline

Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

Definition at line 1443 of file UpdateStackSetRequest.h.

◆ WithPermissionModel() [2/2]

UpdateStackSetRequest& Aws::CloudFormation::Model::UpdateStackSetRequest::WithPermissionModel ( PermissionModels &&  value)
inline

Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

Definition at line 1459 of file UpdateStackSetRequest.h.

◆ WithRegions() [1/2]

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

The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1862 of file UpdateStackSetRequest.h.

◆ WithRegions() [2/2]

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

The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

Definition at line 1845 of file UpdateStackSetRequest.h.

◆ WithStackSetName() [1/3]

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

The name or unique ID of the stack set that you want to update.

Definition at line 82 of file UpdateStackSetRequest.h.

◆ WithStackSetName() [2/3]

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

The name or unique ID of the stack set that you want to update.

Definition at line 77 of file UpdateStackSetRequest.h.

◆ WithStackSetName() [3/3]

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

The name or unique ID of the stack set that you want to update.

Definition at line 87 of file UpdateStackSetRequest.h.

◆ WithTags() [1/2]

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

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

  • If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.

  • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

  • If you specify an empty value, AWS CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

Definition at line 964 of file UpdateStackSetRequest.h.

◆ WithTags() [2/2]

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

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

  • If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.

  • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

  • If you specify an empty value, AWS CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

Definition at line 939 of file UpdateStackSetRequest.h.

◆ WithTemplateBody() [1/3]

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

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 199 of file UpdateStackSetRequest.h.

◆ WithTemplateBody() [2/3]

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

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 189 of file UpdateStackSetRequest.h.

◆ WithTemplateBody() [3/3]

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

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 209 of file UpdateStackSetRequest.h.

◆ WithTemplateURL() [1/3]

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

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 287 of file UpdateStackSetRequest.h.

◆ WithTemplateURL() [2/3]

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

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 276 of file UpdateStackSetRequest.h.

◆ WithTemplateURL() [3/3]

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

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

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

Definition at line 298 of file UpdateStackSetRequest.h.

◆ WithUsePreviousTemplate()

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

Use the existing template that's associated with the stack set that you're updating.

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

Definition at line 331 of file UpdateStackSetRequest.h.


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