Get started with Pulumi in a free one hour introductory workshop. Register Now

PrivateEndpointInterfaceLink

mongodbatlas.PrivateEndpointInterfaceLink provides a Private Endpoint Interface Link resource. This represents a Private Endpoint Interface Link, which adds one interface endpoint to a private endpoint connection in an Atlas project.

IMPORTANT:You must have one of the following roles to successfully handle the resource: * Organization Owner * Project Owner

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var testPrivateEndpoint = new Mongodbatlas.PrivateEndpoint("testPrivateEndpoint", new Mongodbatlas.PrivateEndpointArgs
        {
            ProjectId = "<PROJECT_ID>",
            ProviderName = "AWS",
            Region = "us-east-1",
        });
        var ptfeService = new Aws.Ec2.VpcEndpoint("ptfeService", new Aws.Ec2.VpcEndpointArgs
        {
            SecurityGroupIds = 
            {
                "sg-3f238186",
            },
            ServiceName = testPrivateEndpoint.EndpointServiceName,
            SubnetIds = 
            {
                "subnet-de0406d2",
            },
            VpcEndpointType = "Interface",
            VpcId = "vpc-7fc0a543",
        });
        var testPrivateEndpointInterfaceLink = new Mongodbatlas.PrivateEndpointInterfaceLink("testPrivateEndpointInterfaceLink", new Mongodbatlas.PrivateEndpointInterfaceLinkArgs
        {
            InterfaceEndpointId = ptfeService.Id,
            PrivateLinkId = testPrivateEndpoint.PrivateLinkId,
            ProjectId = testPrivateEndpoint.ProjectId,
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v3/go/aws/ec2"
    "github.com/pulumi/pulumi-mongodbatlas/sdk/go/mongodbatlas"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        testPrivateEndpoint, err := mongodbatlas.NewPrivateEndpoint(ctx, "testPrivateEndpoint", &mongodbatlas.PrivateEndpointArgs{
            ProjectId:    pulumi.String("<PROJECT_ID>"),
            ProviderName: pulumi.String("AWS"),
            Region:       pulumi.String("us-east-1"),
        })
        if err != nil {
            return err
        }
        ptfeService, err := ec2.NewVpcEndpoint(ctx, "ptfeService", &ec2.VpcEndpointArgs{
            SecurityGroupIds: pulumi.StringArray{
                pulumi.String("sg-3f238186"),
            },
            ServiceName: testPrivateEndpoint.EndpointServiceName,
            SubnetIds: pulumi.StringArray{
                pulumi.String("subnet-de0406d2"),
            },
            VpcEndpointType: pulumi.String("Interface"),
            VpcId:           pulumi.String("vpc-7fc0a543"),
        })
        if err != nil {
            return err
        }
        _, err = mongodbatlas.NewPrivateEndpointInterfaceLink(ctx, "testPrivateEndpointInterfaceLink", &mongodbatlas.PrivateEndpointInterfaceLinkArgs{
            InterfaceEndpointId: ptfeService.ID(),
            PrivateLinkId:       testPrivateEndpoint.PrivateLinkId,
            ProjectId:           testPrivateEndpoint.ProjectId,
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws
import pulumi_mongodbatlas as mongodbatlas

test_private_endpoint = mongodbatlas.PrivateEndpoint("testPrivateEndpoint",
    project_id="<PROJECT_ID>",
    provider_name="AWS",
    region="us-east-1")
ptfe_service = aws.ec2.VpcEndpoint("ptfeService",
    security_group_ids=["sg-3f238186"],
    service_name=test_private_endpoint.endpoint_service_name,
    subnet_ids=["subnet-de0406d2"],
    vpc_endpoint_type="Interface",
    vpc_id="vpc-7fc0a543")
test_private_endpoint_interface_link = mongodbatlas.PrivateEndpointInterfaceLink("testPrivateEndpointInterfaceLink",
    interface_endpoint_id=ptfe_service.id,
    private_link_id=test_private_endpoint.private_link_id,
    project_id=test_private_endpoint.project_id)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testPrivateEndpoint = new mongodbatlas.PrivateEndpoint("test", {
    projectId: "<PROJECT_ID>",
    providerName: "AWS",
    region: "us-east-1",
});
const ptfeService = new aws.ec2.VpcEndpoint("ptfe_service", {
    securityGroupIds: ["sg-3f238186"],
    serviceName: testPrivateEndpoint.endpointServiceName,
    subnetIds: ["subnet-de0406d2"],
    vpcEndpointType: "Interface",
    vpcId: "vpc-7fc0a543",
});
const testPrivateEndpointInterfaceLink = new mongodbatlas.PrivateEndpointInterfaceLink("test", {
    interfaceEndpointId: ptfeService.id,
    privateLinkId: testPrivateEndpoint.privateLinkId,
    projectId: testPrivateEndpoint.projectId,
});

Create a PrivateEndpointInterfaceLink Resource

def PrivateEndpointInterfaceLink(resource_name: str, opts: Optional[ResourceOptions] = None, interface_endpoint_id: Optional[str] = None, private_link_id: Optional[str] = None, project_id: Optional[str] = None)
name string
The unique name of the resource.
args PrivateEndpointInterfaceLinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args PrivateEndpointInterfaceLinkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PrivateEndpointInterfaceLinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

PrivateEndpointInterfaceLink Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The PrivateEndpointInterfaceLink resource accepts the following input properties:

InterfaceEndpointId string

Unique identifier of the interface endpoint you created in your VPC with the AWS resource.

PrivateLinkId string

Unique identifier of the AWS PrivateLink connection which is created by mongodbatlas.PrivateEndpoint resource.

ProjectId string

Unique identifier for the project.

InterfaceEndpointId string

Unique identifier of the interface endpoint you created in your VPC with the AWS resource.

PrivateLinkId string

Unique identifier of the AWS PrivateLink connection which is created by mongodbatlas.PrivateEndpoint resource.

ProjectId string

Unique identifier for the project.

interfaceEndpointId string

Unique identifier of the interface endpoint you created in your VPC with the AWS resource.

privateLinkId string

Unique identifier of the AWS PrivateLink connection which is created by mongodbatlas.PrivateEndpoint resource.

projectId string

Unique identifier for the project.

interface_endpoint_id str

Unique identifier of the interface endpoint you created in your VPC with the AWS resource.

private_link_id str

Unique identifier of the AWS PrivateLink connection which is created by mongodbatlas.PrivateEndpoint resource.

project_id str

Unique identifier for the project.

Outputs

All input properties are implicitly available as output properties. Additionally, the PrivateEndpointInterfaceLink resource produces the following output properties:

ConnectionStatus string

Status of the interface endpoint. Returns one of the following values:

DeleteRequested bool

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

ErrorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

Id string
The provider-assigned unique ID for this managed resource.
ConnectionStatus string

Status of the interface endpoint. Returns one of the following values:

DeleteRequested bool

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

ErrorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

Id string
The provider-assigned unique ID for this managed resource.
connectionStatus string

Status of the interface endpoint. Returns one of the following values:

deleteRequested boolean

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

errorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

id string
The provider-assigned unique ID for this managed resource.
connection_status str

Status of the interface endpoint. Returns one of the following values:

delete_requested bool

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

error_message str

Error message pertaining to the interface endpoint. Returns null if there are no errors.

id str
The provider-assigned unique ID for this managed resource.

Look up an Existing PrivateEndpointInterfaceLink Resource

Get an existing PrivateEndpointInterfaceLink resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, connection_status: Optional[str] = None, delete_requested: Optional[bool] = None, error_message: Optional[str] = None, interface_endpoint_id: Optional[str] = None, private_link_id: Optional[str] = None, project_id: Optional[str] = None) -> PrivateEndpointInterfaceLink
func GetPrivateEndpointInterfaceLink(ctx *Context, name string, id IDInput, state *PrivateEndpointInterfaceLinkState, opts ...ResourceOption) (*PrivateEndpointInterfaceLink, error)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

ConnectionStatus string

Status of the interface endpoint. Returns one of the following values:

DeleteRequested bool

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

ErrorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

InterfaceEndpointId string

Unique identifier of the interface endpoint you created in your VPC with the AWS resource.

PrivateLinkId string

Unique identifier of the AWS PrivateLink connection which is created by mongodbatlas.PrivateEndpoint resource.

ProjectId string

Unique identifier for the project.

ConnectionStatus string

Status of the interface endpoint. Returns one of the following values:

DeleteRequested bool

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

ErrorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

InterfaceEndpointId string

Unique identifier of the interface endpoint you created in your VPC with the AWS resource.

PrivateLinkId string

Unique identifier of the AWS PrivateLink connection which is created by mongodbatlas.PrivateEndpoint resource.

ProjectId string

Unique identifier for the project.

connectionStatus string

Status of the interface endpoint. Returns one of the following values:

deleteRequested boolean

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

errorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

interfaceEndpointId string

Unique identifier of the interface endpoint you created in your VPC with the AWS resource.

privateLinkId string

Unique identifier of the AWS PrivateLink connection which is created by mongodbatlas.PrivateEndpoint resource.

projectId string

Unique identifier for the project.

connection_status str

Status of the interface endpoint. Returns one of the following values:

delete_requested bool

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

error_message str

Error message pertaining to the interface endpoint. Returns null if there are no errors.

interface_endpoint_id str

Unique identifier of the interface endpoint you created in your VPC with the AWS resource.

private_link_id str

Unique identifier of the AWS PrivateLink connection which is created by mongodbatlas.PrivateEndpoint resource.

project_id str

Unique identifier for the project.

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.