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 |
Deletes stack instances for the specified accounts, in the specified Regions.
Synopsis
- data DeleteStackInstances = DeleteStackInstances' {}
- newDeleteStackInstances :: Text -> Bool -> DeleteStackInstances
- deleteStackInstances_accounts :: Lens' DeleteStackInstances (Maybe [Text])
- deleteStackInstances_callAs :: Lens' DeleteStackInstances (Maybe CallAs)
- deleteStackInstances_operationPreferences :: Lens' DeleteStackInstances (Maybe StackSetOperationPreferences)
- deleteStackInstances_operationId :: Lens' DeleteStackInstances (Maybe Text)
- deleteStackInstances_deploymentTargets :: Lens' DeleteStackInstances (Maybe DeploymentTargets)
- deleteStackInstances_stackSetName :: Lens' DeleteStackInstances Text
- deleteStackInstances_regions :: Lens' DeleteStackInstances [Text]
- deleteStackInstances_retainStacks :: Lens' DeleteStackInstances Bool
- data DeleteStackInstancesResponse = DeleteStackInstancesResponse' {
- operationId :: Maybe Text
- httpStatus :: Int
- newDeleteStackInstancesResponse :: Int -> DeleteStackInstancesResponse
- deleteStackInstancesResponse_operationId :: Lens' DeleteStackInstancesResponse (Maybe Text)
- deleteStackInstancesResponse_httpStatus :: Lens' DeleteStackInstancesResponse Int
Creating a Request
data DeleteStackInstances Source #
See: newDeleteStackInstances
smart constructor.
DeleteStackInstances' | |
|
Instances
newDeleteStackInstances Source #
:: Text | |
-> Bool | |
-> DeleteStackInstances |
Create a value of DeleteStackInstances
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:DeleteStackInstances'
, deleteStackInstances_accounts
- [Self-managed permissions] The names of the Amazon Web Services accounts
that you want to delete stack instances for.
You can specify Accounts
or DeploymentTargets
, but not both.
$sel:callAs:DeleteStackInstances'
, deleteStackInstances_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:DeleteStackInstances'
, deleteStackInstances_operationPreferences
- Preferences for how CloudFormation performs this stack set operation.
$sel:operationId:DeleteStackInstances'
, deleteStackInstances_operationId
- The unique identifier for this stack set operation.
If you don't specify an operation ID, the SDK generates one automatically.
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 can retry stack set operation requests to ensure that CloudFormation successfully received them.
Repeating this stack set operation with a new operation ID retries all
stack instances whose status is OUTDATED
.
$sel:deploymentTargets:DeleteStackInstances'
, deleteStackInstances_deploymentTargets
- [Service-managed permissions] The Organizations accounts from which to
delete stack instances.
You can specify Accounts
or DeploymentTargets
, but not both.
$sel:stackSetName:DeleteStackInstances'
, deleteStackInstances_stackSetName
- The name or unique ID of the stack set that you want to delete stack
instances for.
$sel:regions:DeleteStackInstances'
, deleteStackInstances_regions
- The Regions where you want to delete stack set instances.
$sel:retainStacks:DeleteStackInstances'
, deleteStackInstances_retainStacks
- Removes the stack instances from the specified stack set, but doesn't
delete the stacks. You can't reassociate a retained stack or add an
existing, saved stack to a new stack set.
For more information, see Stack set operation options.
Request Lenses
deleteStackInstances_accounts :: Lens' DeleteStackInstances (Maybe [Text]) Source #
- Self-managed permissions
- The names of the Amazon Web Services accounts that you want to delete stack instances for.
You can specify Accounts
or DeploymentTargets
, but not both.
deleteStackInstances_callAs :: Lens' DeleteStackInstances (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.
deleteStackInstances_operationPreferences :: Lens' DeleteStackInstances (Maybe StackSetOperationPreferences) Source #
Preferences for how CloudFormation performs this stack set operation.
deleteStackInstances_operationId :: Lens' DeleteStackInstances (Maybe Text) Source #
The unique identifier for this stack set operation.
If you don't specify an operation ID, the SDK generates one automatically.
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 can retry stack set operation requests to ensure that CloudFormation successfully received them.
Repeating this stack set operation with a new operation ID retries all
stack instances whose status is OUTDATED
.
deleteStackInstances_deploymentTargets :: Lens' DeleteStackInstances (Maybe DeploymentTargets) Source #
- Service-managed permissions
- The Organizations accounts from which to delete stack instances.
You can specify Accounts
or DeploymentTargets
, but not both.
deleteStackInstances_stackSetName :: Lens' DeleteStackInstances Text Source #
The name or unique ID of the stack set that you want to delete stack instances for.
deleteStackInstances_regions :: Lens' DeleteStackInstances [Text] Source #
The Regions where you want to delete stack set instances.
deleteStackInstances_retainStacks :: Lens' DeleteStackInstances Bool Source #
Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.
For more information, see Stack set operation options.
Destructuring the Response
data DeleteStackInstancesResponse Source #
See: newDeleteStackInstancesResponse
smart constructor.
DeleteStackInstancesResponse' | |
|
Instances
newDeleteStackInstancesResponse Source #
Create a value of DeleteStackInstancesResponse
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:DeleteStackInstances'
, deleteStackInstancesResponse_operationId
- The unique identifier for this stack set operation.
$sel:httpStatus:DeleteStackInstancesResponse'
, deleteStackInstancesResponse_httpStatus
- The response's http status code.
Response Lenses
deleteStackInstancesResponse_operationId :: Lens' DeleteStackInstancesResponse (Maybe Text) Source #
The unique identifier for this stack set operation.
deleteStackInstancesResponse_httpStatus :: Lens' DeleteStackInstancesResponse Int Source #
The response's http status code.