Control types for @turbot/aws-eks

• AWS > EKS > Cluster > Active
• AWS > EKS > Cluster > Approved
• AWS > EKS > Cluster > CMDB
• AWS > EKS > Cluster > Discovery
• AWS > EKS > Cluster > Tags
• AWS > EKS > Cluster > Usage
• AWS > EKS > Node Group > Active
• AWS > EKS > Node Group > Approved
• AWS > EKS > Node Group > CMDB
• AWS > EKS > Node Group > Configured
• AWS > EKS > Node Group > Discovery
• AWS > EKS > Node Group > Tags
• AWS > EKS > Node Group > Usage

AWS > EKS > Cluster > Active

Take an action when an AWS EKS cluster is not active based on the
AWS > EKS > Cluster > Active > * policies.

The Active control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated compliance
environment, it's common to end up with a wide range of alarms that are difficult
and time consuming to clear. The Active control brings automated, well-defined
control to this process.

The Active control checks the status of all defined Active policies for the
resource (AWS > EKS > Cluster > Active > *),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.

Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.

See Active for more information.

AWS > EKS > Cluster > Approved

Take an action when an AWS EKS cluster is not approved based on AWS > EKS > Cluster > Approved > * policies.

The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.

For any enforcement actions that specify if new, e.g., Enforce: Delete unapproved if new, this control will only take the enforcement actions for resources created within the last 60 minutes.

See Approved for more information.

AWS > EKS > Cluster > CMDB

Record and synchronize details for the AWS EKS cluster into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.

If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.

To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".

CMDB controls also use the Regions policy associated with the resource. If region is not in AWS > EKS > Cluster > Regions policy, the CMDB control will delete the resource from the CMDB. (Note: Setting CMDB to Skip will also pause these changes.)

AWS > EKS > Cluster > Discovery

Discover all AWS EKS cluster resources and add them to the CMDB.

The Discovery control is responsible for finding resources of a specific type. It periodically searches for new resources and saves them to the CMDB. Once discovered, resources are then responsible for tracking changes to themselves through the CMDB control.

Note that Discovery and CMDB controls also use the Regions policy associated with the resource. If the region is not in AWS > EKS > Cluster > Regions policy, the CMDB control will delete the resource from the CMDB.

AWS > EKS > Cluster > Tags

Take an action when an AWS EKS cluster tags is not updated based on the AWS > EKS > Cluster > Tags > * policies.

If the resource is not updated with the tags defined in AWS > EKS > Cluster > Tags > Template, this control raises an alarm and takes the defined enforcement action.

See Tags for more information.

AWS > EKS > Cluster > Usage

The Usage control determines whether the number of AWS EKS cluster resources exceeds the configured usage limit for this region.

You can configure the behavior of this control with the AWS > EKS > Cluster > Usage policy, and set the limit with the AWS > EKS > Cluster > Usage > Limit policy.

AWS > EKS > Node Group > Active

Take an action when an AWS EKS node group is not active based on the
AWS > EKS > Node Group > Active > * policies.

The Active control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated compliance
environment, it's common to end up with a wide range of alarms that are difficult
and time consuming to clear. The Active control brings automated, well-defined
control to this process.

The Active control checks the status of all defined Active policies for the
resource (AWS > EKS > Node Group > Active > *),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.

Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.

See Active for more information.

AWS > EKS > Node Group > Approved

Take an action when an AWS EKS node group is not approved based on AWS > EKS > Node Group > Approved > * policies.

The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.

For any enforcement actions that specify if new, e.g., Enforce: Delete unapproved if new, this control will only take the enforcement actions for resources created within the last 60 minutes.

See Approved for more information.

AWS > EKS > Node Group > CMDB

Record and synchronize details for the AWS EKS node group into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.

If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.

To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".

CMDB controls also use the Regions policy associated with the resource. If region is not in AWS > EKS > Node Group > Regions policy, the CMDB control will delete the resource from the CMDB. (Note: Setting CMDB to Skip will also pause these changes.)

This control will automatically re-run every 24 hours because AWS does not currently support real-time events for this resource type.

AWS > EKS > Node Group > Configured

Maintain AWS > EKS > Node Group configuration.

Note: If the resource is managed by another stack, then the Skip/Check/Enforce values here are ignored
and inherit from the stack that owns it.

AWS > EKS > Node Group > Discovery

Discover all AWS EKS node group resources and add them to the CMDB.

The Discovery control is responsible for finding resources of a specific type. It periodically searches for new resources and saves them to the CMDB. Once discovered, resources are then responsible for tracking changes to themselves through the CMDB control.

Note that Discovery and CMDB controls also use the Regions policy associated with the resource. If the region is not in AWS > EKS > Node Group > Regions policy, the CMDB control will delete the resource from the CMDB.

This control will automatically re-run every 24 hours because AWS does not currently support real-time events for this resource type.

AWS > EKS > Node Group > Tags

Take an action when an AWS EKS node group tags is not updated based on the AWS > EKS > Node Group > Tags > * policies.

If the resource is not updated with the tags defined in AWS > EKS > Node Group > Tags > Template, this control raises an alarm and takes the defined enforcement action.

See Tags for more information.

AWS > EKS > Node Group > Usage

The Usage control determines whether the number of AWS EKS node group resources exceeds the configured usage limit for this cluster.

You can configure the behavior of this control with the AWS > EKS > Node Group > Usage policy, and set the limit with the AWS > EKS > Node Group > Usage > Limit policy.