AWS CLI Command Reference

[ aws . securityagent ]

create-private-connection

Description

Creates a private connection for reaching a self-hosted provider instance over private networking using Amazon VPC Lattice.

See also: AWS API Documentation

Synopsis

  create-private-connection
--private-connection-name <value>
--mode <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

--private-connection-name (string) [required]

A unique name for the private connection within your account.

--mode (tagged union structure) [required]

The configuration for the private connection. Specify either a service-managed or a self-managed mode.

Note

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

serviceManaged -> (structure)

The configuration for a service-managed private connection, where the service manages the resource gateway lifecycle.

hostAddress -> (string) [required]

The IP address or DNS name of the target resource.

vpcId -> (string) [required]

The VPC to create the service-managed resource gateway in.

subnetIds -> (list) [required]

The subnets that the service-managed resource gateway spans.

(string)

The identifier of a subnet.

securityGroupIds -> (list)

The security groups to attach to the service-managed resource gateway.

(string)

The identifier of a security group.

ipAddressType -> (string)

The IP address type of the service-managed resource gateway.

Possible values:

  • IPV4
  • IPV6
  • DUAL_STACK

ipv4AddressesPerEni -> (integer)

The number of IPv4 addresses in each elastic network interface for the service-managed resource gateway.

portRanges -> (list)

The TCP port ranges that a consumer can use to access the resource.

(string)

A single TCP port or an inclusive range of TCP ports, for example 443 or 8000-8100.

certificate -> (string)

The certificate for the private connection.

dnsResolution -> (string)

The DNS resolution mode for the resource gateway. Defaults to PUBLIC when not set.

Possible values:

  • PUBLIC
  • IN_VPC

selfManaged -> (structure)

The configuration for a self-managed private connection, where you manage your own resource configuration.

resourceConfigurationId -> (string) [required]

The identifier or ARN of the resource configuration.

certificate -> (string)

The certificate for the private connection.

Shorthand Syntax:

serviceManaged={hostAddress=string,vpcId=string,subnetIds=[string,string],securityGroupIds=[string,string],ipAddressType=string,ipv4AddressesPerEni=integer,portRanges=[string,string],certificate=string,dnsResolution=string},selfManaged={resourceConfigurationId=string,certificate=string}

JSON Syntax:

{
  "serviceManaged": {
    "hostAddress": "string",
    "vpcId": "string",
    "subnetIds": ["string", ...],
    "securityGroupIds": ["string", ...],
    "ipAddressType": "IPV4"|"IPV6"|"DUAL_STACK",
    "ipv4AddressesPerEni": integer,
    "portRanges": ["string", ...],
    "certificate": "string",
    "dnsResolution": "PUBLIC"|"IN_VPC"
  },
  "selfManaged": {
    "resourceConfigurationId": "string",
    "certificate": "string"
  }
}

--tags (map)

The tags to attach to the private connection.

key -> (string)

Key for a resource tag.

value -> (string)

Value for a resource tag.

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

name -> (string)

The name of the private connection.

type -> (string)

The type of the private connection, indicating whether it is service-managed or self-managed.

Possible values:

  • SERVICE_MANAGED
  • SELF_MANAGED

status -> (string)

The current status of the private connection.

Possible values:

  • ACTIVE
  • CREATE_IN_PROGRESS
  • CREATE_FAILED
  • DELETE_IN_PROGRESS
  • DELETE_FAILED

resourceGatewayId -> (string)

The identifier or ARN of the VPC Lattice resource gateway.

hostAddress -> (string)

The IP address or DNS name of the target resource.

vpcId -> (string)

The identifier of the VPC the resource gateway is created in.

resourceConfigurationId -> (string)

The identifier or ARN of the VPC Lattice resource configuration.

certificateExpiryTime -> (timestamp)

The date and time the connection’s certificate expires, in UTC format.

dnsResolution -> (string)

The DNS resolution mode for the resource gateway.

Possible values:

  • PUBLIC
  • IN_VPC

failureMessage -> (string)

A message describing why the private connection entered a failed state, if applicable.

tags -> (map)

The tags attached to the private connection.

key -> (string)

Key for a resource tag.

value -> (string)

Value for a resource tag.
© Copyright 2026, Amazon Web Services. Created using Sphinx.