Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getStreamConnections
MongoDB Atlas v3.15.1 published on Wednesday, May 29, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getStreamConnections

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.15.1 published on Wednesday, May 29, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    mongodbatlas.getStreamConnections describes all connections of a stream instance for the specified project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = mongodbatlas.getStreamConnections({
    projectId: "<PROJECT_ID>",
    instanceName: "<INSTANCE_NAME>",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_stream_connections(project_id="<PROJECT_ID>",
    instance_name="<INSTANCE_NAME>")

    package main

import (
	"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 {
		_, err := mongodbatlas.LookupStreamConnections(ctx, &mongodbatlas.LookupStreamConnectionsArgs{
			ProjectId:    "<PROJECT_ID>",
			InstanceName: "<INSTANCE_NAME>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = Mongodbatlas.GetStreamConnections.Invoke(new()
    {
        ProjectId = "<PROJECT_ID>",
        InstanceName = "<INSTANCE_NAME>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetStreamConnectionsArgs;
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) {
        final var test = MongodbatlasFunctions.getStreamConnections(GetStreamConnectionsArgs.builder()
            .projectId("<PROJECT_ID>")
            .instanceName("<INSTANCE_NAME>")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getStreamConnections
      Arguments:
        projectId: <PROJECT_ID>
        instanceName: <INSTANCE_NAME>

    Using getStreamConnections

    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 getStreamConnections(args: GetStreamConnectionsArgs, opts?: InvokeOptions): Promise<GetStreamConnectionsResult>
function getStreamConnectionsOutput(args: GetStreamConnectionsOutputArgs, opts?: InvokeOptions): Output<GetStreamConnectionsResult>
    def get_stream_connections(instance_name: Optional[str] = None,
                           items_per_page: Optional[int] = None,
                           page_num: Optional[int] = None,
                           project_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetStreamConnectionsResult
def get_stream_connections_output(instance_name: Optional[pulumi.Input[str]] = None,
                           items_per_page: Optional[pulumi.Input[int]] = None,
                           page_num: Optional[pulumi.Input[int]] = None,
                           project_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetStreamConnectionsResult]
    func LookupStreamConnections(ctx *Context, args *LookupStreamConnectionsArgs, opts ...InvokeOption) (*LookupStreamConnectionsResult, error)
func LookupStreamConnectionsOutput(ctx *Context, args *LookupStreamConnectionsOutputArgs, opts ...InvokeOption) LookupStreamConnectionsResultOutput

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

    public static class GetStreamConnections 
{
    public static Task<GetStreamConnectionsResult> InvokeAsync(GetStreamConnectionsArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamConnectionsResult> Invoke(GetStreamConnectionsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStreamConnectionsResult> getStreamConnections(GetStreamConnectionsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    ItemsPerPage int
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    PageNum int
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    ItemsPerPage int
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    PageNum int
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    itemsPerPage Integer
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    pageNum Integer
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    instanceName string
    Human-readable label that identifies the stream instance.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    itemsPerPage number
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    pageNum number
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    instance_name str
    Human-readable label that identifies the stream instance.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    items_per_page int
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    page_num int
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    itemsPerPage Number
    Number of items that the response returns per page, up to a maximum of 500. Defaults to 100.
    pageNum Number
    Number of the page that displays the current set of the total objects that the response returns. Defaults to 1.

    getStreamConnections Result

    The following output properties are available:

    Id string
    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    Results List<GetStreamConnectionsResult>
    A list where each element contains a stream connection.
    TotalCount int
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    ItemsPerPage int
    PageNum int
    Id string
    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    Results []GetStreamConnectionsResult
    A list where each element contains a stream connection.
    TotalCount int
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    ItemsPerPage int
    PageNum int
    id String
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    results List<GetStreamConnectionsResult>
    A list where each element contains a stream connection.
    totalCount Integer
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage Integer
    pageNum Integer
    id string
    instanceName string
    Human-readable label that identifies the stream instance.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    results GetStreamConnectionsResult[]
    A list where each element contains a stream connection.
    totalCount number
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage number
    pageNum number
    id str
    instance_name str
    Human-readable label that identifies the stream instance.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    results Sequence[GetStreamConnectionsResult]
    A list where each element contains a stream connection.
    total_count int
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    items_per_page int
    page_num int
    id String
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    results List<Property Map>
    A list where each element contains a stream connection.
    totalCount Number
    Count of the total number of items in the result set. The count might be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage Number
    pageNum Number

    Supporting Types

    GetStreamConnectionsResult

    Authentication GetStreamConnectionsResultAuthentication
    User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
    BootstrapServers string
    Comma separated list of server addresses.
    ClusterName string
    Name of the cluster configured for this connection.
    Config Dictionary<string, string>
    A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    ConnectionName string
    Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
    DbRoleToExecute GetStreamConnectionsResultDbRoleToExecute
    The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
    Id string
    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    Security GetStreamConnectionsResultSecurity
    Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
    Type string
    Type of the DB role. Can be either BUILT_IN or CUSTOM.
    Authentication GetStreamConnectionsResultAuthentication
    User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
    BootstrapServers string
    Comma separated list of server addresses.
    ClusterName string
    Name of the cluster configured for this connection.
    Config map[string]string
    A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    ConnectionName string
    Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
    DbRoleToExecute GetStreamConnectionsResultDbRoleToExecute
    The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
    Id string
    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    Security GetStreamConnectionsResultSecurity
    Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
    Type string
    Type of the DB role. Can be either BUILT_IN or CUSTOM.
    authentication GetStreamConnectionsResultAuthentication
    User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
    bootstrapServers String
    Comma separated list of server addresses.
    clusterName String
    Name of the cluster configured for this connection.
    config Map<String,String>
    A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    connectionName String
    Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
    dbRoleToExecute GetStreamConnectionsResultDbRoleToExecute
    The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
    id String
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    security GetStreamConnectionsResultSecurity
    Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
    type String
    Type of the DB role. Can be either BUILT_IN or CUSTOM.
    authentication GetStreamConnectionsResultAuthentication
    User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
    bootstrapServers string
    Comma separated list of server addresses.
    clusterName string
    Name of the cluster configured for this connection.
    config {[key: string]: string}
    A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    connectionName string
    Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
    dbRoleToExecute GetStreamConnectionsResultDbRoleToExecute
    The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
    id string
    instanceName string
    Human-readable label that identifies the stream instance.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    security GetStreamConnectionsResultSecurity
    Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
    type string
    Type of the DB role. Can be either BUILT_IN or CUSTOM.
    authentication GetStreamConnectionsResultAuthentication
    User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
    bootstrap_servers str
    Comma separated list of server addresses.
    cluster_name str
    Name of the cluster configured for this connection.
    config Mapping[str, str]
    A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    connection_name str
    Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
    db_role_to_execute GetStreamConnectionsResultDbRoleToExecute
    The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
    id str
    instance_name str
    Human-readable label that identifies the stream instance.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    security GetStreamConnectionsResultSecurity
    Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
    type str
    Type of the DB role. Can be either BUILT_IN or CUSTOM.
    authentication Property Map
    User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See authentication.
    bootstrapServers String
    Comma separated list of server addresses.
    clusterName String
    Name of the cluster configured for this connection.
    config Map<String>
    A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
    connectionName String
    Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
    dbRoleToExecute Property Map
    The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
    id String
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    security Property Map
    Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See security.
    type String
    Type of the DB role. Can be either BUILT_IN or CUSTOM.

    GetStreamConnectionsResultAuthentication

    Mechanism string
    Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
    Password string
    Password of the account to connect to the Kafka cluster.
    Username string
    Username of the account to connect to the Kafka cluster.
    Mechanism string
    Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
    Password string
    Password of the account to connect to the Kafka cluster.
    Username string
    Username of the account to connect to the Kafka cluster.
    mechanism String
    Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
    password String
    Password of the account to connect to the Kafka cluster.
    username String
    Username of the account to connect to the Kafka cluster.
    mechanism string
    Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
    password string
    Password of the account to connect to the Kafka cluster.
    username string
    Username of the account to connect to the Kafka cluster.
    mechanism str
    Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
    password str
    Password of the account to connect to the Kafka cluster.
    username str
    Username of the account to connect to the Kafka cluster.
    mechanism String
    Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512.
    password String
    Password of the account to connect to the Kafka cluster.
    username String
    Username of the account to connect to the Kafka cluster.

    GetStreamConnectionsResultDbRoleToExecute

    Role string
    The name of the role to use. Can be a built in role or a custom role.
    Type string
    Type of the DB role. Can be either BUILT_IN or CUSTOM.
    Role string
    The name of the role to use. Can be a built in role or a custom role.
    Type string
    Type of the DB role. Can be either BUILT_IN or CUSTOM.
    role String
    The name of the role to use. Can be a built in role or a custom role.
    type String
    Type of the DB role. Can be either BUILT_IN or CUSTOM.
    role string
    The name of the role to use. Can be a built in role or a custom role.
    type string
    Type of the DB role. Can be either BUILT_IN or CUSTOM.
    role str
    The name of the role to use. Can be a built in role or a custom role.
    type str
    Type of the DB role. Can be either BUILT_IN or CUSTOM.
    role String
    The name of the role to use. Can be a built in role or a custom role.
    type String
    Type of the DB role. Can be either BUILT_IN or CUSTOM.

    GetStreamConnectionsResultSecurity

    BrokerPublicCertificate string
    A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
    Protocol string
    Describes the transport type. Can be either PLAINTEXT or SSL.
    BrokerPublicCertificate string
    A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
    Protocol string
    Describes the transport type. Can be either PLAINTEXT or SSL.
    brokerPublicCertificate String
    A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
    protocol String
    Describes the transport type. Can be either PLAINTEXT or SSL.
    brokerPublicCertificate string
    A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
    protocol string
    Describes the transport type. Can be either PLAINTEXT or SSL.
    broker_public_certificate str
    A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
    protocol str
    Describes the transport type. Can be either PLAINTEXT or SSL.
    brokerPublicCertificate String
    A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
    protocol String
    Describes the transport type. Can be either PLAINTEXT or SSL.

    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.15.1 published on Wednesday, May 29, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas