public static interface UpdateStackRequest.Builder extends CloudFormationRequest.Builder, CopyableBuilder<UpdateStackRequest.Builder,UpdateStackRequest>
Modifier and Type | Method and Description |
---|---|
UpdateStackRequest.Builder |
capabilities(Collection<String> capabilities)
A list of values that you must specify before AWS CloudFormation can update certain stacks.
|
UpdateStackRequest.Builder |
capabilities(String... capabilities)
A list of values that you must specify before AWS CloudFormation can update certain stacks.
|
UpdateStackRequest.Builder |
clientRequestToken(String clientRequestToken)
A unique identifier for this
UpdateStack request. |
UpdateStackRequest.Builder |
notificationARNs(Collection<String> notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with
the stack.
|
UpdateStackRequest.Builder |
notificationARNs(String... notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with
the stack.
|
UpdateStackRequest.Builder |
parameters(Collection<Parameter> parameters)
A list of
Parameter structures that specify input parameters for the stack. |
UpdateStackRequest.Builder |
parameters(Parameter... parameters)
A list of
Parameter structures that specify input parameters for the stack. |
UpdateStackRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
UpdateStackRequest.Builder |
resourceTypes(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.Builder |
resourceTypes(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.Builder |
roleARN(String roleARN)
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
assumes to update the stack.
|
default UpdateStackRequest.Builder |
rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and
for the specified monitoring period afterwards.
|
UpdateStackRequest.Builder |
rollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and
for the specified monitoring period afterwards.
|
UpdateStackRequest.Builder |
stackName(String stackName)
The name or unique stack ID of the stack to update.
|
UpdateStackRequest.Builder |
stackPolicyBody(String stackPolicyBody)
Structure containing a new stack policy body.
|
UpdateStackRequest.Builder |
stackPolicyDuringUpdateBody(String stackPolicyDuringUpdateBody)
Structure containing the temporary overriding stack policy body.
|
UpdateStackRequest.Builder |
stackPolicyDuringUpdateURL(String stackPolicyDuringUpdateURL)
Location of a file containing the temporary overriding stack policy.
|
UpdateStackRequest.Builder |
stackPolicyURL(String stackPolicyURL)
Location of a file containing the updated stack policy.
|
UpdateStackRequest.Builder |
tags(Collection<Tag> tags)
Key-value pairs to associate with this stack.
|
UpdateStackRequest.Builder |
tags(Tag... tags)
Key-value pairs to associate with this stack.
|
UpdateStackRequest.Builder |
templateBody(String templateBody)
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
|
UpdateStackRequest.Builder |
templateURL(String templateURL)
Location of file containing the template body.
|
UpdateStackRequest.Builder |
usePreviousTemplate(Boolean usePreviousTemplate)
Reuse the existing template that is associated with the stack that you are updating.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
UpdateStackRequest.Builder stackName(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.UpdateStackRequest.Builder templateBody(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 AWS 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 AWS CloudFormation User Guide.)
Conditional: You must specify only one of the following parameters: TemplateBody
,
TemplateURL
, or set the UsePreviousTemplate
to true
.
UpdateStackRequest.Builder templateURL(String templateURL)
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
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 is located in an
Amazon S3 bucket. For more information, go to Template
Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody
,
TemplateURL
, or set the UsePreviousTemplate
to true
.
UpdateStackRequest.Builder usePreviousTemplate(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
.
UpdateStackRequest.Builder stackPolicyDuringUpdateBody(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 do not 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 do not specify a stack policy, the current policy that is associated with the stack will be used.
UpdateStackRequest.Builder stackPolicyDuringUpdateURL(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. 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 do not 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. 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 do not specify a stack policy, the current policy that is associated with the stack will be used.
UpdateStackRequest.Builder parameters(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.UpdateStackRequest.Builder parameters(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.UpdateStackRequest.Builder capabilities(Collection<String> capabilities)
A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you
review all permissions associated with them and edit their permissions if necessary.
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 this parameter, this action returns
an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
capabilities
- A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack
templates might include resources that can affect permissions in your AWS account, for example, by
creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly
acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The
following resources require you to specify this parameter:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend
that you review all permissions associated with them and edit their permissions if necessary.
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 this parameter, this
action returns an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
UpdateStackRequest.Builder capabilities(String... capabilities)
A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The following
resources require you to specify this parameter:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you
review all permissions associated with them and edit their permissions if necessary.
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 this parameter, this action returns
an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
capabilities
- A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack
templates might include resources that can affect permissions in your AWS account, for example, by
creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly
acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
. The
following resources require you to specify this parameter:
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend
that you review all permissions associated with them and edit their permissions if necessary.
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 this parameter, this
action returns an InsufficientCapabilities
error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
UpdateStackRequest.Builder resourceTypes(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, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
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, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
UpdateStackRequest.Builder resourceTypes(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, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
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, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
UpdateStackRequest.Builder roleARN(String roleARN)
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
roleARN
- The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS
CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make
calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack.
As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if
the users don't have permission to pass it. Ensure that the role grants least privilege.
If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
UpdateStackRequest.Builder rollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
rollbackConfiguration
- The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations,
and for the specified monitoring period afterwards.default UpdateStackRequest.Builder rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
This is a convenience that creates an instance of theRollbackConfiguration.Builder
avoiding the need
to create one manually via RollbackConfiguration.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to rollbackConfiguration(RollbackConfiguration)
.rollbackConfiguration
- a consumer that will call methods on RollbackConfiguration.Builder
rollbackConfiguration(RollbackConfiguration)
UpdateStackRequest.Builder stackPolicyBody(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 do not 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 do not specify a stack policy, the current policy that is associated with the stack is unchanged.
UpdateStackRequest.Builder stackPolicyURL(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. 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 do not 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. 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 do not specify a stack policy, the current policy that is associated with the stack is unchanged.
UpdateStackRequest.Builder notificationARNs(Collection<String> notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS 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 AWS CloudFormation
associates with the stack. Specify an empty list to remove all notification topics.UpdateStackRequest.Builder notificationARNs(String... notificationARNs)
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS 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 AWS CloudFormation
associates with the stack. Specify an empty list to remove all notification topics.UpdateStackRequest.Builder tags(Collection<Tag> tags)
Key-value pairs to associate with this stack. AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
tags
- Key-value pairs to associate with this stack. AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
UpdateStackRequest.Builder tags(Tag... tags)
Key-value pairs to associate with this stack. AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
tags
- Key-value pairs to associate with this stack. AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
UpdateStackRequest.Builder clientRequestToken(String clientRequestToken)
A unique identifier for this UpdateStack
request. Specify this token if you plan to retry
requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name.
You might retry UpdateStack
requests to ensure that AWS 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 AWS CloudFormation knows that you're not attempting to update a stack with the same
name. You might retry UpdateStack
requests to ensure that AWS 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
.
UpdateStackRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.