software.amazon.awssdk.services.cloudformation.model

Interface UpdateStackInstancesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudFormationRequest.Builder, CopyableBuilder<UpdateStackInstancesRequest.Builder,UpdateStackInstancesRequest>, SdkBuilder<UpdateStackInstancesRequest.Builder,UpdateStackInstancesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateStackInstancesRequest

public static interface UpdateStackInstancesRequest.Builder
extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<UpdateStackInstancesRequest.Builder,UpdateStackInstancesRequest>

Method Summary

Modifier and Type	Method and Description
UpdateStackInstancesRequest.Builder	accounts(Collection<String> accounts) The names of one or more AWS accounts for which you want to update parameter values for stack instances.
UpdateStackInstancesRequest.Builder	accounts(String... accounts) The names of one or more AWS accounts for which you want to update parameter values for stack instances.
UpdateStackInstancesRequest.Builder	operationId(String operationId) The unique identifier for this stack set operation.
default UpdateStackInstancesRequest.Builder	operationPreferences(Consumer<StackSetOperationPreferences.Builder> operationPreferences) Preferences for how AWS CloudFormation performs this stack set operation.
UpdateStackInstancesRequest.Builder	operationPreferences(StackSetOperationPreferences operationPreferences) Preferences for how AWS CloudFormation performs this stack set operation.
UpdateStackInstancesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
UpdateStackInstancesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
UpdateStackInstancesRequest.Builder	parameterOverrides(Collection<Parameter> parameterOverrides) A list of input parameters whose values you want to update for the specified stack instances.
UpdateStackInstancesRequest.Builder	parameterOverrides(Consumer<Parameter.Builder>... parameterOverrides) A list of input parameters whose values you want to update for the specified stack instances.
UpdateStackInstancesRequest.Builder	parameterOverrides(Parameter... parameterOverrides) A list of input parameters whose values you want to update for the specified stack instances.
UpdateStackInstancesRequest.Builder	regions(Collection<String> regions) The names of one or more regions in which you want to update parameter values for stack instances.
UpdateStackInstancesRequest.Builder	regions(String... regions) The names of one or more regions in which you want to update parameter values for stack instances.
UpdateStackInstancesRequest.Builder	stackSetName(String stackSetName) The name or unique ID of the stack set associated with the stack instances.

Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

stackSetName

UpdateStackInstancesRequest.Builder stackSetName(String stackSetName)

The name or unique ID of the stack set associated with the stack instances.

Parameters:

stackSetName - The name or unique ID of the stack set associated with the stack instances.

Returns:

Returns a reference to this object so that method calls can be chained together.

accounts

UpdateStackInstancesRequest.Builder accounts(Collection<String> accounts)

The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.

Parameters:

accounts - The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.

Returns:

Returns a reference to this object so that method calls can be chained together.

accounts

UpdateStackInstancesRequest.Builder accounts(String... accounts)

The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.

Parameters:

accounts - The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.

Returns:

Returns a reference to this object so that method calls can be chained together.

regions

UpdateStackInstancesRequest.Builder regions(Collection<String> regions)

The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.

Parameters:

regions - The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.

Returns:

Returns a reference to this object so that method calls can be chained together.

regions

UpdateStackInstancesRequest.Builder regions(String... regions)

The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.

Parameters:

regions - The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.

Returns:

Returns a reference to this object so that method calls can be chained together.

parameterOverrides

UpdateStackInstancesRequest.Builder parameterOverrides(Collection<Parameter> parameterOverrides)

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:

• To override the current value for a parameter, include the parameter and specify its value.

• To leave a parameter set to its present value, you can do one of the following:

  • Do not include the parameter in the list.

  • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

• To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

• To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Parameters:

parameterOverrides - A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:

• To override the current value for a parameter, include the parameter and specify its value.

• To leave a parameter set to its present value, you can do one of the following:

  • Do not include the parameter in the list.

  • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

• To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

• To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Returns:

Returns a reference to this object so that method calls can be chained together.

parameterOverrides

UpdateStackInstancesRequest.Builder parameterOverrides(Parameter... parameterOverrides)

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:

• To override the current value for a parameter, include the parameter and specify its value.

• To leave a parameter set to its present value, you can do one of the following:

  • Do not include the parameter in the list.

  • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

• To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

• To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Parameters:

parameterOverrides - A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:

• To override the current value for a parameter, include the parameter and specify its value.

• To leave a parameter set to its present value, you can do one of the following:

  • Do not include the parameter in the list.

  • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

• To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

• To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Returns:

Returns a reference to this object so that method calls can be chained together.

parameterOverrides

UpdateStackInstancesRequest.Builder parameterOverrides(Consumer<Parameter.Builder>... parameterOverrides)

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:

• To override the current value for a parameter, include the parameter and specify its value.

• To leave a parameter set to its present value, you can do one of the following:

  • Do not include the parameter in the list.

  • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

• To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

• To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

This is a convenience that creates an instance of the 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 #parameterOverrides(List).

Parameters:

parameterOverrides - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#parameterOverrides(List)

operationPreferences

UpdateStackInstancesRequest.Builder operationPreferences(StackSetOperationPreferences operationPreferences)

Preferences for how AWS CloudFormation performs this stack set operation.

Parameters:

operationPreferences - Preferences for how AWS CloudFormation performs this stack set operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

operationPreferences

default UpdateStackInstancesRequest.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 the StackSetOperationPreferences.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).

Parameters:

operationPreferences - a consumer that will call methods on StackSetOperationPreferences.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

operationPreferences(StackSetOperationPreferences)

operationId

UpdateStackInstancesRequest.Builder operationId(String operationId)

The unique identifier 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, the SDK generates one automatically.

Parameters:

operationId - The unique identifier 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, the SDK generates one automatically.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

UpdateStackInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateStackInstancesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.