MongoDB Atlas v3.36.0 published on Friday, Aug 22, 2025 by Pulumi
mongodbatlas.getStreamPrivatelinkEndpoints
Explore with Pulumi AI
# Data Source: mongodbatlas.getStreamPrivatelinkEndpoints
mongodbatlas.getStreamPrivatelinkEndpoints
describes a Privatelink Endpoint for Streams.
Example Usage
S
AWS S3 Privatelink
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as mongodbatlas from "@pulumi/mongodbatlas";
// S3 bucket for stream data
const streamBucket = new aws.index.S3Bucket("stream_bucket", {
bucket: s3BucketName,
forceDestroy: true,
});
const streamBucketVersioning = new aws.index.S3BucketVersioning("stream_bucket_versioning", {
bucket: streamBucket.id,
versioningConfiguration: [{
status: "Enabled",
}],
});
const streamBucketEncryption = new aws.index.S3BucketServerSideEncryptionConfiguration("stream_bucket_encryption", {
bucket: streamBucket.id,
rule: [{
applyServerSideEncryptionByDefault: [{
sseAlgorithm: "AES256",
}],
}],
});
// PrivateLink for S3
const _this = new mongodbatlas.StreamPrivatelinkEndpoint("this", {
projectId: projectId,
providerName: "AWS",
vendor: "S3",
region: region,
serviceEndpointId: serviceEndpointId,
});
export const privatelinkEndpointId = _this.id;
import pulumi
import pulumi_aws as aws
import pulumi_mongodbatlas as mongodbatlas
# S3 bucket for stream data
stream_bucket = aws.index.S3Bucket("stream_bucket",
bucket=s3_bucket_name,
force_destroy=True)
stream_bucket_versioning = aws.index.S3BucketVersioning("stream_bucket_versioning",
bucket=stream_bucket.id,
versioning_configuration=[{
status: Enabled,
}])
stream_bucket_encryption = aws.index.S3BucketServerSideEncryptionConfiguration("stream_bucket_encryption",
bucket=stream_bucket.id,
rule=[{
applyServerSideEncryptionByDefault: [{
sseAlgorithm: AES256,
}],
}])
# PrivateLink for S3
this = mongodbatlas.StreamPrivatelinkEndpoint("this",
project_id=project_id,
provider_name="AWS",
vendor="S3",
region=region,
service_endpoint_id=service_endpoint_id)
pulumi.export("privatelinkEndpointId", this.id)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws"
"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 {
// S3 bucket for stream data
streamBucket, err := aws.NewS3Bucket(ctx, "stream_bucket", &aws.S3BucketArgs{
Bucket: s3BucketName,
ForceDestroy: true,
})
if err != nil {
return err
}
_, err = aws.NewS3BucketVersioning(ctx, "stream_bucket_versioning", &aws.S3BucketVersioningArgs{
Bucket: streamBucket.Id,
VersioningConfiguration: []map[string]interface{}{
map[string]interface{}{
"status": "Enabled",
},
},
})
if err != nil {
return err
}
_, err = aws.NewS3BucketServerSideEncryptionConfiguration(ctx, "stream_bucket_encryption", &aws.S3BucketServerSideEncryptionConfigurationArgs{
Bucket: streamBucket.Id,
Rule: []map[string]interface{}{
map[string]interface{}{
"applyServerSideEncryptionByDefault": []map[string]interface{}{
map[string]interface{}{
"sseAlgorithm": "AES256",
},
},
},
},
})
if err != nil {
return err
}
// PrivateLink for S3
this, err := mongodbatlas.NewStreamPrivatelinkEndpoint(ctx, "this", &mongodbatlas.StreamPrivatelinkEndpointArgs{
ProjectId: pulumi.Any(projectId),
ProviderName: pulumi.String("AWS"),
Vendor: pulumi.String("S3"),
Region: pulumi.Any(region),
ServiceEndpointId: pulumi.Any(serviceEndpointId),
})
if err != nil {
return err
}
ctx.Export("privatelinkEndpointId", this.ID())
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
// S3 bucket for stream data
var streamBucket = new Aws.Index.S3Bucket("stream_bucket", new()
{
Bucket = s3BucketName,
ForceDestroy = true,
});
var streamBucketVersioning = new Aws.Index.S3BucketVersioning("stream_bucket_versioning", new()
{
Bucket = streamBucket.Id,
VersioningConfiguration = new[]
{
{
{ "status", "Enabled" },
},
},
});
var streamBucketEncryption = new Aws.Index.S3BucketServerSideEncryptionConfiguration("stream_bucket_encryption", new()
{
Bucket = streamBucket.Id,
Rule = new[]
{
{
{ "applyServerSideEncryptionByDefault", new[]
{
{
{ "sseAlgorithm", "AES256" },
},
} },
},
},
});
// PrivateLink for S3
var @this = new Mongodbatlas.StreamPrivatelinkEndpoint("this", new()
{
ProjectId = projectId,
ProviderName = "AWS",
Vendor = "S3",
Region = region,
ServiceEndpointId = serviceEndpointId,
});
return new Dictionary<string, object?>
{
["privatelinkEndpointId"] = @this.Id,
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3Bucket;
import com.pulumi.aws.s3BucketArgs;
import com.pulumi.aws.s3BucketVersioning;
import com.pulumi.aws.s3BucketVersioningArgs;
import com.pulumi.aws.s3BucketServerSideEncryptionConfiguration;
import com.pulumi.aws.s3BucketServerSideEncryptionConfigurationArgs;
import com.pulumi.mongodbatlas.StreamPrivatelinkEndpoint;
import com.pulumi.mongodbatlas.StreamPrivatelinkEndpointArgs;
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) {
// S3 bucket for stream data
var streamBucket = new S3Bucket("streamBucket", S3BucketArgs.builder()
.bucket(s3BucketName)
.forceDestroy(true)
.build());
var streamBucketVersioning = new S3BucketVersioning("streamBucketVersioning", S3BucketVersioningArgs.builder()
.bucket(streamBucket.id())
.versioningConfiguration(List.of(Map.of("status", "Enabled")))
.build());
var streamBucketEncryption = new S3BucketServerSideEncryptionConfiguration("streamBucketEncryption", S3BucketServerSideEncryptionConfigurationArgs.builder()
.bucket(streamBucket.id())
.rule(List.of(Map.of("applyServerSideEncryptionByDefault", List.of(Map.of("sseAlgorithm", "AES256")))))
.build());
// PrivateLink for S3
var this_ = new StreamPrivatelinkEndpoint("this", StreamPrivatelinkEndpointArgs.builder()
.projectId(projectId)
.providerName("AWS")
.vendor("S3")
.region(region)
.serviceEndpointId(serviceEndpointId)
.build());
ctx.export("privatelinkEndpointId", this_.id());
}
}
resources:
# S3 bucket for stream data
streamBucket:
type: aws:s3Bucket
name: stream_bucket
properties:
bucket: ${s3BucketName}
forceDestroy: true
streamBucketVersioning:
type: aws:s3BucketVersioning
name: stream_bucket_versioning
properties:
bucket: ${streamBucket.id}
versioningConfiguration:
- status: Enabled
streamBucketEncryption:
type: aws:s3BucketServerSideEncryptionConfiguration
name: stream_bucket_encryption
properties:
bucket: ${streamBucket.id}
rule:
- applyServerSideEncryptionByDefault:
- sseAlgorithm: AES256
# PrivateLink for S3
this:
type: mongodbatlas:StreamPrivatelinkEndpoint
properties:
projectId: ${projectId}
providerName: AWS
vendor: S3
region: ${region}
serviceEndpointId: ${serviceEndpointId}
outputs:
privatelinkEndpointId: ${this.id}
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:
- Project
Id string
- Project
Id string
- project
Id String
- project
Id string
- project_
id str
- project
Id String
getStreamPrivatelinkEndpoints Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - Results
List<Get
Stream Privatelink Endpoints Result>
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - Results
[]Get
Stream Privatelink Endpoints Result
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - results
List<Get
Stream Privatelink Endpoints Result>
- id string
- The provider-assigned unique ID for this managed resource.
- project
Id string - results
Get
Stream Privatelink Endpoints Result[]
- id str
- The provider-assigned unique ID for this managed resource.
- project_
id str - results
Sequence[Get
Stream Privatelink Endpoints Result]
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - results List<Property Map>
Supporting Types
GetStreamPrivatelinkEndpointsResult
- Arn string
- Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
- Dns
Domain string - The domain hostname. Required for the following provider and vendor combinations:
* AWS provider with CONFLUENT vendor.
- AZURE provider with EVENTHUB or CONFLUENT vendor.
- Dns
Sub List<string>Domains - 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 [].
- string
- Error message if the connection is in a failed state.
- Id string
- The ID of the Private Link connection.
- Interface
Endpoint stringId - Interface endpoint ID that is created from the specified service endpoint ID.
- Interface
Endpoint stringName - Name of interface endpoint that is created from the specified service endpoint ID.
- Project
Id 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.NOTE: 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 stringId - Account ID from the cloud provider.
- Provider
Name string - Provider where the endpoint 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 isMSK
, this is computed by the API from the providedarn
. - Service
Endpoint stringId - 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 endpoint. The following are the vendor values per provider:
* **AWS**: MSK, CONFLUENT, and S3 * **Azure**: EVENTHUB and CONFLUENT
- Arn string
- Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
- Dns
Domain string - The domain hostname. Required for the following provider and vendor combinations:
* AWS provider with CONFLUENT vendor.
- AZURE provider with EVENTHUB or CONFLUENT vendor.
- Dns
Sub []stringDomains - 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 [].
- string
- Error message if the connection is in a failed state.
- Id string
- The ID of the Private Link connection.
- Interface
Endpoint stringId - Interface endpoint ID that is created from the specified service endpoint ID.
- Interface
Endpoint stringName - Name of interface endpoint that is created from the specified service endpoint ID.
- Project
Id 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.NOTE: 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 stringId - Account ID from the cloud provider.
- Provider
Name string - Provider where the endpoint 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 isMSK
, this is computed by the API from the providedarn
. - Service
Endpoint stringId - 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 endpoint. The following are the vendor values per provider:
* **AWS**: MSK, CONFLUENT, and S3 * **Azure**: EVENTHUB and CONFLUENT
- arn String
- Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
- dns
Domain String - The domain hostname. Required for the following provider and vendor combinations:
* AWS provider with CONFLUENT vendor.
- AZURE provider with EVENTHUB or CONFLUENT vendor.
- dns
Sub List<String>Domains - 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 [].
- String
- Error message if the connection is in a failed state.
- id String
- The ID of the Private Link connection.
- interface
Endpoint StringId - Interface endpoint ID that is created from the specified service endpoint ID.
- interface
Endpoint StringName - Name of interface endpoint that is created from the specified service endpoint ID.
- project
Id 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.NOTE: 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 StringId - Account ID from the cloud provider.
- provider
Name String - Provider where the endpoint 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 isMSK
, this is computed by the API from the providedarn
. - service
Endpoint StringId - 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 endpoint. The following are the vendor values per provider:
* **AWS**: MSK, CONFLUENT, and S3 * **Azure**: EVENTHUB and CONFLUENT
- arn string
- Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
- dns
Domain string - The domain hostname. Required for the following provider and vendor combinations:
* AWS provider with CONFLUENT vendor.
- AZURE provider with EVENTHUB or CONFLUENT vendor.
- dns
Sub string[]Domains - 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 [].
- string
- Error message if the connection is in a failed state.
- id string
- The ID of the Private Link connection.
- interface
Endpoint stringId - Interface endpoint ID that is created from the specified service endpoint ID.
- interface
Endpoint stringName - Name of interface endpoint that is created from the specified service endpoint ID.
- project
Id 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.NOTE: 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 stringId - Account ID from the cloud provider.
- provider
Name string - Provider where the endpoint 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 isMSK
, this is computed by the API from the providedarn
. - service
Endpoint stringId - 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 endpoint. The following are the vendor values per provider:
* **AWS**: MSK, CONFLUENT, and S3 * **Azure**: EVENTHUB and CONFLUENT
- 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:
* AWS provider with CONFLUENT vendor.
- AZURE provider with EVENTHUB or CONFLUENT vendor.
- dns_
sub_ Sequence[str]domains - 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 [].
- str
- Error message if the connection is in a failed state.
- id str
- The ID of the Private Link connection.
- interface_
endpoint_ strid - Interface endpoint ID that is created from the specified service endpoint ID.
- interface_
endpoint_ strname - 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.NOTE: 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_ strid - Account ID from the cloud provider.
- provider_
name str - Provider where the endpoint 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 isMSK
, this is computed by the API from the providedarn
. - service_
endpoint_ strid - 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 endpoint. The following are the vendor values per provider:
* **AWS**: MSK, CONFLUENT, and S3 * **Azure**: EVENTHUB and CONFLUENT
- arn String
- Amazon Resource Name (ARN). Required for AWS Provider and MSK vendor.
- dns
Domain String - The domain hostname. Required for the following provider and vendor combinations:
* AWS provider with CONFLUENT vendor.
- AZURE provider with EVENTHUB or CONFLUENT vendor.
- dns
Sub List<String>Domains - 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 [].
- String
- Error message if the connection is in a failed state.
- id String
- The ID of the Private Link connection.
- interface
Endpoint StringId - Interface endpoint ID that is created from the specified service endpoint ID.
- interface
Endpoint StringName - Name of interface endpoint that is created from the specified service endpoint ID.
- project
Id 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.NOTE: 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 StringId - Account ID from the cloud provider.
- provider
Name String - Provider where the endpoint 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 isMSK
, this is computed by the API from the providedarn
. - service
Endpoint StringId - 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 endpoint. The following are the vendor values per provider:
* **AWS**: MSK, CONFLUENT, and S3 * **Azure**: EVENTHUB and CONFLUENT
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlas
Terraform Provider.