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

--private-connection-name (string)

A unique name for the private connection within your account.

--mode (tagged union structure)

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)

The IP address or DNS name of the target resource.

vpcId -> (string)

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

subnetIds -> (list)

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.

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.

selfManaged -> (structure)

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

resourceConfigurationId -> (string)

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

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.

status -> (string)

The current status of the private connection.

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.

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.