@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateChangeSetRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
The input for the CreateChangeSet action.
NOOP| Constructor and Description |
|---|
CreateChangeSetRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateChangeSetRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getCapabilities()
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
String |
getChangeSetName()
The name of the change set.
|
String |
getChangeSetType()
The type of change set operation.
|
String |
getClientToken()
A unique identifier for this
CreateChangeSet request. |
String |
getDescription()
A description to help you identify this change set.
|
Boolean |
getImportExistingResources()
Indicates if the change set imports resources that already exist.
|
Boolean |
getIncludeNestedStacks()
Creates a change set for the all nested stacks specified in the template.
|
List<String> |
getNotificationARNs()
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation
associates with the stack.
|
String |
getOnStackFailure()
Determines what action will be taken if stack creation fails.
|
List<Parameter> |
getParameters()
A list of
Parameter structures that specify input parameters for the change set. |
List<ResourceToImport> |
getResourcesToImport()
The resources to import into your stack.
|
List<String> |
getResourceTypes()
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. |
String |
getRoleARN()
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when
executing the change set.
|
RollbackConfiguration |
getRollbackConfiguration()
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
specified monitoring period afterwards.
|
String |
getStackName()
The name or the unique ID of the stack for which you are creating a change set.
|
List<Tag> |
getTags()
Key-value pairs to associate with this stack.
|
String |
getTemplateBody()
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.
|
String |
getTemplateURL()
The location of the file that contains the revised template.
|
Boolean |
getUsePreviousTemplate()
Whether to reuse the template that's associated with the stack to create the change set.
|
int |
hashCode() |
Boolean |
isImportExistingResources()
Indicates if the change set imports resources that already exist.
|
Boolean |
isIncludeNestedStacks()
Creates a change set for the all nested stacks specified in the template.
|
Boolean |
isUsePreviousTemplate()
Whether to reuse the template that's associated with the stack to create the change set.
|
void |
setCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
void |
setChangeSetName(String changeSetName)
The name of the change set.
|
void |
setChangeSetType(ChangeSetType changeSetType)
The type of change set operation.
|
void |
setChangeSetType(String changeSetType)
The type of change set operation.
|
void |
setClientToken(String clientToken)
A unique identifier for this
CreateChangeSet request. |
void |
setDescription(String description)
A description to help you identify this change set.
|
void |
setImportExistingResources(Boolean importExistingResources)
Indicates if the change set imports resources that already exist.
|
void |
setIncludeNestedStacks(Boolean includeNestedStacks)
Creates a change set for the all nested stacks specified in the template.
|
void |
setNotificationARNs(Collection<String> notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation
associates with the stack.
|
void |
setOnStackFailure(OnStackFailure onStackFailure)
Determines what action will be taken if stack creation fails.
|
void |
setOnStackFailure(String onStackFailure)
Determines what action will be taken if stack creation fails.
|
void |
setParameters(Collection<Parameter> parameters)
A list of
Parameter structures that specify input parameters for the change set. |
void |
setResourcesToImport(Collection<ResourceToImport> resourcesToImport)
The resources to import into your stack.
|
void |
setResourceTypes(Collection<String> resourceTypes)
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. |
void |
setRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when
executing the change set.
|
void |
setRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
specified monitoring period afterwards.
|
void |
setStackName(String stackName)
The name or the unique ID of the stack for which you are creating a change set.
|
void |
setTags(Collection<Tag> tags)
Key-value pairs to associate with this stack.
|
void |
setTemplateBody(String templateBody)
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.
|
void |
setTemplateURL(String templateURL)
The location of the file that contains the revised template.
|
void |
setUsePreviousTemplate(Boolean usePreviousTemplate)
Whether to reuse the template that's associated with the stack to create the change set.
|
String |
toString()
Returns a string representation of this object.
|
CreateChangeSetRequest |
withCapabilities(Capability... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
CreateChangeSetRequest |
withCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
CreateChangeSetRequest |
withCapabilities(String... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to create the stack.
|
CreateChangeSetRequest |
withChangeSetName(String changeSetName)
The name of the change set.
|
CreateChangeSetRequest |
withChangeSetType(ChangeSetType changeSetType)
The type of change set operation.
|
CreateChangeSetRequest |
withChangeSetType(String changeSetType)
The type of change set operation.
|
CreateChangeSetRequest |
withClientToken(String clientToken)
A unique identifier for this
CreateChangeSet request. |
CreateChangeSetRequest |
withDescription(String description)
A description to help you identify this change set.
|
CreateChangeSetRequest |
withImportExistingResources(Boolean importExistingResources)
Indicates if the change set imports resources that already exist.
|
CreateChangeSetRequest |
withIncludeNestedStacks(Boolean includeNestedStacks)
Creates a change set for the all nested stacks specified in the template.
|
CreateChangeSetRequest |
withNotificationARNs(Collection<String> notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation
associates with the stack.
|
CreateChangeSetRequest |
withNotificationARNs(String... notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation
associates with the stack.
|
CreateChangeSetRequest |
withOnStackFailure(OnStackFailure onStackFailure)
Determines what action will be taken if stack creation fails.
|
CreateChangeSetRequest |
withOnStackFailure(String onStackFailure)
Determines what action will be taken if stack creation fails.
|
CreateChangeSetRequest |
withParameters(Collection<Parameter> parameters)
A list of
Parameter structures that specify input parameters for the change set. |
CreateChangeSetRequest |
withParameters(Parameter... parameters)
A list of
Parameter structures that specify input parameters for the change set. |
CreateChangeSetRequest |
withResourcesToImport(Collection<ResourceToImport> resourcesToImport)
The resources to import into your stack.
|
CreateChangeSetRequest |
withResourcesToImport(ResourceToImport... resourcesToImport)
The resources to import into your stack.
|
CreateChangeSetRequest |
withResourceTypes(Collection<String> resourceTypes)
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. |
CreateChangeSetRequest |
withResourceTypes(String... resourceTypes)
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. |
CreateChangeSetRequest |
withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when
executing the change set.
|
CreateChangeSetRequest |
withRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
specified monitoring period afterwards.
|
CreateChangeSetRequest |
withStackName(String stackName)
The name or the unique ID of the stack for which you are creating a change set.
|
CreateChangeSetRequest |
withTags(Collection<Tag> tags)
Key-value pairs to associate with this stack.
|
CreateChangeSetRequest |
withTags(Tag... tags)
Key-value pairs to associate with this stack.
|
CreateChangeSetRequest |
withTemplateBody(String templateBody)
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.
|
CreateChangeSetRequest |
withTemplateURL(String templateURL)
The location of the file that contains the revised template.
|
CreateChangeSetRequest |
withUsePreviousTemplate(Boolean usePreviousTemplate)
Whether to reuse the template that's associated with the stack to create the change set.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setStackName(String stackName)
The name or the unique ID of the stack for which you are creating a change set. 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.
stackName - The name or the unique ID of the stack for which you are creating a change set. 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.public String getStackName()
The name or the unique ID of the stack for which you are creating a change set. 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.
public CreateChangeSetRequest withStackName(String stackName)
The name or the unique ID of the stack for which you are creating a change set. 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.
stackName - The name or the unique ID of the stack for which you are creating a change set. 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.public void setTemplateBody(String templateBody)
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. 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.
templateBody - 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. 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.
public String getTemplateBody()
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. 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.
Conditional: You must specify only TemplateBody or TemplateURL.
public CreateChangeSetRequest withTemplateBody(String templateBody)
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. 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.
templateBody - 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. 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.
public void setTemplateURL(String templateURL)
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800
bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change
set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start
with https://.
Conditional: You must specify only TemplateBody or TemplateURL.
templateURL - The location of the file that contains the revised template. The URL must point to a template (max size:
460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation
generates the change set by comparing this template with the stack that you specified. The location for an
Amazon S3 bucket must start with https://.
Conditional: You must specify only TemplateBody or TemplateURL.
public String getTemplateURL()
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800
bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change
set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start
with https://.
Conditional: You must specify only TemplateBody or TemplateURL.
https://.
Conditional: You must specify only TemplateBody or TemplateURL.
public CreateChangeSetRequest withTemplateURL(String templateURL)
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800
bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change
set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start
with https://.
Conditional: You must specify only TemplateBody or TemplateURL.
templateURL - The location of the file that contains the revised template. The URL must point to a template (max size:
460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation
generates the change set by comparing this template with the stack that you specified. The location for an
Amazon S3 bucket must start with https://.
Conditional: You must specify only TemplateBody or TemplateURL.
public void setUsePreviousTemplate(Boolean usePreviousTemplate)
Whether to reuse the template that's associated with the stack to create the change set.
usePreviousTemplate - Whether to reuse the template that's associated with the stack to create the change set.public Boolean getUsePreviousTemplate()
Whether to reuse the template that's associated with the stack to create the change set.
public CreateChangeSetRequest withUsePreviousTemplate(Boolean usePreviousTemplate)
Whether to reuse the template that's associated with the stack to create the change set.
usePreviousTemplate - Whether to reuse the template that's associated with the stack to create the change set.public Boolean isUsePreviousTemplate()
Whether to reuse the template that's associated with the stack to create the change set.
public List<Parameter> getParameters()
A list of Parameter structures that specify input parameters for the change set. For more
information, see the Parameter data type.
Parameter structures that specify input parameters for the change set. For more
information, see the Parameter data type.public void setParameters(Collection<Parameter> parameters)
A list of Parameter structures that specify input parameters for the change set. For more
information, see the Parameter data type.
parameters - A list of Parameter structures that specify input parameters for the change set. For more
information, see the Parameter data type.public CreateChangeSetRequest withParameters(Parameter... parameters)
A list of Parameter structures that specify input parameters for the change set. For more
information, see the Parameter data type.
NOTE: This method appends the values to the existing list (if any). Use
setParameters(java.util.Collection) or withParameters(java.util.Collection) if you want to
override the existing values.
parameters - A list of Parameter structures that specify input parameters for the change set. For more
information, see the Parameter data type.public CreateChangeSetRequest withParameters(Collection<Parameter> parameters)
A list of Parameter structures that specify input parameters for the change set. For more
information, see the Parameter data type.
parameters - A list of Parameter structures that specify input parameters for the change set. For more
information, see the Parameter data type.public List<String> getCapabilities()
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new 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, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
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 about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new 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, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
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 about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic void setCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new 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, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
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 about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new 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, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
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 about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic CreateChangeSetRequest withCapabilities(String... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new 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, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
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 about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
NOTE: This method appends the values to the existing list (if any). Use
setCapabilities(java.util.Collection) or withCapabilities(java.util.Collection) if you want to
override the existing values.
capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new 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, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
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 about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic CreateChangeSetRequest withCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new 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, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
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 about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new 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, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
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 about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic CreateChangeSetRequest withCapabilities(Capability... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new 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, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
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 about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
capabilities - In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in
order for CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new 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, CloudFormation returns an
InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM resources in 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 CloudFormation.
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.
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 about macros, see Using CloudFormation macros to perform custom processing on templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic List<String> getResourceTypes()
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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
Only one of the Capabilities and ResourceType parameters can be specified.
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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
Only one of the Capabilities and ResourceType parameters can be specified.
public void setResourceTypes(Collection<String> resourceTypes)
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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
Only one of the Capabilities and ResourceType parameters can be specified.
resourceTypes - 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
Only one of the Capabilities and ResourceType parameters can be specified.
public CreateChangeSetRequest withResourceTypes(String... resourceTypes)
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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
Only one of the Capabilities and ResourceType parameters can be specified.
NOTE: This method appends the values to the existing list (if any). Use
setResourceTypes(java.util.Collection) or withResourceTypes(java.util.Collection) if you want
to override the existing values.
resourceTypes - 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
Only one of the Capabilities and ResourceType parameters can be specified.
public CreateChangeSetRequest withResourceTypes(Collection<String> resourceTypes)
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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
Only one of the Capabilities and ResourceType parameters can be specified.
resourceTypes - 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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
Only one of the Capabilities and ResourceType parameters can be specified.
public void setRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes
when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf.
CloudFormation uses this role for all future operations on the stack. Provided that users have permission
to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it.
Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
public String getRoleARN()
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
public CreateChangeSetRequest withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes
when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf.
CloudFormation uses this role for all future operations on the stack. Provided that users have permission
to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it.
Ensure that the role grants least permission.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
public void setRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for
the specified monitoring period afterwards.public RollbackConfiguration getRollbackConfiguration()
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
public CreateChangeSetRequest withRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for
the specified monitoring period afterwards.public List<String> getNotificationARNs()
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
public void setNotificationARNs(Collection<String> notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
notificationARNs - The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that
CloudFormation associates with the stack. To remove all associated notification topics, specify an empty
list.public CreateChangeSetRequest withNotificationARNs(String... notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
NOTE: This method appends the values to the existing list (if any). Use
setNotificationARNs(java.util.Collection) or withNotificationARNs(java.util.Collection) if you
want to override the existing values.
notificationARNs - The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that
CloudFormation associates with the stack. To remove all associated notification topics, specify an empty
list.public CreateChangeSetRequest withNotificationARNs(Collection<String> notificationARNs)
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
notificationARNs - The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that
CloudFormation associates with the stack. To remove all associated notification topics, specify an empty
list.public List<Tag> getTags()
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.
public void setTags(Collection<Tag> tags)
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.
tags - Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in
the stack. You can specify a maximum of 50 tags.public CreateChangeSetRequest withTags(Tag... tags)
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the
existing values.
tags - Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in
the stack. You can specify a maximum of 50 tags.public CreateChangeSetRequest withTags(Collection<Tag> tags)
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.
tags - Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in
the stack. You can specify a maximum of 50 tags.public void setChangeSetName(String changeSetName)
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 alphabetical character and can't exceed 128 characters.
changeSetName - 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 alphabetical character and can't exceed 128 characters.
public String getChangeSetName()
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 alphabetical character and can't exceed 128 characters.
A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can't exceed 128 characters.
public CreateChangeSetRequest withChangeSetName(String changeSetName)
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 alphabetical character and can't exceed 128 characters.
changeSetName - 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 alphabetical character and can't exceed 128 characters.
public void setClientToken(String clientToken)
A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to create another change set with the same name.
You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
clientToken - A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to create another change set with the
same name. You might retry CreateChangeSet requests to ensure that CloudFormation
successfully received them.public String getClientToken()
A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to create another change set with the same name.
You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
CreateChangeSet request. Specify this token if you plan to
retry requests so that CloudFormation knows that you're not attempting to create another change set with
the same name. You might retry CreateChangeSet requests to ensure that CloudFormation
successfully received them.public CreateChangeSetRequest withClientToken(String clientToken)
A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to create another change set with the same name.
You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.
clientToken - A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to create another change set with the
same name. You might retry CreateChangeSet requests to ensure that CloudFormation
successfully received them.public void setDescription(String description)
A description to help you identify this change set.
description - A description to help you identify this change set.public String getDescription()
A description to help you identify this change set.
public CreateChangeSetRequest withDescription(String description)
A description to help you identify this change set.
description - A description to help you identify this change set.public void setChangeSetType(String changeSetType)
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, 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, 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.
changeSetType - 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, 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, 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.
ChangeSetTypepublic String getChangeSetType()
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, 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, 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.
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, 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, 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.
ChangeSetTypepublic CreateChangeSetRequest withChangeSetType(String changeSetType)
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, 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, 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.
changeSetType - 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, 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, 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.
ChangeSetTypepublic void setChangeSetType(ChangeSetType changeSetType)
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, 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, 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.
changeSetType - 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, 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, 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.
ChangeSetTypepublic CreateChangeSetRequest withChangeSetType(ChangeSetType changeSetType)
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, 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, 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.
changeSetType - 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, 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, 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.
ChangeSetTypepublic List<ResourceToImport> getResourcesToImport()
The resources to import into your stack.
public void setResourcesToImport(Collection<ResourceToImport> resourcesToImport)
The resources to import into your stack.
resourcesToImport - The resources to import into your stack.public CreateChangeSetRequest withResourcesToImport(ResourceToImport... resourcesToImport)
The resources to import into your stack.
NOTE: This method appends the values to the existing list (if any). Use
setResourcesToImport(java.util.Collection) or withResourcesToImport(java.util.Collection) if
you want to override the existing values.
resourcesToImport - The resources to import into your stack.public CreateChangeSetRequest withResourcesToImport(Collection<ResourceToImport> resourcesToImport)
The resources to import into your stack.
resourcesToImport - The resources to import into your stack.public void setIncludeNestedStacks(Boolean includeNestedStacks)
Creates a change set for the all nested stacks specified in the template. The default behavior of this action is
set to False. To include nested sets in a change set, specify True.
includeNestedStacks - Creates a change set for the all nested stacks specified in the template. The default behavior of this
action is set to False. To include nested sets in a change set, specify True.public Boolean getIncludeNestedStacks()
Creates a change set for the all nested stacks specified in the template. The default behavior of this action is
set to False. To include nested sets in a change set, specify True.
False. To include nested sets in a change set, specify True.public CreateChangeSetRequest withIncludeNestedStacks(Boolean includeNestedStacks)
Creates a change set for the all nested stacks specified in the template. The default behavior of this action is
set to False. To include nested sets in a change set, specify True.
includeNestedStacks - Creates a change set for the all nested stacks specified in the template. The default behavior of this
action is set to False. To include nested sets in a change set, specify True.public Boolean isIncludeNestedStacks()
Creates a change set for the all nested stacks specified in the template. The default behavior of this action is
set to False. To include nested sets in a change set, specify True.
False. To include nested sets in a change set, specify True.public void setOnStackFailure(String onStackFailure)
Determines what action will be taken if stack creation fails. If this parameter is specified, the
DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the
ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the
status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change
set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all
stacks to be deleted.
onStackFailure - Determines what action will be taken if stack creation fails. If this parameter is specified, the
DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the
ChangeSetType parameter is set to CREATE. If the deletion of the stack fails,
the status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the
change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail
and all stacks to be deleted.
OnStackFailurepublic String getOnStackFailure()
Determines what action will be taken if stack creation fails. If this parameter is specified, the
DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the
ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the
status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change
set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all
stacks to be deleted.
DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the
ChangeSetType parameter is set to CREATE. If the deletion of the stack fails,
the status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to
specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the
change set for the parent stack, any failure in a child stack will cause the parent stack creation to
fail and all stacks to be deleted.
OnStackFailurepublic CreateChangeSetRequest withOnStackFailure(String onStackFailure)
Determines what action will be taken if stack creation fails. If this parameter is specified, the
DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the
ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the
status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change
set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all
stacks to be deleted.
onStackFailure - Determines what action will be taken if stack creation fails. If this parameter is specified, the
DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the
ChangeSetType parameter is set to CREATE. If the deletion of the stack fails,
the status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the
change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail
and all stacks to be deleted.
OnStackFailurepublic void setOnStackFailure(OnStackFailure onStackFailure)
Determines what action will be taken if stack creation fails. If this parameter is specified, the
DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the
ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the
status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change
set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all
stacks to be deleted.
onStackFailure - Determines what action will be taken if stack creation fails. If this parameter is specified, the
DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the
ChangeSetType parameter is set to CREATE. If the deletion of the stack fails,
the status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the
change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail
and all stacks to be deleted.
OnStackFailurepublic CreateChangeSetRequest withOnStackFailure(OnStackFailure onStackFailure)
Determines what action will be taken if stack creation fails. If this parameter is specified, the
DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the
ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the
status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change
set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all
stacks to be deleted.
onStackFailure - Determines what action will be taken if stack creation fails. If this parameter is specified, the
DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
DELETE - Deletes the change set if the stack creation fails. This is only valid when the
ChangeSetType parameter is set to CREATE. If the deletion of the stack fails,
the status of the stack is DELETE_FAILED.
DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying
true for the DisableRollback parameter to the ExecuteChangeSet API operation.
ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying
false for the DisableRollback parameter to the ExecuteChangeSet API operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the
change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail
and all stacks to be deleted.
OnStackFailurepublic void setImportExistingResources(Boolean importExistingResources)
Indicates if the change set imports resources that already exist.
This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation management in the CloudFormation User Guide.
importExistingResources - Indicates if the change set imports resources that already exist. This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation management in the CloudFormation User Guide.
public Boolean getImportExistingResources()
Indicates if the change set imports resources that already exist.
This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation management in the CloudFormation User Guide.
This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation management in the CloudFormation User Guide.
public CreateChangeSetRequest withImportExistingResources(Boolean importExistingResources)
Indicates if the change set imports resources that already exist.
This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation management in the CloudFormation User Guide.
importExistingResources - Indicates if the change set imports resources that already exist. This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation management in the CloudFormation User Guide.
public Boolean isImportExistingResources()
Indicates if the change set imports resources that already exist.
This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation management in the CloudFormation User Guide.
This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation management in the CloudFormation User Guide.
public String toString()
toString in class ObjectObject.toString()public CreateChangeSetRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()