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

#include <CreateStackInstancesRequest.h>

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

Public Member Functions

 CreateStackInstancesRequest ()
 
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)
 
CreateStackInstancesRequestWithStackSetName (const Aws::String &value)
 
CreateStackInstancesRequestWithStackSetName (Aws::String &&value)
 
CreateStackInstancesRequestWithStackSetName (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)
 
CreateStackInstancesRequestWithAccounts (const Aws::Vector< Aws::String > &value)
 
CreateStackInstancesRequestWithAccounts (Aws::Vector< Aws::String > &&value)
 
CreateStackInstancesRequestAddAccounts (const Aws::String &value)
 
CreateStackInstancesRequestAddAccounts (Aws::String &&value)
 
CreateStackInstancesRequestAddAccounts (const char *value)
 
const DeploymentTargetsGetDeploymentTargets () const
 
bool DeploymentTargetsHasBeenSet () const
 
void SetDeploymentTargets (const DeploymentTargets &value)
 
void SetDeploymentTargets (DeploymentTargets &&value)
 
CreateStackInstancesRequestWithDeploymentTargets (const DeploymentTargets &value)
 
CreateStackInstancesRequestWithDeploymentTargets (DeploymentTargets &&value)
 
const Aws::Vector< Aws::String > & GetRegions () const
 
bool RegionsHasBeenSet () const
 
void SetRegions (const Aws::Vector< Aws::String > &value)
 
void SetRegions (Aws::Vector< Aws::String > &&value)
 
CreateStackInstancesRequestWithRegions (const Aws::Vector< Aws::String > &value)
 
CreateStackInstancesRequestWithRegions (Aws::Vector< Aws::String > &&value)
 
CreateStackInstancesRequestAddRegions (const Aws::String &value)
 
CreateStackInstancesRequestAddRegions (Aws::String &&value)
 
CreateStackInstancesRequestAddRegions (const char *value)
 
const Aws::Vector< Parameter > & GetParameterOverrides () const
 
bool ParameterOverridesHasBeenSet () const
 
void SetParameterOverrides (const Aws::Vector< Parameter > &value)
 
void SetParameterOverrides (Aws::Vector< Parameter > &&value)
 
CreateStackInstancesRequestWithParameterOverrides (const Aws::Vector< Parameter > &value)
 
CreateStackInstancesRequestWithParameterOverrides (Aws::Vector< Parameter > &&value)
 
CreateStackInstancesRequestAddParameterOverrides (const Parameter &value)
 
CreateStackInstancesRequestAddParameterOverrides (Parameter &&value)
 
const StackSetOperationPreferencesGetOperationPreferences () const
 
bool OperationPreferencesHasBeenSet () const
 
void SetOperationPreferences (const StackSetOperationPreferences &value)
 
void SetOperationPreferences (StackSetOperationPreferences &&value)
 
CreateStackInstancesRequestWithOperationPreferences (const StackSetOperationPreferences &value)
 
CreateStackInstancesRequestWithOperationPreferences (StackSetOperationPreferences &&value)
 
const Aws::StringGetOperationId () const
 
bool OperationIdHasBeenSet () const
 
void SetOperationId (const Aws::String &value)
 
void SetOperationId (Aws::String &&value)
 
void SetOperationId (const char *value)
 
CreateStackInstancesRequestWithOperationId (const Aws::String &value)
 
CreateStackInstancesRequestWithOperationId (Aws::String &&value)
 
CreateStackInstancesRequestWithOperationId (const char *value)
 
const CallAsGetCallAs () const
 
bool CallAsHasBeenSet () const
 
void SetCallAs (const CallAs &value)
 
void SetCallAs (CallAs &&value)
 
CreateStackInstancesRequestWithCallAs (const CallAs &value)
 
CreateStackInstancesRequestWithCallAs (CallAs &&value)
 
- Public Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual ~CloudFormationRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

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

Detailed Description

Definition at line 27 of file CreateStackInstancesRequest.h.

Constructor & Destructor Documentation

◆ CreateStackInstancesRequest()

Aws::CloudFormation::Model::CreateStackInstancesRequest::CreateStackInstancesRequest ( )

Member Function Documentation

◆ AccountsHasBeenSet()

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

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 108 of file CreateStackInstancesRequest.h.

◆ AddAccounts() [1/3]

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

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 156 of file CreateStackInstancesRequest.h.

◆ AddAccounts() [2/3]

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

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 148 of file CreateStackInstancesRequest.h.

◆ AddAccounts() [3/3]

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

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 164 of file CreateStackInstancesRequest.h.

◆ AddParameterOverrides() [1/2]

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

A list of stack set parameters whose values you want to override in the selected stack instances.

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

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

  • To leave a parameter set to its present value, you can do one of the following:

    • Do not include the parameter in the list.

    • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

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

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

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

Definition at line 431 of file CreateStackInstancesRequest.h.

◆ AddParameterOverrides() [2/2]

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

A list of stack set parameters whose values you want to override in the selected stack instances.

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

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

  • To leave a parameter set to its present value, you can do one of the following:

    • Do not include the parameter in the list.

    • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

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

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

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

Definition at line 455 of file CreateStackInstancesRequest.h.

◆ AddRegions() [1/3]

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

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Definition at line 256 of file CreateStackInstancesRequest.h.

◆ AddRegions() [2/3]

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

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Definition at line 250 of file CreateStackInstancesRequest.h.

◆ AddRegions() [3/3]

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

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Definition at line 262 of file CreateStackInstancesRequest.h.

◆ CallAsHasBeenSet()

bool Aws::CloudFormation::Model::CreateStackInstancesRequest::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 616 of file CreateStackInstancesRequest.h.

◆ DeploymentTargetsHasBeenSet()

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

[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 179 of file CreateStackInstancesRequest.h.

◆ DumpBodyToUrl()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetAccounts()

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

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 100 of file CreateStackInstancesRequest.h.

◆ GetCallAs()

const CallAs& Aws::CloudFormation::Model::CreateStackInstancesRequest::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 600 of file CreateStackInstancesRequest.h.

◆ GetDeploymentTargets()

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

[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 172 of file CreateStackInstancesRequest.h.

◆ GetOperationId()

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

The unique identifier 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, the SDK generates one automatically.

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

Definition at line 499 of file CreateStackInstancesRequest.h.

◆ GetOperationPreferences()

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 461 of file CreateStackInstancesRequest.h.

◆ GetParameterOverrides()

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

A list of stack set parameters whose values you want to override in the selected stack instances.

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

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

  • To leave a parameter set to its present value, you can do one of the following:

    • Do not include the parameter in the list.

    • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

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

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

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

Definition at line 287 of file CreateStackInstancesRequest.h.

◆ GetRegions()

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

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Definition at line 214 of file CreateStackInstancesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateStackInstancesRequest.h.

◆ GetStackSetName()

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

The name or unique ID of the stack set that you want to create stack instances from.

Definition at line 49 of file CreateStackInstancesRequest.h.

◆ OperationIdHasBeenSet()

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

The unique identifier 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, the SDK generates one automatically.

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

Definition at line 511 of file CreateStackInstancesRequest.h.

◆ OperationPreferencesHasBeenSet()

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 466 of file CreateStackInstancesRequest.h.

◆ ParameterOverridesHasBeenSet()

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

A list of stack set parameters whose values you want to override in the selected stack instances.

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

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

  • To leave a parameter set to its present value, you can do one of the following:

    • Do not include the parameter in the list.

    • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

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

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

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

Definition at line 311 of file CreateStackInstancesRequest.h.

◆ RegionsHasBeenSet()

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

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Definition at line 220 of file CreateStackInstancesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccounts() [1/2]

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

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 124 of file CreateStackInstancesRequest.h.

◆ SetAccounts() [2/2]

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

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 116 of file CreateStackInstancesRequest.h.

◆ SetCallAs() [1/2]

void Aws::CloudFormation::Model::CreateStackInstancesRequest::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 648 of file CreateStackInstancesRequest.h.

◆ SetCallAs() [2/2]

void Aws::CloudFormation::Model::CreateStackInstancesRequest::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 632 of file CreateStackInstancesRequest.h.

◆ SetDeploymentTargets() [1/2]

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

[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 186 of file CreateStackInstancesRequest.h.

◆ SetDeploymentTargets() [2/2]

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

[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 193 of file CreateStackInstancesRequest.h.

◆ SetOperationId() [1/3]

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

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that 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, the SDK generates one automatically.

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

Definition at line 535 of file CreateStackInstancesRequest.h.

◆ SetOperationId() [2/3]

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

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that 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, the SDK generates one automatically.

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

Definition at line 523 of file CreateStackInstancesRequest.h.

◆ SetOperationId() [3/3]

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

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that 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, the SDK generates one automatically.

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

Definition at line 547 of file CreateStackInstancesRequest.h.

◆ SetOperationPreferences() [1/2]

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 471 of file CreateStackInstancesRequest.h.

◆ SetOperationPreferences() [2/2]

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 476 of file CreateStackInstancesRequest.h.

◆ SetParameterOverrides() [1/2]

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

A list of stack set parameters whose values you want to override in the selected stack instances.

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

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

  • To leave a parameter set to its present value, you can do one of the following:

    • Do not include the parameter in the list.

    • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

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

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

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

Definition at line 359 of file CreateStackInstancesRequest.h.

◆ SetParameterOverrides() [2/2]

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

A list of stack set parameters whose values you want to override in the selected stack instances.

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

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

  • To leave a parameter set to its present value, you can do one of the following:

    • Do not include the parameter in the list.

    • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

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

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

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

Definition at line 335 of file CreateStackInstancesRequest.h.

◆ SetRegions() [1/2]

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

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Definition at line 232 of file CreateStackInstancesRequest.h.

◆ SetRegions() [2/2]

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

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Definition at line 226 of file CreateStackInstancesRequest.h.

◆ SetStackSetName() [1/3]

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

The name or unique ID of the stack set that you want to create stack instances from.

Definition at line 67 of file CreateStackInstancesRequest.h.

◆ SetStackSetName() [2/3]

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

The name or unique ID of the stack set that you want to create stack instances from.

Definition at line 61 of file CreateStackInstancesRequest.h.

◆ SetStackSetName() [3/3]

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

The name or unique ID of the stack set that you want to create stack instances from.

Definition at line 73 of file CreateStackInstancesRequest.h.

◆ StackSetNameHasBeenSet()

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

The name or unique ID of the stack set that you want to create stack instances from.

Definition at line 55 of file CreateStackInstancesRequest.h.

◆ WithAccounts() [1/2]

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

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 140 of file CreateStackInstancesRequest.h.

◆ WithAccounts() [2/2]

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

[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 132 of file CreateStackInstancesRequest.h.

◆ WithCallAs() [1/2]

CreateStackInstancesRequest& Aws::CloudFormation::Model::CreateStackInstancesRequest::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 680 of file CreateStackInstancesRequest.h.

◆ WithCallAs() [2/2]

CreateStackInstancesRequest& Aws::CloudFormation::Model::CreateStackInstancesRequest::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 664 of file CreateStackInstancesRequest.h.

◆ WithDeploymentTargets() [1/2]

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

[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 200 of file CreateStackInstancesRequest.h.

◆ WithDeploymentTargets() [2/2]

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

[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.

You can specify Accounts or DeploymentTargets, but not both.

Definition at line 207 of file CreateStackInstancesRequest.h.

◆ WithOperationId() [1/3]

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

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that 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, the SDK generates one automatically.

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

Definition at line 571 of file CreateStackInstancesRequest.h.

◆ WithOperationId() [2/3]

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

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that 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, the SDK generates one automatically.

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

Definition at line 559 of file CreateStackInstancesRequest.h.

◆ WithOperationId() [3/3]

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

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that 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, the SDK generates one automatically.

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

Definition at line 583 of file CreateStackInstancesRequest.h.

◆ WithOperationPreferences() [1/2]

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 481 of file CreateStackInstancesRequest.h.

◆ WithOperationPreferences() [2/2]

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

Preferences for how AWS CloudFormation performs this stack set operation.

Definition at line 486 of file CreateStackInstancesRequest.h.

◆ WithParameterOverrides() [1/2]

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

A list of stack set parameters whose values you want to override in the selected stack instances.

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

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

  • To leave a parameter set to its present value, you can do one of the following:

    • Do not include the parameter in the list.

    • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

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

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

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

Definition at line 407 of file CreateStackInstancesRequest.h.

◆ WithParameterOverrides() [2/2]

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

A list of stack set parameters whose values you want to override in the selected stack instances.

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

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

  • To leave a parameter set to its present value, you can do one of the following:

    • Do not include the parameter in the list.

    • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

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

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

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

Definition at line 383 of file CreateStackInstancesRequest.h.

◆ WithRegions() [1/2]

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

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Definition at line 244 of file CreateStackInstancesRequest.h.

◆ WithRegions() [2/2]

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

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

Definition at line 238 of file CreateStackInstancesRequest.h.

◆ WithStackSetName() [1/3]

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

The name or unique ID of the stack set that you want to create stack instances from.

Definition at line 85 of file CreateStackInstancesRequest.h.

◆ WithStackSetName() [2/3]

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

The name or unique ID of the stack set that you want to create stack instances from.

Definition at line 79 of file CreateStackInstancesRequest.h.

◆ WithStackSetName() [3/3]

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

The name or unique ID of the stack set that you want to create stack instances from.

Definition at line 91 of file CreateStackInstancesRequest.h.


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