AWS CLI Command Reference

[ aws . bedrock-agent ]

create-vpc-configuration

Description

Creates a VPC configuration that lets a knowledge base connect to a resource in your private VPC. This operation is asynchronous: it returns a vpcConfigurationId with status CREATING . Poll GetVpcConfiguration until the status becomes CREATED or CREATE_FAILED .

See also: AWS API Documentation

Synopsis

  create-vpc-configuration
--knowledge-base-id <value>
[--client-token <value>]
--vpc-id <value>
--subnet-ids <value>
--resource-target <value>
--port <value>
--protocol <value>
--resolution-mode <value>
[--host-header <value>]
[--tls-server-name <value>]
[--name <value>]
[--description <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

--knowledge-base-id (string) [required]

The unique identifier of the knowledge base to associate this VPC configuration with.

Constraints:

  • pattern: [0-9a-zA-Z]{10}

--client-token (string)

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.

Constraints:

  • min: 33
  • max: 256
  • pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

--vpc-id (string) [required]

The identifier of the VPC that the knowledge base connects through to reach the resource.

Constraints:

  • min: 1
  • max: 64
  • pattern: vpc-[a-zA-Z0-9]+

--subnet-ids (list) [required]

The subnets, in the VPC identified by vpcId , that the knowledge base uses to connect to the resource.

Constraints:

  • min: 1
  • max: 6

(string)

Constraints:

  • min: 1
  • max: 64
  • pattern: subnet-[a-zA-Z0-9]+

Syntax:

"string" "string" ...

--resource-target (string) [required]

The private IPv4 address or DNS name of the resource you want the knowledge base to reach. The target must be privately reachable from inside your VPC, such as an internal load balancer or a private IP. The following are not supported:

  • Internet-facing endpoints
  • Loopback addresses
  • Link-local addresses
  • Wildcard addresses
  • Multicast addresses
  • IPv6 literals

Constraints:

  • min: 1
  • max: 255

--port (integer) [required]

The port on which to reach the resource.

Constraints:

  • min: 1
  • max: 65535

--protocol (string) [required]

The protocol used to connect to the resource. Specify HTTP for plaintext or HTTPS for TLS. When you specify HTTPS , you must also provide tlsServerName .

Possible values:

  • HTTP
  • HTTPS

--resolution-mode (string) [required]

Controls how a domain-name resourceTarget is resolved. This applies only when the target is a domain name; it has no effect for IP-address targets, which have no name to resolve. In all cases the resolved address must be reachable from inside your VPC. Valid values:

  • IN_VPC (default, recommended) – The target domain name is resolved privately, using the DNS resolvers of the VPC, such as private Route 53 hosted zones or on-premises DNS reachable from the VPC. Use this for targets that are private to your VPC, such as internal load balancers, private hosted-zone names, or on-premises hosts.
  • PUBLIC – The target domain name is resolved against public DNS resolvers. Select this only when the target’s domain name must be resolved through public DNS and the resulting address is still reachable from the VPC, an uncommon split-horizon configuration. If you are unsure, use IN_VPC .

Possible values:

  • PUBLIC
  • IN_VPC

--host-header (string)

An optional HTTP Host header value to send when invoking the resource. Set this only if your resource (or an upstream router or ingress) routes by the Host header and that host differs from the target. This setting is independent of tlsServerName .

Constraints:

  • min: 1
  • max: 255
  • pattern: [A-Za-z0-9._:\[\]-]{1,255}

--tls-server-name (string)

The expected TLS server name. The service matches this value against the Subject Alternative Names on your resource’s TLS certificate during invocation. This field is required when protocol is HTTPS . Set it to a hostname on your certificate, such as app.internal.example.com . You can use a single leftmost wildcard, such as *.example.com . The value must be a hostname without a port.

Constraints:

  • min: 1
  • max: 253
  • pattern: (\*\.)?([A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?\.)*[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?

--name (string)

An optional human-readable name for the VPC configuration. If you don’t specify a name, the VPC configuration has no name.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9]([a-zA-Z0-9 _-]*[a-zA-Z0-9])?

--description (string)

An optional description of the VPC configuration. If you don’t specify a description, the VPC configuration has no description.

Constraints:

  • min: 0
  • max: 512
  • pattern: [^\p{C}]*

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

vpcConfigurationId -> (string)

The unique identifier of the VPC configuration that was created.

Constraints:

  • min: 32
  • max: 32
  • pattern: [a-z0-9](?:[a-z0-9-]{30}[a-z0-9])

status -> (string)

The current status of the VPC configuration. Immediately after creation this is CREATING .

Possible values:

  • CREATING
  • CREATED
  • DELETING
  • CREATE_FAILED
  • DELETE_FAILED
© Copyright 2026, Amazon Web Services. Created using Sphinx.