servers

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

Overview

Name	servers
Type	Resource
Id	aws.migrationhubstrategy.servers

Fields

The following fields are returned by SELECT queries:

list_servers

Name	Datatype	Description
id	string	The server ID. (pattern: <code>^[0-9a-b]+</code>)
name	string	The name of the server.
antipattern_report_s3_object	object	Contains the S3 bucket name and the Amazon S3 key name.
antipattern_report_status	string	The status of the anti-pattern report generation. (FAILED, IN_PROGRESS, SUCCESS)
antipattern_report_status_message	string	A message about the status of the anti-pattern report generation. (pattern: <code>.\S.</code>)
application_component_strategy_summary	array	A list of strategy summaries.
data_collection_status	string	The status of assessment for the server. (dataCollectionTaskToBeScheduled, dataCollectionTaskScheduled, dataCollectionTaskStarted, dataCollectionTaskStopped, dataCollectionTaskSuccess, dataCollectionTaskFailed, dataCollectionTaskPartialSuccess)
last_analyzed_timestamp	string (date-time)	The timestamp of when the server was assessed.
list_antipattern_severity_summary	array	A list of anti-pattern severity summaries.
recommendation_set	object	A set of recommendations.
server_error	object	The error in server analysis.
server_type	string	The type of server. (pattern: <code>.\S.</code>)
status_message	string	A message about the status of data collection, which contains detailed descriptions of any error messages. (pattern: <code>.\S.</code>)
system_info	object	System information about the server.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_servers	select	region		Returns a list of all the servers.
update_server_config	update	region, serverId		Updates the configuration of the specified server.

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

SELECT examples

list_servers

Returns a list of all the servers.

SELECT
id,
name,
antipattern_report_s3_object,
antipattern_report_status,
antipattern_report_status_message,
application_component_strategy_summary,
data_collection_status,
last_analyzed_timestamp,
list_antipattern_severity_summary,
recommendation_set,
server_error,
server_type,
status_message,
system_info
FROM aws.migrationhubstrategy.servers
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_server_config

Updates the configuration of the specified server.

UPDATE aws.migrationhubstrategy.servers
SET 
serverId = '{{ serverId }}',
strategyOption = '{{ strategyOption }}'
WHERE 
region = '{{ region }}' --required
AND serverId = '{{ serverId }}' --required;