Amazonka.CloudFormation.UpdateStackInstances

Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.

You can only update stack instances in Amazon Web Services 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 aren't 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

data UpdateStackInstances

See: newUpdateStackInstances smart constructor.

Constructors

UpdateStackInstances'

Fields

• accounts :: Maybe [Text]

  Self-managed permissions

  The names of one or more Amazon Web Services 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 Amazon Web Services Regions.

  You can specify Accounts or DeploymentTargets, but not both.

• callAs :: Maybe CallAs

  Service-managed permissions

  Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

  By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

• deploymentTargets :: Maybe DeploymentTargets

  Service-managed permissions

  The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

  You can specify Accounts or DeploymentTargets, but not both.

• operationId :: Maybe Text

  The unique identifier for this stack set operation.

  The operation ID also functions as an idempotency token, to ensure that 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 CloudFormation successfully received them.

  If you don't specify an operation ID, the SDK generates one automatically.

• operationPreferences :: Maybe StackSetOperationPreferences

  Preferences for how CloudFormation performs this stack set operation.

• parameterOverrides :: Maybe [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 Amazon Web Services Regions. When specifying parameters and their values, be aware of how 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 an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
  • To leave all parameters set to their present values, don't specify this property at all.

  During stack set updates, any parameter values overridden for a stack instance aren't 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.

• stackSetName :: Text

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

• regions :: [Text]

  The names of one or more Amazon Web Services 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 Amazon Web Services Regions.

Instances

ToHeaders UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

toHeaders :: UpdateStackInstances -> [Header]

ToPath UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

toPath :: UpdateStackInstances -> ByteString

ToQuery UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

toQuery :: UpdateStackInstances -> QueryString

AWSRequest UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

Associated Types

type AWSResponse UpdateStackInstances

Methods

request :: (Service -> Service) -> UpdateStackInstances -> Request UpdateStackInstances

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateStackInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateStackInstances)))

Generic UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

Associated Types

type Rep UpdateStackInstances :: Type -> Type

Methods

from :: UpdateStackInstances -> Rep UpdateStackInstances x

to :: Rep UpdateStackInstances x -> UpdateStackInstances

Read UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

readsPrec :: Int -> ReadS UpdateStackInstances

readList :: ReadS [UpdateStackInstances]

readPrec :: ReadPrec UpdateStackInstances

readListPrec :: ReadPrec [UpdateStackInstances]

Show UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

showsPrec :: Int -> UpdateStackInstances -> ShowS

show :: UpdateStackInstances -> String

showList :: [UpdateStackInstances] -> ShowS

NFData UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

rnf :: UpdateStackInstances -> ()

Eq UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

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

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

Hashable UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

hashWithSalt :: Int -> UpdateStackInstances -> Int

hash :: UpdateStackInstances -> Int

type AWSResponse UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

type AWSResponse UpdateStackInstances = UpdateStackInstancesResponse

type Rep UpdateStackInstances

Defined in Amazonka.CloudFormation.UpdateStackInstances

type Rep UpdateStackInstances = D1 ('MetaData "UpdateStackInstances" "Amazonka.CloudFormation.UpdateStackInstances" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "UpdateStackInstances'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs))) :*: (S1 ('MetaSel ('Just "deploymentTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentTargets)) :*: S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "operationPreferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackSetOperationPreferences)) :*: S1 ('MetaSel ('Just "parameterOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter]))) :*: (S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newUpdateStackInstances

Arguments

:: Text

UpdateStackInstances

-> UpdateStackInstances

Create a value of UpdateStackInstances with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateStackInstances, updateStackInstances_accounts - [Self-managed permissions] The names of one or more Amazon Web Services 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 Amazon Web Services Regions.

You can specify Accounts or DeploymentTargets, but not both.

$sel:callAs:UpdateStackInstances', updateStackInstances_callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

UpdateStackInstances, updateStackInstances_deploymentTargets - [Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

You can specify Accounts or DeploymentTargets, but not both.

UpdateStackInstances, updateStackInstances_operationId - The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that 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 CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

UpdateStackInstances, updateStackInstances_operationPreferences - Preferences for how CloudFormation performs this stack set operation.

UpdateStackInstances, updateStackInstances_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 Amazon Web Services Regions. When specifying parameters and their values, be aware of how 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 an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
• To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
• To leave all parameters set to their present values, don't specify this property at all.

During stack set updates, any parameter values overridden for a stack instance aren't 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.

UpdateStackInstances, updateStackInstances_stackSetName - The name or unique ID of the stack set associated with the stack instances.

$sel:regions:UpdateStackInstances', updateStackInstances_regions - The names of one or more Amazon Web Services 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 Amazon Web Services Regions.

Request Lenses

updateStackInstances_accounts :: Lens' UpdateStackInstances (Maybe [Text])

Self-managed permissions

The names of one or more Amazon Web Services 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 Amazon Web Services Regions.

You can specify Accounts or DeploymentTargets, but not both.

updateStackInstances_callAs :: Lens' UpdateStackInstances (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

• If you are signed in to the management account, specify SELF.

• If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

updateStackInstances_deploymentTargets :: Lens' UpdateStackInstances (Maybe DeploymentTargets)

Service-managed permissions

The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.

You can specify Accounts or DeploymentTargets, but not both.

updateStackInstances_operationId :: Lens' UpdateStackInstances (Maybe Text)

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that 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 CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

updateStackInstances_operationPreferences :: Lens' UpdateStackInstances (Maybe StackSetOperationPreferences)

Preferences for how CloudFormation performs this stack set operation.

updateStackInstances_parameterOverrides :: Lens' UpdateStackInstances (Maybe [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 Amazon Web Services Regions. When specifying parameters and their values, be aware of how 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 an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
• To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
• To leave all parameters set to their present values, don't specify this property at all.

During stack set updates, any parameter values overridden for a stack instance aren't 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.

updateStackInstances_stackSetName :: Lens' UpdateStackInstances Text

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

updateStackInstances_regions :: Lens' UpdateStackInstances [Text]

The names of one or more Amazon Web Services 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 Amazon Web Services Regions.

Destructuring the Response

data UpdateStackInstancesResponse

See: newUpdateStackInstancesResponse smart constructor.

Constructors

UpdateStackInstancesResponse'

Fields

• operationId :: Maybe Text

  The unique identifier for this stack set operation.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateStackInstancesResponse

Defined in Amazonka.CloudFormation.UpdateStackInstances

Associated Types

type Rep UpdateStackInstancesResponse :: Type -> Type

Methods

from :: UpdateStackInstancesResponse -> Rep UpdateStackInstancesResponse x

to :: Rep UpdateStackInstancesResponse x -> UpdateStackInstancesResponse

Read UpdateStackInstancesResponse

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

readsPrec :: Int -> ReadS UpdateStackInstancesResponse

readList :: ReadS [UpdateStackInstancesResponse]

readPrec :: ReadPrec UpdateStackInstancesResponse

readListPrec :: ReadPrec [UpdateStackInstancesResponse]

Show UpdateStackInstancesResponse

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

showsPrec :: Int -> UpdateStackInstancesResponse -> ShowS

show :: UpdateStackInstancesResponse -> String

showList :: [UpdateStackInstancesResponse] -> ShowS

NFData UpdateStackInstancesResponse

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

rnf :: UpdateStackInstancesResponse -> ()

Eq UpdateStackInstancesResponse

Defined in Amazonka.CloudFormation.UpdateStackInstances

Methods

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

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

type Rep UpdateStackInstancesResponse

Defined in Amazonka.CloudFormation.UpdateStackInstances

type Rep UpdateStackInstancesResponse = D1 ('MetaData "UpdateStackInstancesResponse" "Amazonka.CloudFormation.UpdateStackInstances" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "UpdateStackInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateStackInstancesResponse

Arguments

:: Int

$sel:httpStatus:UpdateStackInstancesResponse'

-> UpdateStackInstancesResponse

Create a value of UpdateStackInstancesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateStackInstances, updateStackInstancesResponse_operationId - The unique identifier for this stack set operation.

$sel:httpStatus:UpdateStackInstancesResponse', updateStackInstancesResponse_httpStatus - The response's http status code.

Response Lenses

updateStackInstancesResponse_operationId :: Lens' UpdateStackInstancesResponse (Maybe Text)

The unique identifier for this stack set operation.

updateStackInstancesResponse_httpStatus :: Lens' UpdateStackInstancesResponse Int

The response's http status code.