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

#include <CreateChangeSetRequest.h>

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

Public Member Functions

 CreateChangeSetRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetStackName () const
 
bool StackNameHasBeenSet () const
 
void SetStackName (const Aws::String &value)
 
void SetStackName (Aws::String &&value)
 
void SetStackName (const char *value)
 
CreateChangeSetRequestWithStackName (const Aws::String &value)
 
CreateChangeSetRequestWithStackName (Aws::String &&value)
 
CreateChangeSetRequestWithStackName (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)
 
CreateChangeSetRequestWithTemplateBody (const Aws::String &value)
 
CreateChangeSetRequestWithTemplateBody (Aws::String &&value)
 
CreateChangeSetRequestWithTemplateBody (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)
 
CreateChangeSetRequestWithTemplateURL (const Aws::String &value)
 
CreateChangeSetRequestWithTemplateURL (Aws::String &&value)
 
CreateChangeSetRequestWithTemplateURL (const char *value)
 
bool GetUsePreviousTemplate () const
 
bool UsePreviousTemplateHasBeenSet () const
 
void SetUsePreviousTemplate (bool value)
 
CreateChangeSetRequestWithUsePreviousTemplate (bool value)
 
const Aws::Vector< Parameter > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Vector< Parameter > &value)
 
void SetParameters (Aws::Vector< Parameter > &&value)
 
CreateChangeSetRequestWithParameters (const Aws::Vector< Parameter > &value)
 
CreateChangeSetRequestWithParameters (Aws::Vector< Parameter > &&value)
 
CreateChangeSetRequestAddParameters (const Parameter &value)
 
CreateChangeSetRequestAddParameters (Parameter &&value)
 
const Aws::Vector< Capability > & GetCapabilities () const
 
bool CapabilitiesHasBeenSet () const
 
void SetCapabilities (const Aws::Vector< Capability > &value)
 
void SetCapabilities (Aws::Vector< Capability > &&value)
 
CreateChangeSetRequestWithCapabilities (const Aws::Vector< Capability > &value)
 
CreateChangeSetRequestWithCapabilities (Aws::Vector< Capability > &&value)
 
CreateChangeSetRequestAddCapabilities (const Capability &value)
 
CreateChangeSetRequestAddCapabilities (Capability &&value)
 
const Aws::Vector< Aws::String > & GetResourceTypes () const
 
bool ResourceTypesHasBeenSet () const
 
void SetResourceTypes (const Aws::Vector< Aws::String > &value)
 
void SetResourceTypes (Aws::Vector< Aws::String > &&value)
 
CreateChangeSetRequestWithResourceTypes (const Aws::Vector< Aws::String > &value)
 
CreateChangeSetRequestWithResourceTypes (Aws::Vector< Aws::String > &&value)
 
CreateChangeSetRequestAddResourceTypes (const Aws::String &value)
 
CreateChangeSetRequestAddResourceTypes (Aws::String &&value)
 
CreateChangeSetRequestAddResourceTypes (const char *value)
 
const Aws::StringGetRoleARN () const
 
bool RoleARNHasBeenSet () const
 
void SetRoleARN (const Aws::String &value)
 
void SetRoleARN (Aws::String &&value)
 
void SetRoleARN (const char *value)
 
CreateChangeSetRequestWithRoleARN (const Aws::String &value)
 
CreateChangeSetRequestWithRoleARN (Aws::String &&value)
 
CreateChangeSetRequestWithRoleARN (const char *value)
 
const RollbackConfigurationGetRollbackConfiguration () const
 
bool RollbackConfigurationHasBeenSet () const
 
void SetRollbackConfiguration (const RollbackConfiguration &value)
 
void SetRollbackConfiguration (RollbackConfiguration &&value)
 
CreateChangeSetRequestWithRollbackConfiguration (const RollbackConfiguration &value)
 
CreateChangeSetRequestWithRollbackConfiguration (RollbackConfiguration &&value)
 
const Aws::Vector< Aws::String > & GetNotificationARNs () const
 
bool NotificationARNsHasBeenSet () const
 
void SetNotificationARNs (const Aws::Vector< Aws::String > &value)
 
void SetNotificationARNs (Aws::Vector< Aws::String > &&value)
 
CreateChangeSetRequestWithNotificationARNs (const Aws::Vector< Aws::String > &value)
 
CreateChangeSetRequestWithNotificationARNs (Aws::Vector< Aws::String > &&value)
 
CreateChangeSetRequestAddNotificationARNs (const Aws::String &value)
 
CreateChangeSetRequestAddNotificationARNs (Aws::String &&value)
 
CreateChangeSetRequestAddNotificationARNs (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateChangeSetRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateChangeSetRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateChangeSetRequestAddTags (const Tag &value)
 
CreateChangeSetRequestAddTags (Tag &&value)
 
const Aws::StringGetChangeSetName () const
 
bool ChangeSetNameHasBeenSet () const
 
void SetChangeSetName (const Aws::String &value)
 
void SetChangeSetName (Aws::String &&value)
 
void SetChangeSetName (const char *value)
 
CreateChangeSetRequestWithChangeSetName (const Aws::String &value)
 
CreateChangeSetRequestWithChangeSetName (Aws::String &&value)
 
CreateChangeSetRequestWithChangeSetName (const char *value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreateChangeSetRequestWithClientToken (const Aws::String &value)
 
CreateChangeSetRequestWithClientToken (Aws::String &&value)
 
CreateChangeSetRequestWithClientToken (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)
 
CreateChangeSetRequestWithDescription (const Aws::String &value)
 
CreateChangeSetRequestWithDescription (Aws::String &&value)
 
CreateChangeSetRequestWithDescription (const char *value)
 
const ChangeSetTypeGetChangeSetType () const
 
bool ChangeSetTypeHasBeenSet () const
 
void SetChangeSetType (const ChangeSetType &value)
 
void SetChangeSetType (ChangeSetType &&value)
 
CreateChangeSetRequestWithChangeSetType (const ChangeSetType &value)
 
CreateChangeSetRequestWithChangeSetType (ChangeSetType &&value)
 
const Aws::Vector< ResourceToImport > & GetResourcesToImport () const
 
bool ResourcesToImportHasBeenSet () const
 
void SetResourcesToImport (const Aws::Vector< ResourceToImport > &value)
 
void SetResourcesToImport (Aws::Vector< ResourceToImport > &&value)
 
CreateChangeSetRequestWithResourcesToImport (const Aws::Vector< ResourceToImport > &value)
 
CreateChangeSetRequestWithResourcesToImport (Aws::Vector< ResourceToImport > &&value)
 
CreateChangeSetRequestAddResourcesToImport (const ResourceToImport &value)
 
CreateChangeSetRequestAddResourcesToImport (ResourceToImport &&value)
 
- Public Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual ~CloudFormationRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

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

Detailed Description

The input for the CreateChangeSet action.

See Also:

AWS API Reference

Definition at line 32 of file CreateChangeSetRequest.h.

Constructor & Destructor Documentation

◆ CreateChangeSetRequest()

Aws::CloudFormation::Model::CreateChangeSetRequest::CreateChangeSetRequest ( )

Member Function Documentation

◆ AddCapabilities() [1/2]

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

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

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, 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 template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.

    Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

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

Definition at line 760 of file CreateChangeSetRequest.h.

◆ AddCapabilities() [2/2]

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

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

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, 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 template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.

    Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

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

Definition at line 821 of file CreateChangeSetRequest.h.

◆ AddNotificationARNs() [1/3]

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

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

Definition at line 1157 of file CreateChangeSetRequest.h.

◆ AddNotificationARNs() [2/3]

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

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

Definition at line 1164 of file CreateChangeSetRequest.h.

◆ AddNotificationARNs() [3/3]

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

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

Definition at line 1171 of file CreateChangeSetRequest.h.

◆ AddParameters() [1/2]

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

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

Definition at line 326 of file CreateChangeSetRequest.h.

◆ AddParameters() [2/2]

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

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

Definition at line 332 of file CreateChangeSetRequest.h.

◆ AddResourcesToImport() [1/2]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::AddResourcesToImport ( const ResourceToImport value)
inline

The resources to import into your stack.

Definition at line 1534 of file CreateChangeSetRequest.h.

◆ AddResourcesToImport() [2/2]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::AddResourcesToImport ( ResourceToImport &&  value)
inline

The resources to import into your stack.

Definition at line 1539 of file CreateChangeSetRequest.h.

◆ AddResourceTypes() [1/3]

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

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

Definition at line 927 of file CreateChangeSetRequest.h.

◆ AddResourceTypes() [2/3]

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

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

Definition at line 942 of file CreateChangeSetRequest.h.

◆ AddResourceTypes() [3/3]

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

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

Definition at line 957 of file CreateChangeSetRequest.h.

◆ AddTags() [1/2]

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

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

Definition at line 1221 of file CreateChangeSetRequest.h.

◆ AddTags() [2/2]

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

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

Definition at line 1228 of file CreateChangeSetRequest.h.

◆ CapabilitiesHasBeenSet()

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

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

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, 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 template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.

    Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

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

Definition at line 455 of file CreateChangeSetRequest.h.

◆ ChangeSetNameHasBeenSet()

bool Aws::CloudFormation::Model::CreateChangeSetRequest::ChangeSetNameHasBeenSet ( ) const
inline

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

Definition at line 1245 of file CreateChangeSetRequest.h.

◆ ChangeSetTypeHasBeenSet()

bool Aws::CloudFormation::Model::CreateChangeSetRequest::ChangeSetTypeHasBeenSet ( ) const
inline

The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

Definition at line 1438 of file CreateChangeSetRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::CloudFormation::Model::CreateChangeSetRequest::ClientTokenHasBeenSet ( ) const
inline

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

Definition at line 1312 of file CreateChangeSetRequest.h.

◆ DescriptionHasBeenSet()

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

A description to help you identify this change set.

Definition at line 1377 of file CreateChangeSetRequest.h.

◆ DumpBodyToUrl()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetCapabilities()

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

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

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, 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 template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.

    Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

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

Definition at line 394 of file CreateChangeSetRequest.h.

◆ GetChangeSetName()

const Aws::String& Aws::CloudFormation::Model::CreateChangeSetRequest::GetChangeSetName ( ) const
inline

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

Definition at line 1237 of file CreateChangeSetRequest.h.

◆ GetChangeSetType()

const ChangeSetType& Aws::CloudFormation::Model::CreateChangeSetRequest::GetChangeSetType ( ) const
inline

The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

Definition at line 1423 of file CreateChangeSetRequest.h.

◆ GetClientToken()

const Aws::String& Aws::CloudFormation::Model::CreateChangeSetRequest::GetClientToken ( ) const
inline

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

Definition at line 1303 of file CreateChangeSetRequest.h.

◆ GetDescription()

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

A description to help you identify this change set.

Definition at line 1372 of file CreateChangeSetRequest.h.

◆ GetNotificationARNs()

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

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

Definition at line 1115 of file CreateChangeSetRequest.h.

◆ GetParameters()

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

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

Definition at line 290 of file CreateChangeSetRequest.h.

◆ GetResourcesToImport()

const Aws::Vector<ResourceToImport>& Aws::CloudFormation::Model::CreateChangeSetRequest::GetResourcesToImport ( ) const
inline

The resources to import into your stack.

Definition at line 1504 of file CreateChangeSetRequest.h.

◆ GetResourceTypes()

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

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

Definition at line 837 of file CreateChangeSetRequest.h.

◆ GetRoleARN()

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

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 972 of file CreateChangeSetRequest.h.

◆ GetRollbackConfiguration()

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

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

Definition at line 1077 of file CreateChangeSetRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 41 of file CreateChangeSetRequest.h.

◆ GetStackName()

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

The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

Definition at line 56 of file CreateChangeSetRequest.h.

◆ GetTags()

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

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

Definition at line 1179 of file CreateChangeSetRequest.h.

◆ GetTemplateBody()

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

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 122 of file CreateChangeSetRequest.h.

◆ GetTemplateURL()

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

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 195 of file CreateChangeSetRequest.h.

◆ GetUsePreviousTemplate()

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

Whether to reuse the template that is associated with the stack to create the change set.

Definition at line 265 of file CreateChangeSetRequest.h.

◆ NotificationARNsHasBeenSet()

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

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

Definition at line 1122 of file CreateChangeSetRequest.h.

◆ ParametersHasBeenSet()

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

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

Definition at line 296 of file CreateChangeSetRequest.h.

◆ ResourcesToImportHasBeenSet()

bool Aws::CloudFormation::Model::CreateChangeSetRequest::ResourcesToImportHasBeenSet ( ) const
inline

The resources to import into your stack.

Definition at line 1509 of file CreateChangeSetRequest.h.

◆ ResourceTypesHasBeenSet()

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

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

Definition at line 852 of file CreateChangeSetRequest.h.

◆ RoleARNHasBeenSet()

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

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 986 of file CreateChangeSetRequest.h.

◆ RollbackConfigurationHasBeenSet()

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

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

Definition at line 1083 of file CreateChangeSetRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCapabilities() [1/2]

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

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

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, 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 template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.

    Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

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

Definition at line 516 of file CreateChangeSetRequest.h.

◆ SetCapabilities() [2/2]

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

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

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, 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 template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.

    Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

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

Definition at line 577 of file CreateChangeSetRequest.h.

◆ SetChangeSetName() [1/3]

void Aws::CloudFormation::Model::CreateChangeSetRequest::SetChangeSetName ( const Aws::String value)
inline

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

Definition at line 1253 of file CreateChangeSetRequest.h.

◆ SetChangeSetName() [2/3]

void Aws::CloudFormation::Model::CreateChangeSetRequest::SetChangeSetName ( Aws::String &&  value)
inline

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

Definition at line 1261 of file CreateChangeSetRequest.h.

◆ SetChangeSetName() [3/3]

void Aws::CloudFormation::Model::CreateChangeSetRequest::SetChangeSetName ( const char *  value)
inline

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

Definition at line 1269 of file CreateChangeSetRequest.h.

◆ SetChangeSetType() [1/2]

void Aws::CloudFormation::Model::CreateChangeSetRequest::SetChangeSetType ( const ChangeSetType value)
inline

The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

Definition at line 1453 of file CreateChangeSetRequest.h.

◆ SetChangeSetType() [2/2]

void Aws::CloudFormation::Model::CreateChangeSetRequest::SetChangeSetType ( ChangeSetType &&  value)
inline

The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

Definition at line 1468 of file CreateChangeSetRequest.h.

◆ SetClientToken() [1/3]

void Aws::CloudFormation::Model::CreateChangeSetRequest::SetClientToken ( const Aws::String value)
inline

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

Definition at line 1321 of file CreateChangeSetRequest.h.

◆ SetClientToken() [2/3]

void Aws::CloudFormation::Model::CreateChangeSetRequest::SetClientToken ( Aws::String &&  value)
inline

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

Definition at line 1330 of file CreateChangeSetRequest.h.

◆ SetClientToken() [3/3]

void Aws::CloudFormation::Model::CreateChangeSetRequest::SetClientToken ( const char *  value)
inline

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

Definition at line 1339 of file CreateChangeSetRequest.h.

◆ SetDescription() [1/3]

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

A description to help you identify this change set.

Definition at line 1382 of file CreateChangeSetRequest.h.

◆ SetDescription() [2/3]

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

A description to help you identify this change set.

Definition at line 1387 of file CreateChangeSetRequest.h.

◆ SetDescription() [3/3]

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

A description to help you identify this change set.

Definition at line 1392 of file CreateChangeSetRequest.h.

◆ SetNotificationARNs() [1/2]

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

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

Definition at line 1129 of file CreateChangeSetRequest.h.

◆ SetNotificationARNs() [2/2]

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

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

Definition at line 1136 of file CreateChangeSetRequest.h.

◆ SetParameters() [1/2]

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

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

Definition at line 302 of file CreateChangeSetRequest.h.

◆ SetParameters() [2/2]

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

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

Definition at line 308 of file CreateChangeSetRequest.h.

◆ SetResourcesToImport() [1/2]

void Aws::CloudFormation::Model::CreateChangeSetRequest::SetResourcesToImport ( const Aws::Vector< ResourceToImport > &  value)
inline

The resources to import into your stack.

Definition at line 1514 of file CreateChangeSetRequest.h.

◆ SetResourcesToImport() [2/2]

void Aws::CloudFormation::Model::CreateChangeSetRequest::SetResourcesToImport ( Aws::Vector< ResourceToImport > &&  value)
inline

The resources to import into your stack.

Definition at line 1519 of file CreateChangeSetRequest.h.

◆ SetResourceTypes() [1/2]

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

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

Definition at line 867 of file CreateChangeSetRequest.h.

◆ SetResourceTypes() [2/2]

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

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

Definition at line 882 of file CreateChangeSetRequest.h.

◆ SetRoleARN() [1/3]

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

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1000 of file CreateChangeSetRequest.h.

◆ SetRoleARN() [2/3]

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

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1014 of file CreateChangeSetRequest.h.

◆ SetRoleARN() [3/3]

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

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1028 of file CreateChangeSetRequest.h.

◆ SetRollbackConfiguration() [1/2]

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

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

Definition at line 1089 of file CreateChangeSetRequest.h.

◆ SetRollbackConfiguration() [2/2]

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

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

Definition at line 1095 of file CreateChangeSetRequest.h.

◆ SetStackName() [1/3]

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

The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

Definition at line 72 of file CreateChangeSetRequest.h.

◆ SetStackName() [2/3]

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

The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

Definition at line 80 of file CreateChangeSetRequest.h.

◆ SetStackName() [3/3]

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

The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

Definition at line 88 of file CreateChangeSetRequest.h.

◆ SetTags() [1/2]

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

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

Definition at line 1193 of file CreateChangeSetRequest.h.

◆ SetTags() [2/2]

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

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

Definition at line 1200 of file CreateChangeSetRequest.h.

◆ SetTemplateBody() [1/3]

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

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 140 of file CreateChangeSetRequest.h.

◆ SetTemplateBody() [2/3]

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

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 149 of file CreateChangeSetRequest.h.

◆ SetTemplateBody() [3/3]

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

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 158 of file CreateChangeSetRequest.h.

◆ SetTemplateURL() [1/3]

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

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 213 of file CreateChangeSetRequest.h.

◆ SetTemplateURL() [2/3]

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

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 222 of file CreateChangeSetRequest.h.

◆ SetTemplateURL() [3/3]

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

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 231 of file CreateChangeSetRequest.h.

◆ SetUsePreviousTemplate()

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

Whether to reuse the template that is associated with the stack to create the change set.

Definition at line 277 of file CreateChangeSetRequest.h.

◆ StackNameHasBeenSet()

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

The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

Definition at line 64 of file CreateChangeSetRequest.h.

◆ TagsHasBeenSet()

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

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

Definition at line 1186 of file CreateChangeSetRequest.h.

◆ TemplateBodyHasBeenSet()

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

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 131 of file CreateChangeSetRequest.h.

◆ TemplateURLHasBeenSet()

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

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 204 of file CreateChangeSetRequest.h.

◆ UsePreviousTemplateHasBeenSet()

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

Whether to reuse the template that is associated with the stack to create the change set.

Definition at line 271 of file CreateChangeSetRequest.h.

◆ WithCapabilities() [1/2]

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

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

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, 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 template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.

    Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

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

Definition at line 638 of file CreateChangeSetRequest.h.

◆ WithCapabilities() [2/2]

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

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

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, 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 template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.

    Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

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

Definition at line 699 of file CreateChangeSetRequest.h.

◆ WithChangeSetName() [1/3]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::WithChangeSetName ( const Aws::String value)
inline

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

Definition at line 1277 of file CreateChangeSetRequest.h.

◆ WithChangeSetName() [2/3]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::WithChangeSetName ( Aws::String &&  value)
inline

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

Definition at line 1285 of file CreateChangeSetRequest.h.

◆ WithChangeSetName() [3/3]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::WithChangeSetName ( const char *  value)
inline

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

Definition at line 1293 of file CreateChangeSetRequest.h.

◆ WithChangeSetType() [1/2]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::WithChangeSetType ( const ChangeSetType value)
inline

The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

Definition at line 1483 of file CreateChangeSetRequest.h.

◆ WithChangeSetType() [2/2]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::WithChangeSetType ( ChangeSetType &&  value)
inline

The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

Definition at line 1498 of file CreateChangeSetRequest.h.

◆ WithClientToken() [1/3]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::WithClientToken ( const Aws::String value)
inline

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

Definition at line 1348 of file CreateChangeSetRequest.h.

◆ WithClientToken() [2/3]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::WithClientToken ( Aws::String &&  value)
inline

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

Definition at line 1357 of file CreateChangeSetRequest.h.

◆ WithClientToken() [3/3]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::WithClientToken ( const char *  value)
inline

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

Definition at line 1366 of file CreateChangeSetRequest.h.

◆ WithDescription() [1/3]

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

A description to help you identify this change set.

Definition at line 1397 of file CreateChangeSetRequest.h.

◆ WithDescription() [2/3]

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

A description to help you identify this change set.

Definition at line 1402 of file CreateChangeSetRequest.h.

◆ WithDescription() [3/3]

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

A description to help you identify this change set.

Definition at line 1407 of file CreateChangeSetRequest.h.

◆ WithNotificationARNs() [1/2]

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

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

Definition at line 1143 of file CreateChangeSetRequest.h.

◆ WithNotificationARNs() [2/2]

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

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

Definition at line 1150 of file CreateChangeSetRequest.h.

◆ WithParameters() [1/2]

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

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

Definition at line 314 of file CreateChangeSetRequest.h.

◆ WithParameters() [2/2]

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

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

Definition at line 320 of file CreateChangeSetRequest.h.

◆ WithResourcesToImport() [1/2]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::WithResourcesToImport ( const Aws::Vector< ResourceToImport > &  value)
inline

The resources to import into your stack.

Definition at line 1524 of file CreateChangeSetRequest.h.

◆ WithResourcesToImport() [2/2]

CreateChangeSetRequest& Aws::CloudFormation::Model::CreateChangeSetRequest::WithResourcesToImport ( Aws::Vector< ResourceToImport > &&  value)
inline

The resources to import into your stack.

Definition at line 1529 of file CreateChangeSetRequest.h.

◆ WithResourceTypes() [1/2]

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

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

Definition at line 897 of file CreateChangeSetRequest.h.

◆ WithResourceTypes() [2/2]

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

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

Definition at line 912 of file CreateChangeSetRequest.h.

◆ WithRoleARN() [1/3]

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

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1042 of file CreateChangeSetRequest.h.

◆ WithRoleARN() [2/3]

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

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1056 of file CreateChangeSetRequest.h.

◆ WithRoleARN() [3/3]

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

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

Definition at line 1070 of file CreateChangeSetRequest.h.

◆ WithRollbackConfiguration() [1/2]

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

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

Definition at line 1101 of file CreateChangeSetRequest.h.

◆ WithRollbackConfiguration() [2/2]

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

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

Definition at line 1107 of file CreateChangeSetRequest.h.

◆ WithStackName() [1/3]

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

The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

Definition at line 96 of file CreateChangeSetRequest.h.

◆ WithStackName() [2/3]

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

The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

Definition at line 104 of file CreateChangeSetRequest.h.

◆ WithStackName() [3/3]

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

The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

Definition at line 112 of file CreateChangeSetRequest.h.

◆ WithTags() [1/2]

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

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

Definition at line 1207 of file CreateChangeSetRequest.h.

◆ WithTags() [2/2]

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

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

Definition at line 1214 of file CreateChangeSetRequest.h.

◆ WithTemplateBody() [1/3]

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

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 167 of file CreateChangeSetRequest.h.

◆ WithTemplateBody() [2/3]

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

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 176 of file CreateChangeSetRequest.h.

◆ WithTemplateBody() [3/3]

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

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 185 of file CreateChangeSetRequest.h.

◆ WithTemplateURL() [1/3]

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

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 240 of file CreateChangeSetRequest.h.

◆ WithTemplateURL() [2/3]

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

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 249 of file CreateChangeSetRequest.h.

◆ WithTemplateURL() [3/3]

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

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

Definition at line 258 of file CreateChangeSetRequest.h.

◆ WithUsePreviousTemplate()

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

Whether to reuse the template that is associated with the stack to create the change set.

Definition at line 283 of file CreateChangeSetRequest.h.


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