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

#include <CreateStackSetRequest.h>

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

Public Member Functions

 CreateStackSetRequest ()
 
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)
 
CreateStackSetRequestWithStackSetName (const Aws::String &value)
 
CreateStackSetRequestWithStackSetName (Aws::String &&value)
 
CreateStackSetRequestWithStackSetName (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)
 
CreateStackSetRequestWithDescription (const Aws::String &value)
 
CreateStackSetRequestWithDescription (Aws::String &&value)
 
CreateStackSetRequestWithDescription (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)
 
CreateStackSetRequestWithTemplateBody (const Aws::String &value)
 
CreateStackSetRequestWithTemplateBody (Aws::String &&value)
 
CreateStackSetRequestWithTemplateBody (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)
 
CreateStackSetRequestWithTemplateURL (const Aws::String &value)
 
CreateStackSetRequestWithTemplateURL (Aws::String &&value)
 
CreateStackSetRequestWithTemplateURL (const char *value)
 
const Aws::Vector< Parameter > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Vector< Parameter > &value)
 
void SetParameters (Aws::Vector< Parameter > &&value)
 
CreateStackSetRequestWithParameters (const Aws::Vector< Parameter > &value)
 
CreateStackSetRequestWithParameters (Aws::Vector< Parameter > &&value)
 
CreateStackSetRequestAddParameters (const Parameter &value)
 
CreateStackSetRequestAddParameters (Parameter &&value)
 
const Aws::Vector< Capability > & GetCapabilities () const
 
bool CapabilitiesHasBeenSet () const
 
void SetCapabilities (const Aws::Vector< Capability > &value)
 
void SetCapabilities (Aws::Vector< Capability > &&value)
 
CreateStackSetRequestWithCapabilities (const Aws::Vector< Capability > &value)
 
CreateStackSetRequestWithCapabilities (Aws::Vector< Capability > &&value)
 
CreateStackSetRequestAddCapabilities (const Capability &value)
 
CreateStackSetRequestAddCapabilities (Capability &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateStackSetRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateStackSetRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateStackSetRequestAddTags (const Tag &value)
 
CreateStackSetRequestAddTags (Tag &&value)
 
const Aws::StringGetAdministrationRoleARN () const
 
bool AdministrationRoleARNHasBeenSet () const
 
void SetAdministrationRoleARN (const Aws::String &value)
 
void SetAdministrationRoleARN (Aws::String &&value)
 
void SetAdministrationRoleARN (const char *value)
 
CreateStackSetRequestWithAdministrationRoleARN (const Aws::String &value)
 
CreateStackSetRequestWithAdministrationRoleARN (Aws::String &&value)
 
CreateStackSetRequestWithAdministrationRoleARN (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)
 
CreateStackSetRequestWithExecutionRoleName (const Aws::String &value)
 
CreateStackSetRequestWithExecutionRoleName (Aws::String &&value)
 
CreateStackSetRequestWithExecutionRoleName (const char *value)
 
const PermissionModelsGetPermissionModel () const
 
bool PermissionModelHasBeenSet () const
 
void SetPermissionModel (const PermissionModels &value)
 
void SetPermissionModel (PermissionModels &&value)
 
CreateStackSetRequestWithPermissionModel (const PermissionModels &value)
 
CreateStackSetRequestWithPermissionModel (PermissionModels &&value)
 
const AutoDeploymentGetAutoDeployment () const
 
bool AutoDeploymentHasBeenSet () const
 
void SetAutoDeployment (const AutoDeployment &value)
 
void SetAutoDeployment (AutoDeployment &&value)
 
CreateStackSetRequestWithAutoDeployment (const AutoDeployment &value)
 
CreateStackSetRequestWithAutoDeployment (AutoDeployment &&value)
 
const CallAsGetCallAs () const
 
bool CallAsHasBeenSet () const
 
void SetCallAs (const CallAs &value)
 
void SetCallAs (CallAs &&value)
 
CreateStackSetRequestWithCallAs (const CallAs &value)
 
CreateStackSetRequestWithCallAs (CallAs &&value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
CreateStackSetRequestWithClientRequestToken (const Aws::String &value)
 
CreateStackSetRequestWithClientRequestToken (Aws::String &&value)
 
CreateStackSetRequestWithClientRequestToken (const char *value)
 
- Public Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual ~CloudFormationRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

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

Detailed Description

Definition at line 29 of file CreateStackSetRequest.h.

Constructor & Destructor Documentation

◆ CreateStackSetRequest()

Aws::CloudFormation::Model::CreateStackSetRequest::CreateStackSetRequest ( )

Member Function Documentation

◆ AddCapabilities() [1/2]

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

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related 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 stack 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 create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create 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 794 of file CreateStackSetRequest.h.

◆ AddCapabilities() [2/2]

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

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related 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 stack 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 create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create 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 739 of file CreateStackSetRequest.h.

◆ AddParameters() [1/2]

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

The input parameters for the stack set template.

Definition at line 348 of file CreateStackSetRequest.h.

◆ AddParameters() [2/2]

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

The input parameters for the stack set template.

Definition at line 353 of file CreateStackSetRequest.h.

◆ AddTags() [1/2]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

Definition at line 879 of file CreateStackSetRequest.h.

◆ AddTags() [2/2]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

Definition at line 891 of file CreateStackSetRequest.h.

◆ AdministrationRoleARNHasBeenSet()

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

The Amazon Resource Number (ARN) of the IAM role to use to create 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 Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

Definition at line 914 of file CreateStackSetRequest.h.

◆ AutoDeploymentHasBeenSet()

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

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

Definition at line 1175 of file CreateStackSetRequest.h.

◆ CallAsHasBeenSet()

bool Aws::CloudFormation::Model::CreateStackSetRequest::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.

  • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

  • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

Definition at line 1246 of file CreateStackSetRequest.h.

◆ CapabilitiesHasBeenSet()

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

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related 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 stack 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 create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create 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 464 of file CreateStackSetRequest.h.

◆ ClientRequestTokenHasBeenSet()

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

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

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

Definition at line 1343 of file CreateStackSetRequest.h.

◆ DescriptionHasBeenSet()

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

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

Definition at line 122 of file CreateStackSetRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudFormation::Model::CreateStackSetRequest::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::CreateStackSetRequest::ExecutionRoleNameHasBeenSet ( ) const
inline

The name of the IAM execution role to use to create 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.

Definition at line 1001 of file CreateStackSetRequest.h.

◆ GetAdministrationRoleARN()

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

The Amazon Resource Number (ARN) of the IAM role to use to create 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 Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

Definition at line 903 of file CreateStackSetRequest.h.

◆ GetAutoDeployment()

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

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

Definition at line 1167 of file CreateStackSetRequest.h.

◆ GetCallAs()

const CallAs& Aws::CloudFormation::Model::CreateStackSetRequest::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.

  • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

  • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

Definition at line 1227 of file CreateStackSetRequest.h.

◆ GetCapabilities()

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

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related 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 stack 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 create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create 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 409 of file CreateStackSetRequest.h.

◆ GetClientRequestToken()

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

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

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

Definition at line 1333 of file CreateStackSetRequest.h.

◆ GetDescription()

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

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

Definition at line 116 of file CreateStackSetRequest.h.

◆ GetExecutionRoleName()

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

The name of the IAM execution role to use to create 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.

Definition at line 991 of file CreateStackSetRequest.h.

◆ GetParameters()

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

The input parameters for the stack set template.

Definition at line 318 of file CreateStackSetRequest.h.

◆ GetPermissionModel()

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

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

Definition at line 1078 of file CreateStackSetRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file CreateStackSetRequest.h.

◆ GetStackSetName()

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

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

Definition at line 53 of file CreateStackSetRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::CloudFormation::Model::CreateStackSetRequest::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. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

Definition at line 807 of file CreateStackSetRequest.h.

◆ GetTemplateBody()

const Aws::String& Aws::CloudFormation::Model::CreateStackSetRequest::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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 168 of file CreateStackSetRequest.h.

◆ GetTemplateURL()

const Aws::String& Aws::CloudFormation::Model::CreateStackSetRequest::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's 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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 242 of file CreateStackSetRequest.h.

◆ ParametersHasBeenSet()

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

The input parameters for the stack set template.

Definition at line 323 of file CreateStackSetRequest.h.

◆ PermissionModelHasBeenSet()

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

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

Definition at line 1094 of file CreateStackSetRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAdministrationRoleARN() [1/3]

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

The Amazon Resource Number (ARN) of the IAM role to use to create 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 Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

Definition at line 936 of file CreateStackSetRequest.h.

◆ SetAdministrationRoleARN() [2/3]

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

The Amazon Resource Number (ARN) of the IAM role to use to create 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 Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

Definition at line 925 of file CreateStackSetRequest.h.

◆ SetAdministrationRoleARN() [3/3]

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

The Amazon Resource Number (ARN) of the IAM role to use to create 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 Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

Definition at line 947 of file CreateStackSetRequest.h.

◆ SetAutoDeployment() [1/2]

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

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

Definition at line 1191 of file CreateStackSetRequest.h.

◆ SetAutoDeployment() [2/2]

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

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

Definition at line 1183 of file CreateStackSetRequest.h.

◆ SetCallAs() [1/2]

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

  • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

  • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

Definition at line 1284 of file CreateStackSetRequest.h.

◆ SetCallAs() [2/2]

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

  • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

  • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

Definition at line 1265 of file CreateStackSetRequest.h.

◆ SetCapabilities() [1/2]

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

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related 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 stack 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 create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create 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 574 of file CreateStackSetRequest.h.

◆ SetCapabilities() [2/2]

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

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related 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 stack 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 create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create 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 519 of file CreateStackSetRequest.h.

◆ SetClientRequestToken() [1/3]

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

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

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

Definition at line 1363 of file CreateStackSetRequest.h.

◆ SetClientRequestToken() [2/3]

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

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

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

Definition at line 1353 of file CreateStackSetRequest.h.

◆ SetClientRequestToken() [3/3]

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

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

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

Definition at line 1373 of file CreateStackSetRequest.h.

◆ SetDescription() [1/3]

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

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

Definition at line 134 of file CreateStackSetRequest.h.

◆ SetDescription() [2/3]

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

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

Definition at line 128 of file CreateStackSetRequest.h.

◆ SetDescription() [3/3]

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

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

Definition at line 140 of file CreateStackSetRequest.h.

◆ SetExecutionRoleName() [1/3]

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

The name of the IAM execution role to use to create 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.

Definition at line 1021 of file CreateStackSetRequest.h.

◆ SetExecutionRoleName() [2/3]

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

The name of the IAM execution role to use to create 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.

Definition at line 1011 of file CreateStackSetRequest.h.

◆ SetExecutionRoleName() [3/3]

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

The name of the IAM execution role to use to create 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.

Definition at line 1031 of file CreateStackSetRequest.h.

◆ SetParameters() [1/2]

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

The input parameters for the stack set template.

Definition at line 333 of file CreateStackSetRequest.h.

◆ SetParameters() [2/2]

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

The input parameters for the stack set template.

Definition at line 328 of file CreateStackSetRequest.h.

◆ SetPermissionModel() [1/2]

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

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

Definition at line 1110 of file CreateStackSetRequest.h.

◆ SetPermissionModel() [2/2]

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

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

Definition at line 1126 of file CreateStackSetRequest.h.

◆ SetStackSetName() [1/3]

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

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

Definition at line 77 of file CreateStackSetRequest.h.

◆ SetStackSetName() [2/3]

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

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

Definition at line 69 of file CreateStackSetRequest.h.

◆ SetStackSetName() [3/3]

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

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

Definition at line 85 of file CreateStackSetRequest.h.

◆ SetTags() [1/2]

void Aws::CloudFormation::Model::CreateStackSetRequest::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. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

Definition at line 843 of file CreateStackSetRequest.h.

◆ SetTags() [2/2]

void Aws::CloudFormation::Model::CreateStackSetRequest::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. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

Definition at line 831 of file CreateStackSetRequest.h.

◆ SetTemplateBody() [1/3]

void Aws::CloudFormation::Model::CreateStackSetRequest::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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 195 of file CreateStackSetRequest.h.

◆ SetTemplateBody() [2/3]

void Aws::CloudFormation::Model::CreateStackSetRequest::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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 186 of file CreateStackSetRequest.h.

◆ SetTemplateBody() [3/3]

void Aws::CloudFormation::Model::CreateStackSetRequest::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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 204 of file CreateStackSetRequest.h.

◆ SetTemplateURL() [1/3]

void Aws::CloudFormation::Model::CreateStackSetRequest::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's 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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 272 of file CreateStackSetRequest.h.

◆ SetTemplateURL() [2/3]

void Aws::CloudFormation::Model::CreateStackSetRequest::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's 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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 262 of file CreateStackSetRequest.h.

◆ SetTemplateURL() [3/3]

void Aws::CloudFormation::Model::CreateStackSetRequest::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's 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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 282 of file CreateStackSetRequest.h.

◆ StackSetNameHasBeenSet()

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

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

Definition at line 61 of file CreateStackSetRequest.h.

◆ TagsHasBeenSet()

bool Aws::CloudFormation::Model::CreateStackSetRequest::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. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

Definition at line 819 of file CreateStackSetRequest.h.

◆ TemplateBodyHasBeenSet()

bool Aws::CloudFormation::Model::CreateStackSetRequest::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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 177 of file CreateStackSetRequest.h.

◆ TemplateURLHasBeenSet()

bool Aws::CloudFormation::Model::CreateStackSetRequest::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's 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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 252 of file CreateStackSetRequest.h.

◆ WithAdministrationRoleARN() [1/3]

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

The Amazon Resource Number (ARN) of the IAM role to use to create 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 Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

Definition at line 969 of file CreateStackSetRequest.h.

◆ WithAdministrationRoleARN() [2/3]

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

The Amazon Resource Number (ARN) of the IAM role to use to create 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 Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

Definition at line 958 of file CreateStackSetRequest.h.

◆ WithAdministrationRoleARN() [3/3]

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

The Amazon Resource Number (ARN) of the IAM role to use to create 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 Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

Definition at line 980 of file CreateStackSetRequest.h.

◆ WithAutoDeployment() [1/2]

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

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

Definition at line 1207 of file CreateStackSetRequest.h.

◆ WithAutoDeployment() [2/2]

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

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

Definition at line 1199 of file CreateStackSetRequest.h.

◆ WithCallAs() [1/2]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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.

  • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

  • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

Definition at line 1322 of file CreateStackSetRequest.h.

◆ WithCallAs() [2/2]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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.

  • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

  • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

Definition at line 1303 of file CreateStackSetRequest.h.

◆ WithCapabilities() [1/2]

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

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related 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 stack 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 create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create 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 684 of file CreateStackSetRequest.h.

◆ WithCapabilities() [2/2]

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

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related 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 stack 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 create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create 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 629 of file CreateStackSetRequest.h.

◆ WithClientRequestToken() [1/3]

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

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

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

Definition at line 1393 of file CreateStackSetRequest.h.

◆ WithClientRequestToken() [2/3]

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

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

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

Definition at line 1383 of file CreateStackSetRequest.h.

◆ WithClientRequestToken() [3/3]

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

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

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

Definition at line 1403 of file CreateStackSetRequest.h.

◆ WithDescription() [1/3]

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

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

Definition at line 152 of file CreateStackSetRequest.h.

◆ WithDescription() [2/3]

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

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

Definition at line 146 of file CreateStackSetRequest.h.

◆ WithDescription() [3/3]

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

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

Definition at line 158 of file CreateStackSetRequest.h.

◆ WithExecutionRoleName() [1/3]

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

The name of the IAM execution role to use to create 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.

Definition at line 1051 of file CreateStackSetRequest.h.

◆ WithExecutionRoleName() [2/3]

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

The name of the IAM execution role to use to create 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.

Definition at line 1041 of file CreateStackSetRequest.h.

◆ WithExecutionRoleName() [3/3]

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

The name of the IAM execution role to use to create 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.

Definition at line 1061 of file CreateStackSetRequest.h.

◆ WithParameters() [1/2]

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

The input parameters for the stack set template.

Definition at line 343 of file CreateStackSetRequest.h.

◆ WithParameters() [2/2]

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

The input parameters for the stack set template.

Definition at line 338 of file CreateStackSetRequest.h.

◆ WithPermissionModel() [1/2]

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

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

Definition at line 1142 of file CreateStackSetRequest.h.

◆ WithPermissionModel() [2/2]

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

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

Definition at line 1158 of file CreateStackSetRequest.h.

◆ WithStackSetName() [1/3]

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

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

Definition at line 101 of file CreateStackSetRequest.h.

◆ WithStackSetName() [2/3]

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

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

Definition at line 93 of file CreateStackSetRequest.h.

◆ WithStackSetName() [3/3]

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

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

Definition at line 109 of file CreateStackSetRequest.h.

◆ WithTags() [1/2]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

Definition at line 867 of file CreateStackSetRequest.h.

◆ WithTags() [2/2]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

Definition at line 855 of file CreateStackSetRequest.h.

◆ WithTemplateBody() [1/3]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 222 of file CreateStackSetRequest.h.

◆ WithTemplateBody() [2/3]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 213 of file CreateStackSetRequest.h.

◆ WithTemplateBody() [3/3]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 231 of file CreateStackSetRequest.h.

◆ WithTemplateURL() [1/3]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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's 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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 302 of file CreateStackSetRequest.h.

◆ WithTemplateURL() [2/3]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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's 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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 292 of file CreateStackSetRequest.h.

◆ WithTemplateURL() [3/3]

CreateStackSetRequest& Aws::CloudFormation::Model::CreateStackSetRequest::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's 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 either the TemplateBody or the TemplateURL parameter, but not both.

Definition at line 312 of file CreateStackSetRequest.h.


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