1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getStreamPrivatelinkEndpoint
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.getStreamPrivatelinkEndpoint

Explore with Pulumi AI

# Data Source: mongodbatlas.StreamPrivatelinkEndpoint

mongodbatlas.StreamPrivatelinkEndpoint describes a Privatelink Endpoint for Streams.

Example Usage

S

Using getStreamPrivatelinkEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getStreamPrivatelinkEndpoint(args: GetStreamPrivatelinkEndpointArgs, opts?: InvokeOptions): Promise<GetStreamPrivatelinkEndpointResult>
function getStreamPrivatelinkEndpointOutput(args: GetStreamPrivatelinkEndpointOutputArgs, opts?: InvokeOptions): Output<GetStreamPrivatelinkEndpointResult>
Copy
def get_stream_privatelink_endpoint(id: Optional[str] = None,
                                    project_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetStreamPrivatelinkEndpointResult
def get_stream_privatelink_endpoint_output(id: Optional[pulumi.Input[str]] = None,
                                    project_id: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetStreamPrivatelinkEndpointResult]
Copy
func LookupStreamPrivatelinkEndpoint(ctx *Context, args *LookupStreamPrivatelinkEndpointArgs, opts ...InvokeOption) (*LookupStreamPrivatelinkEndpointResult, error)
func LookupStreamPrivatelinkEndpointOutput(ctx *Context, args *LookupStreamPrivatelinkEndpointOutputArgs, opts ...InvokeOption) LookupStreamPrivatelinkEndpointResultOutput
Copy

> Note: This function is named LookupStreamPrivatelinkEndpoint in the Go SDK.

public static class GetStreamPrivatelinkEndpoint 
{
    public static Task<GetStreamPrivatelinkEndpointResult> InvokeAsync(GetStreamPrivatelinkEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamPrivatelinkEndpointResult> Invoke(GetStreamPrivatelinkEndpointInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetStreamPrivatelinkEndpointResult> getStreamPrivatelinkEndpoint(GetStreamPrivatelinkEndpointArgs args, InvokeOptions options)
public static Output<GetStreamPrivatelinkEndpointResult> getStreamPrivatelinkEndpoint(GetStreamPrivatelinkEndpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getStreamPrivatelinkEndpoint:getStreamPrivatelinkEndpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The ID of the Private Link connection.
ProjectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
Id This property is required. string
The ID of the Private Link connection.
ProjectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
id This property is required. String
The ID of the Private Link connection.
projectId This property is required. String
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
id This property is required. string
The ID of the Private Link connection.
projectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
id This property is required. str
The ID of the Private Link connection.
project_id This property is required. str
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
id This property is required. String
The ID of the Private Link connection.
projectId This property is required. String
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

getStreamPrivatelinkEndpoint Result

The following output properties are available:

Arn string
DnsDomain string
DnsSubDomains List<string>
ErrorMessage string
Id string
The ID of the Private Link connection.
InterfaceEndpointId string
InterfaceEndpointName string
ProjectId string
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
ProviderAccountId string
ProviderName string
Region string
ServiceEndpointId string
State string
Vendor string
Arn string
DnsDomain string
DnsSubDomains []string
ErrorMessage string
Id string
The ID of the Private Link connection.
InterfaceEndpointId string
InterfaceEndpointName string
ProjectId string
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
ProviderAccountId string
ProviderName string
Region string
ServiceEndpointId string
State string
Vendor string
arn String
dnsDomain String
dnsSubDomains List<String>
errorMessage String
id String
The ID of the Private Link connection.
interfaceEndpointId String
interfaceEndpointName String
projectId String
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
providerAccountId String
providerName String
region String
serviceEndpointId String
state String
vendor String
arn string
dnsDomain string
dnsSubDomains string[]
errorMessage string
id string
The ID of the Private Link connection.
interfaceEndpointId string
interfaceEndpointName string
projectId string
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
providerAccountId string
providerName string
region string
serviceEndpointId string
state string
vendor string
arn str
dns_domain str
dns_sub_domains Sequence[str]
error_message str
id str
The ID of the Private Link connection.
interface_endpoint_id str
interface_endpoint_name str
project_id str
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
provider_account_id str
provider_name str
region str
service_endpoint_id str
state str
vendor str
arn String
dnsDomain String
dnsSubDomains List<String>
errorMessage String
id String
The ID of the Private Link connection.
interfaceEndpointId String
interfaceEndpointName String
projectId String
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
providerAccountId String
providerName String
region String
serviceEndpointId String
state String
vendor String

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.