Class 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,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

PrivateEndpointInterfaceLink

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Mongodbatlas

Assembly: Pulumi.Mongodbatlas.dll

Syntax

public class PrivateEndpointInterfaceLink : CustomResource

Constructors

PrivateEndpointInterfaceLink(String, PrivateEndpointInterfaceLinkArgs, CustomResourceOptions)

Create a PrivateEndpointInterfaceLink resource with the given unique name, arguments, and options.

Declaration

public PrivateEndpointInterfaceLink(string name, PrivateEndpointInterfaceLinkArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
PrivateEndpointInterfaceLinkArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ConnectionStatus

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

Declaration

public Output<string> ConnectionStatus { get; }

Property Value

Type	Description
Output<System.String>

DeleteRequested

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

Declaration

public Output<bool> DeleteRequested { get; }

Property Value

Type	Description
Output<System.Boolean>

ErrorMessage

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

Declaration

public Output<string> ErrorMessage { get; }

Property Value

Type	Description
Output<System.String>

InterfaceEndpointId

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

Declaration

public Output<string> InterfaceEndpointId { get; }

Property Value

Type	Description
Output<System.String>

PrivateLinkId

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

Declaration

public Output<string> PrivateLinkId { get; }

Property Value

Type	Description
Output<System.String>

ProjectId

Unique identifier for the project.

Declaration

public Output<string> ProjectId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, PrivateEndpointInterfaceLinkState, CustomResourceOptions)

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

Declaration

public static PrivateEndpointInterfaceLink Get(string name, Input<string> id, PrivateEndpointInterfaceLinkState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
PrivateEndpointInterfaceLinkState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
PrivateEndpointInterfaceLink