@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateStackRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
The input for an UpdateStack action.
NOOP| Constructor and Description |
|---|
UpdateStackRequest() |
| Modifier and Type | Method and Description |
|---|---|
UpdateStackRequest |
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 update the stack.
|
String |
getClientRequestToken()
A unique identifier for this
UpdateStack request. |
Boolean |
getDisableRollback()
Preserve the state of previously provisioned resources when an operation fails.
|
List<String> |
getNotificationARNs()
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the
stack.
|
List<Parameter> |
getParameters()
A list of
Parameter structures that specify input parameters for the stack. |
List<String> |
getResourceTypes()
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. |
Boolean |
getRetainExceptOnCreate()
When set to
true, newly created resources are deleted when the operation rolls back. |
String |
getRoleARN()
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to
update the stack.
|
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 unique stack ID of the stack to update.
|
String |
getStackPolicyBody()
Structure containing a new stack policy body.
|
String |
getStackPolicyDuringUpdateBody()
Structure containing the temporary overriding stack policy body.
|
String |
getStackPolicyDuringUpdateURL()
Location of a file containing the temporary overriding stack policy.
|
String |
getStackPolicyURL()
Location of a file containing the updated stack policy.
|
List<Tag> |
getTags()
Key-value pairs to associate with this stack.
|
String |
getTemplateBody()
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
|
String |
getTemplateURL()
Location of file containing the template body.
|
Boolean |
getUsePreviousTemplate()
Reuse the existing template that is associated with the stack that you are updating.
|
int |
hashCode() |
Boolean |
isDisableRollback()
Preserve the state of previously provisioned resources when an operation fails.
|
Boolean |
isRetainExceptOnCreate()
When set to
true, newly created resources are deleted when the operation rolls back. |
Boolean |
isUsePreviousTemplate()
Reuse the existing template that is associated with the stack that you are updating.
|
void |
setCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to update the stack.
|
void |
setClientRequestToken(String clientRequestToken)
A unique identifier for this
UpdateStack request. |
void |
setDisableRollback(Boolean disableRollback)
Preserve the state of previously provisioned resources when an operation fails.
|
void |
setNotificationARNs(Collection<String> notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the
stack.
|
void |
setParameters(Collection<Parameter> parameters)
A list of
Parameter structures that specify input parameters for the stack. |
void |
setResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. |
void |
setRetainExceptOnCreate(Boolean retainExceptOnCreate)
When set to
true, newly created resources are deleted when the operation rolls back. |
void |
setRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to
update the stack.
|
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 unique stack ID of the stack to update.
|
void |
setStackPolicyBody(String stackPolicyBody)
Structure containing a new stack policy body.
|
void |
setStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
Structure containing the temporary overriding stack policy body.
|
void |
setStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)
Location of a file containing the temporary overriding stack policy.
|
void |
setStackPolicyURL(String stackPolicyURL)
Location of a file containing the updated stack policy.
|
void |
setTags(Collection<Tag> tags)
Key-value pairs to associate with this stack.
|
void |
setTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
|
void |
setTemplateURL(String templateURL)
Location of file containing the template body.
|
void |
setUsePreviousTemplate(Boolean usePreviousTemplate)
Reuse the existing template that is associated with the stack that you are updating.
|
String |
toString()
Returns a string representation of this object.
|
UpdateStackRequest |
withCapabilities(Capability... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to update the stack.
|
UpdateStackRequest |
withCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to update the stack.
|
UpdateStackRequest |
withCapabilities(String... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
for CloudFormation to update the stack.
|
UpdateStackRequest |
withClientRequestToken(String clientRequestToken)
A unique identifier for this
UpdateStack request. |
UpdateStackRequest |
withDisableRollback(Boolean disableRollback)
Preserve the state of previously provisioned resources when an operation fails.
|
UpdateStackRequest |
withNotificationARNs(Collection<String> notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the
stack.
|
UpdateStackRequest |
withNotificationARNs(String... notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the
stack.
|
UpdateStackRequest |
withParameters(Collection<Parameter> parameters)
A list of
Parameter structures that specify input parameters for the stack. |
UpdateStackRequest |
withParameters(Parameter... parameters)
A list of
Parameter structures that specify input parameters for the stack. |
UpdateStackRequest |
withResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. |
UpdateStackRequest |
withResourceTypes(String... resourceTypes)
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. |
UpdateStackRequest |
withRetainExceptOnCreate(Boolean retainExceptOnCreate)
When set to
true, newly created resources are deleted when the operation rolls back. |
UpdateStackRequest |
withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to
update the stack.
|
UpdateStackRequest |
withRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the
specified monitoring period afterwards.
|
UpdateStackRequest |
withStackName(String stackName)
The name or unique stack ID of the stack to update.
|
UpdateStackRequest |
withStackPolicyBody(String stackPolicyBody)
Structure containing a new stack policy body.
|
UpdateStackRequest |
withStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
Structure containing the temporary overriding stack policy body.
|
UpdateStackRequest |
withStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)
Location of a file containing the temporary overriding stack policy.
|
UpdateStackRequest |
withStackPolicyURL(String stackPolicyURL)
Location of a file containing the updated stack policy.
|
UpdateStackRequest |
withTags(Collection<Tag> tags)
Key-value pairs to associate with this stack.
|
UpdateStackRequest |
withTags(Tag... tags)
Key-value pairs to associate with this stack.
|
UpdateStackRequest |
withTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
|
UpdateStackRequest |
withTemplateURL(String templateURL)
Location of file containing the template body.
|
UpdateStackRequest |
withUsePreviousTemplate(Boolean usePreviousTemplate)
Reuse the existing template that is associated with the stack that you are updating.
|
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 unique stack ID of the stack to update.
stackName - The name or unique stack ID of the stack to update.public String getStackName()
The name or unique stack ID of the stack to update.
public UpdateStackRequest withStackName(String stackName)
The name or unique stack ID of the stack to update.
stackName - The name or unique stack ID of the stack to update.public void setTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
templateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200
bytes. (For more information, go to Template
Anatomy in the CloudFormation User Guide.)
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
public String getTemplateBody()
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
public UpdateStackRequest withTemplateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
templateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200
bytes. (For more information, go to Template
Anatomy in the CloudFormation User Guide.)
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
public void setTemplateURL(String templateURL)
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3
bucket or a Systems Manager document. For more information, go to Template Anatomy
in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with
https://.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
templateURL - Location of file containing the template body. The URL must point to a template that's located in an
Amazon S3 bucket or a Systems Manager document. For more information, go to Template
Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with
https://.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
public String getTemplateURL()
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3
bucket or a Systems Manager document. For more information, go to Template Anatomy
in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with
https://.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
https://.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
public UpdateStackRequest withTemplateURL(String templateURL)
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3
bucket or a Systems Manager document. For more information, go to Template Anatomy
in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with
https://.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
templateURL - Location of file containing the template body. The URL must point to a template that's located in an
Amazon S3 bucket or a Systems Manager document. For more information, go to Template
Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with
https://.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
public void setUsePreviousTemplate(Boolean usePreviousTemplate)
Reuse the existing template that is associated with the stack that you are updating.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
usePreviousTemplate - Reuse the existing template that is associated with the stack that you are updating.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
public Boolean getUsePreviousTemplate()
Reuse the existing template that is associated with the stack that you are updating.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
public UpdateStackRequest withUsePreviousTemplate(Boolean usePreviousTemplate)
Reuse the existing template that is associated with the stack that you are updating.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
usePreviousTemplate - Reuse the existing template that is associated with the stack that you are updating.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
public Boolean isUsePreviousTemplate()
Reuse the existing template that is associated with the stack that you are updating.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
Conditional: You must specify only one of the following parameters: TemplateBody,
TemplateURL, or set the UsePreviousTemplate to true.
public void setStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
Structure containing the temporary overriding stack policy body. You can specify either the
StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
stackPolicyDuringUpdateBody - Structure containing the temporary overriding stack policy body. You can specify either the
StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not
both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
public String getStackPolicyDuringUpdateBody()
Structure containing the temporary overriding stack policy body. You can specify either the
StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but
not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
public UpdateStackRequest withStackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
Structure containing the temporary overriding stack policy body. You can specify either the
StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
stackPolicyDuringUpdateBody - Structure containing the temporary overriding stack policy body. You can specify either the
StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not
both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
public void setStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)
Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:
16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start
with https://. You can specify either the StackPolicyDuringUpdateBody or the
StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
stackPolicyDuringUpdateURL - Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max
size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket
must start with https://. You can specify either the StackPolicyDuringUpdateBody
or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
public String getStackPolicyDuringUpdateURL()
Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:
16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start
with https://. You can specify either the StackPolicyDuringUpdateBody or the
StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
https://. You can specify either the
StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but
not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
public UpdateStackRequest withStackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)
Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:
16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start
with https://. You can specify either the StackPolicyDuringUpdateBody or the
StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
stackPolicyDuringUpdateURL - Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max
size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket
must start with https://. You can specify either the StackPolicyDuringUpdateBody
or the StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.
public List<Parameter> getParameters()
A list of Parameter structures that specify input parameters for the stack. For more information,
see the Parameter data
type.
Parameter structures that specify input parameters for the stack. 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 stack. For more information,
see the Parameter data
type.
parameters - A list of Parameter structures that specify input parameters for the stack. For more
information, see the Parameter
data type.public UpdateStackRequest withParameters(Parameter... parameters)
A list of Parameter structures that specify input parameters for the stack. 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 stack. For more
information, see the Parameter
data type.public UpdateStackRequest withParameters(Collection<Parameter> parameters)
A list of Parameter structures that specify input parameters for the stack. For more information,
see the Parameter data
type.
parameters - A list of Parameter structures that specify input parameters for the stack. 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 update 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, 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 update 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, 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 update 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic UpdateStackRequest withCapabilities(String... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, 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 update 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic UpdateStackRequest withCapabilities(Collection<String> capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, 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 update 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
Only one of the Capabilities and ResourceType parameters can be specified.
Capabilitypublic UpdateStackRequest withCapabilities(Capability... capabilities)
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, 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 update 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 updating the stack. If your stack template contains one or more macros, and you choose to update 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.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, 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 for this update stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource 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 CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
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 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 CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
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 for this update stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource 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 CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
resourceTypes - The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource 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 CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
public UpdateStackRequest withResourceTypes(String... resourceTypes)
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource 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 CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
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 for this update stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource 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 CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
public UpdateStackRequest withResourceTypes(Collection<String> resourceTypes)
The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource 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 CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
Only one of the Capabilities and ResourceType parameters can be specified.
resourceTypes - The template resource types that you have permissions to work with for this update stack action, such as
AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource 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 CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
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 to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always 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 privilege.
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
to update the stack. CloudFormation uses the role's credentials to make calls on your behalf.
CloudFormation always 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 privilege.
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 to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always 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 privilege.
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 UpdateStackRequest withRoleARN(String roleARN)
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always 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 privilege.
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
to update the stack. CloudFormation uses the role's credentials to make calls on your behalf.
CloudFormation always 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 privilege.
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 UpdateStackRequest 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 void setStackPolicyBody(String stackPolicyBody)
Structure containing a new stack policy body. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
stackPolicyBody - Structure containing a new stack policy body. You can specify either the StackPolicyBody or
the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
public String getStackPolicyBody()
Structure containing a new stack policy body. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
StackPolicyBody or
the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
public UpdateStackRequest withStackPolicyBody(String stackPolicyBody)
Structure containing a new stack policy body. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
stackPolicyBody - Structure containing a new stack policy body. You can specify either the StackPolicyBody or
the StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
public void setStackPolicyURL(String stackPolicyURL)
Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located
in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with
https://. You can specify either the StackPolicyBody or the StackPolicyURL
parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
stackPolicyURL - Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB)
located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start
with https://. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
public String getStackPolicyURL()
Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located
in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with
https://. You can specify either the StackPolicyBody or the StackPolicyURL
parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
https://. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
public UpdateStackRequest withStackPolicyURL(String stackPolicyURL)
Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located
in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with
https://. You can specify either the StackPolicyBody or the StackPolicyURL
parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
stackPolicyURL - Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB)
located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start
with https://. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.
public List<String> getNotificationARNs()
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
public void setNotificationARNs(Collection<String> notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
notificationARNs - Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with
the stack. Specify an empty list to remove all notification topics.public UpdateStackRequest withNotificationARNs(String... notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
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 - Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with
the stack. Specify an empty list to remove all notification topics.public UpdateStackRequest withNotificationARNs(Collection<String> notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
notificationARNs - Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with
the stack. Specify an empty list to remove all notification topics.public List<Tag> getTags()
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
public void setTags(Collection<Tag> tags)
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
tags - Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported
resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
public UpdateStackRequest withTags(Tag... tags)
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated 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 supported
resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
public UpdateStackRequest withTags(Collection<Tag> tags)
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
tags - Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported
resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
public void setDisableRollback(Boolean disableRollback)
Preserve the state of previously provisioned resources when an operation fails.
Default: False
disableRollback - Preserve the state of previously provisioned resources when an operation fails.
Default: False
public Boolean getDisableRollback()
Preserve the state of previously provisioned resources when an operation fails.
Default: False
Default: False
public UpdateStackRequest withDisableRollback(Boolean disableRollback)
Preserve the state of previously provisioned resources when an operation fails.
Default: False
disableRollback - Preserve the state of previously provisioned resources when an operation fails.
Default: False
public Boolean isDisableRollback()
Preserve the state of previously provisioned resources when an operation fails.
Default: False
Default: False
public void setClientRequestToken(String clientRequestToken)
A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests
so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry
UpdateStack requests to ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to
track operations. For example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will have
ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are
initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
the stack operation . For example, if you create a stack using the console, each stack event would be assigned
the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
clientRequestToken - A unique identifier for this UpdateStack request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You
might retry UpdateStack requests to ensure that CloudFormation successfully received
them.
All events triggered by a given stack operation are assigned the same client request token, which you can
use to track operations. For example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will have
ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that
are initiated from the console use the token format Console-StackOperation-ID, which helps you
easily identify the stack operation . For example, if you create a stack using the console, each stack
event would be assigned the same token in the following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
public String getClientRequestToken()
A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests
so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry
UpdateStack requests to ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to
track operations. For example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will have
ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are
initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
the stack operation . For example, if you create a stack using the console, each stack event would be assigned
the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
UpdateStack request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to update a stack with the same name.
You might retry UpdateStack requests to ensure that CloudFormation successfully received
them.
All events triggered by a given stack operation are assigned the same client request token, which you can
use to track operations. For example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will have
ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations
that are initiated from the console use the token format Console-StackOperation-ID, which helps
you easily identify the stack operation . For example, if you create a stack using the console, each
stack event would be assigned the same token in the following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
public UpdateStackRequest withClientRequestToken(String clientRequestToken)
A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests
so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry
UpdateStack requests to ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to
track operations. For example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will have
ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are
initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
the stack operation . For example, if you create a stack using the console, each stack event would be assigned
the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
clientRequestToken - A unique identifier for this UpdateStack request. Specify this token if you plan to retry
requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You
might retry UpdateStack requests to ensure that CloudFormation successfully received
them.
All events triggered by a given stack operation are assigned the same client request token, which you can
use to track operations. For example, if you execute a CreateStack operation with the token
token1, then all the StackEvents generated by that operation will have
ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that
are initiated from the console use the token format Console-StackOperation-ID, which helps you
easily identify the stack operation . For example, if you create a stack using the console, each stack
event would be assigned the same token in the following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
public void setRetainExceptOnCreate(Boolean retainExceptOnCreate)
When set to true, newly created resources are deleted when the operation rolls back. This includes
newly created resources marked with a deletion policy of Retain.
Default: false
retainExceptOnCreate - When set to true, newly created resources are deleted when the operation rolls back. This
includes newly created resources marked with a deletion policy of Retain.
Default: false
public Boolean getRetainExceptOnCreate()
When set to true, newly created resources are deleted when the operation rolls back. This includes
newly created resources marked with a deletion policy of Retain.
Default: false
true, newly created resources are deleted when the operation rolls back. This
includes newly created resources marked with a deletion policy of Retain.
Default: false
public UpdateStackRequest withRetainExceptOnCreate(Boolean retainExceptOnCreate)
When set to true, newly created resources are deleted when the operation rolls back. This includes
newly created resources marked with a deletion policy of Retain.
Default: false
retainExceptOnCreate - When set to true, newly created resources are deleted when the operation rolls back. This
includes newly created resources marked with a deletion policy of Retain.
Default: false
public Boolean isRetainExceptOnCreate()
When set to true, newly created resources are deleted when the operation rolls back. This includes
newly created resources marked with a deletion policy of Retain.
Default: false
true, newly created resources are deleted when the operation rolls back. This
includes newly created resources marked with a deletion policy of Retain.
Default: false
public String toString()
toString in class ObjectObject.toString()public UpdateStackRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()