You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudFormation::Types::UpdateStackInstancesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::UpdateStackInstancesInput
- Defined in:
- (unknown)
Overview
When passing UpdateStackInstancesInput as input to an Aws::Client method, you can use a vanilla Hash:
{
stack_set_name: "StackSetNameOrId", # required
accounts: ["Account"],
deployment_targets: {
accounts: ["Account"],
organizational_unit_ids: ["OrganizationalUnitId"],
},
regions: ["Region"], # required
parameter_overrides: [
{
parameter_key: "ParameterKey",
parameter_value: "ParameterValue",
use_previous_value: false,
resolved_value: "ParameterValue",
},
],
operation_preferences: {
region_order: ["Region"],
failure_tolerance_count: 1,
failure_tolerance_percentage: 1,
max_concurrent_count: 1,
max_concurrent_percentage: 1,
},
operation_id: "ClientRequestToken",
}
Instance Attribute Summary collapse
-
#accounts ⇒ Array<String>
[
Self-managed
permissions] The names of one or more AWS accounts for which you want to update parameter values for stack instances. -
#deployment_targets ⇒ Types::DeploymentTargets
[
Service-managed
permissions] The AWS Organizations accounts for which you want to update parameter values for stack instances. -
#operation_id ⇒ String
The unique identifier for this stack set operation.
-
#operation_preferences ⇒ Types::StackSetOperationPreferences
Preferences for how AWS CloudFormation performs this stack set operation.
-
#parameter_overrides ⇒ Array<Types::Parameter>
A list of input parameters whose values you want to update for the specified stack instances.
-
#regions ⇒ Array<String>
The names of one or more Regions in which you want to update parameter values for stack instances.
-
#stack_set_name ⇒ String
The name or unique ID of the stack set associated with the stack instances.
Instance Attribute Details
#accounts ⇒ Array<String>
[Self-managed
permissions] 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.
You can specify Accounts
or DeploymentTargets
, but not both.
#deployment_targets ⇒ Types::DeploymentTargets
[Service-managed
permissions] The AWS 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.
#operation_id ⇒ String
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.
#operation_preferences ⇒ Types::StackSetOperationPreferences
Preferences for how AWS CloudFormation performs this stack set operation.
#parameter_overrides ⇒ Array<Types::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
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, 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
.
#regions ⇒ Array<String>
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.
#stack_set_name ⇒ String
The name or unique ID of the stack set associated with the stack instances.