Serverless databases: Connect via a private endpoint
To better protect your database connection, you can connect to a private endpoint using the DataStax Astra DB private endpoint.
Private endpoints available on only serverless databases.
Get private endpoints information with the DevOps API
Use the DevOps API to create, remove, and manage private endpoints.
You can use the DevOps API to perform the actions your role permissions allow.
The following roles can manage private endpoints:
-
Organization Administrator
-
Database Administrator
Alternatively, you can use a custom role with permissions to manage private endpoints.
Prerequisites
Ensure you have permission to manage private endpoints.
To increase your security, consider restricting public access to your database using the access list. |
Getting a list of private endpoint configurations
-
Check existing private endpoint configurations within your organization or database:
curl --request GET \ --url 'https://api.astra.datastax.com/v2/organizations/<organizationID>/clusters/private-link' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <application_token>'
curl --request GET \ --url 'https://api.astra.datastax.com/v2/organizations/clusters/<databaseId>/private-link' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <application_token>'
{ "provider": "aws", "region": "us-east-1", "description": "Private Endpoint B", "organizationId": "string", "datacenterID": "string", "endpoints": [ { "id": "string", "dateActivation": "1997-12-09T02:03:33.57Z", "dateDeactivation": "1997-12-09T02:03:33.57Z" } ] }
Getting a list of private endpoint connections
-
Check existing private endpoint connections within your organization or database:
curl --request GET \ --url 'https://api.astra.datastax.com/v2/organizations/clusters/private-link' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <application_token>'
curl --request GET \ --url 'https://api.astra.datastax.com/v2/organizations/clusters/<databaseID>/private-link' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <application_token>'
curl --request GET \ --url 'https://api.astra.datastax.com/v2/organizations/clusters/<databaseID>/datacenters/<datacenterID>/private-link' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <application_token>'
If the database is only in a single region,
datacenterID
is yourdatabaseID
.{ "clusters": [ { "databaseID": "string", "datacenters": [ { "serviceName": "com.amazonaws.vpce.us-east-1.vpce-svc-1148ea04af491da11", "allowedPrincipals": [ "arn:aws:iam::123456789012:role/admin" ], "datacenterID": "string", "endpoints": [ { "endpointID": "vpce-svc-1148ea04af491da11", "description": "ecomm-team-billing-app", "status": "Accepted", "createdDateTime": "2009-11-10T23:00:00" } ] } ] } ] }
What’s next?
Learn how to connect to AWS PrivateLink, Azure Private Link, or GCP Private Service Connect.
Explore Private endpoints in the DevOps API.
Connecting to AWS PrivateLink
To better protect your database connection, you can connect to a private endpoint using the Astra DB private endpoint. Private endpoints are available for only intra-region use. The region for your private endpoint in the AWS console and your Astra DB database must match.
For pricing related to using private endpoints, see Pricing and billing.
The following roles can manage private endpoints:
-
Organization Administrator
-
Database Administrator
Alternatively, you can use a custom role with permissions to manage private endpoints.
For more about AWS PrivateLink, see AWS PrivateLink.
Prerequisites
-
Create your Astra DB database using Astra Portal.
-
Ensure you have permission to manage private endpoints.
Only VPC owners can create resources such as VPC endpoints, subnets, route tables, and NACLs. Participants cannot view, modify, or delete resources that belong to other participants or the VPC owner. Thus a user cannot create resources, including a private endpoint, in a shared VPC that is owned by a different AWS account. To see which account owns your VPC, look at the Owner ID in the AWS Console. Example: ![]() For more, see Work with shared VPCs - Amazon Virtual Private Cloud. |
To increase your security, restrict public access to your database using the access list. |
If you are using Postman for your API calls, ensure you use the |
Connect to your AWS PrivateLink endpoint
-
Get the allowed principal from your AWS account.
-
In your AWS console on the Identify and Access Management (IAM) Users page, select your user name from the available users.
-
Select the User ARN as your allowed principal. For example,
arn:aws:iam::123456789012:root
.
-
-
Enter the allowed principal for your private endpoints to Astra DB:
curl --request POST \ --url 'https://api.astra.datastax.com/v2/organizations/clusters/<databaseID>/datacenters/<datacenterID>/private-link' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <application_token>' \ --data '{ "allowedPrincipals": [ "arn:aws:iam::123456789012:role/admin" ] }'
To confirm your datacenter ID, see your database Dashboard or use the DevOps API to get all datacenter IDs within your database.
{ "serviceName": "com.amazonaws.vpce.us-east-1.vpce-svc-1148ea04af491da11", "allowedPrincipals": [ "arn:aws:iam::123456789012:role/admin" ] }
-
Use the
serviceName
to create an endpoint in your AWS Console.Get a list of available services:
aws ec2 describe-vpc-endpoint-services
Results:
{ "VpcEndpoints": [ { "VpcEndpointId": "vpce-08a979e28f97a9f7c", "VpcEndpointType": "Interface", "VpcId": "vpc-06e4ab6c6c3b23ae3", "ServiceName": "com.amazonaws.us-east-2.monitoring", "State": "available", "PolicyDocument": "{\n \"Statement\": [\n {\n \"Action\": \"*\", \n \"Effect\": \"Allow\", \n \"Principal\": \"*\", \n \"Resource\": \"*\"\n }\n ]\n}", "RouteTableIds": [], "SubnetIds": [ "subnet-0931fc2fa5f1cbe44" ], "Groups": [ { "GroupId": "sg-06e1d57ab87d8f182", "GroupName": "default" } ], "PrivateDnsEnabled": false, "RequesterManaged": false, "NetworkInterfaceIds": [ "eni-019b0bb3ede80ebfd" ], "DnsEntries": [ { "DnsName": "vpce-08a979e28f97a9f7c-4r5zme9n.monitoring.us-east-2.vpce.amazonaws.com", "HostedZoneId": "ZC8PG0KIFKBRI" }, { "DnsName": "vpce-08a979e28f97a9f7c-4r5zme9n-us-east-2c.monitoring.us-east-2.vpce.amazonaws.com", "HostedZoneId": "ZC8PG0KIFKBRI" } ], "CreationTimestamp": "2019-06-04T19:10:37.000Z", "Tags": [], "OwnerId": "123456789012" } ]
In the Amazon VPC console navigation pane, select Endpoints > Create Endpoint. The available
serviceNames
are listed in the Service Name section.The status for your private endpoint should show
pending acceptance
. -
Accept your AWS private endpoint connection with your
serviceName
:curl --request POST \ --url 'https://api.astra.datastax.com/v2/organizations/clusters/<databaseID>/datacenters/<datacenterID>/endpoints' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <application_token>' \ --data '{ "endpointID": "vpce-svc-1148ea04af491da11", "description": "project-desc-dev-app" }'
{ "datacenters": [ { "serviceName": "com.amazonaws.vpce.us-east-1.vpce-svc-1148ea04af491da11", "allowedPrincipals": [ "arn:aws:iam::123456789012:role/admin" ], "datacenterID": "string", "endpoints": [ { "endpointID": "vpce-svc-1148ea04af491da11", "description": "project-desc-dev-app", "status": "Accepted", "createdDateTime": "2021-04-10T23:00:00" } ] } ] }
Your AWS console will show that it is in the
available
state. For more, see Accept and reject endpoint connect requests. -
Create a DNS entry for your private endpoint.
-
Download your secure connect bundle for the region of your choice. Get your latest secure connect bundle.
-
Unzip the secure connect bundle.
-
In
config.json
, copy thehost
key’s value. -
In the AWS Console, create a CNAME record that points to the DNS name found in your VPC Endpoint details.
-
In the AWS Console, create a private zone to route traffic to your virtual IP using Amazon Route 53. Update the following domains to use REST and CQL:
efe451fe-709e-4700-9185-5cf0fd3474a7-2-us-east-1.apps.astra.datastax.com
efe451fe-709e-4700-9185-5cf0fd3474a7-2-us-east-1.db.astra.datastax.com
-
In the AWS Console, create a DNS entry for the key
host
value and map it to your virtual IP address.
-
You can now connect to your private endpoint using your updated secure connect bundle. For more, see Drivers for Astra.
Remove a private endpoint
-
Delete a private endpoint from your Astra DB:
-
Remove your connection from AWS PrivateLink:
aws ec2 delete-vpc-endpoint-service-configurations --service-ids <serviceId>
-
In the Amazon VPC console navigation pane, select Endpoint Services.
-
For the service you want to delete, select Actions > Delete.
-
Select Yes, Delete to remove the connection.
-
Connect to Azure Private Link with the DevOps API
To better protect your database connection, you can connect to a private endpoint using the Astra DB private endpoint.
For pricing related to using private endpoints, see Pricing and billing.
The following roles can manage private endpoints:
-
Organization Administrator
-
Database Administrator
Alternatively, you can use a custom role with permissions to manage private endpoints.
Prerequisites
-
Ensure you have permission to manage private endpoints.
To increase your security, consider restricting public access to your database using the access list. |
Connect to your Azure Private Link endpoint
-
Get the allowed principal from your Azure account. This is your Subscription ID.
-
Enter your Subscription ID as the allowed principal for your private endpoints to Astra DB:
curl --request POST \ --url 'https://api.astra.datastax.com/v2/organizations/clusters/<databaseID>/datacenters/<datacenterID>/private-link' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <application_token>' \ --data '{ "allowedPrincipals": [ "9cbbd094-fa31-490f-863d-897d01661681" ] }'
To confirm your datacenter ID, see your database Dashboard or use the DevOps API to get all datacenter IDs within your database.
{ "serviceName": "test.a51y2a51-f9j4-4ad2-l863-67e5ac6g10m.westus2.azure.privatelinkservice", "allowedPrincipals": [ "9cbbd094-fa31-490f-863d-897d01661681" ] }
-
In your Azure Private endpoints, select Add.
-
Select your Subscription and then your Resource group for your project.
-
Enter your private endpoint name.
-
Select the region for your private endpoint. This region should match your Astra DB region.
-
Select Next: Resource.
-
Select Connect to an Azure resource by resource ID or alias as your Connection method.
-
Enter your
serviceName
as your Resource ID or alias. -
Select Next: Configuration.
-
Select your Virtual network and Subnet from the menus.
-
Select Review + create and then select Create to finish creating your private endpoint.
For more, see Create a Private Endpoint using the Azure portal. Alternatively, you can create a private endpoint using Azure CLI.
-
-
Connect your Azure private endpoint connection:
Your
endpointId
is the Resource ID for your private link endpoint, which is available in your Azure console by selecting JSON View for your private link endpoint. For example,/subscriptions/$SUBSCRIPTION_ID/resourceGroups/$RESOURCE_GROUP_NAME/providers/Microsoft.Network/privateEndpoints/$ENDPOINT_NAME
.curl --request POST \ --url 'https://api.astra.datastax.com/v2/organizations/clusters/<databaseID>/datacenters/<datacenterID>/endpoints' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <application_token>' \ --data '{ "endpointID": "/subscriptions/a51y2a51-f9j4-4ad2-l863-67e5ac6g10m/resourceGroups/lab-resourceGroups/providers/Microsoft.Network/privateEndpoints/dev-poc", "description": "project-desc-dev-app" }'
{ "datacenters": [ { "serviceName": "test.a51y2a51-f9j4-4ad2-l863-67e5ac6g10m.westus2.azure.privatelinkservice", "allowedPrincipals": [ "9cbbd094-fa31-490f-863d-897d01661681" ], "datacenterID": "string", "endpoints": [ { "endpointID": "/subscriptions/a51y2a51-f9j4-4ad2-l863-67e5ac6g10m/resourceGroups/lab-resourceGroups/providers/Microsoft.Network/privateEndpoints/dev-poc", "description": "project-desc-dev-app", "status": "Accepted", "createdDateTime": "2021-04-10T23:00:00" } ] } ] }
-
Create a DNS entry for your private endpoint. For more, see:
Your Azure portal will show that it is in the approved
state.
Remove a private endpoint
-
Delete a private endpoint from your Astra DB:
-
Remove your connection from your Azure portal:
-
In the Azure VPC console, select Private Link Center > Private endpoints.
-
Select the checkbox beside the private endpoint you want to remove.
-
Select Remove.
Remove-AzPrivateEndpointConnection -Name myPrivateEndpointConnection1 -ResourceGroupName myResourceGroup -ServiceName myPrivateLinkServiceName
-
Connect to Google Cloud Private Service Connect with the DevOps API
To better protect your database connection, you can connect to a private endpoint using the Astra DB private endpoint. Private endpoints are available for only intra-region use. The region for your private endpoint in the Google Cloud Console and your Astra DB database must match.
For pricing related to using private endpoints, see Pricing and billing.
The following roles can manage private endpoints:
-
Organization Administrator
-
Database Administrator
Alternatively, you can use a custom role with permissions to manage private endpoints.
For more, see Google Cloud Private Service Connect.
Prerequisites
-
Create your Astra DB database using Astra Portal.
-
Ensure you have permission to manage private endpoints.
-
From your Google Cloud Console, get your Project ID. For example,
valiant-ocean-258751
. -
Create a Google Cloud Console network, subnetwork, and IP address for your private endpoint. For more, see Creating neworks.
To increase your security, restrict public access to your database using the access list. |
If you are using Postman for your API calls, ensure you use the |
Connect to your Google Cloud Private Service Connect endpoint
-
Enter the Project ID as your allowed principal for your private endpoints to Astra DB:
curl --request POST \ --url 'https://api.astra.datastax.com/v2/organizations/clusters/<databaseID>/datacenters/<datacenterID>/private-link' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <application_token>' \ --data '{ "allowedPrincipals": [ "valiant-ocean-258751" ] }'
To confirm your datacenter ID, see your database Dashboard or use the DevOps API to get all datacenter IDs within your database.
{ "serviceName": "projects/<projectID>/regions/<regionName>/serviceAttachments/<serviceAttachmentName>", "allowedPrincipals": [ "valiant-ocean-258751" ] }
-
Create the endpoint in your Google Cloud Console.
-
In the Google Cloud Console, go to Private Service Connect.
-
Select Connect endpoint.
-
Select Published service as the Target.
-
Enter the 'serviceName' from the DevOps API result as the Target service.
-
Enter a name for the Endpoint name.
-
Select your Network and Subnetwork for the endpoint.
-
Select an IP address for the endpoint.
-
Select Add endpoint.
The status for the endpoint will show as Accepted. This does not mean that the endpoint is ready for use and must be accepted in the Astra DB DevOps API.
-
-
Using the PSC Connection ID from your Google Cloud Console as your endpoint ID, accept your Google Cloud private endpoint connection:
curl --request POST \ --url 'https://api.astra.datastax.com/v2/organizations/clusters/<databaseID>/datacenters/<datacenterID>/endpoints' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <application_token>' \ --data '{ "endpointID": "2755639674399101", "description": "project-desc-dev-app" }' .sh[]
{ "datacenters": [ { "serviceName": "projects/<projectID>/regions/<regionName>/serviceAttachments/<serviceAttachmentName>", "allowedPrincipals": [ "valiant-ocean-258751" ], "datacenterID": "string", "endpoints": [ { "endpointID": "2755639674399101", "description": "project-desc-dev-app", "status": "Accepted", "createdDateTime": "2021-04-10T23:00:00" } ] } ] }
Your Google Private Service Connect menu will show the private endpoint.
-
Create a DNS entry for your private endpoint.
-
Download your secure connect bundle for the region of your choice. Get your latest secure connect bundle.
-
Unzip the secure connect bundle.
-
In
config.json
, copy thehost
key’s value. -
In the Google Cloud Console, create a private zone to route traffic to your endpoint IP. Update the following domains to use REST and CQL:
efe451fe-709e-4700-9185-5cf0fd3474a7-2-us-east-1.apps.astra.datastax.com
efe451fe-709e-4700-9185-5cf0fd3474a7-2-us-east-1.db.astra.datastax.com
For more, see Create a private zone.
-
You can now connect to your private endpoint using your updated secure connect bundle. For more, see Drivers for Astra.
Remove a private endpoint
-
Delete a private endpoint from your Astra DB:
-
In the Google Cloud Console, go to Private Service Connect.
-
Select the endpoint you want to remove.
-
Select Delete.
What’s next?
For more about adding private endpoints with the DevOps API, see the DevOps API reference.