Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.
update-web-app¶
Description¶
Assigns new properties to a web app. You can modify the access point, identity provider details, endpoint configuration, and the web app units.
For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC .
See also: AWS API Documentation
Synopsis¶
update-web-app
--web-app-id <value>
[--identity-provider-details <value>]
[--access-endpoint <value>]
[--web-app-units <value>]
[--endpoint-details <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>]
[--v2-debug]
Options¶
--web-app-id (string)
Provide the identifier of the web app that you are updating.
--identity-provider-details (tagged union structure)
Provide updated identity provider values in a
WebAppIdentityProviderDetailsobject.Note
This is a Tagged Union structure. Only one of the following top level keys can be set:IdentityCenterConfig.IdentityCenterConfig -> (structure)
A structure that describes the values to use for the IAM Identity Center settings when you update a web app.
Role -> (string)
The IAM role used to access IAM Identity Center.
Shorthand Syntax:
IdentityCenterConfig={Role=string}
JSON Syntax:
{
"IdentityCenterConfig": {
"Role": "string"
}
}
--access-endpoint (string)
TheAccessEndpointis the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.
--web-app-units (tagged union structure)
A union that contains the value for number of concurrent connections or the user sessions on your web app.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Provisioned.Provisioned -> (integer)
An integer that represents the number of units for your desired number of concurrent connections, or the number of user sessions on your web app at the same time.
Each increment allows an additional 250 concurrent sessions: a value of
1sets the number of concurrent sessions to 250;2sets a value of 500, and so on.
Shorthand Syntax:
Provisioned=integer
JSON Syntax:
{
"Provisioned": integer
}
--endpoint-details (tagged union structure)
The updated endpoint configuration for the web app. You can modify the endpoint type and VPC configuration settings.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:Vpc.Vpc -> (structure)
The VPC configuration details for updating a web app endpoint hosted within a VPC. This includes the subnet IDs for endpoint deployment.
SubnetIds -> (list)
The list of subnet IDs within the VPC where the web app endpoint should be deployed during the update operation.
(string)
Shorthand Syntax:
Vpc={SubnetIds=[string,string]}
JSON Syntax:
{
"Vpc": {
"SubnetIds": ["string", ...]
}
}
--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.
--v2-debug (boolean)
Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.