getPrivateLinkEndpointService
mongodbatlas.PrivateLinkEndpointService
describe a Private Endpoint Link. This represents a Private Endpoint Link Connection that wants to retrieve details in an Atlas project.
NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.
Example Usage
Coming soon!
Coming soon!
Coming soon!
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const testPrivateLinkEndpoint = new mongodbatlas.PrivateLinkEndpoint("test", {
projectId: "<PROJECT_ID>",
providerName: "AWS",
region: "us-east-1",
});
const ptfeService = new aws.ec2.VpcEndpoint("ptfe_service", {
securityGroupIds: ["sg-3f238186"],
serviceName: testPrivateLinkEndpoint.endpointServiceName,
subnetIds: ["subnet-de0406d2"],
vpcEndpointType: "Interface",
vpcId: "vpc-7fc0a543",
});
const testMongodbatlasPrivateLinkEndpointService = new mongodbatlas.PrivateLinkEndpointService("test", {
endpointServiceId: ptfeService.id,
privateLinkId: testPrivateLinkEndpoint.privateLinkId,
projectId: testPrivateLinkEndpoint.projectId,
providerName: "AWS",
});
const testPrivateLinkEndpointService = pulumi.all([testMongodbatlasPrivateLinkEndpointService.interfaceEndpointId, testMongodbatlasPrivateLinkEndpointService.privateLinkId, testMongodbatlasPrivateLinkEndpointService.projectId]).apply(([interfaceEndpointId, privateLinkId, projectId]) => mongodbatlas.getPrivateLinkEndpointService({
interfaceEndpointId: interfaceEndpointId,
privateLinkId: privateLinkId,
projectId: projectId,
}, { async: true }));
Using getPrivateLinkEndpointService
function getPrivateLinkEndpointService(args: GetPrivateLinkEndpointServiceArgs, opts?: InvokeOptions): Promise<GetPrivateLinkEndpointServiceResult>
def get_private_link_endpoint_service(endpoint_service_id: Optional[str] = None, private_link_id: Optional[str] = None, project_id: Optional[str] = None, provider_name: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetPrivateLinkEndpointServiceResult
func LookupPrivateLinkEndpointService(ctx *Context, args *LookupPrivateLinkEndpointServiceArgs, opts ...InvokeOption) (*LookupPrivateLinkEndpointServiceResult, error)
Note: This function is named
LookupPrivateLinkEndpointService
in the Go SDK.
public static class GetPrivateLinkEndpointService {
public static Task<GetPrivateLinkEndpointServiceResult> InvokeAsync(GetPrivateLinkEndpointServiceArgs args, InvokeOptions? opts = null)
}
The following arguments are supported:
- Endpoint
Service stringId Unique identifier of the
AWS
orAZURE
resource.- Private
Link stringId Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
- 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
orAZURE
.
- Endpoint
Service stringId Unique identifier of the
AWS
orAZURE
resource.- Private
Link stringId Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
- 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
orAZURE
.
- endpoint
Service stringId Unique identifier of the
AWS
orAZURE
resource.- private
Link stringId Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
- 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
orAZURE
.
- endpoint_
service_ strid Unique identifier of the
AWS
orAZURE
resource.- private_
link_ strid Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
- 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
orAZURE
.
getPrivateLinkEndpointService Result
The following output properties are available:
- 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
Service stringId - Error
Message 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.
- 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.
- Private
Endpoint stringResource Id Unique identifier of the private endpoint.
- Private
Link stringId - Project
Id string - Provider
Name string
- 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
Service stringId - Error
Message 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.
- 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.
- Private
Endpoint stringResource Id Unique identifier of the private endpoint.
- Private
Link stringId - Project
Id string - Provider
Name string
- 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
Service stringId - error
Message 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.
- 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.
- private
Endpoint stringResource Id Unique identifier of the private endpoint.
- private
Link stringId - project
Id string - provider
Name string
- 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_
service_ strid - 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.
- 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.
- private_
endpoint_ strresource_ id Unique identifier of the private endpoint.
- private_
link_ strid - project_
id str - provider_
name str
Package Details
- Repository
- https://github.com/pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlas
Terraform Provider.