insights

Creates, updates, deletes, gets or lists an insights resource.

Overview

Name	insights
Type	Resource
Id	aws.eks.insights

Fields

The following fields are returned by SELECT queries:

describe_insight

Name	Datatype	Description
id	string	The ID of the insight.
name	string	The name of the insight.
additional_info	object	Links to sources that provide additional context on the insight.
category	string	The category of the insight. (UPGRADE_READINESS, MISCONFIGURATION, ROLLBACK_READINESS)
category_specific_summary	object	Summary information that relates to the category of the insight. Currently only returned with certain insights having category UPGRADE_READINESS.
description	string	The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).
insight_status	object	An object containing more detail on the status of the insight resource.
kubernetes_version	string	The Kubernetes minor version associated with an insight if applicable.
last_refresh_time	string (date-time)	The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.
last_transition_time	string (date-time)	The time the status of the insight last changed.
recommendation	string	A summary of how to remediate the finding of this insight if applicable.
resources	array	The details about each resource listed in the insight check result.

list_insights

Name	Datatype	Description
id	string	The ID of the insight.
name	string	The name of the insight.
category	string	The category of the insight. (UPGRADE_READINESS, MISCONFIGURATION, ROLLBACK_READINESS)
description	string	The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).
insight_status	object	An object containing more detail on the status of the insight.
kubernetes_version	string	The Kubernetes minor version associated with an insight if applicable.
last_refresh_time	string (date-time)	The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.
last_transition_time	string (date-time)	The time the status of the insight last changed.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_insight	select	name, id, region		Returns details about an insight that you specify using its ID.
list_insights	select	name, region		Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. The default filter lists all categories and every status. The following lists the available categories: UPGRADE_READINESS: Amazon EKS identifies issues that could impact your ability to upgrade to new versions of Kubernetes. These are called upgrade insights. MISCONFIGURATION: Amazon EKS identifies misconfiguration in your EKS Hybrid Nodes setup that could impair functionality of your cluster or workloads. These are called configuration insights.
start_insights_refresh	exec	name, region		Initiates an on-demand refresh operation for cluster insights, getting the latest analysis outside of the standard refresh schedule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The identity of the insight to describe.
name	string	The name of the cluster for the refresh insights operation.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_insight

Returns details about an insight that you specify using its ID.

SELECT
id,
name,
additional_info,
category,
category_specific_summary,
description,
insight_status,
kubernetes_version,
last_refresh_time,
last_transition_time,
recommendation,
resources
FROM aws.eks.insights
WHERE name = '{{ name }}' -- required
AND id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_insights

Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. The default filter lists all categories and every status. The following lists the available categories: UPGRADE_READINESS: Amazon EKS identifies issues that could impact your ability to upgrade to new versions of Kubernetes. These are called upgrade insights. MISCONFIGURATION: Amazon EKS identifies misconfiguration in your EKS Hybrid Nodes setup that could impair functionality of your cluster or workloads. These are called configuration insights.

SELECT
id,
name,
category,
description,
insight_status,
kubernetes_version,
last_refresh_time,
last_transition_time
FROM aws.eks.insights
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

Lifecycle Methods

start_insights_refresh

Initiates an on-demand refresh operation for cluster insights, getting the latest analysis outside of the standard refresh schedule.

EXEC aws.eks.insights.start_insights_refresh 
@name='{{ name }}' --required, 
@region='{{ region }}' --required
;