MongoDB Atlas v3.18.0, Sep 12 24

MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi

mongodbatlas.getCloudBackupSnapshotExportBuckets

Explore with Pulumi AI

MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi

# Data Source: mongodbatlas.getCloudBackupSnapshotExportBuckets

mongodbatlas.getCloudBackupSnapshotExportBuckets 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.getCloudBackupSnapshotExportBuckets({
    projectId: "{PROJECT_ID}",
});

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_buckets(project_id="{PROJECT_ID}")

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.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
		}
		_, err = mongodbatlas.LookupCloudBackupSnapshotExportBuckets(ctx, &mongodbatlas.LookupCloudBackupSnapshotExportBucketsArgs{
			ProjectId: "{PROJECT_ID}",
		}, 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 testCloudBackupSnapshotExportBucket = new Mongodbatlas.CloudBackupSnapshotExportBucket("test", new()
    {
        ProjectId = "{PROJECT_ID}",
        IamRoleId = "{IAM_ROLE_ID}",
        BucketName = "example-bucket",
        CloudProvider = "AWS",
    });

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

});

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.GetCloudBackupSnapshotExportBucketsArgs;
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.getCloudBackupSnapshotExportBuckets(GetCloudBackupSnapshotExportBucketsArgs.builder()
            .projectId("{PROJECT_ID}")
            .build());

    }
}

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:getCloudBackupSnapshotExportBuckets
      Arguments:
        projectId: '{PROJECT_ID}'

Using getCloudBackupSnapshotExportBuckets

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 getCloudBackupSnapshotExportBuckets(args: GetCloudBackupSnapshotExportBucketsArgs, opts?: InvokeOptions): Promise<GetCloudBackupSnapshotExportBucketsResult>
function getCloudBackupSnapshotExportBucketsOutput(args: GetCloudBackupSnapshotExportBucketsOutputArgs, opts?: InvokeOptions): Output<GetCloudBackupSnapshotExportBucketsResult>

def get_cloud_backup_snapshot_export_buckets(items_per_page: Optional[int] = None,
                                             page_num: Optional[int] = None,
                                             project_id: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetCloudBackupSnapshotExportBucketsResult
def get_cloud_backup_snapshot_export_buckets_output(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[GetCloudBackupSnapshotExportBucketsResult]

func LookupCloudBackupSnapshotExportBuckets(ctx *Context, args *LookupCloudBackupSnapshotExportBucketsArgs, opts ...InvokeOption) (*LookupCloudBackupSnapshotExportBucketsResult, error)
func LookupCloudBackupSnapshotExportBucketsOutput(ctx *Context, args *LookupCloudBackupSnapshotExportBucketsOutputArgs, opts ...InvokeOption) LookupCloudBackupSnapshotExportBucketsResultOutput

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

public static class GetCloudBackupSnapshotExportBuckets 
{
    public static Task<GetCloudBackupSnapshotExportBucketsResult> InvokeAsync(GetCloudBackupSnapshotExportBucketsArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupSnapshotExportBucketsResult> Invoke(GetCloudBackupSnapshotExportBucketsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCloudBackupSnapshotExportBucketsResult> getCloudBackupSnapshotExportBuckets(GetCloudBackupSnapshotExportBucketsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

ProjectId string: The unique identifier of the project for the Atlas cluster.
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int: The page to return. Defaults to 1.

ProjectId string: The unique identifier of the project for the Atlas cluster.
ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int: The page to return. Defaults to 1.

projectId String: The unique identifier of the project for the Atlas cluster.
itemsPerPage Integer: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum Integer: The page to return. Defaults to 1.

projectId string: The unique identifier of the project for the Atlas cluster.
itemsPerPage number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum number: The page to return. Defaults to 1.

project_id str: The unique identifier of the project for the Atlas cluster.
items_per_page int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
page_num int: The page to return. Defaults to 1.

projectId String: The unique identifier of the project for the Atlas cluster.
itemsPerPage Number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum Number: The page to return. Defaults to 1.

getCloudBackupSnapshotExportBuckets Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

ProjectId string

The unique identifier of the project for the Atlas cluster.

Results List<GetCloudBackupSnapshotExportBucketsResult>

Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

TotalCount int

ItemsPerPage int

PageNum int

Id string

The provider-assigned unique ID for this managed resource.

ProjectId string

The unique identifier of the project for the Atlas cluster.

Results []GetCloudBackupSnapshotExportBucketsResult

Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

TotalCount int

ItemsPerPage int

PageNum int

id String

The provider-assigned unique ID for this managed resource.

projectId String

The unique identifier of the project for the Atlas cluster.

results List<GetCloudBackupSnapshotExportBucketsResult>

Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

totalCount Integer

itemsPerPage Integer

pageNum Integer

id string

The provider-assigned unique ID for this managed resource.

projectId string

The unique identifier of the project for the Atlas cluster.

results GetCloudBackupSnapshotExportBucketsResult[]

Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

totalCount number

itemsPerPage number

pageNum number

id str

The provider-assigned unique ID for this managed resource.

project_id str

The unique identifier of the project for the Atlas cluster.

results Sequence[GetCloudBackupSnapshotExportBucketsResult]

Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

total_count int

items_per_page int

page_num int

id String

The provider-assigned unique ID for this managed resource.

projectId String

The unique identifier of the project for the Atlas cluster.

results List<Property Map>

Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.

totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

totalCount Number

itemsPerPage Number

pageNum Number

Supporting Types

GetCloudBackupSnapshotExportBucketsResult

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: Unique identifier of the snapshot bucket id.
IamRoleId string: Unique identifier of the role that Atlas can use to access the bucket.
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: Unique identifier of the snapshot bucket id.
IamRoleId string: Unique identifier of the role that Atlas can use to access the bucket.
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: Unique identifier of the snapshot bucket id.
iamRoleId String: Unique identifier of the role that Atlas can use to access the bucket.
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: Unique identifier of the snapshot bucket id.
iamRoleId string: Unique identifier of the role that Atlas can use to access the bucket.
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: Unique identifier of the snapshot bucket id.
iam_role_id str: Unique identifier of the role that Atlas can use to access the bucket.
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: Unique identifier of the snapshot bucket id.
iamRoleId String: Unique identifier of the role that Atlas can use to access the bucket.
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.18.0 published on Thursday, Sep 12, 2024 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getCloudBackupSnapshotExportBuckets

On this page

On this page

# Data Source: mongodbatlas.getCloudBackupSnapshotExportBuckets

Example Usage

Using getCloudBackupSnapshotExportBuckets

getCloudBackupSnapshotExportBuckets Result

Supporting Types

GetCloudBackupSnapshotExportBucketsResult

Package Details

On this page

On this page