UpdateStackInstancesRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cloudformation.model.UpdateStackInstancesRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateStackInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

UpdateStackInstancesRequest()

Constructors
Constructor and Description
`UpdateStackInstancesRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateStackInstancesRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`List<String>`	`getAccounts()` The names of one or more AWS accounts for which you want to update parameter values for stack instances.
`String`	`getOperationId()` The unique identifier for this stack set operation.
`StackSetOperationPreferences`	`getOperationPreferences()` Preferences for how AWS CloudFormation performs this stack set operation.
`List<Parameter>`	`getParameterOverrides()` A list of input parameters whose values you want to update for the specified stack instances.
`List<String>`	`getRegions()` The names of one or more regions in which you want to update parameter values for stack instances.
`String`	`getStackSetName()` The name or unique ID of the stack set associated with the stack instances.
`int`	`hashCode()`
`void`	`setAccounts(Collection<String> accounts)` The names of one or more AWS accounts for which you want to update parameter values for stack instances.
`void`	`setOperationId(String operationId)` The unique identifier for this stack set operation.
`void`	`setOperationPreferences(StackSetOperationPreferences operationPreferences)` Preferences for how AWS CloudFormation performs this stack set operation.
`void`	`setParameterOverrides(Collection<Parameter> parameterOverrides)` A list of input parameters whose values you want to update for the specified stack instances.
`void`	`setRegions(Collection<String> regions)` The names of one or more regions in which you want to update parameter values for stack instances.
`void`	`setStackSetName(String stackSetName)` The name or unique ID of the stack set associated with the stack instances.
`String`	`toString()` Returns a string representation of this object.
`UpdateStackInstancesRequest`	`withAccounts(Collection<String> accounts)` The names of one or more AWS accounts for which you want to update parameter values for stack instances.
`UpdateStackInstancesRequest`	`withAccounts(String... accounts)` The names of one or more AWS accounts for which you want to update parameter values for stack instances.
`UpdateStackInstancesRequest`	`withOperationId(String operationId)` The unique identifier for this stack set operation.
`UpdateStackInstancesRequest`	`withOperationPreferences(StackSetOperationPreferences operationPreferences)` Preferences for how AWS CloudFormation performs this stack set operation.
`UpdateStackInstancesRequest`	`withParameterOverrides(Collection<Parameter> parameterOverrides)` A list of input parameters whose values you want to update for the specified stack instances.
`UpdateStackInstancesRequest`	`withParameterOverrides(Parameter... parameterOverrides)` A list of input parameters whose values you want to update for the specified stack instances.
`UpdateStackInstancesRequest`	`withRegions(Collection<String> regions)` The names of one or more regions in which you want to update parameter values for stack instances.
`UpdateStackInstancesRequest`	`withRegions(String... regions)` The names of one or more regions in which you want to update parameter values for stack instances.
`UpdateStackInstancesRequest`	`withStackSetName(String stackSetName)` The name or unique ID of the stack set associated with the stack instances.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateStackInstancesRequest
```
public UpdateStackInstancesRequest()
```
- Method Detail
  - setStackSetName
```
public void setStackSetName(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.
  - getStackSetName
```
public String getStackSetName()
```
    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.
  - withStackSetName
```
public UpdateStackInstancesRequest withStackSetName(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.
  - getAccounts
```
public List<String> getAccounts()
```
    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:
    
    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.
  - setAccounts
```
public void setAccounts(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.
  - withAccounts
```
public UpdateStackInstancesRequest withAccounts(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAccounts(java.util.Collection) or withAccounts(java.util.Collection) if you want to override the existing values.
    
    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.
  - withAccounts
```
public UpdateStackInstancesRequest withAccounts(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.
  - getRegions
```
public List<String> getRegions()
```
    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:
    
    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.
  - setRegions
```
public void setRegions(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.
  - withRegions
```
public UpdateStackInstancesRequest withRegions(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setRegions(java.util.Collection) or withRegions(java.util.Collection) if you want to override the existing values.
    
    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.
  - withRegions
```
public UpdateStackInstancesRequest withRegions(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.
  - getParameterOverrides
```
public List<Parameter> getParameterOverrides()
```
    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:
    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.
  - setParameterOverrides
```
public void setParameterOverrides(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.
  - withParameterOverrides
```
public UpdateStackInstancesRequest withParameterOverrides(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setParameterOverrides(java.util.Collection) or withParameterOverrides(java.util.Collection) if you want to override the existing values.
    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.
  - withParameterOverrides
```
public UpdateStackInstancesRequest withParameterOverrides(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.
  - setOperationPreferences
```
public void setOperationPreferences(StackSetOperationPreferences operationPreferences)
```
    Preferences for how AWS CloudFormation performs this stack set operation.
    
    Parameters:
    
    operationPreferences - Preferences for how AWS CloudFormation performs this stack set operation.
  - getOperationPreferences
```
public StackSetOperationPreferences getOperationPreferences()
```
    Preferences for how AWS CloudFormation performs this stack set operation.
    
    Returns:
    
    Preferences for how AWS CloudFormation performs this stack set operation.
  - withOperationPreferences
```
public UpdateStackInstancesRequest withOperationPreferences(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.
  - setOperationId
```
public void setOperationId(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.
  - getOperationId
```
public String getOperationId()
```
    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.
  - withOperationId
```
public UpdateStackInstancesRequest withOperationId(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.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UpdateStackInstancesRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class UpdateStackInstancesRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateStackInstancesRequest

Method Detail

setStackSetName

getStackSetName

withStackSetName

getAccounts

setAccounts

withAccounts

withAccounts

getRegions

setRegions

withRegions

withRegions

getParameterOverrides

setParameterOverrides

withParameterOverrides

withParameterOverrides

setOperationPreferences

getOperationPreferences

withOperationPreferences

setOperationId

getOperationId

withOperationId

toString

equals

hashCode

clone