# The VpcEndpoint object

*

## Attributes

- `vpc_endpoint_id` (string)
  Databricks VPC endpoint ID. This is the <Databricks>-specific name of the VPC endpoint. Do not confuse this with the `aws_vpc_endpoint_id`, which is the ID within AWS of the VPC endpoint.
- `account_id` (string)
  The <Databricks> account ID that hosts the VPC endpoint configuration.
- `vpc_endpoint_name` (string)
  The human-readable name of the storage configuration.
  Constraints: `[ 4 .. 256 ] characters`
- `aws_vpc_endpoint_id` (string)
  The ID of the VPC endpoint object in AWS.
- `aws_endpoint_service_id` (string)
  The ID of the <Databricks> [endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/endpoint-service.html) that this VPC endpoint is connected to. For a list of endpoint service IDs for each supported AWS region, see the [Databricks PrivateLink documentation](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).
- `use_case` (string)
  This enumeration represents the type of Databricks VPC endpoint service that was used when creating this VPC endpoint.
   If the VPC endpoint connects to the <Databricks> control plane for either the front-end connection or the back-end REST API connection, the value is GENERAL_ACCESS.
   If the VPC endpoint connects to the <Databricks> workspace for the back-end secure cluster connectivity relay, the value is DATAPLANE_RELAY_ACCESS.
  Possible values: `WORKSPACE_ACCESS`, `DATAPLANE_RELAY_ACCESS`, `GENERAL_ACCESS`
- `region` (string)
  The AWS region in which this VPC endpoint object exists.
- `aws_account_id` (string)
  The AWS Account in which the VPC endpoint object exists.
- `state` (string)
  The current state (such as `available` or `rejected`) of the VPC endpoint. Derived from AWS. For the full set of values, see [AWS DescribeVpcEndpoint documentation](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html).
- `gcp_vpc_endpoint_info` (object)
  The cloud info of this vpc endpoint.
   Info for a GCP vpc endpoint.
  - `psc_connection_id` (string)
    **GCP:** The ID of the underlying PSC Connection in GCP consumer projects. This is assigned by GCP when user sets up the
    PSC connection in their consumer project on GCP. Read only to users.
  - `project_id` (string)
    **GCP:** The ID of the GCP consumer project this PSC endpoint is created within.
  - `psc_endpoint_name` (string)
    **GCP:** The name of this PSC connection in GCP consumer project. This is named by user when user sets up the PSC connection
    in their consumer project on GCP.
  - `endpoint_region` (string)
    **GCP:** The GCP region of the PSC connection endpoint.
    Currently GCP only supports same region PSC connection, which means the endpoint region needs to be same with the
    workspace region to build a PSC connection successfully.
  - `service_attachment_id` (string)
    **GCP:** The ID of the Service Attachment on our Control Plane this PSC endpoint connects to. Read only to users.

## Example

```json
{
  "vpc_endpoint_id": "string",
  "account_id": "string",
  "vpc_endpoint_name": "string",
  "aws_vpc_endpoint_id": "string",
  "aws_endpoint_service_id": "string",
  "use_case": "string",
  "region": "string",
  "aws_account_id": "string",
  "state": "string",
  "gcp_vpc_endpoint_info": {
    "psc_connection_id": "string",
    "project_id": "string",
    "psc_endpoint_name": "string",
    "endpoint_region": "string",
    "service_attachment_id": "string"
  }
}
```