MongoDB Atlas

Pulumi Official
Package maintained by Pulumi
v3.5.0 published on Wednesday, Jul 20, 2022 by Pulumi

getCloudBackupSnapshotExportJobs

mongodbatlas.getCloudBackupSnapshotExportJobs 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 Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var testCloudBackupSnapshotExportBucket = new Mongodbatlas.CloudBackupSnapshotExportBucket("testCloudBackupSnapshotExportBucket", new Mongodbatlas.CloudBackupSnapshotExportBucketArgs
        {
            ProjectId = "{PROJECT_ID}",
            IamRoleId = "{IAM_ROLE_ID}",
            BucketName = "example_bucket",
            CloudProvider = "AWS",
        });
        var testCloudBackupSnapshotExportJob = new Mongodbatlas.CloudBackupSnapshotExportJob("testCloudBackupSnapshotExportJob", new Mongodbatlas.CloudBackupSnapshotExportJobArgs
        {
            ProjectId = "{PROJECT_ID}",
            ClusterName = "{CLUSTER_NAME}",
            SnapshotId = "{SNAPSHOT_ID}",
            ExportBucketId = testCloudBackupSnapshotExportBucket.ExportBucketId,
            CustomDatas = 
            {
                new Mongodbatlas.Inputs.CloudBackupSnapshotExportJobCustomDataArgs
                {
                    Key = "exported by",
                    Value = "myName",
                },
            },
        });
        var testCloudBackupSnapshotExportJobs = Output.Create(Mongodbatlas.GetCloudBackupSnapshotExportJobs.InvokeAsync(new Mongodbatlas.GetCloudBackupSnapshotExportJobsArgs
        {
            ProjectId = "{PROJECT_ID}",
            ClusterName = "{CLUSTER_NAME}",
        }));
    }

}
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, "testCloudBackupSnapshotExportBucket", &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.NewCloudBackupSnapshotExportJob(ctx, "testCloudBackupSnapshotExportJob", &mongodbatlas.CloudBackupSnapshotExportJobArgs{
			ProjectId:      pulumi.String("{PROJECT_ID}"),
			ClusterName:    pulumi.String("{CLUSTER_NAME}"),
			SnapshotId:     pulumi.String("{SNAPSHOT_ID}"),
			ExportBucketId: testCloudBackupSnapshotExportBucket.ExportBucketId,
			CustomDatas: CloudBackupSnapshotExportJobCustomDataArray{
				&CloudBackupSnapshotExportJobCustomDataArgs{
					Key:   pulumi.String("exported by"),
					Value: pulumi.String("myName"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = mongodbatlas.LookupCloudBackupSnapshotExportJobs(ctx, &GetCloudBackupSnapshotExportJobsArgs{
			ProjectId:   "{PROJECT_ID}",
			ClusterName: "{CLUSTER_NAME}",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_cloud_backup_snapshot_export_bucket = mongodbatlas.CloudBackupSnapshotExportBucket("testCloudBackupSnapshotExportBucket",
    project_id="{PROJECT_ID}",
    iam_role_id="{IAM_ROLE_ID}",
    bucket_name="example_bucket",
    cloud_provider="AWS")
test_cloud_backup_snapshot_export_job = mongodbatlas.CloudBackupSnapshotExportJob("testCloudBackupSnapshotExportJob",
    project_id="{PROJECT_ID}",
    cluster_name="{CLUSTER_NAME}",
    snapshot_id="{SNAPSHOT_ID}",
    export_bucket_id=test_cloud_backup_snapshot_export_bucket.export_bucket_id,
    custom_datas=[mongodbatlas.CloudBackupSnapshotExportJobCustomDataArgs(
        key="exported by",
        value="myName",
    )])
test_cloud_backup_snapshot_export_jobs = mongodbatlas.get_cloud_backup_snapshot_export_jobs(project_id="{PROJECT_ID}",
    cluster_name="{CLUSTER_NAME}")
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testCloudBackupSnapshotExportBucket = new mongodbatlas.CloudBackupSnapshotExportBucket("testCloudBackupSnapshotExportBucket", {
    projectId: "{PROJECT_ID}",
    iamRoleId: "{IAM_ROLE_ID}",
    bucketName: "example_bucket",
    cloudProvider: "AWS",
});
const testCloudBackupSnapshotExportJob = new mongodbatlas.CloudBackupSnapshotExportJob("testCloudBackupSnapshotExportJob", {
    projectId: "{PROJECT_ID}",
    clusterName: "{CLUSTER_NAME}",
    snapshotId: "{SNAPSHOT_ID}",
    exportBucketId: testCloudBackupSnapshotExportBucket.exportBucketId,
    customDatas: [{
        key: "exported by",
        value: "myName",
    }],
});
const testCloudBackupSnapshotExportJobs = mongodbatlas.getCloudBackupSnapshotExportJobs({
    projectId: "{PROJECT_ID}",
    clusterName: "{CLUSTER_NAME}",
});

Coming soon!

Using getCloudBackupSnapshotExportJobs

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 getCloudBackupSnapshotExportJobs(args: GetCloudBackupSnapshotExportJobsArgs, opts?: InvokeOptions): Promise<GetCloudBackupSnapshotExportJobsResult>
function getCloudBackupSnapshotExportJobsOutput(args: GetCloudBackupSnapshotExportJobsOutputArgs, opts?: InvokeOptions): Output<GetCloudBackupSnapshotExportJobsResult>
def get_cloud_backup_snapshot_export_jobs(cluster_name: Optional[str] = None,
                                          items_per_page: Optional[int] = None,
                                          page_num: Optional[int] = None,
                                          project_id: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetCloudBackupSnapshotExportJobsResult
def get_cloud_backup_snapshot_export_jobs_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                          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[GetCloudBackupSnapshotExportJobsResult]
func LookupCloudBackupSnapshotExportJobs(ctx *Context, args *LookupCloudBackupSnapshotExportJobsArgs, opts ...InvokeOption) (*LookupCloudBackupSnapshotExportJobsResult, error)
func LookupCloudBackupSnapshotExportJobsOutput(ctx *Context, args *LookupCloudBackupSnapshotExportJobsOutputArgs, opts ...InvokeOption) LookupCloudBackupSnapshotExportJobsResultOutput

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

public static class GetCloudBackupSnapshotExportJobs 
{
    public static Task<GetCloudBackupSnapshotExportJobsResult> InvokeAsync(GetCloudBackupSnapshotExportJobsArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupSnapshotExportJobsResult> Invoke(GetCloudBackupSnapshotExportJobsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCloudBackupSnapshotExportJobsResult> getCloudBackupSnapshotExportJobs(GetCloudBackupSnapshotExportJobsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: mongodbatlas:index/getCloudBackupSnapshotExportJobs:getCloudBackupSnapshotExportJobs
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ClusterName string

Name of the Atlas cluster whose export job you want to retrieve.

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.

ClusterName string

Name of the Atlas cluster whose export job you want to retrieve.

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.

clusterName String

Name of the Atlas cluster whose export job you want to retrieve.

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.

clusterName string

Name of the Atlas cluster whose export job you want to retrieve.

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.

cluster_name str

Name of the Atlas cluster whose export job you want to retrieve.

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.

clusterName String

Name of the Atlas cluster whose export job you want to retrieve.

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.

getCloudBackupSnapshotExportJobs Result

The following output properties are available:

ClusterName string
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<GetCloudBackupSnapshotExportJobsResult>

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

TotalCount int
ItemsPerPage int
PageNum int
ClusterName string
Id string

The provider-assigned unique ID for this managed resource.

ProjectId string

The unique identifier of the project for the Atlas cluster.

Results []GetCloudBackupSnapshotExportJobsResult

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

TotalCount int
ItemsPerPage int
PageNum int
clusterName String
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<GetCloudBackupSnapshotExportJobsResult>

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

totalCount Integer
itemsPerPage Integer
pageNum Integer
clusterName string
id string

The provider-assigned unique ID for this managed resource.

projectId string

The unique identifier of the project for the Atlas cluster.

results GetCloudBackupSnapshotExportJobsResult[]

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

totalCount number
itemsPerPage number
pageNum number
cluster_name str
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[GetCloudBackupSnapshotExportJobsResult]

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

total_count int
items_per_page int
page_num int
clusterName String
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 CloudProviderSnapshotExportJob object for each item detailed in the results array section.

totalCount Number
itemsPerPage Number
pageNum Number

Supporting Types

GetCloudBackupSnapshotExportJobsResult

Components List<GetCloudBackupSnapshotExportJobsResultComponent>

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

CreatedAt string

Timestamp in ISO 8601 date and time format in UTC when the export job was created.

CustomDatas List<GetCloudBackupSnapshotExportJobsResultCustomData>

Custom data to include in the metadata file named .complete that Atlas uploads to the bucket when the export job finishes. Custom data can be specified as key and value pairs.

ErrMsg string

Error message, only if the export job failed.

ExportBucketId string

Unique identifier of the AWS bucket to export the Cloud Backup snapshot to.

ExportJobId string

Unique identifier of the export job.

  • prefix - Full path on the cloud provider bucket to the folder where the snapshot is exported. The path is in the following format:/exported_snapshots/{ORG-NAME}/{PROJECT-NAME}/{CLUSTER-NAME}/{SNAPSHOT-INITIATION-DATE}/{TIMESTAMP}
ExportStatusExportedCollections int
ExportStatusTotalCollections int
FinishedAt string

Timestamp in ISO 8601 date and time format in UTC when the export job completes.

Prefix string
SnapshotId string

Unique identifier of the Cloud Backup snapshot to export.

State string

Status of the export job. Value can be one of the following:

Components []GetCloudBackupSnapshotExportJobsResultComponent

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

CreatedAt string

Timestamp in ISO 8601 date and time format in UTC when the export job was created.

CustomDatas []GetCloudBackupSnapshotExportJobsResultCustomData

Custom data to include in the metadata file named .complete that Atlas uploads to the bucket when the export job finishes. Custom data can be specified as key and value pairs.

ErrMsg string

Error message, only if the export job failed.

ExportBucketId string

Unique identifier of the AWS bucket to export the Cloud Backup snapshot to.

ExportJobId string

Unique identifier of the export job.

  • prefix - Full path on the cloud provider bucket to the folder where the snapshot is exported. The path is in the following format:/exported_snapshots/{ORG-NAME}/{PROJECT-NAME}/{CLUSTER-NAME}/{SNAPSHOT-INITIATION-DATE}/{TIMESTAMP}
ExportStatusExportedCollections int
ExportStatusTotalCollections int
FinishedAt string

Timestamp in ISO 8601 date and time format in UTC when the export job completes.

Prefix string
SnapshotId string

Unique identifier of the Cloud Backup snapshot to export.

State string

Status of the export job. Value can be one of the following:

components List<GetCloudBackupSnapshotExportJobsResultComponent>

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

createdAt String

Timestamp in ISO 8601 date and time format in UTC when the export job was created.

customDatas List<GetCloudBackupSnapshotExportJobsResultCustomData>

Custom data to include in the metadata file named .complete that Atlas uploads to the bucket when the export job finishes. Custom data can be specified as key and value pairs.

errMsg String

Error message, only if the export job failed.

exportBucketId String

Unique identifier of the AWS bucket to export the Cloud Backup snapshot to.

exportJobId String

Unique identifier of the export job.

  • prefix - Full path on the cloud provider bucket to the folder where the snapshot is exported. The path is in the following format:/exported_snapshots/{ORG-NAME}/{PROJECT-NAME}/{CLUSTER-NAME}/{SNAPSHOT-INITIATION-DATE}/{TIMESTAMP}
exportStatusExportedCollections Integer
exportStatusTotalCollections Integer
finishedAt String

Timestamp in ISO 8601 date and time format in UTC when the export job completes.

prefix String
snapshotId String

Unique identifier of the Cloud Backup snapshot to export.

state String

Status of the export job. Value can be one of the following:

components GetCloudBackupSnapshotExportJobsResultComponent[]

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

createdAt string

Timestamp in ISO 8601 date and time format in UTC when the export job was created.

customDatas GetCloudBackupSnapshotExportJobsResultCustomData[]

Custom data to include in the metadata file named .complete that Atlas uploads to the bucket when the export job finishes. Custom data can be specified as key and value pairs.

errMsg string

Error message, only if the export job failed.

exportBucketId string

Unique identifier of the AWS bucket to export the Cloud Backup snapshot to.

exportJobId string

Unique identifier of the export job.

  • prefix - Full path on the cloud provider bucket to the folder where the snapshot is exported. The path is in the following format:/exported_snapshots/{ORG-NAME}/{PROJECT-NAME}/{CLUSTER-NAME}/{SNAPSHOT-INITIATION-DATE}/{TIMESTAMP}
exportStatusExportedCollections number
exportStatusTotalCollections number
finishedAt string

Timestamp in ISO 8601 date and time format in UTC when the export job completes.

prefix string
snapshotId string

Unique identifier of the Cloud Backup snapshot to export.

state string

Status of the export job. Value can be one of the following:

components Sequence[GetCloudBackupSnapshotExportJobsResultComponent]

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

created_at str

Timestamp in ISO 8601 date and time format in UTC when the export job was created.

custom_datas Sequence[GetCloudBackupSnapshotExportJobsResultCustomData]

Custom data to include in the metadata file named .complete that Atlas uploads to the bucket when the export job finishes. Custom data can be specified as key and value pairs.

err_msg str

Error message, only if the export job failed.

export_bucket_id str

Unique identifier of the AWS bucket to export the Cloud Backup snapshot to.

export_job_id str

Unique identifier of the export job.

  • prefix - Full path on the cloud provider bucket to the folder where the snapshot is exported. The path is in the following format:/exported_snapshots/{ORG-NAME}/{PROJECT-NAME}/{CLUSTER-NAME}/{SNAPSHOT-INITIATION-DATE}/{TIMESTAMP}
export_status_exported_collections int
export_status_total_collections int
finished_at str

Timestamp in ISO 8601 date and time format in UTC when the export job completes.

prefix str
snapshot_id str

Unique identifier of the Cloud Backup snapshot to export.

state str

Status of the export job. Value can be one of the following:

components List<Property Map>

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

createdAt String

Timestamp in ISO 8601 date and time format in UTC when the export job was created.

customDatas List<Property Map>

Custom data to include in the metadata file named .complete that Atlas uploads to the bucket when the export job finishes. Custom data can be specified as key and value pairs.

errMsg String

Error message, only if the export job failed.

exportBucketId String

Unique identifier of the AWS bucket to export the Cloud Backup snapshot to.

exportJobId String

Unique identifier of the export job.

  • prefix - Full path on the cloud provider bucket to the folder where the snapshot is exported. The path is in the following format:/exported_snapshots/{ORG-NAME}/{PROJECT-NAME}/{CLUSTER-NAME}/{SNAPSHOT-INITIATION-DATE}/{TIMESTAMP}
exportStatusExportedCollections Number
exportStatusTotalCollections Number
finishedAt String

Timestamp in ISO 8601 date and time format in UTC when the export job completes.

prefix String
snapshotId String

Unique identifier of the Cloud Backup snapshot to export.

state String

Status of the export job. Value can be one of the following:

GetCloudBackupSnapshotExportJobsResultComponent

ExportId string

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

ReplicaSetName string

Returned for sharded clusters only. Unique identifier of the export job for the replica set.

ExportId string

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

ReplicaSetName string

Returned for sharded clusters only. Unique identifier of the export job for the replica set.

exportId String

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

replicaSetName String

Returned for sharded clusters only. Unique identifier of the export job for the replica set.

exportId string

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

replicaSetName string

Returned for sharded clusters only. Unique identifier of the export job for the replica set.

export_id str

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

replica_set_name str

Returned for sharded clusters only. Unique identifier of the export job for the replica set.

exportId String

Returned for sharded clusters only. Export job details for each replica set in the sharded cluster.

replicaSetName String

Returned for sharded clusters only. Unique identifier of the export job for the replica set.

GetCloudBackupSnapshotExportJobsResultCustomData

Key string

Custom data specified as key in the key and value pair.

Value string

Value for the key specified using key.

Key string

Custom data specified as key in the key and value pair.

Value string

Value for the key specified using key.

key String

Custom data specified as key in the key and value pair.

value String

Value for the key specified using key.

key string

Custom data specified as key in the key and value pair.

value string

Value for the key specified using key.

key str

Custom data specified as key in the key and value pair.

value str

Value for the key specified using key.

key String

Custom data specified as key in the key and value pair.

value String

Value for the key specified using key.

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.