mongodbatlas.getCloudBackupSnapshotExportBuckets
Explore with Pulumi AI
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
using System.Collections.Generic;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var testCloudBackupSnapshotExportBucket = new Mongodbatlas.CloudBackupSnapshotExportBucket("testCloudBackupSnapshotExportBucket", new()
{
BucketName = "example-bucket",
CloudProvider = "AWS",
IamRoleId = "{IAM_ROLE_ID}",
ProjectId = "{PROJECT_ID}",
});
var testCloudBackupSnapshotExportBuckets = Mongodbatlas.GetCloudBackupSnapshotExportBuckets.Invoke(new()
{
ProjectId = "{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, "testCloudBackupSnapshotExportBucket", &mongodbatlas.CloudBackupSnapshotExportBucketArgs{
BucketName: pulumi.String("example-bucket"),
CloudProvider: pulumi.String("AWS"),
IamRoleId: pulumi.String("{IAM_ROLE_ID}"),
ProjectId: pulumi.String("{PROJECT_ID}"),
})
if err != nil {
return err
}
_, err = mongodbatlas.LookupCloudBackupSnapshotExportBuckets(ctx, &mongodbatlas.LookupCloudBackupSnapshotExportBucketsArgs{
ProjectId: "{PROJECT_ID}",
}, nil)
if err != nil {
return err
}
return nil
})
}
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()
.bucketName("example-bucket")
.cloudProvider("AWS")
.iamRoleId("{IAM_ROLE_ID}")
.projectId("{PROJECT_ID}")
.build());
final var testCloudBackupSnapshotExportBuckets = MongodbatlasFunctions.getCloudBackupSnapshotExportBuckets(GetCloudBackupSnapshotExportBucketsArgs.builder()
.projectId("{PROJECT_ID}")
.build());
}
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test_cloud_backup_snapshot_export_bucket = mongodbatlas.CloudBackupSnapshotExportBucket("testCloudBackupSnapshotExportBucket",
bucket_name="example-bucket",
cloud_provider="AWS",
iam_role_id="{IAM_ROLE_ID}",
project_id="{PROJECT_ID}")
test_cloud_backup_snapshot_export_buckets = mongodbatlas.get_cloud_backup_snapshot_export_buckets(project_id="{PROJECT_ID}")
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const testCloudBackupSnapshotExportBucket = new mongodbatlas.CloudBackupSnapshotExportBucket("testCloudBackupSnapshotExportBucket", {
bucketName: "example-bucket",
cloudProvider: "AWS",
iamRoleId: "{IAM_ROLE_ID}",
projectId: "{PROJECT_ID}",
});
const testCloudBackupSnapshotExportBuckets = mongodbatlas.getCloudBackupSnapshotExportBuckets({
projectId: "{PROJECT_ID}",
});
resources:
testCloudBackupSnapshotExportBucket:
type: mongodbatlas:CloudBackupSnapshotExportBucket
properties:
bucketName: example-bucket
cloudProvider: AWS
iamRoleId: '{IAM_ROLE_ID}'
projectId: '{PROJECT_ID}'
variables:
testCloudBackupSnapshotExportBuckets:
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:
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Items
Per intPage 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
.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Items
Per intPage 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
.
- project
Id String The unique identifier of the project for the Atlas cluster.
- items
Per IntegerPage Number of items to return per page, up to a maximum of 500. Defaults to
100
.- page
Num Integer The page to return. Defaults to
1
.
- project
Id string The unique identifier of the project for the Atlas cluster.
- items
Per numberPage Number of items to return per page, up to a maximum of 500. Defaults to
100
.- page
Num number The page to return. Defaults to
1
.
- project_
id str The unique identifier of the project for the Atlas cluster.
- items_
per_ intpage 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
.
- project
Id String The unique identifier of the project for the Atlas cluster.
- items
Per NumberPage Number of items to return per page, up to a maximum of 500. Defaults to
100
.- page
Num 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.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Results
List<Get
Cloud Backup Snapshot Export Buckets Result> Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.
- Total
Count int - Items
Per intPage - Page
Num int
- Id string
The provider-assigned unique ID for this managed resource.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Results
[]Get
Cloud Backup Snapshot Export Buckets Result Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.
- Total
Count int - Items
Per intPage - Page
Num int
- id String
The provider-assigned unique ID for this managed resource.
- project
Id String The unique identifier of the project for the Atlas cluster.
- results
List<Get
Cloud Backup Snapshot Export Buckets Result> Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.
- total
Count Integer - items
Per IntegerPage - page
Num Integer
- id string
The provider-assigned unique ID for this managed resource.
- project
Id string The unique identifier of the project for the Atlas cluster.
- results
Get
Cloud Backup Snapshot Export Buckets Result[] Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.
- total
Count number - items
Per numberPage - page
Num 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[Get
Cloud Backup Snapshot Export Buckets Result] Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.
- total_
count int - items_
per_ intpage - page_
num int
- id String
The provider-assigned unique ID for this managed resource.
- project
Id 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.
- total
Count Number - items
Per NumberPage - page
Num Number
Supporting Types
GetCloudBackupSnapshotExportBucketsResult
- Bucket
Name string Name of the bucket that the provided role ID is authorized to access. You must also specify the
iam_role_id
.- Cloud
Provider string Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports
AWS
.- Export
Bucket stringId Unique identifier of the snapshot bucket id.
- Iam
Role stringId Unique identifier of the role that Atlas can use to access the bucket. You must also specify the
bucket_name
.
- Bucket
Name string Name of the bucket that the provided role ID is authorized to access. You must also specify the
iam_role_id
.- Cloud
Provider string Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports
AWS
.- Export
Bucket stringId Unique identifier of the snapshot bucket id.
- Iam
Role stringId Unique identifier of the role that Atlas can use to access the bucket. You must also specify the
bucket_name
.
- bucket
Name String Name of the bucket that the provided role ID is authorized to access. You must also specify the
iam_role_id
.- cloud
Provider String Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports
AWS
.- export
Bucket StringId Unique identifier of the snapshot bucket id.
- iam
Role StringId Unique identifier of the role that Atlas can use to access the bucket. You must also specify the
bucket_name
.
- bucket
Name string Name of the bucket that the provided role ID is authorized to access. You must also specify the
iam_role_id
.- cloud
Provider string Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports
AWS
.- export
Bucket stringId Unique identifier of the snapshot bucket id.
- iam
Role stringId Unique identifier of the role that Atlas can use to access the bucket. You must also specify the
bucket_name
.
- bucket_
name str Name of the bucket that the provided role ID is authorized to access. You must also specify the
iam_role_id
.- cloud_
provider str Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports
AWS
.- export_
bucket_ strid Unique identifier of the snapshot bucket id.
- iam_
role_ strid Unique identifier of the role that Atlas can use to access the bucket. You must also specify the
bucket_name
.
- bucket
Name String Name of the bucket that the provided role ID is authorized to access. You must also specify the
iam_role_id
.- cloud
Provider String Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports
AWS
.- export
Bucket StringId Unique identifier of the snapshot bucket id.
- iam
Role StringId Unique identifier of the role that Atlas can use to access the bucket. You must also specify the
bucket_name
.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlas
Terraform Provider.