Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getStreamPrivatelinkEndpoints
MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getStreamPrivatelinkEndpoints

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

    # Data Source: mongodbatlas.getStreamPrivatelinkEndpoints

    mongodbatlas.getStreamPrivatelinkEndpoints describes a Privatelink Endpoint for Streams.

    Example Usage

    S

    Using getStreamPrivatelinkEndpoints

    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 getStreamPrivatelinkEndpoints(args: GetStreamPrivatelinkEndpointsArgs, opts?: InvokeOptions): Promise<GetStreamPrivatelinkEndpointsResult>
function getStreamPrivatelinkEndpointsOutput(args: GetStreamPrivatelinkEndpointsOutputArgs, opts?: InvokeOptions): Output<GetStreamPrivatelinkEndpointsResult>
    def get_stream_privatelink_endpoints(project_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetStreamPrivatelinkEndpointsResult
def get_stream_privatelink_endpoints_output(project_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetStreamPrivatelinkEndpointsResult]
    func LookupStreamPrivatelinkEndpoints(ctx *Context, args *LookupStreamPrivatelinkEndpointsArgs, opts ...InvokeOption) (*LookupStreamPrivatelinkEndpointsResult, error)
func LookupStreamPrivatelinkEndpointsOutput(ctx *Context, args *LookupStreamPrivatelinkEndpointsOutputArgs, opts ...InvokeOption) LookupStreamPrivatelinkEndpointsResultOutput

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

    public static class GetStreamPrivatelinkEndpoints 
{
    public static Task<GetStreamPrivatelinkEndpointsResult> InvokeAsync(GetStreamPrivatelinkEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamPrivatelinkEndpointsResult> Invoke(GetStreamPrivatelinkEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStreamPrivatelinkEndpointsResult> getStreamPrivatelinkEndpoints(GetStreamPrivatelinkEndpointsArgs args, InvokeOptions options)
public static Output<GetStreamPrivatelinkEndpointsResult> getStreamPrivatelinkEndpoints(GetStreamPrivatelinkEndpointsArgs args, InvokeOptions options)

    fn::invoke:
  function: mongodbatlas:index/getStreamPrivatelinkEndpoints:getStreamPrivatelinkEndpoints
  arguments:
    # arguments dictionary

    The following arguments are supported:

    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.

    getStreamPrivatelinkEndpoints Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    Results List<GetStreamPrivatelinkEndpointsResult>
    List of documents that MongoDB Cloud returns for this request.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    Results []GetStreamPrivatelinkEndpointsResult
    List of documents that MongoDB Cloud returns for this request.
    id String
    The provider-assigned unique ID for this managed resource.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    results List<GetStreamPrivatelinkEndpointsResult>
    List of documents that MongoDB Cloud returns for this request.
    id string
    The provider-assigned unique ID for this managed resource.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    results GetStreamPrivatelinkEndpointsResult[]
    List of documents that MongoDB Cloud returns for this request.
    id str
    The provider-assigned unique ID for this managed resource.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    results Sequence[GetStreamPrivatelinkEndpointsResult]
    List of documents that MongoDB Cloud returns for this request.
    id String
    The provider-assigned unique ID for this managed resource.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    results List<Property Map>
    List of documents that MongoDB Cloud returns for this request.

    Supporting Types

    GetStreamPrivatelinkEndpointsResult

    Arn string
    Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
    DnsDomain string
    The domain hostname. Required for the following provider and vendor combinations:\n\n- AWS provider with CONFLUENT vendor.\n\n- AZURE provider with EVENTHUB or CONFLUENT vendor.
    DnsSubDomains List<string>
    Sub-Domain name of Confluent cluster. These are typically your availability zones. Required for AWS Provider and CONFLUENT vendor. If your AWS CONFLUENT cluster doesn't use subdomains, you must set this to the empty array [].
    ErrorMessage string
    Error message if the connection is in a failed state.
    Id string
    The ID of the Private Link connection.
    InterfaceEndpointId string
    Interface endpoint ID that is created from the specified service endpoint ID.
    InterfaceEndpointName string
    Name of interface endpoint that is created from the specified service endpoint ID.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    ProviderAccountId string
    Account ID from the cloud provider.
    ProviderName string
    Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
    Region string
    The region of the Provider’s cluster. See AZURE and AWS supported regions. When the vendor is CONFLUENT, this is the domain name of Confluent cluster. When the vendor is MSK, this is computed by the API from the provided arn.
    ServiceEndpointId string
    For AZURE EVENTHUB, this is the namespace endpoint ID. For AWS CONFLUENT cluster, this is the VPC Endpoint service name.
    State string
    Status of the connection.
    Vendor string
    Vendor that manages the Kafka cluster. The following are the vendor values per provider:\n\n- MSK and CONFLUENT for the AWS provider.\n\n- EVENTHUB and CONFLUENT for the AZURE provider.
    Arn string
    Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
    DnsDomain string
    The domain hostname. Required for the following provider and vendor combinations:\n\n- AWS provider with CONFLUENT vendor.\n\n- AZURE provider with EVENTHUB or CONFLUENT vendor.
    DnsSubDomains []string
    Sub-Domain name of Confluent cluster. These are typically your availability zones. Required for AWS Provider and CONFLUENT vendor. If your AWS CONFLUENT cluster doesn't use subdomains, you must set this to the empty array [].
    ErrorMessage string
    Error message if the connection is in a failed state.
    Id string
    The ID of the Private Link connection.
    InterfaceEndpointId string
    Interface endpoint ID that is created from the specified service endpoint ID.
    InterfaceEndpointName string
    Name of interface endpoint that is created from the specified service endpoint ID.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    ProviderAccountId string
    Account ID from the cloud provider.
    ProviderName string
    Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
    Region string
    The region of the Provider’s cluster. See AZURE and AWS supported regions. When the vendor is CONFLUENT, this is the domain name of Confluent cluster. When the vendor is MSK, this is computed by the API from the provided arn.
    ServiceEndpointId string
    For AZURE EVENTHUB, this is the namespace endpoint ID. For AWS CONFLUENT cluster, this is the VPC Endpoint service name.
    State string
    Status of the connection.
    Vendor string
    Vendor that manages the Kafka cluster. The following are the vendor values per provider:\n\n- MSK and CONFLUENT for the AWS provider.\n\n- EVENTHUB and CONFLUENT for the AZURE provider.
    arn String
    Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
    dnsDomain String
    The domain hostname. Required for the following provider and vendor combinations:\n\n- AWS provider with CONFLUENT vendor.\n\n- AZURE provider with EVENTHUB or CONFLUENT vendor.
    dnsSubDomains List<String>
    Sub-Domain name of Confluent cluster. These are typically your availability zones. Required for AWS Provider and CONFLUENT vendor. If your AWS CONFLUENT cluster doesn't use subdomains, you must set this to the empty array [].
    errorMessage String
    Error message if the connection is in a failed state.
    id String
    The ID of the Private Link connection.
    interfaceEndpointId String
    Interface endpoint ID that is created from the specified service endpoint ID.
    interfaceEndpointName String
    Name of interface endpoint that is created from the specified service endpoint ID.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    providerAccountId String
    Account ID from the cloud provider.
    providerName String
    Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
    region String
    The region of the Provider’s cluster. See AZURE and AWS supported regions. When the vendor is CONFLUENT, this is the domain name of Confluent cluster. When the vendor is MSK, this is computed by the API from the provided arn.
    serviceEndpointId String
    For AZURE EVENTHUB, this is the namespace endpoint ID. For AWS CONFLUENT cluster, this is the VPC Endpoint service name.
    state String
    Status of the connection.
    vendor String
    Vendor that manages the Kafka cluster. The following are the vendor values per provider:\n\n- MSK and CONFLUENT for the AWS provider.\n\n- EVENTHUB and CONFLUENT for the AZURE provider.
    arn string
    Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
    dnsDomain string
    The domain hostname. Required for the following provider and vendor combinations:\n\n- AWS provider with CONFLUENT vendor.\n\n- AZURE provider with EVENTHUB or CONFLUENT vendor.
    dnsSubDomains string[]
    Sub-Domain name of Confluent cluster. These are typically your availability zones. Required for AWS Provider and CONFLUENT vendor. If your AWS CONFLUENT cluster doesn't use subdomains, you must set this to the empty array [].
    errorMessage string
    Error message if the connection is in a failed state.
    id string
    The ID of the Private Link connection.
    interfaceEndpointId string
    Interface endpoint ID that is created from the specified service endpoint ID.
    interfaceEndpointName string
    Name of interface endpoint that is created from the specified service endpoint ID.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    providerAccountId string
    Account ID from the cloud provider.
    providerName string
    Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
    region string
    The region of the Provider’s cluster. See AZURE and AWS supported regions. When the vendor is CONFLUENT, this is the domain name of Confluent cluster. When the vendor is MSK, this is computed by the API from the provided arn.
    serviceEndpointId string
    For AZURE EVENTHUB, this is the namespace endpoint ID. For AWS CONFLUENT cluster, this is the VPC Endpoint service name.
    state string
    Status of the connection.
    vendor string
    Vendor that manages the Kafka cluster. The following are the vendor values per provider:\n\n- MSK and CONFLUENT for the AWS provider.\n\n- EVENTHUB and CONFLUENT for the AZURE provider.
    arn str
    Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
    dns_domain str
    The domain hostname. Required for the following provider and vendor combinations:\n\n- AWS provider with CONFLUENT vendor.\n\n- AZURE provider with EVENTHUB or CONFLUENT vendor.
    dns_sub_domains Sequence[str]
    Sub-Domain name of Confluent cluster. These are typically your availability zones. Required for AWS Provider and CONFLUENT vendor. If your AWS CONFLUENT cluster doesn't use subdomains, you must set this to the empty array [].
    error_message str
    Error message if the connection is in a failed state.
    id str
    The ID of the Private Link connection.
    interface_endpoint_id str
    Interface endpoint ID that is created from the specified service endpoint ID.
    interface_endpoint_name str
    Name of interface endpoint that is created from the specified service endpoint ID.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    provider_account_id str
    Account ID from the cloud provider.
    provider_name str
    Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
    region str
    The region of the Provider’s cluster. See AZURE and AWS supported regions. When the vendor is CONFLUENT, this is the domain name of Confluent cluster. When the vendor is MSK, this is computed by the API from the provided arn.
    service_endpoint_id str
    For AZURE EVENTHUB, this is the namespace endpoint ID. For AWS CONFLUENT cluster, this is the VPC Endpoint service name.
    state str
    Status of the connection.
    vendor str
    Vendor that manages the Kafka cluster. The following are the vendor values per provider:\n\n- MSK and CONFLUENT for the AWS provider.\n\n- EVENTHUB and CONFLUENT for the AZURE provider.
    arn String
    Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
    dnsDomain String
    The domain hostname. Required for the following provider and vendor combinations:\n\n- AWS provider with CONFLUENT vendor.\n\n- AZURE provider with EVENTHUB or CONFLUENT vendor.
    dnsSubDomains List<String>
    Sub-Domain name of Confluent cluster. These are typically your availability zones. Required for AWS Provider and CONFLUENT vendor. If your AWS CONFLUENT cluster doesn't use subdomains, you must set this to the empty array [].
    errorMessage String
    Error message if the connection is in a failed state.
    id String
    The ID of the Private Link connection.
    interfaceEndpointId String
    Interface endpoint ID that is created from the specified service endpoint ID.
    interfaceEndpointName String
    Name of interface endpoint that is created from the specified service endpoint ID.
    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.\n\nNOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group or project id remains the same. The resource and corresponding endpoints use the term groups.
    providerAccountId String
    Account ID from the cloud provider.
    providerName String
    Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
    region String
    The region of the Provider’s cluster. See AZURE and AWS supported regions. When the vendor is CONFLUENT, this is the domain name of Confluent cluster. When the vendor is MSK, this is computed by the API from the provided arn.
    serviceEndpointId String
    For AZURE EVENTHUB, this is the namespace endpoint ID. For AWS CONFLUENT cluster, this is the VPC Endpoint service name.
    state String
    Status of the connection.
    vendor String
    Vendor that manages the Kafka cluster. The following are the vendor values per provider:\n\n- MSK and CONFLUENT for the AWS provider.\n\n- EVENTHUB and CONFLUENT for the AZURE provider.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi
    pulumi/pulumi-mongodbatlas