Autoscaling Report: Production databases on Neon use 2.4x less compute and 50% less cost than if they were running on a provisioned platform.
Neon
    Docs
    Log inSign up
    /CLI/vpc

    Neon CLI command: vpc

    Manage Private Networking VPC endpoints and project-level restrictions

    The vpc command manages Private Networking configurations in Neon. Use it to register VPC endpoints at the organization level and to restrict individual projects to connections from a specific VPC.

    Subcommands: endpoint, project

    VPC endpoints

    The vpc endpoint subcommands list, assign, remove, and check the status of VPC endpoints for a Neon organization.

    Subcommands: assign, list, remove, status

    You only need --org-id if your Neon account belongs to more than one organization. If your account has a single organization, the CLI uses it automatically. Instead of passing IDs on each command, you can also set them in a context file and reference it with the --context-file option.

    neon vpc endpoint list

    Lists the VPC endpoints configured for a Neon organization.

    neon vpc endpoint list [options]
    OptionDescriptionTypeDefaultRequired
    --org-idOrganization IDstring—No
    --region-idThe region ID. Possible values: aws-us-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-eu-central-1, aws-us-east-2, aws-us-east-1, azure-eastus2string—Yes
    neon vpc endpoint list --org-id org-bold-bonus-12345678

    neon vpc endpoint assign

    Adds or updates a VPC endpoint in a Neon organization. add and update are aliases for this command.

    neon vpc endpoint assign <id> [options]
    OptionDescriptionTypeDefaultRequired
    --labelAn optional descriptive label for the VPC endpointstring—No
    --org-idOrganization IDstring—No
    --region-idThe region ID. Possible values: aws-us-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-eu-central-1, aws-us-east-2, aws-us-east-1, azure-eastus2string—Yes

    Add a VPC endpoint to a Neon organization in a specific region:

    neon vpc endpoint assign vpce-1234567890abcdef0 --org-id org-bold-bonus-12345678 --region-id aws-us-east-1

    After you assign a VPC endpoint to a Neon organization, client connections are accepted from the corresponding VPC for all projects in the organization unless you restrict access at the project level with vpc project restrict.

    neon vpc endpoint remove

    Removes a VPC endpoint from a Neon organization.

    neon vpc endpoint remove <id> [options]
    OptionDescriptionTypeDefaultRequired
    --org-idOrganization IDstring—No
    --region-idThe region ID. Possible values: aws-us-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-eu-central-1, aws-us-east-2, aws-us-east-1, azure-eastus2string—Yes
    neon vpc endpoint remove vpce-1234567890abcdef0 --org-id org-bold-bonus-12345678

    note

    A removed VPC endpoint cannot be added back to the Neon organization.

    neon vpc endpoint status

    Gets the status of a VPC endpoint in a Neon organization.

    neon vpc endpoint status <id> [options]
    OptionDescriptionTypeDefaultRequired
    --org-idOrganization IDstring—No
    --region-idThe region ID. Possible values: aws-us-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-eu-central-1, aws-us-east-2, aws-us-east-1, azure-eastus2string—Yes
    neon vpc endpoint status vpce-1234567890abcdef0 --org-id org-bold-bonus-12345678

    Project VPC restrictions

    The vpc project subcommands list, configure, or remove VPC endpoint restrictions for specific projects in your Neon organization. By default, a project accepts connections from any VPC configured at the organization level. A restriction limits a project to connections from a specific VPC.

    Subcommands: list, remove, restrict

    You only need --project-id if your Neon account has more than one project.

    neon vpc project list

    Lists all VPC endpoint restrictions for a Neon project.

    neon vpc project list [options]
    OptionDescriptionTypeDefaultRequired
    --project-idProject IDstring—No
    neon vpc project list --project-id orange-credit-12345678

    neon vpc project restrict

    Configures or updates a VPC endpoint restriction for a Neon project. update is an alias for this command.

    neon vpc project restrict <id> [options]
    OptionDescriptionTypeDefaultRequired
    --labelAn optional descriptive label for the VPC endpoint restrictionstring—No
    --project-idProject IDstring—No
    neon vpc project restrict vpce-1234567890abcdef0 --project-id orange-credit-12345678

    neon vpc project remove

    Removes a VPC endpoint restriction from a Neon project.

    neon vpc project remove <id> [options]
    OptionDescriptionTypeDefaultRequired
    --project-idProject IDstring—No
    neon vpc project remove vpce-1234567890abcdef0 --project-id orange-credit-12345678
    Was this page helpful?
    Edit on GitHub
    Previous ip-allowNext Overview

    On this page

    Copy neon init command