Network.AWS.CloudFormation.UpdateStackInstances

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 .

Creating a Request

updateStackInstances

Arguments

:: Text

usiStackSetName

-> UpdateStackInstances

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

See: updateStackInstances smart constructor.

Instances

Eq UpdateStackInstances

Methods

(==) :: UpdateStackInstances -> UpdateStackInstances -> Bool

(/=) :: UpdateStackInstances -> UpdateStackInstances -> Bool

Data UpdateStackInstances

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateStackInstances -> c UpdateStackInstances

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateStackInstances

toConstr :: UpdateStackInstances -> Constr

dataTypeOf :: UpdateStackInstances -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateStackInstances)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateStackInstances)

gmapT :: (forall b. Data b => b -> b) -> UpdateStackInstances -> UpdateStackInstances

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStackInstances -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStackInstances -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateStackInstances -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateStackInstances -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateStackInstances -> m UpdateStackInstances

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStackInstances -> m UpdateStackInstances

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStackInstances -> m UpdateStackInstances

Read UpdateStackInstances

Methods

readsPrec :: Int -> ReadS UpdateStackInstances

readList :: ReadS [UpdateStackInstances]

readPrec :: ReadPrec UpdateStackInstances

readListPrec :: ReadPrec [UpdateStackInstances]

Show UpdateStackInstances

Methods

showsPrec :: Int -> UpdateStackInstances -> ShowS

show :: UpdateStackInstances -> String

showList :: [UpdateStackInstances] -> ShowS

Generic UpdateStackInstances

Associated Types

type Rep UpdateStackInstances :: * -> *

Methods

from :: UpdateStackInstances -> Rep UpdateStackInstances x

to :: Rep UpdateStackInstances x -> UpdateStackInstances

Hashable UpdateStackInstances

Methods

hashWithSalt :: Int -> UpdateStackInstances -> Int

hash :: UpdateStackInstances -> Int

NFData UpdateStackInstances

Methods

rnf :: UpdateStackInstances -> ()

AWSRequest UpdateStackInstances

Associated Types

type Rs UpdateStackInstances :: *

Methods

request :: UpdateStackInstances -> Request UpdateStackInstances

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateStackInstances -> ClientResponse -> m (Response UpdateStackInstances)

ToHeaders UpdateStackInstances

Methods

toHeaders :: UpdateStackInstances -> [Header]

ToPath UpdateStackInstances

Methods

toPath :: UpdateStackInstances -> ByteString

ToQuery UpdateStackInstances

Methods

toQuery :: UpdateStackInstances -> QueryString

type Rep UpdateStackInstances

type Rep UpdateStackInstances = D1 * (MetaData "UpdateStackInstances" "Network.AWS.CloudFormation.UpdateStackInstances" "amazonka-cloudformation-1.6.0-E2GV66prdF5G8DMBRBifWM" False) (C1 * (MetaCons "UpdateStackInstances'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_usiOperationPreferences") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe StackSetOperationPreferences))) ((:*:) * (S1 * (MetaSel (Just Symbol "_usiOperationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_usiParameterOverrides") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Parameter]))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_usiStackSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_usiAccounts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Text])) (S1 * (MetaSel (Just Symbol "_usiRegions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Text]))))))

type Rs UpdateStackInstances

type Rs UpdateStackInstances = UpdateStackInstancesResponse

Request Lenses

usiOperationPreferences :: Lens' UpdateStackInstances (Maybe StackSetOperationPreferences)

Preferences for how AWS CloudFormation performs this stack set operation.

usiOperationId :: Lens' UpdateStackInstances (Maybe Text)

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]

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

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

usiAccounts :: Lens' UpdateStackInstances [Text]

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]

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

Arguments

:: Int

usirsResponseStatus

-> UpdateStackInstancesResponse

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

See: updateStackInstancesResponse smart constructor.

Instances

Eq UpdateStackInstancesResponse

Methods

(==) :: UpdateStackInstancesResponse -> UpdateStackInstancesResponse -> Bool

(/=) :: UpdateStackInstancesResponse -> UpdateStackInstancesResponse -> Bool

Data UpdateStackInstancesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateStackInstancesResponse -> c UpdateStackInstancesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateStackInstancesResponse

toConstr :: UpdateStackInstancesResponse -> Constr

dataTypeOf :: UpdateStackInstancesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateStackInstancesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateStackInstancesResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateStackInstancesResponse -> UpdateStackInstancesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStackInstancesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStackInstancesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateStackInstancesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateStackInstancesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateStackInstancesResponse -> m UpdateStackInstancesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStackInstancesResponse -> m UpdateStackInstancesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStackInstancesResponse -> m UpdateStackInstancesResponse

Read UpdateStackInstancesResponse

Methods

readsPrec :: Int -> ReadS UpdateStackInstancesResponse

readList :: ReadS [UpdateStackInstancesResponse]

readPrec :: ReadPrec UpdateStackInstancesResponse

readListPrec :: ReadPrec [UpdateStackInstancesResponse]

Show UpdateStackInstancesResponse

Methods

showsPrec :: Int -> UpdateStackInstancesResponse -> ShowS

show :: UpdateStackInstancesResponse -> String

showList :: [UpdateStackInstancesResponse] -> ShowS

Generic UpdateStackInstancesResponse

Associated Types

type Rep UpdateStackInstancesResponse :: * -> *

Methods

from :: UpdateStackInstancesResponse -> Rep UpdateStackInstancesResponse x

to :: Rep UpdateStackInstancesResponse x -> UpdateStackInstancesResponse

NFData UpdateStackInstancesResponse

Methods

rnf :: UpdateStackInstancesResponse -> ()

type Rep UpdateStackInstancesResponse

type Rep UpdateStackInstancesResponse = D1 * (MetaData "UpdateStackInstancesResponse" "Network.AWS.CloudFormation.UpdateStackInstances" "amazonka-cloudformation-1.6.0-E2GV66prdF5G8DMBRBifWM" False) (C1 * (MetaCons "UpdateStackInstancesResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_usirsOperationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_usirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

usirsOperationId :: Lens' UpdateStackInstancesResponse (Maybe Text)

The unique identifier for this stack set operation.

usirsResponseStatus :: Lens' UpdateStackInstancesResponse Int

• - | The response status code.