AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . migrationhubstrategy ]

update-application-component-config

Description

Updates the configuration of an application component.

See also: AWS API Documentation

Synopsis

  update-application-component-config
[--app-type <value>]
--application-component-id <value>
[--configure-only | --no-configure-only]
[--inclusion-status <value>]
[--secrets-manager-key <value>]
[--source-code-list <value>]
[--strategy-option <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--app-type (string)

The type of known component.

Possible values:

  • 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

--application-component-id (string)

The ID of the application component. The ID is unique within an AWS account.

--configure-only | --no-configure-only (boolean)

Update the configuration request of an application component. If it is set to true, the source code and/or database credentials are updated. If it is set to false, the source code and/or database credentials are updated and an analysis is initiated.

--inclusion-status (string)

Indicates whether the application component has been included for server recommendation or not.

Possible values:

  • excludeFromAssessment
  • includeInAssessment

--secrets-manager-key (string)

Database credentials.

--source-code-list (list)

The list of source code configurations to update for the application component.

(structure)

Object containing source code information that is linked to an application component.

location -> (string)

The repository name for the source code.

projectName -> (string)

The name of the project.

sourceVersion -> (string)

The branch of the source code.

versionControl -> (string)

The type of repository to use for the source code.

Shorthand Syntax:

location=string,projectName=string,sourceVersion=string,versionControl=string ...

JSON Syntax:

[
  {
    "location": "string",
    "projectName": "string",
    "sourceVersion": "string",
    "versionControl": "GITHUB"|"GITHUB_ENTERPRISE"|"AZURE_DEVOPS_GIT"
  }
  ...
]

--strategy-option (structure)

The preferred strategy options for the application component. Use values from the GetApplicationComponentStrategies response.

isPreferred -> (boolean)

Indicates if a specific strategy is preferred for the application component.

strategy -> (string)

Type of transformation. For example, Rehost, Replatform, and so on.

targetDestination -> (string)

Destination information about where the application component can migrate to. For example, EC2 , ECS , and so on.

toolName -> (string)

The name of the tool that can be used to transform an application component using this strategy.

Shorthand Syntax:

isPreferred=boolean,strategy=string,targetDestination=string,toolName=string

JSON Syntax:

{
  "isPreferred": true|false,
  "strategy": "Rehost"|"Retirement"|"Refactor"|"Replatform"|"Retain"|"Relocate"|"Repurchase",
  "targetDestination": "None specified"|"AWS Elastic BeanStalk"|"AWS Fargate"|"Amazon Elastic Cloud Compute (EC2)"|"Amazon Elastic Container Service (ECS)"|"Amazon Elastic Kubernetes Service (EKS)"|"Aurora MySQL"|"Aurora PostgreSQL"|"Amazon Relational Database Service on MySQL"|"Amazon Relational Database Service on PostgreSQL"|"Amazon DocumentDB"|"Amazon DynamoDB"|"Amazon Relational Database Service"|"Babelfish for Aurora PostgreSQL",
  "toolName": "App2Container"|"Porting Assistant For .NET"|"End of Support Migration"|"Windows Web Application Migration Assistant"|"Application Migration Service"|"Strategy Recommendation Support"|"In Place Operating System Upgrade"|"Schema Conversion Tool"|"Database Migration Service"|"Native SQL Server Backup/Restore"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

None