amazonka-cloudformation-2.0: Amazon CloudFormation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFormation.Types.StackInstanceSummary

Description

 
Synopsis

Documentation

data StackInstanceSummary Source #

The structure that contains summary information about a stack instance.

See: newStackInstanceSummary smart constructor.

Constructors

StackInstanceSummary' 

Fields

  • account :: Maybe Text
    Self-managed permissions
    The name of the Amazon Web Services account that the stack instance is associated with.
  • driftStatus :: Maybe StackDriftStatus

    Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.

    • DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
    • NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration.
    • IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.
    • UNKNOWN: This value is reserved for future use.
  • lastDriftCheckTimestamp :: Maybe ISO8601

    Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection hasn't yet been performed.

  • lastOperationId :: Maybe Text

    The last unique ID of a StackSet operation performed on a stack instance.

  • organizationalUnitId :: Maybe Text
    Service-managed permissions
    The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
  • region :: Maybe Text

    The name of the Amazon Web Services Region that the stack instance is associated with.

  • stackId :: Maybe Text

    The ID of the stack instance.

  • stackInstanceStatus :: Maybe StackInstanceComprehensiveStatus

    The detailed status of the stack instance.

  • stackSetId :: Maybe Text

    The name or unique ID of the stack set that the stack instance is associated with.

  • status :: Maybe StackInstanceStatus

    The status of the stack instance, in terms of its synchronization with its associated stack set.

    • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.
    • OUTDATED: The stack isn't currently up to date with the stack set because:

      • The associated stack failed during a CreateStackSet or UpdateStackSet operation.
      • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
    • CURRENT: The stack is currently up to date with the stack set.
  • statusReason :: Maybe Text

    The explanation for the specific status code assigned to this stack instance.

Instances

Instances details
FromXML StackInstanceSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackInstanceSummary

Generic StackInstanceSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackInstanceSummary

Associated Types

type Rep StackInstanceSummary :: Type -> Type #

Read StackInstanceSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackInstanceSummary

Show StackInstanceSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackInstanceSummary

NFData StackInstanceSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackInstanceSummary

Methods

rnf :: StackInstanceSummary -> () #

Eq StackInstanceSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackInstanceSummary

Hashable StackInstanceSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackInstanceSummary

type Rep StackInstanceSummary Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackInstanceSummary

type Rep StackInstanceSummary = D1 ('MetaData "StackInstanceSummary" "Amazonka.CloudFormation.Types.StackInstanceSummary" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "StackInstanceSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "account") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "driftStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackDriftStatus))) :*: (S1 ('MetaSel ('Just "lastDriftCheckTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "lastOperationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "organizationalUnitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackInstanceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackInstanceComprehensiveStatus)))) :*: (S1 ('MetaSel ('Just "stackSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackInstanceStatus)) :*: S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newStackInstanceSummary :: StackInstanceSummary Source #

Create a value of StackInstanceSummary 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:account:StackInstanceSummary', stackInstanceSummary_account - [Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

$sel:driftStatus:StackInstanceSummary', stackInstanceSummary_driftStatus - Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.

  • DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
  • NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration.
  • IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.
  • UNKNOWN: This value is reserved for future use.

$sel:lastDriftCheckTimestamp:StackInstanceSummary', stackInstanceSummary_lastDriftCheckTimestamp - Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection hasn't yet been performed.

$sel:lastOperationId:StackInstanceSummary', stackInstanceSummary_lastOperationId - The last unique ID of a StackSet operation performed on a stack instance.

$sel:organizationalUnitId:StackInstanceSummary', stackInstanceSummary_organizationalUnitId - [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

$sel:region:StackInstanceSummary', stackInstanceSummary_region - The name of the Amazon Web Services Region that the stack instance is associated with.

$sel:stackId:StackInstanceSummary', stackInstanceSummary_stackId - The ID of the stack instance.

$sel:stackInstanceStatus:StackInstanceSummary', stackInstanceSummary_stackInstanceStatus - The detailed status of the stack instance.

$sel:stackSetId:StackInstanceSummary', stackInstanceSummary_stackSetId - The name or unique ID of the stack set that the stack instance is associated with.

$sel:status:StackInstanceSummary', stackInstanceSummary_status - The status of the stack instance, in terms of its synchronization with its associated stack set.

  • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.
  • OUTDATED: The stack isn't currently up to date with the stack set because:

    • The associated stack failed during a CreateStackSet or UpdateStackSet operation.
    • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
  • CURRENT: The stack is currently up to date with the stack set.

$sel:statusReason:StackInstanceSummary', stackInstanceSummary_statusReason - The explanation for the specific status code assigned to this stack instance.

stackInstanceSummary_account :: Lens' StackInstanceSummary (Maybe Text) Source #

Self-managed permissions
The name of the Amazon Web Services account that the stack instance is associated with.

stackInstanceSummary_driftStatus :: Lens' StackInstanceSummary (Maybe StackDriftStatus) Source #

Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.

  • DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.
  • NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration.
  • IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.
  • UNKNOWN: This value is reserved for future use.

stackInstanceSummary_lastDriftCheckTimestamp :: Lens' StackInstanceSummary (Maybe UTCTime) Source #

Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection hasn't yet been performed.

stackInstanceSummary_lastOperationId :: Lens' StackInstanceSummary (Maybe Text) Source #

The last unique ID of a StackSet operation performed on a stack instance.

stackInstanceSummary_organizationalUnitId :: Lens' StackInstanceSummary (Maybe Text) Source #

Service-managed permissions
The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

stackInstanceSummary_region :: Lens' StackInstanceSummary (Maybe Text) Source #

The name of the Amazon Web Services Region that the stack instance is associated with.

stackInstanceSummary_stackSetId :: Lens' StackInstanceSummary (Maybe Text) Source #

The name or unique ID of the stack set that the stack instance is associated with.

stackInstanceSummary_status :: Lens' StackInstanceSummary (Maybe StackInstanceStatus) Source #

The status of the stack instance, in terms of its synchronization with its associated stack set.

  • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.
  • OUTDATED: The stack isn't currently up to date with the stack set because:

    • The associated stack failed during a CreateStackSet or UpdateStackSet operation.
    • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.
  • CURRENT: The stack is currently up to date with the stack set.

stackInstanceSummary_statusReason :: Lens' StackInstanceSummary (Maybe Text) Source #

The explanation for the specific status code assigned to this stack instance.