AWS CLI Command Reference

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.

[ aws . lambda-core ]

update-network-connector

Description

Updates the VPC configuration or operator role of an existing network connector. You can modify the subnet IDs, security group IDs, network protocol, or operator role. The connector must be in ACTIVE state to accept updates.

This operation is asynchronous. The connector remains in ACTIVE state during the update — existing workloads that reference this connector are not disrupted. Use GetNetworkConnector to monitor the LastUpdateStatus field, which transitions through InProgress to Successful or Failed . If the update fails, the LastUpdateStatusReasonCode field provides a specific error code for troubleshooting. This operation is idempotent when you provide a ClientToken .

See also: AWS API Documentation

Synopsis

  update-network-connector
--identifier <value>
[--configuration <value>]
[--operator-role <value>]
[--client-token <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

--identifier (string)

A flexible identifier that accepts a network connector ID, name, or ARN

--configuration (tagged union structure)

The updated network configuration for the connector. Provide the full VpcEgressConfiguration including all subnet IDs and security group IDs — this replaces the existing configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: VpcEgressConfiguration.

VpcEgressConfiguration -> (structure)

Configuration for a VPC egress network connector. Specifies the subnets, security groups, and network protocol for routing outbound traffic through your VPC.

SubnetIds -> (list)

The IDs of the VPC subnets where Lambda provisions elastic network interfaces (ENIs). Specify 1 to 16 subnets. All subnets must be in the same VPC.

(string)

SecurityGroupIds -> (list)

The IDs of the VPC security groups to attach to the ENIs. Specify 0 to 5 security groups. All security groups must be in the same VPC as the subnets.

(string)

NetworkProtocol -> (string)

The network protocol for the connector. Specify IPv4 for IPv4-only networking, or DualStack for both IPv4 and IPv6.

AssociatedComputeResourceTypes -> (list)

The types of Lambda compute resources that can use this connector. Currently, only MicroVm is supported.

(string)

Shorthand Syntax:

VpcEgressConfiguration={SubnetIds=[string,string],SecurityGroupIds=[string,string],NetworkProtocol=string,AssociatedComputeResourceTypes=[string,string]}

JSON Syntax:

{
  "VpcEgressConfiguration": {
    "SubnetIds": ["string", ...],
    "SecurityGroupIds": ["string", ...],
    "NetworkProtocol": "IPv4"|"DualStack",
    "AssociatedComputeResourceTypes": ["MicroVm", ...]
  }
}

--operator-role (string)

The updated ARN of the IAM role that Lambda assumes to manage ENIs. Use this to change the operator role without recreating the connector.

--client-token (string)

A unique, case-sensitive identifier to ensure idempotency of the update request.

--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.

Output

Arn -> (string)

The Amazon Resource Name (ARN) of the network connector.

Name -> (string)

The name of the network connector.

Id -> (string)

The unique identifier for a network connector, assigned by the service at creation time

OperatorRole -> (string)

The ARN of the IAM role that Lambda uses to manage the underlying ENI resources for this connector.

Configuration -> (tagged union structure)

The network configuration of the connector, including VPC subnets and security groups.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: VpcEgressConfiguration.

VpcEgressConfiguration -> (structure)

Configuration for a VPC egress network connector. Specifies the subnets, security groups, and network protocol for routing outbound traffic through your VPC.

SubnetIds -> (list)

The IDs of the VPC subnets where Lambda provisions elastic network interfaces (ENIs). Specify 1 to 16 subnets. All subnets must be in the same VPC.

(string)

SecurityGroupIds -> (list)

The IDs of the VPC security groups to attach to the ENIs. Specify 0 to 5 security groups. All security groups must be in the same VPC as the subnets.

(string)

NetworkProtocol -> (string)

The network protocol for the connector. Specify IPv4 for IPv4-only networking, or DualStack for both IPv4 and IPv6.

AssociatedComputeResourceTypes -> (list)

The types of Lambda compute resources that can use this connector. Currently, only MicroVm is supported.

(string)

State -> (string)

The current state of the network connector.

LastUpdateStatus -> (string)

The status of this update operation (typically InProgress immediately after the call).

LastUpdateStatusReason -> (string)

A human-readable explanation of the update status.

LastModified -> (timestamp)

The timestamp of this update.