Amazonka.CloudFormation.DeleteStackInstances

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.

Creating a Request

data DeleteStackInstances

See: newDeleteStackInstances smart constructor.

Constructors

DeleteStackInstances'

Fields

• accounts :: Maybe [Text]

  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.

• 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 from which to delete stack instances.

  You can specify Accounts or DeploymentTargets, but not both.

• operationId :: Maybe Text

  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.

• operationPreferences :: Maybe StackSetOperationPreferences

  Preferences for how CloudFormation performs this stack set operation.

• stackSetName :: Text

  The name or unique ID of the stack set that you want to delete stack instances for.

• regions :: [Text]

  The Amazon Web Services Regions where you want to delete stack set instances.

• retainStacks :: Bool

  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.

Instances

ToHeaders DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

toHeaders :: DeleteStackInstances -> [Header]

ToPath DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

toPath :: DeleteStackInstances -> ByteString

ToQuery DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

toQuery :: DeleteStackInstances -> QueryString

AWSRequest DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

Associated Types

type AWSResponse DeleteStackInstances

Methods

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

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

Generic DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

Associated Types

type Rep DeleteStackInstances :: Type -> Type

Methods

from :: DeleteStackInstances -> Rep DeleteStackInstances x

to :: Rep DeleteStackInstances x -> DeleteStackInstances

Read DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

readsPrec :: Int -> ReadS DeleteStackInstances

readList :: ReadS [DeleteStackInstances]

readPrec :: ReadPrec DeleteStackInstances

readListPrec :: ReadPrec [DeleteStackInstances]

Show DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

showsPrec :: Int -> DeleteStackInstances -> ShowS

show :: DeleteStackInstances -> String

showList :: [DeleteStackInstances] -> ShowS

NFData DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

rnf :: DeleteStackInstances -> ()

Eq DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

(==) :: DeleteStackInstances -> DeleteStackInstances -> Bool

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

Hashable DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

hashWithSalt :: Int -> DeleteStackInstances -> Int

hash :: DeleteStackInstances -> Int

type AWSResponse DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

type AWSResponse DeleteStackInstances = DeleteStackInstancesResponse

type Rep DeleteStackInstances

Defined in Amazonka.CloudFormation.DeleteStackInstances

type Rep DeleteStackInstances = D1 ('MetaData "DeleteStackInstances" "Amazonka.CloudFormation.DeleteStackInstances" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DeleteStackInstances'" '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 "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "retainStacks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

newDeleteStackInstances

Arguments

:: Text

DeleteStackInstances

-> Bool

DeleteStackInstances

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

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.

DeleteStackInstances, deleteStackInstances_deploymentTargets - [Service-managed permissions] The Organizations accounts from which to delete stack instances.

You can specify Accounts or DeploymentTargets, but not both.

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.

DeleteStackInstances, deleteStackInstances_operationPreferences - Preferences for how CloudFormation performs this stack set operation.

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 Amazon Web Services Regions where you want to delete stack set instances.

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

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)

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_deploymentTargets :: Lens' DeleteStackInstances (Maybe DeploymentTargets)

Service-managed permissions

The Organizations accounts from which to delete stack instances.

You can specify Accounts or DeploymentTargets, but not both.

deleteStackInstances_operationId :: Lens' DeleteStackInstances (Maybe Text)

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_operationPreferences :: Lens' DeleteStackInstances (Maybe StackSetOperationPreferences)

Preferences for how CloudFormation performs this stack set operation.

deleteStackInstances_stackSetName :: Lens' DeleteStackInstances Text

The name or unique ID of the stack set that you want to delete stack instances for.

deleteStackInstances_regions :: Lens' DeleteStackInstances [Text]

The Amazon Web Services Regions where you want to delete stack set instances.

deleteStackInstances_retainStacks :: Lens' DeleteStackInstances Bool

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

See: newDeleteStackInstancesResponse smart constructor.

Constructors

DeleteStackInstancesResponse'

Fields

• operationId :: Maybe Text

  The unique identifier for this stack set operation.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteStackInstancesResponse

Defined in Amazonka.CloudFormation.DeleteStackInstances

Associated Types

type Rep DeleteStackInstancesResponse :: Type -> Type

Methods

from :: DeleteStackInstancesResponse -> Rep DeleteStackInstancesResponse x

to :: Rep DeleteStackInstancesResponse x -> DeleteStackInstancesResponse

Read DeleteStackInstancesResponse

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

readsPrec :: Int -> ReadS DeleteStackInstancesResponse

readList :: ReadS [DeleteStackInstancesResponse]

readPrec :: ReadPrec DeleteStackInstancesResponse

readListPrec :: ReadPrec [DeleteStackInstancesResponse]

Show DeleteStackInstancesResponse

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

showsPrec :: Int -> DeleteStackInstancesResponse -> ShowS

show :: DeleteStackInstancesResponse -> String

showList :: [DeleteStackInstancesResponse] -> ShowS

NFData DeleteStackInstancesResponse

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

rnf :: DeleteStackInstancesResponse -> ()

Eq DeleteStackInstancesResponse

Defined in Amazonka.CloudFormation.DeleteStackInstances

Methods

(==) :: DeleteStackInstancesResponse -> DeleteStackInstancesResponse -> Bool

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

type Rep DeleteStackInstancesResponse

Defined in Amazonka.CloudFormation.DeleteStackInstances

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

newDeleteStackInstancesResponse

Arguments

:: Int

$sel:httpStatus:DeleteStackInstancesResponse'

-> DeleteStackInstancesResponse

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:

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)

The unique identifier for this stack set operation.

deleteStackInstancesResponse_httpStatus :: Lens' DeleteStackInstancesResponse Int

The response's http status code.