Manage Private Endpoints for an Federated Database Instance

Find the service name for your private endpoint.

Use the following table to find the service name that corresponds to the AWS region for your private endpoint:

Use the AWS CLI to configure each private endpoint.

To create your application VPC interface endpoint:

1. Copy the following command:

   aws ec2 create-vpc-endpoint --vpc-id {your-application-vpc-id} --region {aws-region} --service-name {service-name} --vpc-endpoint-type Interface --subnet-ids {your-application-subnet-ids}

2. Replace the following placeholders with the details about your AWS VPC:

   your-application-vpc-id	Unique string that identifies the peer AWS VPC. Find this value on the VPC dashboard in your AWS account.
   aws-region	Label that identifies the AWS region of the private endpoint.
   service-name	Unique string that identifies the service for your private endpoint. This is the service name value you retrieved in the previous step.
   your-application-subnet-ids	Unique strings that identify the subnets your AWS VPC uses. Separate each subnet with a space. Find these values on the Subnet dashboard in your AWS account. IMPORTANT: You must specify at least one subnet. If you don't, AWS won't provision a interface endpoint in your VPC. An interface endpoint is required for clients in your VPC to send traffic to the private endpoint.

3. Run the command with the AWS CLI.

4. Note the VpcEndpointId value in the output.

   Example

   "VpcEndpoint": {
            "VpcEndpointId": "vpce-XXXXXX”,
            "VpcEndpointType": "Interface",
            "VpcId": "vpc-XXXXX”,
            "ServiceName": "com.amazonaws.vpce.{aws-region}.vpce-svc-XXXX”,
            "State": "pendingAcceptance",
            }

To learn more, see Creating an Interface Endpoint in the AWS documentation.

Specify the spec.privateEndpoints parameter.

Specify the spec.privateEndpoints parameter for the AtlasDataFederation Custom Resource. Replace vpce-id with the VpcEndpointId value from the previous step and run the following command:

cat <<EOF | kubectl apply -f -
apiVersion: atlas.mongodb.com/v1
kind: AtlasDataFederation
metadata:
  name: my-federated-deployment
spec:
  name: my-fdi
  privateEndpoints:
  - endpointId: {vpce-id}
    provider: AWS
    type: DATA_LAKE
EOF

Check the status of your private endpoints using Atlas Kubernetes Operator.

Run the following command:

kubectl get atlasdatafederation my-fdi -o yaml