Class PrivateEndpoint

mongodbatlas..PrivateEndpoint provides a Private Endpoint resource. This represents a Private Endpoint Connection that can be created 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 Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
public MyStack()
{
    var test = new Mongodbatlas.PrivateEndpoint("test", new Mongodbatlas.PrivateEndpointArgs
    {
        ProjectId = "<PROJECT-ID>",
        ProviderName = "AWS",
        Region = "us-east-1",
    });
}

}
Inheritance
System.Object
Resource
CustomResource
PrivateEndpoint
Inherited Members
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 PrivateEndpoint : CustomResource

Constructors

View Source

PrivateEndpoint(String, PrivateEndpointArgs, CustomResourceOptions)

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

Declaration
public PrivateEndpoint(string name, PrivateEndpointArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
PrivateEndpointArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

EndpointServiceName

Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.

Declaration
public Output<string> EndpointServiceName { get; }
Property Value
Type Description
Output<System.String>
View Source

ErrorMessage

Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.

Declaration
public Output<string> ErrorMessage { get; }
Property Value
Type Description
Output<System.String>
View Source

InterfaceEndpoints

Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.

Declaration
public Output<ImmutableArray<string>> InterfaceEndpoints { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

PrivateLinkId

Unique identifier of the AWS PrivateLink connection.

Declaration
public Output<string> PrivateLinkId { get; }
Property Value
Type Description
Output<System.String>
View Source

ProjectId

Required Unique identifier for the project.

Declaration
public Output<string> ProjectId { get; }
Property Value
Type Description
Output<System.String>
View Source

ProviderName

Declaration
public Output<string> ProviderName { get; }
Property Value
Type Description
Output<System.String>
View Source

Region

Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • ca-central-1
  • sa-east-1
  • eu-north-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • me-south-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-east-1
Declaration
public Output<string> Region { get; }
Property Value
Type Description
Output<System.String>
View Source

Status

Status of the AWS PrivateLink connection. Returns one of the following values:

Declaration
public Output<string> Status { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

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

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

Declaration
public static PrivateEndpoint Get(string name, Input<string> id, PrivateEndpointState 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.
PrivateEndpointState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
PrivateEndpoint