create-network-connector¶

Description¶

Creates a network connector that enables Lambda compute resources to route outbound traffic through your Amazon VPC. The network connector provisions elastic network interfaces (ENIs) in the subnets you specify, providing a managed network path to private resources such as databases, caches, and internal APIs.

This operation is asynchronous. The network connector starts in PENDING state while ENIs are provisioned in your VPC (provisioning typically takes up to 10 minutes). Use GetNetworkConnector to poll the connector state until it reaches ACTIVE . Once active, you can attach the connector to Lambda MicroVMs at run time using the egressNetworkConnectors parameter on RunMicroVm .

This operation is idempotent when you provide a ClientToken — if you retry a request that completed successfully using the same client token, the operation returns the existing connector without creating a duplicate.

Synopsis¶

  create-network-connector
--name <value>
--configuration <value>
[--operator-role <value>]
[--client-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--name (string) [required]

A unique name for the network connector within your account and Region. You can use the name to identify the connector in subsequent API calls.

Constraints:

min: 1

max: 140

pattern: (arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:network-connector:[a-zA-Z0-9-_]+(:[1-9]|[1-9][0-9]+)?)|[a-zA-Z0-9_-]{1,64}

--configuration (tagged union structure) [required]

The network configuration for the connector. Specify a VpcEgressConfiguration to enable outbound traffic routing through your VPC.

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.

Constraints:

min: 1

max: 16

(string)

Constraints:

min: 0

max: 1024

pattern: subnet-[0-9a-z]*

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.

Constraints:

min: 0

max: 5

(string)

Constraints:

min: 0

max: 1024

pattern: sg-[0-9a-zA-Z]*

NetworkProtocol -> (string)

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

Possible values:

IPv4

DualStack

AssociatedComputeResourceTypes -> (list)

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

Constraints:

min: 1

max: 1

(string)

Possible values:

MicroVm

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 ARN of the IAM role that Lambda assumes to manage elastic network interfaces in your VPC. This role must have permissions for ec2:CreateNetworkInterface , ec2:DeleteNetworkInterface , and related describe operations.

Constraints:

min: 0

max: 10000

pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request with the same client token, the API returns the existing connector without creating a duplicate.

Constraints:

min: 1

max: 64

--tags (map)

A map of key-value pairs to associate with the network connector for organization, cost allocation, or access control.

key -> (string)

Constraints:

min: 1

max: 128

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

value -> (string)

Constraints:

min: 0

max: 256

pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

Arn -> (string)

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

Constraints:

min: 1

max: 140

pattern: (arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:network-connector:[a-zA-Z0-9-_]+(:[1-9]|[1-9][0-9]+)?)

Name -> (string)

The name of the network connector.

Constraints:

min: 1

max: 140

pattern: (arn:aws[a-zA-Z-]*:lambda:(eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}:\d{12}:network-connector:[a-zA-Z0-9-_]+(:[1-9]|[1-9][0-9]+)?)|[a-zA-Z0-9_-]{1,64}

Id -> (string)

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

Constraints:

min: 1

max: 140

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.

Constraints:

min: 1

max: 16

(string)

Constraints:

min: 0

max: 1024

pattern: subnet-[0-9a-z]*

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.

Constraints:

min: 0

max: 5

(string)

Constraints:

min: 0

max: 1024

pattern: sg-[0-9a-zA-Z]*

NetworkProtocol -> (string)

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

Possible values:

IPv4

DualStack

AssociatedComputeResourceTypes -> (list)

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

Constraints:

min: 1

max: 1

(string)

Possible values:

MicroVm

OperatorRole -> (string)

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

Constraints:

min: 0

max: 10000

pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

State -> (string)

The current state of the network connector.

Possible values:

PENDING

ACTIVE

INACTIVE

FAILED

DELETING

DELETE_FAILED

Table of Contents

Feedback

User Guide

create-network-connector¶

Description¶

Synopsis¶

Options¶

Note

Global Options¶

Output¶

Note