MongoDB Atlas v3.31.0, May 6 25

MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi

mongodbatlas.StreamPrivatelinkEndpoint

Explore with Pulumi AI

MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi

pulumi/pulumi-mongodbatlas

# Resource: mongodbatlas.StreamPrivatelinkEndpoint

mongodbatlas.StreamPrivatelinkEndpoint describes a Privatelink Endpoint for Streams.

Example Usage

S

Create StreamPrivatelinkEndpoint Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new StreamPrivatelinkEndpoint(name: string, args: StreamPrivatelinkEndpointArgs, opts?: CustomResourceOptions);

@overload
def StreamPrivatelinkEndpoint(resource_name: str,
                              args: StreamPrivatelinkEndpointArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def StreamPrivatelinkEndpoint(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              project_id: Optional[str] = None,
                              provider_name: Optional[str] = None,
                              vendor: Optional[str] = None,
                              arn: Optional[str] = None,
                              dns_domain: Optional[str] = None,
                              dns_sub_domains: Optional[Sequence[str]] = None,
                              region: Optional[str] = None,
                              service_endpoint_id: Optional[str] = None)

func NewStreamPrivatelinkEndpoint(ctx *Context, name string, args StreamPrivatelinkEndpointArgs, opts ...ResourceOption) (*StreamPrivatelinkEndpoint, error)

public StreamPrivatelinkEndpoint(string name, StreamPrivatelinkEndpointArgs args, CustomResourceOptions? opts = null)

public StreamPrivatelinkEndpoint(String name, StreamPrivatelinkEndpointArgs args)
public StreamPrivatelinkEndpoint(String name, StreamPrivatelinkEndpointArgs args, CustomResourceOptions options)

type: mongodbatlas:StreamPrivatelinkEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args StreamPrivatelinkEndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args StreamPrivatelinkEndpointArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args StreamPrivatelinkEndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args StreamPrivatelinkEndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args StreamPrivatelinkEndpointArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var streamPrivatelinkEndpointResource = new Mongodbatlas.StreamPrivatelinkEndpoint("streamPrivatelinkEndpointResource", new()
{
    ProjectId = "string",
    ProviderName = "string",
    Vendor = "string",
    Arn = "string",
    DnsDomain = "string",
    DnsSubDomains = new[]
    {
        "string",
    },
    Region = "string",
    ServiceEndpointId = "string",
});

example, err := mongodbatlas.NewStreamPrivatelinkEndpoint(ctx, "streamPrivatelinkEndpointResource", &mongodbatlas.StreamPrivatelinkEndpointArgs{
	ProjectId:    pulumi.String("string"),
	ProviderName: pulumi.String("string"),
	Vendor:       pulumi.String("string"),
	Arn:          pulumi.String("string"),
	DnsDomain:    pulumi.String("string"),
	DnsSubDomains: pulumi.StringArray{
		pulumi.String("string"),
	},
	Region:            pulumi.String("string"),
	ServiceEndpointId: pulumi.String("string"),
})

var streamPrivatelinkEndpointResource = new StreamPrivatelinkEndpoint("streamPrivatelinkEndpointResource", StreamPrivatelinkEndpointArgs.builder()
    .projectId("string")
    .providerName("string")
    .vendor("string")
    .arn("string")
    .dnsDomain("string")
    .dnsSubDomains("string")
    .region("string")
    .serviceEndpointId("string")
    .build());

stream_privatelink_endpoint_resource = mongodbatlas.StreamPrivatelinkEndpoint("streamPrivatelinkEndpointResource",
    project_id="string",
    provider_name="string",
    vendor="string",
    arn="string",
    dns_domain="string",
    dns_sub_domains=["string"],
    region="string",
    service_endpoint_id="string")

const streamPrivatelinkEndpointResource = new mongodbatlas.StreamPrivatelinkEndpoint("streamPrivatelinkEndpointResource", {
    projectId: "string",
    providerName: "string",
    vendor: "string",
    arn: "string",
    dnsDomain: "string",
    dnsSubDomains: ["string"],
    region: "string",
    serviceEndpointId: "string",
});

type: mongodbatlas:StreamPrivatelinkEndpoint
properties:
    arn: string
    dnsDomain: string
    dnsSubDomains:
        - string
    projectId: string
    providerName: string
    region: string
    serviceEndpointId: string
    vendor: string

StreamPrivatelinkEndpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The StreamPrivatelinkEndpoint resource accepts the following input properties:

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.
ProviderName string: Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
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 [].
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.

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.
ProviderName string: Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
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 [].
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.

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.
providerName String: Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
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 [].
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.

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.
providerName string: Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
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 [].
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.

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_name str: Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
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 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 [].
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.

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.
providerName String: Provider where the Kafka cluster is deployed. Valid values are AWS and AZURE.
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 [].
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the StreamPrivatelinkEndpoint resource produces the following output properties:

ErrorMessage string: Error message if the connection is in a failed state.
Id string: The provider-assigned unique ID for this managed resource.
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.
ProviderAccountId string: Account ID from the cloud provider.
State string: Status of the connection.

ErrorMessage string: Error message if the connection is in a failed state.
Id string: The provider-assigned unique ID for this managed resource.
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.
ProviderAccountId string: Account ID from the cloud provider.
State string: Status of the connection.

errorMessage String: Error message if the connection is in a failed state.
id String: The provider-assigned unique ID for this managed resource.
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.
providerAccountId String: Account ID from the cloud provider.
state String: Status of the connection.

errorMessage string: Error message if the connection is in a failed state.
id string: The provider-assigned unique ID for this managed resource.
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.
providerAccountId string: Account ID from the cloud provider.
state string: Status of the connection.

error_message str: Error message if the connection is in a failed state.
id str: The provider-assigned unique ID for this managed resource.
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.
provider_account_id str: Account ID from the cloud provider.
state str: Status of the connection.

errorMessage String: Error message if the connection is in a failed state.
id String: The provider-assigned unique ID for this managed resource.
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.
providerAccountId String: Account ID from the cloud provider.
state String: Status of the connection.

Look up Existing StreamPrivatelinkEndpoint Resource

Get an existing StreamPrivatelinkEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: StreamPrivatelinkEndpointState, opts?: CustomResourceOptions): StreamPrivatelinkEndpoint

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        dns_domain: Optional[str] = None,
        dns_sub_domains: Optional[Sequence[str]] = None,
        error_message: Optional[str] = None,
        interface_endpoint_id: Optional[str] = None,
        interface_endpoint_name: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_account_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        region: Optional[str] = None,
        service_endpoint_id: Optional[str] = None,
        state: Optional[str] = None,
        vendor: Optional[str] = None) -> StreamPrivatelinkEndpoint

func GetStreamPrivatelinkEndpoint(ctx *Context, name string, id IDInput, state *StreamPrivatelinkEndpointState, opts ...ResourceOption) (*StreamPrivatelinkEndpoint, error)

public static StreamPrivatelinkEndpoint Get(string name, Input<string> id, StreamPrivatelinkEndpointState? state, CustomResourceOptions? opts = null)

public static StreamPrivatelinkEndpoint get(String name, Output<String> id, StreamPrivatelinkEndpointState state, CustomResourceOptions options)

resources:  _:    type: mongodbatlas:StreamPrivatelinkEndpoint    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

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.
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.
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.
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.
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.
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.
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.

MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.StreamPrivatelinkEndpoint

On this page

On this page

# Resource: mongodbatlas.StreamPrivatelinkEndpoint

Example Usage

S

Create StreamPrivatelinkEndpoint Resource

Constructor syntax

Parameters

Constructor example

StreamPrivatelinkEndpoint Resource Properties

Inputs

Outputs

Look up Existing StreamPrivatelinkEndpoint Resource

Package Details

On this page

On this page