Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudFormation.DetectStackSetDrift

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift detection on a stack set.

DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.

Once the operation has completed, use the following actions to return drift information:

Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)
Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.
Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.

For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets.

You can only run a single drift detection operation on a given stack set at one time.

To stop a drift detection stack set operation, use StopStackSetOperation .

Synopsis

Creating a Request

data DetectStackSetDrift Source #

See: newDetectStackSetDrift smart constructor.

Constructors

DetectStackSetDrift'

Fields

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.
operationId :: Maybe Text
The ID of the stack set operation.
operationPreferences :: Maybe StackSetOperationPreferences
stackSetName :: Text
The name of the stack set on which to perform the drift detection operation.

Instances

Instances details

ToHeaders DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods toHeaders :: DetectStackSetDrift -> [Header] #
ToPath DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods toPath :: DetectStackSetDrift -> ByteString #
ToQuery DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods toQuery :: DetectStackSetDrift -> QueryString #
AWSRequest DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Associated Types type AWSResponse DetectStackSetDrift # Methods request :: (Service -> Service) -> DetectStackSetDrift -> Request DetectStackSetDrift # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DetectStackSetDrift -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DetectStackSetDrift))) #
Generic DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Associated Types type Rep DetectStackSetDrift :: Type -> Type # Methods from :: DetectStackSetDrift -> Rep DetectStackSetDrift x # to :: Rep DetectStackSetDrift x -> DetectStackSetDrift #
Read DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods readsPrec :: Int -> ReadS DetectStackSetDrift # readList :: ReadS [DetectStackSetDrift] # readPrec :: ReadPrec DetectStackSetDrift # readListPrec :: ReadPrec [DetectStackSetDrift] #
Show DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods showsPrec :: Int -> DetectStackSetDrift -> ShowS # show :: DetectStackSetDrift -> String # showList :: [DetectStackSetDrift] -> ShowS #
NFData DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods rnf :: DetectStackSetDrift -> () #
Eq DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods (==) :: DetectStackSetDrift -> DetectStackSetDrift -> Bool # (/=) :: DetectStackSetDrift -> DetectStackSetDrift -> Bool #
Hashable DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods hashWithSalt :: Int -> DetectStackSetDrift -> Int # hash :: DetectStackSetDrift -> Int #
type AWSResponse DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift type AWSResponse DetectStackSetDrift = DetectStackSetDriftResponse
type Rep DetectStackSetDrift Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift type Rep DetectStackSetDrift = D1 ('MetaData "DetectStackSetDrift" "Amazonka.CloudFormation.DetectStackSetDrift" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DetectStackSetDrift'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)) :: 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))))

newDetectStackSetDrift Source #

Arguments

:: Text	`DetectStackSetDrift`
-> DetectStackSetDrift

Create a value of DetectStackSetDrift 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:callAs:DetectStackSetDrift', detectStackSetDrift_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.

DetectStackSetDrift, detectStackSetDrift_operationId - The ID of the stack set operation.

DetectStackSetDrift, detectStackSetDrift_operationPreferences - Undocumented member.

DetectStackSetDrift, detectStackSetDrift_stackSetName - The name of the stack set on which to perform the drift detection operation.

Request Lenses

detectStackSetDrift_callAs :: Lens' DetectStackSetDrift (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.

detectStackSetDrift_operationId :: Lens' DetectStackSetDrift (Maybe Text) Source #

The ID of the stack set operation.

detectStackSetDrift_operationPreferences :: Lens' DetectStackSetDrift (Maybe StackSetOperationPreferences) Source #

Undocumented member.

detectStackSetDrift_stackSetName :: Lens' DetectStackSetDrift Text Source #

The name of the stack set on which to perform the drift detection operation.

Destructuring the Response

data DetectStackSetDriftResponse Source #

See: newDetectStackSetDriftResponse smart constructor.

Constructors

DetectStackSetDriftResponse'
Fields operationId :: Maybe Text The ID of the drift detection stack set operation. You can use this operation ID with `DescribeStackSetOperation` to monitor the progress of the drift detection operation. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DetectStackSetDriftResponse Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Associated Types type Rep DetectStackSetDriftResponse :: Type -> Type # Methods from :: DetectStackSetDriftResponse -> Rep DetectStackSetDriftResponse x # to :: Rep DetectStackSetDriftResponse x -> DetectStackSetDriftResponse #
Read DetectStackSetDriftResponse Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods readsPrec :: Int -> ReadS DetectStackSetDriftResponse # readList :: ReadS [DetectStackSetDriftResponse] # readPrec :: ReadPrec DetectStackSetDriftResponse # readListPrec :: ReadPrec [DetectStackSetDriftResponse] #
Show DetectStackSetDriftResponse Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods showsPrec :: Int -> DetectStackSetDriftResponse -> ShowS # show :: DetectStackSetDriftResponse -> String # showList :: [DetectStackSetDriftResponse] -> ShowS #
NFData DetectStackSetDriftResponse Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods rnf :: DetectStackSetDriftResponse -> () #
Eq DetectStackSetDriftResponse Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift Methods (==) :: DetectStackSetDriftResponse -> DetectStackSetDriftResponse -> Bool # (/=) :: DetectStackSetDriftResponse -> DetectStackSetDriftResponse -> Bool #
type Rep DetectStackSetDriftResponse Source #
Instance details Defined in Amazonka.CloudFormation.DetectStackSetDrift type Rep DetectStackSetDriftResponse = D1 ('MetaData "DetectStackSetDriftResponse" "Amazonka.CloudFormation.DetectStackSetDrift" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DetectStackSetDriftResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDetectStackSetDriftResponse Source #

Arguments

:: Int	`$sel:httpStatus:DetectStackSetDriftResponse'`
-> DetectStackSetDriftResponse

Create a value of DetectStackSetDriftResponse 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:

DetectStackSetDrift, detectStackSetDriftResponse_operationId - The ID of the drift detection stack set operation.

You can use this operation ID with DescribeStackSetOperation to monitor the progress of the drift detection operation.

$sel:httpStatus:DetectStackSetDriftResponse', detectStackSetDriftResponse_httpStatus - The response's http status code.

Response Lenses

detectStackSetDriftResponse_operationId :: Lens' DetectStackSetDriftResponse (Maybe Text) Source #

The ID of the drift detection stack set operation.

You can use this operation ID with DescribeStackSetOperation to monitor the progress of the drift detection operation.

detectStackSetDriftResponse_httpStatus :: Lens' DetectStackSetDriftResponse Int Source #

The response's http status code.