application_components

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

Overview

Name	application_components
Type	Resource
Id	aws.migrationhubstrategy.application_components

Fields

The following fields are returned by SELECT queries:

list_application_components

Name	Datatype	Description
id	string	The ID of the application component. (pattern: <code>^[0-9a-b]+</code>)
name	string	The name of application component.
analysis_status	string	The status of analysis, if the application component has source code or an associated database. (ANALYSIS_TO_BE_SCHEDULED, ANALYSIS_STARTED, ANALYSIS_SUCCESS, ANALYSIS_FAILED, ANALYSIS_PARTIAL_SUCCESS, UNCONFIGURED, CONFIGURED)
antipattern_report_s3_object	object	The S3 bucket name and the Amazon S3 key name for the anti-pattern report.
antipattern_report_status	string	The status of the anti-pattern report generation. (FAILED, IN_PROGRESS, SUCCESS)
antipattern_report_status_message	string	The status message for the anti-pattern. (pattern: <code>.\S.</code>)
app_type	string	The type of application component. (DotNetFramework, Java, SQLServer, IIS, Oracle, Other, Tomcat, JBoss, Spring, Mongo DB, DB2, Maria DB, MySQL, Sybase, PostgreSQLServer, Cassandra, IBM WebSphere, Oracle WebLogic, Visual Basic, Unknown, DotnetCore, Dotnet)
app_unit_error	object	The error in the analysis of the source code or database.
associated_server_id	string	The ID of the server that the application component is running on. (pattern: <code>.\S.</code>)
database_config_detail	object	Configuration details for the database associated with the application component.
inclusion_status	string	Indicates whether the application component has been included for server recommendation or not. (excludeFromAssessment, includeInAssessment)
last_analyzed_timestamp	string (date-time)	The timestamp of when the application component was assessed.
list_antipattern_severity_summary	array	A list of anti-pattern severity summaries.
more_server_association_exists	boolean	Set to true if the application component is running on multiple servers.
os_driver	string	OS driver. (pattern: <code>.\S.</code>)
os_version	string	OS version. (pattern: <code>.\S.</code>)
recommendation_set	object	The top recommendation set for the application component.
resource_sub_type	string	The application component subtype. (Database, Process, DatabaseProcess)
result_list	array	A list of the analysis results.
runtime_status	string	The status of the application unit. (ANALYSIS_TO_BE_SCHEDULED, ANALYSIS_STARTED, ANALYSIS_SUCCESS, ANALYSIS_FAILED)
runtime_status_message	string	The status message for the application unit. (pattern: <code>.\S.</code>)
source_code_repositories	array	Details about the source code repository associated with the application component.
status_message	string	A detailed description of the analysis status and any failure message. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_application_components	select	region		Retrieves a list of all the application components (processes).
update_application_component_config	update	region, applicationComponentId		Updates the configuration of an application component.

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_application_components

Retrieves a list of all the application components (processes).

SELECT
id,
name,
analysis_status,
antipattern_report_s3_object,
antipattern_report_status,
antipattern_report_status_message,
app_type,
app_unit_error,
associated_server_id,
database_config_detail,
inclusion_status,
last_analyzed_timestamp,
list_antipattern_severity_summary,
more_server_association_exists,
os_driver,
os_version,
recommendation_set,
resource_sub_type,
result_list,
runtime_status,
runtime_status_message,
source_code_repositories,
status_message
FROM aws.migrationhubstrategy.application_components
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_application_component_config

Updates the configuration of an application component.

UPDATE aws.migrationhubstrategy.application_components
SET 
appType = '{{ appType }}',
applicationComponentId = '{{ applicationComponentId }}',
configureOnly = {{ configureOnly }},
inclusionStatus = '{{ inclusionStatus }}',
secretsManagerKey = '{{ secretsManagerKey }}',
sourceCodeList = '{{ sourceCodeList }}',
strategyOption = '{{ strategyOption }}'
WHERE 
region = '{{ region }}' --required
AND applicationComponentId = '{{ applicationComponentId }}' --required;