Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getCloudBackupSnapshotExportBucket
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getCloudBackupSnapshotExportBucket

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

# Data Source: mongodbatlas.CloudBackupSnapshotExportBucket

mongodbatlas.CloudBackupSnapshotExportBucket datasource allows you to retrieve all the buckets for the specified project.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Example Usage

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

const testCloudBackupSnapshotExportBucket = new mongodbatlas.CloudBackupSnapshotExportBucket("test", {
    projectId: "{PROJECT_ID}",
    iamRoleId: "{IAM_ROLE_ID}",
    bucketName: "example-bucket",
    cloudProvider: "AWS",
});
const test = mongodbatlas.getCloudBackupSnapshotExportBucketOutput({
    projectId: "{PROJECT_ID}",
    exportBucketId: testCloudBackupSnapshotExportBucket.exportBucketId,
});
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_cloud_backup_snapshot_export_bucket = mongodbatlas.CloudBackupSnapshotExportBucket("test",
    project_id="{PROJECT_ID}",
    iam_role_id="{IAM_ROLE_ID}",
    bucket_name="example-bucket",
    cloud_provider="AWS")
test = mongodbatlas.get_cloud_backup_snapshot_export_bucket_output(project_id="{PROJECT_ID}",
    export_bucket_id=test_cloud_backup_snapshot_export_bucket.export_bucket_id)
Copy
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 {
		testCloudBackupSnapshotExportBucket, err := mongodbatlas.NewCloudBackupSnapshotExportBucket(ctx, "test", &mongodbatlas.CloudBackupSnapshotExportBucketArgs{
			ProjectId:     pulumi.String("{PROJECT_ID}"),
			IamRoleId:     pulumi.String("{IAM_ROLE_ID}"),
			BucketName:    pulumi.String("example-bucket"),
			CloudProvider: pulumi.String("AWS"),
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.LookupCloudBackupSnapshotExportBucketOutput(ctx, mongodbatlas.GetCloudBackupSnapshotExportBucketOutputArgs{
			ProjectId:      pulumi.String("{PROJECT_ID}"),
			ExportBucketId: testCloudBackupSnapshotExportBucket.ExportBucketId,
		}, nil)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var testCloudBackupSnapshotExportBucket = new Mongodbatlas.CloudBackupSnapshotExportBucket("test", new()
    {
        ProjectId = "{PROJECT_ID}",
        IamRoleId = "{IAM_ROLE_ID}",
        BucketName = "example-bucket",
        CloudProvider = "AWS",
    });

    var test = Mongodbatlas.GetCloudBackupSnapshotExportBucket.Invoke(new()
    {
        ProjectId = "{PROJECT_ID}",
        ExportBucketId = testCloudBackupSnapshotExportBucket.ExportBucketId,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.CloudBackupSnapshotExportBucket;
import com.pulumi.mongodbatlas.CloudBackupSnapshotExportBucketArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetCloudBackupSnapshotExportBucketArgs;
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) {
        var testCloudBackupSnapshotExportBucket = new CloudBackupSnapshotExportBucket("testCloudBackupSnapshotExportBucket", CloudBackupSnapshotExportBucketArgs.builder()
            .projectId("{PROJECT_ID}")
            .iamRoleId("{IAM_ROLE_ID}")
            .bucketName("example-bucket")
            .cloudProvider("AWS")
            .build());

        final var test = MongodbatlasFunctions.getCloudBackupSnapshotExportBucket(GetCloudBackupSnapshotExportBucketArgs.builder()
            .projectId("{PROJECT_ID}")
            .exportBucketId(testCloudBackupSnapshotExportBucket.exportBucketId())
            .build());

    }
}
Copy
resources:
  testCloudBackupSnapshotExportBucket:
    type: mongodbatlas:CloudBackupSnapshotExportBucket
    name: test
    properties:
      projectId: '{PROJECT_ID}'
      iamRoleId: '{IAM_ROLE_ID}'
      bucketName: example-bucket
      cloudProvider: AWS
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getCloudBackupSnapshotExportBucket
      arguments:
        projectId: '{PROJECT_ID}'
        exportBucketId: ${testCloudBackupSnapshotExportBucket.exportBucketId}
Copy

Using getCloudBackupSnapshotExportBucket

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 getCloudBackupSnapshotExportBucket(args: GetCloudBackupSnapshotExportBucketArgs, opts?: InvokeOptions): Promise<GetCloudBackupSnapshotExportBucketResult>
function getCloudBackupSnapshotExportBucketOutput(args: GetCloudBackupSnapshotExportBucketOutputArgs, opts?: InvokeOptions): Output<GetCloudBackupSnapshotExportBucketResult>
Copy
def get_cloud_backup_snapshot_export_bucket(export_bucket_id: Optional[str] = None,
                                            project_id: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetCloudBackupSnapshotExportBucketResult
def get_cloud_backup_snapshot_export_bucket_output(export_bucket_id: Optional[pulumi.Input[str]] = None,
                                            project_id: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetCloudBackupSnapshotExportBucketResult]
Copy
func LookupCloudBackupSnapshotExportBucket(ctx *Context, args *LookupCloudBackupSnapshotExportBucketArgs, opts ...InvokeOption) (*LookupCloudBackupSnapshotExportBucketResult, error)
func LookupCloudBackupSnapshotExportBucketOutput(ctx *Context, args *LookupCloudBackupSnapshotExportBucketOutputArgs, opts ...InvokeOption) LookupCloudBackupSnapshotExportBucketResultOutput
Copy

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

public static class GetCloudBackupSnapshotExportBucket 
{
    public static Task<GetCloudBackupSnapshotExportBucketResult> InvokeAsync(GetCloudBackupSnapshotExportBucketArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupSnapshotExportBucketResult> Invoke(GetCloudBackupSnapshotExportBucketInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCloudBackupSnapshotExportBucketResult> getCloudBackupSnapshotExportBucket(GetCloudBackupSnapshotExportBucketArgs args, InvokeOptions options)
public static Output<GetCloudBackupSnapshotExportBucketResult> getCloudBackupSnapshotExportBucket(GetCloudBackupSnapshotExportBucketArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getCloudBackupSnapshotExportBucket:getCloudBackupSnapshotExportBucket
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ExportBucketId This property is required. string
Unique identifier of the snapshot export bucket.
ProjectId This property is required. string
The unique identifier of the project for the Atlas cluster.
ExportBucketId This property is required. string
Unique identifier of the snapshot export bucket.
ProjectId This property is required. string
The unique identifier of the project for the Atlas cluster.
exportBucketId This property is required. String
Unique identifier of the snapshot export bucket.
projectId This property is required. String
The unique identifier of the project for the Atlas cluster.
exportBucketId This property is required. string
Unique identifier of the snapshot export bucket.
projectId This property is required. string
The unique identifier of the project for the Atlas cluster.
export_bucket_id This property is required. str
Unique identifier of the snapshot export bucket.
project_id This property is required. str
The unique identifier of the project for the Atlas cluster.
exportBucketId This property is required. String
Unique identifier of the snapshot export bucket.
projectId This property is required. String
The unique identifier of the project for the Atlas cluster.

getCloudBackupSnapshotExportBucket Result

The following output properties are available:

BucketName string
Name of the bucket that the provided role ID is authorized to access.
CloudProvider string
Name of the provider of the cloud service where Atlas can access the S3 bucket.
ExportBucketId string
IamRoleId string
Unique identifier of the role that Atlas can use to access the bucket.
Id string
ProjectId string
RoleId string
Unique identifier of the Azure Service Principal that Atlas can use to access the Azure Blob Storage Container.
ServiceUrl string
URL that identifies the blob Endpoint of the Azure Blob Storage Account.
TenantId string
UUID that identifies the Azure Active Directory Tenant ID.
BucketName string
Name of the bucket that the provided role ID is authorized to access.
CloudProvider string
Name of the provider of the cloud service where Atlas can access the S3 bucket.
ExportBucketId string
IamRoleId string
Unique identifier of the role that Atlas can use to access the bucket.
Id string
ProjectId string
RoleId string
Unique identifier of the Azure Service Principal that Atlas can use to access the Azure Blob Storage Container.
ServiceUrl string
URL that identifies the blob Endpoint of the Azure Blob Storage Account.
TenantId string
UUID that identifies the Azure Active Directory Tenant ID.
bucketName String
Name of the bucket that the provided role ID is authorized to access.
cloudProvider String
Name of the provider of the cloud service where Atlas can access the S3 bucket.
exportBucketId String
iamRoleId String
Unique identifier of the role that Atlas can use to access the bucket.
id String
projectId String
roleId String
Unique identifier of the Azure Service Principal that Atlas can use to access the Azure Blob Storage Container.
serviceUrl String
URL that identifies the blob Endpoint of the Azure Blob Storage Account.
tenantId String
UUID that identifies the Azure Active Directory Tenant ID.
bucketName string
Name of the bucket that the provided role ID is authorized to access.
cloudProvider string
Name of the provider of the cloud service where Atlas can access the S3 bucket.
exportBucketId string
iamRoleId string
Unique identifier of the role that Atlas can use to access the bucket.
id string
projectId string
roleId string
Unique identifier of the Azure Service Principal that Atlas can use to access the Azure Blob Storage Container.
serviceUrl string
URL that identifies the blob Endpoint of the Azure Blob Storage Account.
tenantId string
UUID that identifies the Azure Active Directory Tenant ID.
bucket_name str
Name of the bucket that the provided role ID is authorized to access.
cloud_provider str
Name of the provider of the cloud service where Atlas can access the S3 bucket.
export_bucket_id str
iam_role_id str
Unique identifier of the role that Atlas can use to access the bucket.
id str
project_id str
role_id str
Unique identifier of the Azure Service Principal that Atlas can use to access the Azure Blob Storage Container.
service_url str
URL that identifies the blob Endpoint of the Azure Blob Storage Account.
tenant_id str
UUID that identifies the Azure Active Directory Tenant ID.
bucketName String
Name of the bucket that the provided role ID is authorized to access.
cloudProvider String
Name of the provider of the cloud service where Atlas can access the S3 bucket.
exportBucketId String
iamRoleId String
Unique identifier of the role that Atlas can use to access the bucket.
id String
projectId String
roleId String
Unique identifier of the Azure Service Principal that Atlas can use to access the Azure Blob Storage Container.
serviceUrl String
URL that identifies the blob Endpoint of the Azure Blob Storage Account.
tenantId String
UUID that identifies the Azure Active Directory Tenant ID.

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.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas