software.amazon.awssdk.services.cloudformation.model

Class UpdateStackInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest

software.amazon.awssdk.services.cloudformation.model.UpdateStackInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateStackInstancesRequest.Builder,UpdateStackInstancesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateStackInstancesRequest
extends CloudFormationRequest
implements ToCopyableBuilder<UpdateStackInstancesRequest.Builder,UpdateStackInstancesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateStackInstancesRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	accounts() The names of one or more AWS accounts for which you want to update parameter values for stack instances.
static UpdateStackInstancesRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	operationId() The unique identifier for this stack set operation.
StackSetOperationPreferences	operationPreferences() Preferences for how AWS CloudFormation performs this stack set operation.
List<Parameter>	parameterOverrides() A list of input parameters whose values you want to update for the specified stack instances.
List<String>	regions() The names of one or more regions in which you want to update parameter values for stack instances.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateStackInstancesRequest.Builder>	serializableBuilderClass()
String	stackSetName() The name or unique ID of the stack set associated with the stack instances.
UpdateStackInstancesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

stackSetName

public String stackSetName()

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

Returns:

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

accounts

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

regions

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

parameterOverrides

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

operationPreferences

public StackSetOperationPreferences operationPreferences()

Preferences for how AWS CloudFormation performs this stack set operation.

Returns:

Preferences for how AWS CloudFormation performs this stack set operation.

operationId

public 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.

Returns:

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.

toBuilder

public UpdateStackInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateStackInstancesRequest.Builder,UpdateStackInstancesRequest>

Specified by:

toBuilder in class CloudFormationRequest

builder

public static UpdateStackInstancesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateStackInstancesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo