Copyright | (c) 2013-2021 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 |
Creates stack instances for the specified accounts, within the specified
Regions. A stack instance refers to a stack in a specific account and
Region. You must specify at least one value for either Accounts
or
DeploymentTargets
, and you must specify at least one value for
Regions
.
Synopsis
- data CreateStackInstances = CreateStackInstances' {}
- newCreateStackInstances :: Text -> CreateStackInstances
- createStackInstances_accounts :: Lens' CreateStackInstances (Maybe [Text])
- createStackInstances_callAs :: Lens' CreateStackInstances (Maybe CallAs)
- createStackInstances_operationPreferences :: Lens' CreateStackInstances (Maybe StackSetOperationPreferences)
- createStackInstances_operationId :: Lens' CreateStackInstances (Maybe Text)
- createStackInstances_deploymentTargets :: Lens' CreateStackInstances (Maybe DeploymentTargets)
- createStackInstances_parameterOverrides :: Lens' CreateStackInstances (Maybe [Parameter])
- createStackInstances_stackSetName :: Lens' CreateStackInstances Text
- createStackInstances_regions :: Lens' CreateStackInstances [Text]
- data CreateStackInstancesResponse = CreateStackInstancesResponse' {
- operationId :: Maybe Text
- httpStatus :: Int
- newCreateStackInstancesResponse :: Int -> CreateStackInstancesResponse
- createStackInstancesResponse_operationId :: Lens' CreateStackInstancesResponse (Maybe Text)
- createStackInstancesResponse_httpStatus :: Lens' CreateStackInstancesResponse Int
Creating a Request
data CreateStackInstances Source #
See: newCreateStackInstances
smart constructor.
CreateStackInstances' | |
|
Instances
newCreateStackInstances Source #
Create a value of CreateStackInstances
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:
$sel:accounts:CreateStackInstances'
, createStackInstances_accounts
- [Self-managed permissions] The names of one or more Amazon Web Services
accounts that you want to create stack instances in the specified
Region(s) for.
You can specify Accounts
or DeploymentTargets
, but not both.
$sel:callAs:CreateStackInstances'
, createStackInstances_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.
$sel:operationPreferences:CreateStackInstances'
, createStackInstances_operationPreferences
- Preferences for how CloudFormation performs this stack set operation.
$sel:operationId:CreateStackInstances'
, createStackInstances_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.
Repeating this stack set operation with a new operation ID retries all
stack instances whose status is OUTDATED
.
$sel:deploymentTargets:CreateStackInstances'
, createStackInstances_deploymentTargets
- [Service-managed permissions] The Organizations accounts for which to
create stack instances in the specified Regions.
You can specify Accounts
or DeploymentTargets
, but not both.
$sel:parameterOverrides:CreateStackInstances'
, createStackInstances_parameterOverrides
- A list of stack set parameters whose values you want to override in the
selected 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 CloudFormation sets parameter values during stack instance 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
astrue
. (You cannot specify both a value and setUsePreviousValue
totrue
.) - To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.
- 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.
$sel:stackSetName:CreateStackInstances'
, createStackInstances_stackSetName
- The name or unique ID of the stack set that you want to create stack
instances from.
$sel:regions:CreateStackInstances'
, createStackInstances_regions
- The names of one or more Regions where you want to create stack
instances using the specified Amazon Web Services accounts.
Request Lenses
createStackInstances_accounts :: Lens' CreateStackInstances (Maybe [Text]) Source #
- Self-managed permissions
- The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.
You can specify Accounts
or DeploymentTargets
, but not both.
createStackInstances_callAs :: Lens' CreateStackInstances (Maybe CallAs) Source #
- 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.
createStackInstances_operationPreferences :: Lens' CreateStackInstances (Maybe StackSetOperationPreferences) Source #
Preferences for how CloudFormation performs this stack set operation.
createStackInstances_operationId :: Lens' CreateStackInstances (Maybe Text) Source #
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.
Repeating this stack set operation with a new operation ID retries all
stack instances whose status is OUTDATED
.
createStackInstances_deploymentTargets :: Lens' CreateStackInstances (Maybe DeploymentTargets) Source #
- Service-managed permissions
- The Organizations accounts for which to create stack instances in the specified Regions.
You can specify Accounts
or DeploymentTargets
, but not both.
createStackInstances_parameterOverrides :: Lens' CreateStackInstances (Maybe [Parameter]) Source #
A list of stack set parameters whose values you want to override in the selected 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 CloudFormation sets parameter values during stack instance 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
astrue
. (You cannot specify both a value and setUsePreviousValue
totrue
.) - To set an overridden parameter back to the value specified in the stack set, specify a parameter list but do not include the parameter in the list.
- 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.
createStackInstances_stackSetName :: Lens' CreateStackInstances Text Source #
The name or unique ID of the stack set that you want to create stack instances from.
createStackInstances_regions :: Lens' CreateStackInstances [Text] Source #
The names of one or more Regions where you want to create stack instances using the specified Amazon Web Services accounts.
Destructuring the Response
data CreateStackInstancesResponse Source #
See: newCreateStackInstancesResponse
smart constructor.
CreateStackInstancesResponse' | |
|
Instances
newCreateStackInstancesResponse Source #
Create a value of CreateStackInstancesResponse
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:
$sel:operationId:CreateStackInstances'
, createStackInstancesResponse_operationId
- The unique identifier for this stack set operation.
$sel:httpStatus:CreateStackInstancesResponse'
, createStackInstancesResponse_httpStatus
- The response's http status code.
Response Lenses
createStackInstancesResponse_operationId :: Lens' CreateStackInstancesResponse (Maybe Text) Source #
The unique identifier for this stack set operation.
createStackInstancesResponse_httpStatus :: Lens' CreateStackInstancesResponse Int Source #
The response's http status code.