MongoDB Atlas v3.15.2, Jun 3 24

MongoDB Atlas v3.15.2 published on Monday, Jun 3, 2024 by Pulumi

mongodbatlas.getStreamConnection

Explore with Pulumi AI

MongoDB Atlas v3.15.2 published on Monday, Jun 3, 2024 by Pulumi

Example Usage

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

const example = mongodbatlas.getStreamConnection({
    projectId: "<PROJECT_ID>",
    instanceName: "<INSTANCE_NAME>",
    connectionName: "<CONNECTION_NAME>",
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

example = mongodbatlas.get_stream_connection(project_id="<PROJECT_ID>",
    instance_name="<INSTANCE_NAME>",
    connection_name="<CONNECTION_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.LookupStreamConnection(ctx, &mongodbatlas.LookupStreamConnectionArgs{
			ProjectId:      "<PROJECT_ID>",
			InstanceName:   "<INSTANCE_NAME>",
			ConnectionName: "<CONNECTION_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 example = Mongodbatlas.GetStreamConnection.Invoke(new()
    {
        ProjectId = "<PROJECT_ID>",
        InstanceName = "<INSTANCE_NAME>",
        ConnectionName = "<CONNECTION_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.GetStreamConnectionArgs;
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 example = MongodbatlasFunctions.getStreamConnection(GetStreamConnectionArgs.builder()
            .projectId("<PROJECT_ID>")
            .instanceName("<INSTANCE_NAME>")
            .connectionName("<CONNECTION_NAME>")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: mongodbatlas:getStreamConnection
      Arguments:
        projectId: <PROJECT_ID>
        instanceName: <INSTANCE_NAME>
        connectionName: <CONNECTION_NAME>

Using getStreamConnection

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 getStreamConnection(args: GetStreamConnectionArgs, opts?: InvokeOptions): Promise<GetStreamConnectionResult>
function getStreamConnectionOutput(args: GetStreamConnectionOutputArgs, opts?: InvokeOptions): Output<GetStreamConnectionResult>

def get_stream_connection(connection_name: Optional[str] = None,
                          instance_name: Optional[str] = None,
                          project_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetStreamConnectionResult
def get_stream_connection_output(connection_name: Optional[pulumi.Input[str]] = None,
                          instance_name: Optional[pulumi.Input[str]] = None,
                          project_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetStreamConnectionResult]

func LookupStreamConnection(ctx *Context, args *LookupStreamConnectionArgs, opts ...InvokeOption) (*LookupStreamConnectionResult, error)
func LookupStreamConnectionOutput(ctx *Context, args *LookupStreamConnectionOutputArgs, opts ...InvokeOption) LookupStreamConnectionResultOutput

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

public static class GetStreamConnection 
{
    public static Task<GetStreamConnectionResult> InvokeAsync(GetStreamConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamConnectionResult> Invoke(GetStreamConnectionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetStreamConnectionResult> getStreamConnection(GetStreamConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

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.
InstanceName string: Human-readable label that identifies the stream instance.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project.

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.
InstanceName string: Human-readable label that identifies the stream instance.
ProjectId string: Unique 24-hexadecimal digit string that identifies your project.

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.
instanceName String: Human-readable label that identifies the stream instance.
projectId String: Unique 24-hexadecimal digit string that identifies your project.

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.
instanceName string: Human-readable label that identifies the stream instance.
projectId string: Unique 24-hexadecimal digit string that identifies your project.

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.
instance_name str: Human-readable label that identifies the stream instance.
project_id str: Unique 24-hexadecimal digit string that identifies your project.

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.
instanceName String: Human-readable label that identifies the stream instance.
projectId String: Unique 24-hexadecimal digit string that identifies your project.

getStreamConnection Result

The following output properties are available:

Authentication GetStreamConnectionAuthentication: 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
DbRoleToExecute GetStreamConnectionDbRoleToExecute: The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
Id string
InstanceName string
ProjectId string
Security GetStreamConnectionSecurity: 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 GetStreamConnectionAuthentication: 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
DbRoleToExecute GetStreamConnectionDbRoleToExecute: The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
Id string
InstanceName string
ProjectId string
Security GetStreamConnectionSecurity: 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 GetStreamConnectionAuthentication: 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
dbRoleToExecute GetStreamConnectionDbRoleToExecute: The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
id String
instanceName String
projectId String
security GetStreamConnectionSecurity: 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 GetStreamConnectionAuthentication: 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
dbRoleToExecute GetStreamConnectionDbRoleToExecute: The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
id string
instanceName string
projectId string
security GetStreamConnectionSecurity: 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 GetStreamConnectionAuthentication: 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
db_role_to_execute GetStreamConnectionDbRoleToExecute: The name of a Built in or Custom DB Role to connect to an Atlas Cluster. See DBRoleToExecute.
id str
instance_name str
project_id str
security GetStreamConnectionSecurity: 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
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
projectId String
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.

Supporting Types

GetStreamConnectionAuthentication

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.

GetStreamConnectionDbRoleToExecute

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.

GetStreamConnectionSecurity

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.

MongoDB Atlas v3.15.2 published on Monday, Jun 3, 2024 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getStreamConnection

On this page

On this page

Example Usage

Using getStreamConnection

getStreamConnection Result

Supporting Types

GetStreamConnectionAuthentication

GetStreamConnectionDbRoleToExecute

GetStreamConnectionSecurity

Package Details

On this page

On this page