public static interface UpdateStackSetRequest.Builder extends CloudFormationRequest.Builder, CopyableBuilder<UpdateStackSetRequest.Builder,UpdateStackSetRequest>
Modifier and Type | Method and Description |
---|---|
UpdateStackSetRequest.Builder |
capabilities(Capability... capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
UpdateStackSetRequest.Builder |
capabilities(Collection<Capability> capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
UpdateStackSetRequest.Builder |
capabilitiesWithStrings(Collection<String> capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
UpdateStackSetRequest.Builder |
capabilitiesWithStrings(String... capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets.
|
UpdateStackSetRequest.Builder |
description(String description)
A brief description of updates that you are making.
|
UpdateStackSetRequest.Builder |
operationId(String operationId)
The unique ID for this stack set operation.
|
default UpdateStackSetRequest.Builder |
operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)
Preferences for how AWS CloudFormation performs this stack set operation.
|
UpdateStackSetRequest.Builder |
operationPreferences(StackSetOperationPreferences operationPreferences)
Preferences for how AWS CloudFormation performs this stack set operation.
|
UpdateStackSetRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
UpdateStackSetRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
UpdateStackSetRequest.Builder |
parameters(Collection<Parameter> parameters)
A list of input parameters for the stack set template.
|
UpdateStackSetRequest.Builder |
parameters(Consumer<Parameter.Builder>... parameters)
A list of input parameters for the stack set template.
|
UpdateStackSetRequest.Builder |
parameters(Parameter... parameters)
A list of input parameters for the stack set template.
|
UpdateStackSetRequest.Builder |
stackSetName(String stackSetName)
The name or unique ID of the stack set that you want to update.
|
UpdateStackSetRequest.Builder |
tags(Collection<Tag> tags)
The key-value pairs to associate with this stack set and the stacks created from it.
|
UpdateStackSetRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
The key-value pairs to associate with this stack set and the stacks created from it.
|
UpdateStackSetRequest.Builder |
tags(Tag... tags)
The key-value pairs to associate with this stack set and the stacks created from it.
|
UpdateStackSetRequest.Builder |
templateBody(String templateBody)
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
bytes.
|
UpdateStackSetRequest.Builder |
templateURL(String templateURL)
The location of the file that contains the template body.
|
UpdateStackSetRequest.Builder |
usePreviousTemplate(Boolean usePreviousTemplate)
Use the existing template that's associated with the stack set that you're updating.
|
build
overrideConfiguration
copy
applyMutation, build
UpdateStackSetRequest.Builder stackSetName(String stackSetName)
The name or unique ID of the stack set that you want to update.
stackSetName
- The name or unique ID of the stack set that you want to update.UpdateStackSetRequest.Builder description(String description)
A brief description of updates that you are making.
description
- A brief description of updates that you are making.UpdateStackSetRequest.Builder templateBody(String templateBody)
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
templateBody
- The structure that contains the template body, with a minimum length of 1 byte and a maximum length of
51,200 bytes. For more information, see Template
Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
UpdateStackSetRequest.Builder templateURL(String templateURL)
The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
templateURL
- The location of the file that contains the template body. The URL must point to a template (maximum
size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template
Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
UpdateStackSetRequest.Builder usePreviousTemplate(Boolean usePreviousTemplate)
Use the existing template that's associated with the stack set that you're updating.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
usePreviousTemplate
- Use the existing template that's associated with the stack set that you're updating.
Conditional: You must specify only one of the following parameters: TemplateBody
or
TemplateURL
—or set UsePreviousTemplate
to true.
UpdateStackSetRequest.Builder parameters(Collection<Parameter> parameters)
A list of input parameters for the stack set template.
parameters
- A list of input parameters for the stack set template.UpdateStackSetRequest.Builder parameters(Parameter... parameters)
A list of input parameters for the stack set template.
parameters
- A list of input parameters for the stack set template.UpdateStackSetRequest.Builder parameters(Consumer<Parameter.Builder>... parameters)
A list of input parameters for the stack set template.
This is a convenience that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #parameters(List)
.parameters
- a consumer that will call methods on List.Builder
#parameters(List)
UpdateStackSetRequest.Builder capabilitiesWithStrings(Collection<String> capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge 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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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 create certain stack sets. Some
stack set templates might include resources that can affect permissions in your AWS account—for
example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you
must explicitly acknowledge 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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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.
UpdateStackSetRequest.Builder capabilitiesWithStrings(String... capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge 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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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 create certain stack sets. Some
stack set templates might include resources that can affect permissions in your AWS account—for
example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you
must explicitly acknowledge 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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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.
UpdateStackSetRequest.Builder capabilities(Collection<Capability> capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge 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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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 create certain stack sets. Some
stack set templates might include resources that can affect permissions in your AWS account—for
example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you
must explicitly acknowledge 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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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.
UpdateStackSetRequest.Builder capabilities(Capability... capabilities)
A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge 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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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 create certain stack sets. Some
stack set templates might include resources that can affect permissions in your AWS account—for
example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you
must explicitly acknowledge 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
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are 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.
UpdateStackSetRequest.Builder tags(Collection<Tag> tags)
The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
If you specify an empty value, AWS CloudFormation removes all currently associated tags.
If you specify new tags as part of an UpdateStackSet
action, AWS CloudFormation checks to see if
you have the required IAM permission to tag resources. If you omit tags that are currently associated with
the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those
tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the
necessary permission(s), the entire UpdateStackSet
action fails with an
access denied
error, and the stack set is not updated.
tags
- The key-value pairs to associate with this stack set and the stacks created from it. AWS
CloudFormation also propagates these tags to supported resources that are created in the stacks. You
can specify a maximum number of 50 tags.
If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
If you specify an empty value, AWS CloudFormation removes all currently associated tags.
If you specify new tags as part of an UpdateStackSet
action, AWS CloudFormation checks to
see if you have the required IAM permission to tag resources. If you omit tags that are currently
associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you
want to remove those tags from the stack set, and checks to see if you have permission to untag
resources. If you don't have the necessary permission(s), the entire UpdateStackSet
action fails with an access denied
error, and the stack set is not updated.
UpdateStackSetRequest.Builder tags(Tag... tags)
The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
If you specify an empty value, AWS CloudFormation removes all currently associated tags.
If you specify new tags as part of an UpdateStackSet
action, AWS CloudFormation checks to see if
you have the required IAM permission to tag resources. If you omit tags that are currently associated with
the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those
tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the
necessary permission(s), the entire UpdateStackSet
action fails with an
access denied
error, and the stack set is not updated.
tags
- The key-value pairs to associate with this stack set and the stacks created from it. AWS
CloudFormation also propagates these tags to supported resources that are created in the stacks. You
can specify a maximum number of 50 tags.
If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
If you specify an empty value, AWS CloudFormation removes all currently associated tags.
If you specify new tags as part of an UpdateStackSet
action, AWS CloudFormation checks to
see if you have the required IAM permission to tag resources. If you omit tags that are currently
associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you
want to remove those tags from the stack set, and checks to see if you have permission to untag
resources. If you don't have the necessary permission(s), the entire UpdateStackSet
action fails with an access denied
error, and the stack set is not updated.
UpdateStackSetRequest.Builder tags(Consumer<Tag.Builder>... tags)
The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.
If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
If you specify an empty value, AWS CloudFormation removes all currently associated tags.
If you specify new tags as part of an UpdateStackSet
action, AWS CloudFormation checks to see if
you have the required IAM permission to tag resources. If you omit tags that are currently associated with
the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those
tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the
necessary permission(s), the entire UpdateStackSet
action fails with an
access denied
error, and the stack set is not updated.
List.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
UpdateStackSetRequest.Builder operationPreferences(StackSetOperationPreferences operationPreferences)
Preferences for how AWS CloudFormation performs this stack set operation.
operationPreferences
- Preferences for how AWS CloudFormation performs this stack set operation.default UpdateStackSetRequest.Builder operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences)
Preferences for how AWS CloudFormation performs this stack set operation.
This is a convenience that creates an instance of theStackSetOperationPreferences.Builder
avoiding
the need to create one manually via StackSetOperationPreferences.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called
immediately and its result is passed to operationPreferences(StackSetOperationPreferences)
.operationPreferences
- a consumer that will call methods on StackSetOperationPreferences.Builder
operationPreferences(StackSetOperationPreferences)
UpdateStackSetRequest.Builder operationId(String operationId)
The unique ID for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
If you don't specify an operation ID, AWS CloudFormation generates one automatically.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is
OUTDATED
.
operationId
- The unique ID for this stack set operation.
The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.
If you don't specify an operation ID, AWS CloudFormation generates one automatically.
Repeating this stack set operation with a new operation ID retries all stack instances whose status is
OUTDATED
.
UpdateStackSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.UpdateStackSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.