Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region.
You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances .
During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.
You can only update 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
.
Synopsis
- updateStackInstances :: Text -> UpdateStackInstances
- data UpdateStackInstances
- usiOperationPreferences :: Lens' UpdateStackInstances (Maybe StackSetOperationPreferences)
- usiOperationId :: Lens' UpdateStackInstances (Maybe Text)
- usiParameterOverrides :: Lens' UpdateStackInstances [Parameter]
- usiStackSetName :: Lens' UpdateStackInstances Text
- usiAccounts :: Lens' UpdateStackInstances [Text]
- usiRegions :: Lens' UpdateStackInstances [Text]
- updateStackInstancesResponse :: Int -> UpdateStackInstancesResponse
- data UpdateStackInstancesResponse
- usirsOperationId :: Lens' UpdateStackInstancesResponse (Maybe Text)
- usirsResponseStatus :: Lens' UpdateStackInstancesResponse Int
Creating a Request
Creates a value of UpdateStackInstances
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
usiOperationPreferences
- Preferences for how AWS CloudFormation performs this stack set operation.usiOperationId
- 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.usiParameterOverrides
- 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 specifyUsePreviousValue
astrue
. (You cannot specify both a value and setUsePreviousValue
totrue
.) * 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, useUpdateStackSet
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 usingUpdateStackInstances
.usiStackSetName
- The name or unique ID of the stack set associated with the stack instances.usiAccounts
- 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.usiRegions
- 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.
data UpdateStackInstances Source #
See: updateStackInstances
smart constructor.
Instances
Request Lenses
usiOperationPreferences :: Lens' UpdateStackInstances (Maybe StackSetOperationPreferences) Source #
Preferences for how AWS CloudFormation performs this stack set operation.
usiOperationId :: Lens' UpdateStackInstances (Maybe Text) Source #
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.
usiParameterOverrides :: Lens' UpdateStackInstances [Parameter] Source #
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
.
usiStackSetName :: Lens' UpdateStackInstances Text Source #
The name or unique ID of the stack set associated with the stack instances.
usiAccounts :: Lens' UpdateStackInstances [Text] Source #
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.
usiRegions :: Lens' UpdateStackInstances [Text] Source #
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.
Destructuring the Response
updateStackInstancesResponse Source #
Creates a value of UpdateStackInstancesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
usirsOperationId
- The unique identifier for this stack set operation.usirsResponseStatus
- -- | The response status code.
data UpdateStackInstancesResponse Source #
See: updateStackInstancesResponse
smart constructor.
Instances
Response Lenses
usirsOperationId :: Lens' UpdateStackInstancesResponse (Maybe Text) Source #
The unique identifier for this stack set operation.
usirsResponseStatus :: Lens' UpdateStackInstancesResponse Int Source #
- - | The response status code.