Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Baseline
Operation An object of shape
BaselineOperation, returning details about the specifiedBaselineoperation ID.- Baseline
Summary Returns a summary of information about a
Baselineobject.- Control
Operation An operation performed by the control.
- Control
Operation Filter A filter object that lets you call
ListControlOperationswith a specific filter.- Control
Operation Summary A summary of information about the specified control operation.
- Drift
Status Summary The drift summary of the enabled control.
Amazon Web Services Control Tower expects the enabled control configuration to include all supported and governed Regions. If the enabled control differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.
- Enabled
Baseline Details Details of the
EnabledBaselineresource.- Enabled
Baseline Drift Status Summary The drift summary of the enabled baseline. Amazon Web Services Control Tower reports inheritance drift when an enabled baseline configuration of a member account is different than the configuration that applies to the OU. Amazon Web Services Control Tower reports this type of drift for a parent or child enabled baseline. One way to repair this drift by resetting the parent enabled baseline, on the OU.
For example, you may see this type of drift if you move accounts between OUs, but the accounts are not yet (re-)enrolled.
- Enabled
Baseline Drift Types The types of drift that can be detected for an enabled baseline.
-
Amazon Web Services Control Tower detects inheritance drift on the enabled baselines that target OUs:
AWSControlTowerBaselineandBackupBaseline. -
Amazon Web Services Control Tower does not detect drift on the baselines that apply to your landing zone:
IdentityCenterBaseline,AuditBaseline,LogArchiveBaseline,BackupCentralVaultBaseline, orBackupAdminBaseline. For more information, see Types of baselines.
Baselines enabled on an OU are inherited by its member accounts as child
EnabledBaselineresources. The baseline on the OU serves as the parentEnabledBaseline, which governs the configuration of each childEnabledBaseline.If the baseline configuration of a member account in an OU does not match the configuration of the parent OU, the parent and child baseline is in a state of inheritance drift. This drift could occur in the
AWSControlTowerBaselineor theBackupBaselinerelated to that account.-
- Enabled
Baseline Filter A filter applied on the
ListEnabledBaselineoperation. Allowed filters arebaselineIdentifiersandtargetIdentifiers. The filter can be applied for either, or both.- Enabled
Baseline Inheritance Drift The inheritance drift summary for the enabled baseline. Inheritance drift occurs when any accounts in the target OU do not match the baseline configuration defined on that OU.
- Enabled
Baseline Parameter A key-value parameter to an
EnabledBaselineresource.- Enabled
Baseline Parameter Summary Summary of an applied parameter to an
EnabledBaselineresource.- Enabled
Baseline Summary Returns a summary of information about an
EnabledBaselineobject.- Enabled
Control Details Information about the enabled control.
- Enabled
Control Drift Types Defines the various categories of drift that can occur for an enabled control resource.
- Enabled
Control Filter A structure that returns a set of control identifiers, the control status for each control in the set, and the drift status for each control in the set.
- Enabled
Control Inheritance Drift Represents drift information related to control inheritance between organizational units.
- Enabled
Control Parameter A key/value pair, where
Keyis of typeStringandValueis of typeDocument.- Enabled
Control Parameter Summary Returns a summary of information about the parameters of an enabled control.
- Enabled
Control Resource Drift Represents drift information related to the underlying Amazon Web Services resources managed by the control.
- Enabled
Control Summary Returns a summary of information about an enabled control.
- Enablement
Status Summary The deployment summary of an
EnabledControlorEnabledBaselineresource.- Landing
Zone Detail Information about the landing zone.
- Landing
Zone Drift Status Summary The drift status summary of the landing zone.
If the landing zone differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the landing zone.
- Landing
Zone Operation Detail Information about a landing zone operation.
- Landing
Zone Operation Filter A filter object that lets you call
ListLandingZoneOperationswith a specific filter.- Landing
Zone Operation Summary Returns a summary of information about a landing zone operation.
- Landing
Zone Summary Returns a summary of information about a landing zone.
- Region
An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.
The expected Regions are based on the Regions that are governed by the landing zone. In certain cases, a control is not actually enabled in the Region as expected, such as during drift, or mixed governance.
Enums§
- Baseline
Operation Status - When writing a match expression against
BaselineOperationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Baseline
Operation Type - When writing a match expression against
BaselineOperationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Control
Operation Status - When writing a match expression against
ControlOperationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Control
Operation Type - When writing a match expression against
ControlOperationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Drift
Status - When writing a match expression against
DriftStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Enabled
Baseline Drift Status - When writing a match expression against
EnabledBaselineDriftStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Enablement
Status - When writing a match expression against
EnablementStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Landing
Zone Drift Status - When writing a match expression against
LandingZoneDriftStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Landing
Zone Operation Status - When writing a match expression against
LandingZoneOperationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Landing
Zone Operation Type - When writing a match expression against
LandingZoneOperationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Landing
Zone Status - When writing a match expression against
LandingZoneStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Remediation
Type - When writing a match expression against
RemediationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.