upgrade_status

Creates, updates, deletes, gets or lists a upgrade_status resource.

Overview

Name	upgrade_status
Type	Resource
Id	aws.es.upgrade_status

Fields

The following fields are returned by SELECT queries:

get_upgrade_status

Name	Datatype	Description
step_status	string	One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed (IN_PROGRESS, SUCCEEDED, SUCCEEDED_WITH_ISSUES, FAILED)
upgrade_name	string	A string that describes the update briefly
upgrade_step	string	Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: PreUpgradeCheck Snapshot Upgrade (PRE_UPGRADE_CHECK, SNAPSHOT, UPGRADE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_upgrade_status	select	domain_name, region		Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

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
domain_name	string
region	string	AWS region (default: us-east-1)

SELECT examples

get_upgrade_status

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

SELECT
step_status,
upgrade_name,
upgrade_step
FROM aws.es.upgrade_status
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
;