This topic describes how to connect to OceanBase Cloud by using Amazon Web Services (AWS) PrivateLink.
Prerequisites
- You have registered an AWS account.
- You have registered an OceanBase Cloud account, and have created a cluster instance. For more information, refer to Create a cluster instance.
- Make sure your client IP address has been added to the allowlist of your instance. For detailed instructions, refer to Set allowlist groups.
Procedure
Log in to the OceanBase Cloud console, and in the left-side navigation pane, click Networking.
Under the tab Private Connectivity, click Create Private Connection.
Under Step 1: Create your endpoint service, select AWS as the cloud vendor, and select the target instance for the connection.
Navigate to the AWS console, click the username in the upper right corner, and copy the account ID in the drop-down menu.
Navigate back to the OceanBase Cloud console, enter the account ID under 3. Create an endpoint service in Step 1: Create your endpoint service and click Create Endpoint Service.
After the service is created, under Step 2: Create an endpoint, copy the service ID.
Navigate to the Endpoints page in the Virtual Private Cloud (VPC) console of AWS, and click Create endpoint.
Specify the following information on the Create endpoint page.
Parameter Description Name tag - optional Specify a name for the endpoint. Type Select Endpoint services that use NLBs and GWLBs. Service name Enter the service ID copied in Step 6 above in Service name under Service settings, and click Verify service. VPC Select the VPC in which to create the endpoint. Click Create endpoint.
On the Endpoints page, select the endpoint just created and choose Actions > Modify private DNS name in the upper right corner of the page. On the page that appears, select Enable for this endpoint and click Save changes.
Copy the endpoint ID on the Endpoints page in the AWS console and then navigate back to the OceanBase Cloud console. Enter the endpoint in the VPC Endpoint ID field in Step 2: Create an endpoint, then click Connect.
In Step 3: Enable private DNS, first enable private DNS, and then select an existing database and account, or create new ones.
Notice
Please save the password generated in a secure place when the account is created.
Select MySQL CLI as the connection method and copy the generated connection string to your client.
Currently, OceanBase Cloud supports a wide range of clients, drivers, and languages. For more information, see Overview.
In the CLI of your MySQL client, enter the account name and password generated in Step 12. Then, you can connect to and use OceanBase Cloud.
What's next
After creating the endpoint, you can view its details on the Topology Diagram tab on the Overview page of the instance. If you need to update the endpoint due to VPC changes, OceanBase Cloud allows you to delete the existing endpoint and recreate it.
To delete an endpoint:
In the OceanBase Cloud console, navigate to the Instances page and click the target instance name to enter the Overview page of the instance.
In the Topology Diagram, click the delete button to remove the existing endpoint.