mongodbatlas.PrivateLinkEndpointService
Explore with Pulumi AI
mongodbatlas.PrivateLinkEndpointService
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.
NOTE: Create and delete wait for all clusters on the project to IDLE in order for their operations to complete. This ensures the latest connection strings can be retrieved following creation or deletion of this resource. Default timeout is 2hrs.
Example with AWS
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const testPrivateLinkEndpoint = new mongodbatlas.PrivateLinkEndpoint("testPrivateLinkEndpoint", {
projectId: "<PROJECT_ID>",
providerName: "AWS",
region: "US_EAST_1",
});
const ptfeService = new aws.ec2.VpcEndpoint("ptfeService", {
vpcId: "vpc-7fc0a543",
serviceName: testPrivateLinkEndpoint.endpointServiceName,
vpcEndpointType: "Interface",
subnetIds: ["subnet-de0406d2"],
securityGroupIds: ["sg-3f238186"],
});
const testPrivateLinkEndpointService = new mongodbatlas.PrivateLinkEndpointService("testPrivateLinkEndpointService", {
projectId: testPrivateLinkEndpoint.projectId,
privateLinkId: testPrivateLinkEndpoint.privateLinkId,
endpointServiceId: ptfeService.id,
providerName: "AWS",
});
import pulumi
import pulumi_aws as aws
import pulumi_mongodbatlas as mongodbatlas
test_private_link_endpoint = mongodbatlas.PrivateLinkEndpoint("testPrivateLinkEndpoint",
project_id="<PROJECT_ID>",
provider_name="AWS",
region="US_EAST_1")
ptfe_service = aws.ec2.VpcEndpoint("ptfeService",
vpc_id="vpc-7fc0a543",
service_name=test_private_link_endpoint.endpoint_service_name,
vpc_endpoint_type="Interface",
subnet_ids=["subnet-de0406d2"],
security_group_ids=["sg-3f238186"])
test_private_link_endpoint_service = mongodbatlas.PrivateLinkEndpointService("testPrivateLinkEndpointService",
project_id=test_private_link_endpoint.project_id,
private_link_id=test_private_link_endpoint.private_link_id,
endpoint_service_id=ptfe_service.id,
provider_name="AWS")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2"
"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
testPrivateLinkEndpoint, err := mongodbatlas.NewPrivateLinkEndpoint(ctx, "testPrivateLinkEndpoint", &mongodbatlas.PrivateLinkEndpointArgs{
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{
VpcId: pulumi.String("vpc-7fc0a543"),
ServiceName: testPrivateLinkEndpoint.EndpointServiceName,
VpcEndpointType: pulumi.String("Interface"),
SubnetIds: pulumi.StringArray{
pulumi.String("subnet-de0406d2"),
},
SecurityGroupIds: pulumi.StringArray{
pulumi.String("sg-3f238186"),
},
})
if err != nil {
return err
}
_, err = mongodbatlas.NewPrivateLinkEndpointService(ctx, "testPrivateLinkEndpointService", &mongodbatlas.PrivateLinkEndpointServiceArgs{
ProjectId: testPrivateLinkEndpoint.ProjectId,
PrivateLinkId: testPrivateLinkEndpoint.PrivateLinkId,
EndpointServiceId: ptfeService.ID(),
ProviderName: pulumi.String("AWS"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var testPrivateLinkEndpoint = new Mongodbatlas.PrivateLinkEndpoint("testPrivateLinkEndpoint", new()
{
ProjectId = "<PROJECT_ID>",
ProviderName = "AWS",
Region = "US_EAST_1",
});
var ptfeService = new Aws.Ec2.VpcEndpoint("ptfeService", new()
{
VpcId = "vpc-7fc0a543",
ServiceName = testPrivateLinkEndpoint.EndpointServiceName,
VpcEndpointType = "Interface",
SubnetIds = new[]
{
"subnet-de0406d2",
},
SecurityGroupIds = new[]
{
"sg-3f238186",
},
});
var testPrivateLinkEndpointService = new Mongodbatlas.PrivateLinkEndpointService("testPrivateLinkEndpointService", new()
{
ProjectId = testPrivateLinkEndpoint.ProjectId,
PrivateLinkId = testPrivateLinkEndpoint.PrivateLinkId,
EndpointServiceId = ptfeService.Id,
ProviderName = "AWS",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.PrivateLinkEndpoint;
import com.pulumi.mongodbatlas.PrivateLinkEndpointArgs;
import com.pulumi.aws.ec2.VpcEndpoint;
import com.pulumi.aws.ec2.VpcEndpointArgs;
import com.pulumi.mongodbatlas.PrivateLinkEndpointService;
import com.pulumi.mongodbatlas.PrivateLinkEndpointServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testPrivateLinkEndpoint = new PrivateLinkEndpoint("testPrivateLinkEndpoint", PrivateLinkEndpointArgs.builder()
.projectId("<PROJECT_ID>")
.providerName("AWS")
.region("US_EAST_1")
.build());
var ptfeService = new VpcEndpoint("ptfeService", VpcEndpointArgs.builder()
.vpcId("vpc-7fc0a543")
.serviceName(testPrivateLinkEndpoint.endpointServiceName())
.vpcEndpointType("Interface")
.subnetIds("subnet-de0406d2")
.securityGroupIds("sg-3f238186")
.build());
var testPrivateLinkEndpointService = new PrivateLinkEndpointService("testPrivateLinkEndpointService", PrivateLinkEndpointServiceArgs.builder()
.projectId(testPrivateLinkEndpoint.projectId())
.privateLinkId(testPrivateLinkEndpoint.privateLinkId())
.endpointServiceId(ptfeService.id())
.providerName("AWS")
.build());
}
}
resources:
testPrivateLinkEndpoint:
type: mongodbatlas:PrivateLinkEndpoint
properties:
projectId: <PROJECT_ID>
providerName: AWS
region: US_EAST_1
ptfeService:
type: aws:ec2:VpcEndpoint
properties:
vpcId: vpc-7fc0a543
serviceName: ${testPrivateLinkEndpoint.endpointServiceName}
vpcEndpointType: Interface
subnetIds:
- subnet-de0406d2
securityGroupIds:
- sg-3f238186
testPrivateLinkEndpointService:
type: mongodbatlas:PrivateLinkEndpointService
properties:
projectId: ${testPrivateLinkEndpoint.projectId}
privateLinkId: ${testPrivateLinkEndpoint.privateLinkId}
endpointServiceId: ${ptfeService.id}
providerName: AWS
Example with Azure
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const testPrivateLinkEndpoint = new mongodbatlas.PrivateLinkEndpoint("testPrivateLinkEndpoint", {
projectId: _var.project_id,
providerName: "AZURE",
region: "eastus2",
});
const testEndpoint = new azure.privatelink.Endpoint("testEndpoint", {
location: data.azurerm_resource_group.test.location,
resourceGroupName: _var.resource_group_name,
subnetId: azurerm_subnet.test.id,
privateServiceConnection: {
name: testPrivateLinkEndpoint.privateLinkServiceName,
privateConnectionResourceId: testPrivateLinkEndpoint.privateLinkServiceResourceId,
isManualConnection: true,
requestMessage: "Azure Private Link test",
},
});
const testPrivateLinkEndpointService = new mongodbatlas.PrivateLinkEndpointService("testPrivateLinkEndpointService", {
projectId: testPrivateLinkEndpoint.projectId,
privateLinkId: testPrivateLinkEndpoint.privateLinkId,
endpointServiceId: testEndpoint.id,
privateEndpointIpAddress: testEndpoint.privateServiceConnection.apply(privateServiceConnection => privateServiceConnection.privateIpAddress),
providerName: "AZURE",
});
import pulumi
import pulumi_azure as azure
import pulumi_mongodbatlas as mongodbatlas
test_private_link_endpoint = mongodbatlas.PrivateLinkEndpoint("testPrivateLinkEndpoint",
project_id=var["project_id"],
provider_name="AZURE",
region="eastus2")
test_endpoint = azure.privatelink.Endpoint("testEndpoint",
location=data["azurerm_resource_group"]["test"]["location"],
resource_group_name=var["resource_group_name"],
subnet_id=azurerm_subnet["test"]["id"],
private_service_connection=azure.privatelink.EndpointPrivateServiceConnectionArgs(
name=test_private_link_endpoint.private_link_service_name,
private_connection_resource_id=test_private_link_endpoint.private_link_service_resource_id,
is_manual_connection=True,
request_message="Azure Private Link test",
))
test_private_link_endpoint_service = mongodbatlas.PrivateLinkEndpointService("testPrivateLinkEndpointService",
project_id=test_private_link_endpoint.project_id,
private_link_id=test_private_link_endpoint.private_link_id,
endpoint_service_id=test_endpoint.id,
private_endpoint_ip_address=test_endpoint.private_service_connection.private_ip_address,
provider_name="AZURE")
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/privatelink"
"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
testPrivateLinkEndpoint, err := mongodbatlas.NewPrivateLinkEndpoint(ctx, "testPrivateLinkEndpoint", &mongodbatlas.PrivateLinkEndpointArgs{
ProjectId: pulumi.Any(_var.Project_id),
ProviderName: pulumi.String("AZURE"),
Region: pulumi.String("eastus2"),
})
if err != nil {
return err
}
testEndpoint, err := privatelink.NewEndpoint(ctx, "testEndpoint", &privatelink.EndpointArgs{
Location: pulumi.Any(data.Azurerm_resource_group.Test.Location),
ResourceGroupName: pulumi.Any(_var.Resource_group_name),
SubnetId: pulumi.Any(azurerm_subnet.Test.Id),
PrivateServiceConnection: &privatelink.EndpointPrivateServiceConnectionArgs{
Name: testPrivateLinkEndpoint.PrivateLinkServiceName,
PrivateConnectionResourceId: testPrivateLinkEndpoint.PrivateLinkServiceResourceId,
IsManualConnection: pulumi.Bool(true),
RequestMessage: pulumi.String("Azure Private Link test"),
},
})
if err != nil {
return err
}
_, err = mongodbatlas.NewPrivateLinkEndpointService(ctx, "testPrivateLinkEndpointService", &mongodbatlas.PrivateLinkEndpointServiceArgs{
ProjectId: testPrivateLinkEndpoint.ProjectId,
PrivateLinkId: testPrivateLinkEndpoint.PrivateLinkId,
EndpointServiceId: testEndpoint.ID(),
PrivateEndpointIpAddress: testEndpoint.PrivateServiceConnection.ApplyT(func(privateServiceConnection privatelink.EndpointPrivateServiceConnection) (*string, error) {
return &privateServiceConnection.PrivateIpAddress, nil
}).(pulumi.StringPtrOutput),
ProviderName: pulumi.String("AZURE"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var testPrivateLinkEndpoint = new Mongodbatlas.PrivateLinkEndpoint("testPrivateLinkEndpoint", new()
{
ProjectId = @var.Project_id,
ProviderName = "AZURE",
Region = "eastus2",
});
var testEndpoint = new Azure.PrivateLink.Endpoint("testEndpoint", new()
{
Location = data.Azurerm_resource_group.Test.Location,
ResourceGroupName = @var.Resource_group_name,
SubnetId = azurerm_subnet.Test.Id,
PrivateServiceConnection = new Azure.PrivateLink.Inputs.EndpointPrivateServiceConnectionArgs
{
Name = testPrivateLinkEndpoint.PrivateLinkServiceName,
PrivateConnectionResourceId = testPrivateLinkEndpoint.PrivateLinkServiceResourceId,
IsManualConnection = true,
RequestMessage = "Azure Private Link test",
},
});
var testPrivateLinkEndpointService = new Mongodbatlas.PrivateLinkEndpointService("testPrivateLinkEndpointService", new()
{
ProjectId = testPrivateLinkEndpoint.ProjectId,
PrivateLinkId = testPrivateLinkEndpoint.PrivateLinkId,
EndpointServiceId = testEndpoint.Id,
PrivateEndpointIpAddress = testEndpoint.PrivateServiceConnection.Apply(privateServiceConnection => privateServiceConnection.PrivateIpAddress),
ProviderName = "AZURE",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.PrivateLinkEndpoint;
import com.pulumi.mongodbatlas.PrivateLinkEndpointArgs;
import com.pulumi.azure.privatelink.Endpoint;
import com.pulumi.azure.privatelink.EndpointArgs;
import com.pulumi.azure.privatelink.inputs.EndpointPrivateServiceConnectionArgs;
import com.pulumi.mongodbatlas.PrivateLinkEndpointService;
import com.pulumi.mongodbatlas.PrivateLinkEndpointServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testPrivateLinkEndpoint = new PrivateLinkEndpoint("testPrivateLinkEndpoint", PrivateLinkEndpointArgs.builder()
.projectId(var_.project_id())
.providerName("AZURE")
.region("eastus2")
.build());
var testEndpoint = new Endpoint("testEndpoint", EndpointArgs.builder()
.location(data.azurerm_resource_group().test().location())
.resourceGroupName(var_.resource_group_name())
.subnetId(azurerm_subnet.test().id())
.privateServiceConnection(EndpointPrivateServiceConnectionArgs.builder()
.name(testPrivateLinkEndpoint.privateLinkServiceName())
.privateConnectionResourceId(testPrivateLinkEndpoint.privateLinkServiceResourceId())
.isManualConnection(true)
.requestMessage("Azure Private Link test")
.build())
.build());
var testPrivateLinkEndpointService = new PrivateLinkEndpointService("testPrivateLinkEndpointService", PrivateLinkEndpointServiceArgs.builder()
.projectId(testPrivateLinkEndpoint.projectId())
.privateLinkId(testPrivateLinkEndpoint.privateLinkId())
.endpointServiceId(testEndpoint.id())
.privateEndpointIpAddress(testEndpoint.privateServiceConnection().applyValue(privateServiceConnection -> privateServiceConnection.privateIpAddress()))
.providerName("AZURE")
.build());
}
}
resources:
testPrivateLinkEndpoint:
type: mongodbatlas:PrivateLinkEndpoint
properties:
projectId: ${var.project_id}
providerName: AZURE
region: eastus2
testEndpoint:
type: azure:privatelink:Endpoint
properties:
location: ${data.azurerm_resource_group.test.location}
resourceGroupName: ${var.resource_group_name}
subnetId: ${azurerm_subnet.test.id}
privateServiceConnection:
name: ${testPrivateLinkEndpoint.privateLinkServiceName}
privateConnectionResourceId: ${testPrivateLinkEndpoint.privateLinkServiceResourceId}
isManualConnection: true
requestMessage: Azure Private Link test
testPrivateLinkEndpointService:
type: mongodbatlas:PrivateLinkEndpointService
properties:
projectId: ${testPrivateLinkEndpoint.projectId}
privateLinkId: ${testPrivateLinkEndpoint.privateLinkId}
endpointServiceId: ${testEndpoint.id}
privateEndpointIpAddress: ${testEndpoint.privateServiceConnection.privateIpAddress}
providerName: AZURE
Example with GCP
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.PrivateLinkEndpoint;
import com.pulumi.mongodbatlas.PrivateLinkEndpointArgs;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.Subnetwork;
import com.pulumi.gcp.compute.SubnetworkArgs;
import com.pulumi.gcp.compute.Address;
import com.pulumi.gcp.compute.AddressArgs;
import com.pulumi.gcp.compute.ForwardingRule;
import com.pulumi.gcp.compute.ForwardingRuleArgs;
import com.pulumi.mongodbatlas.PrivateLinkEndpointService;
import com.pulumi.mongodbatlas.PrivateLinkEndpointServiceArgs;
import com.pulumi.codegen.internal.KeyedValue;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testPrivateLinkEndpoint = new PrivateLinkEndpoint("testPrivateLinkEndpoint", PrivateLinkEndpointArgs.builder()
.projectId(var_.project_id())
.providerName("GCP")
.region(var_.gcp_region())
.build());
// Create a Google Network
var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.project(var_.gcp_project())
.build());
// Create a Google Sub Network
var defaultSubnetwork = new Subnetwork("defaultSubnetwork", SubnetworkArgs.builder()
.project(defaultNetwork.project())
.ipCidrRange("10.0.0.0/16")
.region(var_.gcp_region())
.network(defaultNetwork.id())
.build());
// Create Google 50 Addresses
for (var i = 0; i < 50; i++) {
new Address("defaultAddress-" + i, AddressArgs.builder()
.project(defaultSubnetwork.project())
.subnetwork(defaultSubnetwork.id())
.addressType("INTERNAL")
.address(String.format("10.0.42.%s", range.value()))
.region(var_.gcp_region())
.build(), CustomResourceOptions.builder()
.dependsOn(testPrivateLinkEndpoint)
.build());
}
// Create 50 Forwarding rules
for (var i = 0; i < 50; i++) {
new ForwardingRule("defaultForwardingRule-" + i, ForwardingRuleArgs.builder()
.target(testPrivateLinkEndpoint.serviceAttachmentNames().applyValue(serviceAttachmentNames -> serviceAttachmentNames[range.value()]))
.project(defaultAddress[range.value()].project())
.region(defaultAddress[range.value()].region())
.ipAddress(defaultAddress[range.value()].id())
.network(defaultNetwork.id())
.loadBalancingScheme("")
.build());
}
var testPrivateLinkEndpointService = new PrivateLinkEndpointService("testPrivateLinkEndpointService", PrivateLinkEndpointServiceArgs.builder()
.projectId(testPrivateLinkEndpoint.projectId())
.privateLinkId(testPrivateLinkEndpoint.privateLinkId())
.providerName("GCP")
.endpointServiceId(defaultNetwork.name())
.gcpProjectId(var_.gcp_project())
.dynamic(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build(), CustomResourceOptions.builder()
.dependsOn(defaultForwardingRule)
.build());
}
}
Coming soon!
Available complete examples
- Setup private connection to a MongoDB Atlas Cluster with AWS VPC
Create PrivateLinkEndpointService Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PrivateLinkEndpointService(name: string, args: PrivateLinkEndpointServiceArgs, opts?: CustomResourceOptions);
@overload
def PrivateLinkEndpointService(resource_name: str,
args: PrivateLinkEndpointServiceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PrivateLinkEndpointService(resource_name: str,
opts: Optional[ResourceOptions] = None,
endpoint_service_id: Optional[str] = None,
private_link_id: Optional[str] = None,
project_id: Optional[str] = None,
provider_name: Optional[str] = None,
endpoints: Optional[Sequence[PrivateLinkEndpointServiceEndpointArgs]] = None,
gcp_project_id: Optional[str] = None,
private_endpoint_ip_address: Optional[str] = None)
func NewPrivateLinkEndpointService(ctx *Context, name string, args PrivateLinkEndpointServiceArgs, opts ...ResourceOption) (*PrivateLinkEndpointService, error)
public PrivateLinkEndpointService(string name, PrivateLinkEndpointServiceArgs args, CustomResourceOptions? opts = null)
public PrivateLinkEndpointService(String name, PrivateLinkEndpointServiceArgs args)
public PrivateLinkEndpointService(String name, PrivateLinkEndpointServiceArgs args, CustomResourceOptions options)
type: mongodbatlas:PrivateLinkEndpointService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PrivateLinkEndpointServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PrivateLinkEndpointServiceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PrivateLinkEndpointServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivateLinkEndpointServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PrivateLinkEndpointServiceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var privateLinkEndpointServiceResource = new Mongodbatlas.PrivateLinkEndpointService("privateLinkEndpointServiceResource", new()
{
EndpointServiceId = "string",
PrivateLinkId = "string",
ProjectId = "string",
ProviderName = "string",
Endpoints = new[]
{
new Mongodbatlas.Inputs.PrivateLinkEndpointServiceEndpointArgs
{
EndpointName = "string",
IpAddress = "string",
ServiceAttachmentName = "string",
Status = "string",
},
},
GcpProjectId = "string",
PrivateEndpointIpAddress = "string",
});
example, err := mongodbatlas.NewPrivateLinkEndpointService(ctx, "privateLinkEndpointServiceResource", &mongodbatlas.PrivateLinkEndpointServiceArgs{
EndpointServiceId: pulumi.String("string"),
PrivateLinkId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
ProviderName: pulumi.String("string"),
Endpoints: mongodbatlas.PrivateLinkEndpointServiceEndpointArray{
&mongodbatlas.PrivateLinkEndpointServiceEndpointArgs{
EndpointName: pulumi.String("string"),
IpAddress: pulumi.String("string"),
ServiceAttachmentName: pulumi.String("string"),
Status: pulumi.String("string"),
},
},
GcpProjectId: pulumi.String("string"),
PrivateEndpointIpAddress: pulumi.String("string"),
})
var privateLinkEndpointServiceResource = new PrivateLinkEndpointService("privateLinkEndpointServiceResource", PrivateLinkEndpointServiceArgs.builder()
.endpointServiceId("string")
.privateLinkId("string")
.projectId("string")
.providerName("string")
.endpoints(PrivateLinkEndpointServiceEndpointArgs.builder()
.endpointName("string")
.ipAddress("string")
.serviceAttachmentName("string")
.status("string")
.build())
.gcpProjectId("string")
.privateEndpointIpAddress("string")
.build());
private_link_endpoint_service_resource = mongodbatlas.PrivateLinkEndpointService("privateLinkEndpointServiceResource",
endpoint_service_id="string",
private_link_id="string",
project_id="string",
provider_name="string",
endpoints=[mongodbatlas.PrivateLinkEndpointServiceEndpointArgs(
endpoint_name="string",
ip_address="string",
service_attachment_name="string",
status="string",
)],
gcp_project_id="string",
private_endpoint_ip_address="string")
const privateLinkEndpointServiceResource = new mongodbatlas.PrivateLinkEndpointService("privateLinkEndpointServiceResource", {
endpointServiceId: "string",
privateLinkId: "string",
projectId: "string",
providerName: "string",
endpoints: [{
endpointName: "string",
ipAddress: "string",
serviceAttachmentName: "string",
status: "string",
}],
gcpProjectId: "string",
privateEndpointIpAddress: "string",
});
type: mongodbatlas:PrivateLinkEndpointService
properties:
endpointServiceId: string
endpoints:
- endpointName: string
ipAddress: string
serviceAttachmentName: string
status: string
gcpProjectId: string
privateEndpointIpAddress: string
privateLinkId: string
projectId: string
providerName: string
PrivateLinkEndpointService Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The PrivateLinkEndpointService resource accepts the following input properties:
- Endpoint
Service stringId - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - Private
Link stringId - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - Project
Id string - Unique identifier for the project.
- Provider
Name string - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
. - Endpoints
List<Private
Link Endpoint Service Endpoint> - Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - Gcp
Project stringId - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - Private
Endpoint stringIp Address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
- Endpoint
Service stringId - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - Private
Link stringId - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - Project
Id string - Unique identifier for the project.
- Provider
Name string - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
. - Endpoints
[]Private
Link Endpoint Service Endpoint Args - Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - Gcp
Project stringId - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - Private
Endpoint stringIp Address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
- endpoint
Service StringId - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - private
Link StringId - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - project
Id String - Unique identifier for the project.
- provider
Name String - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
. - endpoints
List<Private
Link Endpoint Service Endpoint> - Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - gcp
Project StringId - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - private
Endpoint StringIp Address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
- endpoint
Service stringId - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - private
Link stringId - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - project
Id string - Unique identifier for the project.
- provider
Name string - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
. - endpoints
Private
Link Endpoint Service Endpoint[] - Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - gcp
Project stringId - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - private
Endpoint stringIp Address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
- endpoint_
service_ strid - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - private_
link_ strid - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - project_
id str - Unique identifier for the project.
- provider_
name str - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
. - endpoints
Sequence[Private
Link Endpoint Service Endpoint Args] - Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - gcp_
project_ strid - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - private_
endpoint_ strip_ address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
- endpoint
Service StringId - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - private
Link StringId - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - project
Id String - Unique identifier for the project.
- provider
Name String - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
. - endpoints List<Property Map>
- Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - gcp
Project StringId - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - private
Endpoint StringIp Address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
.
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivateLinkEndpointService resource produces the following output properties:
- Aws
Connection stringStatus - Status of the interface endpoint for AWS. Returns one of the following values:
- Azure
Status string - Status of the interface endpoint for AZURE. 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.
- Endpoint
Group stringName - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- Error
Message string - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- Gcp
Status string - Status of the interface endpoint for GCP. Returns one of the following values:
- Id string
- The provider-assigned unique ID for this managed resource.
- Interface
Endpoint stringId - Unique identifier of the interface endpoint.
- Private
Endpoint stringConnection Name - Name of the connection for this private endpoint that Atlas generates.
- Private
Endpoint stringResource Id - Unique identifier of the private endpoint.
- Aws
Connection stringStatus - Status of the interface endpoint for AWS. Returns one of the following values:
- Azure
Status string - Status of the interface endpoint for AZURE. 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.
- Endpoint
Group stringName - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- Error
Message string - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- Gcp
Status string - Status of the interface endpoint for GCP. Returns one of the following values:
- Id string
- The provider-assigned unique ID for this managed resource.
- Interface
Endpoint stringId - Unique identifier of the interface endpoint.
- Private
Endpoint stringConnection Name - Name of the connection for this private endpoint that Atlas generates.
- Private
Endpoint stringResource Id - Unique identifier of the private endpoint.
- aws
Connection StringStatus - Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status String - Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested Boolean - Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group StringName - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- error
Message String - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Status String - Status of the interface endpoint for GCP. Returns one of the following values:
- id String
- The provider-assigned unique ID for this managed resource.
- interface
Endpoint StringId - Unique identifier of the interface endpoint.
- private
Endpoint StringConnection Name - Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint StringResource Id - Unique identifier of the private endpoint.
- aws
Connection stringStatus - Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status string - Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested boolean - Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group stringName - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- error
Message string - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Status string - Status of the interface endpoint for GCP. Returns one of the following values:
- id string
- The provider-assigned unique ID for this managed resource.
- interface
Endpoint stringId - Unique identifier of the interface endpoint.
- private
Endpoint stringConnection Name - Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint stringResource Id - Unique identifier of the private endpoint.
- aws_
connection_ strstatus - Status of the interface endpoint for AWS. Returns one of the following values:
- azure_
status str - Status of the interface endpoint for AZURE. 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.
- endpoint_
group_ strname - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- error_
message str - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp_
status str - Status of the interface endpoint for GCP. Returns one of the following values:
- id str
- The provider-assigned unique ID for this managed resource.
- interface_
endpoint_ strid - Unique identifier of the interface endpoint.
- private_
endpoint_ strconnection_ name - Name of the connection for this private endpoint that Atlas generates.
- private_
endpoint_ strresource_ id - Unique identifier of the private endpoint.
- aws
Connection StringStatus - Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status String - Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested Boolean - Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group StringName - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- error
Message String - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Status String - Status of the interface endpoint for GCP. Returns one of the following values:
- id String
- The provider-assigned unique ID for this managed resource.
- interface
Endpoint StringId - Unique identifier of the interface endpoint.
- private
Endpoint StringConnection Name - Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint StringResource Id - Unique identifier of the private endpoint.
Look up Existing PrivateLinkEndpointService Resource
Get an existing PrivateLinkEndpointService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PrivateLinkEndpointServiceState, opts?: CustomResourceOptions): PrivateLinkEndpointService
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aws_connection_status: Optional[str] = None,
azure_status: Optional[str] = None,
delete_requested: Optional[bool] = None,
endpoint_group_name: Optional[str] = None,
endpoint_service_id: Optional[str] = None,
endpoints: Optional[Sequence[PrivateLinkEndpointServiceEndpointArgs]] = None,
error_message: Optional[str] = None,
gcp_project_id: Optional[str] = None,
gcp_status: Optional[str] = None,
interface_endpoint_id: Optional[str] = None,
private_endpoint_connection_name: Optional[str] = None,
private_endpoint_ip_address: Optional[str] = None,
private_endpoint_resource_id: Optional[str] = None,
private_link_id: Optional[str] = None,
project_id: Optional[str] = None,
provider_name: Optional[str] = None) -> PrivateLinkEndpointService
func GetPrivateLinkEndpointService(ctx *Context, name string, id IDInput, state *PrivateLinkEndpointServiceState, opts ...ResourceOption) (*PrivateLinkEndpointService, error)
public static PrivateLinkEndpointService Get(string name, Input<string> id, PrivateLinkEndpointServiceState? state, CustomResourceOptions? opts = null)
public static PrivateLinkEndpointService get(String name, Output<String> id, PrivateLinkEndpointServiceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Aws
Connection stringStatus - Status of the interface endpoint for AWS. Returns one of the following values:
- Azure
Status string - Status of the interface endpoint for AZURE. 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.
- Endpoint
Group stringName - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- Endpoint
Service stringId - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - Endpoints
List<Private
Link Endpoint Service Endpoint> - Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - Error
Message string - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- Gcp
Project stringId - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - Gcp
Status string - Status of the interface endpoint for GCP. Returns one of the following values:
- Interface
Endpoint stringId - Unique identifier of the interface endpoint.
- Private
Endpoint stringConnection Name - Name of the connection for this private endpoint that Atlas generates.
- Private
Endpoint stringIp Address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
. - Private
Endpoint stringResource Id - Unique identifier of the private endpoint.
- Private
Link stringId - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - Project
Id string - Unique identifier for the project.
- Provider
Name string - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
- Aws
Connection stringStatus - Status of the interface endpoint for AWS. Returns one of the following values:
- Azure
Status string - Status of the interface endpoint for AZURE. 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.
- Endpoint
Group stringName - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- Endpoint
Service stringId - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - Endpoints
[]Private
Link Endpoint Service Endpoint Args - Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - Error
Message string - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- Gcp
Project stringId - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - Gcp
Status string - Status of the interface endpoint for GCP. Returns one of the following values:
- Interface
Endpoint stringId - Unique identifier of the interface endpoint.
- Private
Endpoint stringConnection Name - Name of the connection for this private endpoint that Atlas generates.
- Private
Endpoint stringIp Address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
. - Private
Endpoint stringResource Id - Unique identifier of the private endpoint.
- Private
Link stringId - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - Project
Id string - Unique identifier for the project.
- Provider
Name string - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
- aws
Connection StringStatus - Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status String - Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested Boolean - Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group StringName - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- endpoint
Service StringId - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - endpoints
List<Private
Link Endpoint Service Endpoint> - Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - error
Message String - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Project StringId - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - gcp
Status String - Status of the interface endpoint for GCP. Returns one of the following values:
- interface
Endpoint StringId - Unique identifier of the interface endpoint.
- private
Endpoint StringConnection Name - Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint StringIp Address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
. - private
Endpoint StringResource Id - Unique identifier of the private endpoint.
- private
Link StringId - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - project
Id String - Unique identifier for the project.
- provider
Name String - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
- aws
Connection stringStatus - Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status string - Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested boolean - Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group stringName - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- endpoint
Service stringId - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - endpoints
Private
Link Endpoint Service Endpoint[] - Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - error
Message string - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Project stringId - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - gcp
Status string - Status of the interface endpoint for GCP. Returns one of the following values:
- interface
Endpoint stringId - Unique identifier of the interface endpoint.
- private
Endpoint stringConnection Name - Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint stringIp Address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
. - private
Endpoint stringResource Id - Unique identifier of the private endpoint.
- private
Link stringId - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - project
Id string - Unique identifier for the project.
- provider
Name string - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
- aws_
connection_ strstatus - Status of the interface endpoint for AWS. Returns one of the following values:
- azure_
status str - Status of the interface endpoint for AZURE. 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.
- endpoint_
group_ strname - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- endpoint_
service_ strid - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - endpoints
Sequence[Private
Link Endpoint Service Endpoint Args] - Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - error_
message str - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp_
project_ strid - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - gcp_
status str - Status of the interface endpoint for GCP. Returns one of the following values:
- interface_
endpoint_ strid - Unique identifier of the interface endpoint.
- private_
endpoint_ strconnection_ name - Name of the connection for this private endpoint that Atlas generates.
- private_
endpoint_ strip_ address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
. - private_
endpoint_ strresource_ id - Unique identifier of the private endpoint.
- private_
link_ strid - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - project_
id str - Unique identifier for the project.
- provider_
name str - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
- aws
Connection StringStatus - Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status String - Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested Boolean - Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Group StringName - (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
- endpoint
Service StringId - Unique identifier of the interface endpoint you created in your VPC with the
AWS
,AZURE
orGCP
resource. - endpoints List<Property Map>
- Collection of individual private endpoints that comprise your endpoint group. Only for
GCP
. See below. - error
Message String - Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Project StringId - Unique identifier of the GCP project in which you created your endpoints. Only for
GCP
. - gcp
Status String - Status of the interface endpoint for GCP. Returns one of the following values:
- interface
Endpoint StringId - Unique identifier of the interface endpoint.
- private
Endpoint StringConnection Name - Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint StringIp Address - Private IP address of the private endpoint network interface you created in your Azure VNet. Only for
AZURE
. - private
Endpoint StringResource Id - Unique identifier of the private endpoint.
- private
Link StringId - Unique identifier of the
AWS
orAZURE
PrivateLink connection which is created bymongodbatlas.PrivateLinkEndpoint
resource. - project
Id String - Unique identifier for the project.
- provider
Name String - Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
,AZURE
orGCP
.
Supporting Types
PrivateLinkEndpointServiceEndpoint, PrivateLinkEndpointServiceEndpointArgs
- Endpoint
Name string - Forwarding rule that corresponds to the endpoint you created in GCP.
- Ip
Address string - Private IP address of the endpoint you created in GCP.
- Service
Attachment stringName - Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- Status string
- Status of the endpoint. Atlas returns one of the values shown above.
- Endpoint
Name string - Forwarding rule that corresponds to the endpoint you created in GCP.
- Ip
Address string - Private IP address of the endpoint you created in GCP.
- Service
Attachment stringName - Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- Status string
- Status of the endpoint. Atlas returns one of the values shown above.
- endpoint
Name String - Forwarding rule that corresponds to the endpoint you created in GCP.
- ip
Address String - Private IP address of the endpoint you created in GCP.
- service
Attachment StringName - Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- status String
- Status of the endpoint. Atlas returns one of the values shown above.
- endpoint
Name string - Forwarding rule that corresponds to the endpoint you created in GCP.
- ip
Address string - Private IP address of the endpoint you created in GCP.
- service
Attachment stringName - Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- status string
- Status of the endpoint. Atlas returns one of the values shown above.
- endpoint_
name str - Forwarding rule that corresponds to the endpoint you created in GCP.
- ip_
address str - Private IP address of the endpoint you created in GCP.
- service_
attachment_ strname - Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- status str
- Status of the endpoint. Atlas returns one of the values shown above.
- endpoint
Name String - Forwarding rule that corresponds to the endpoint you created in GCP.
- ip
Address String - Private IP address of the endpoint you created in GCP.
- service
Attachment StringName - Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.
- status String
- Status of the endpoint. Atlas returns one of the values shown above.
Import
Private Endpoint Link Connection can be imported using project ID and username, in the format {project_id}--{private_link_id}--{endpoint_service_id}--{provider_name}
, e.g.
$ pulumi import mongodbatlas:index/privateLinkEndpointService:PrivateLinkEndpointService test 1112222b3bf99403840e8934--3242342343112--vpce-4242342343--AWS
See detailed information for arguments and attributes: MongoDB API Private Endpoint Link Connection
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlas
Terraform Provider.