Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getCloudBackupSnapshotExportJob
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getCloudBackupSnapshotExportJob

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    mongodbatlas.CloudBackupSnapshotExportJob datasource allows you to retrieve a snapshot export job for the specified project and cluster.

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

    Using getCloudBackupSnapshotExportJob

    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 getCloudBackupSnapshotExportJob(args: GetCloudBackupSnapshotExportJobArgs, opts?: InvokeOptions): Promise<GetCloudBackupSnapshotExportJobResult>
function getCloudBackupSnapshotExportJobOutput(args: GetCloudBackupSnapshotExportJobOutputArgs, opts?: InvokeOptions): Output<GetCloudBackupSnapshotExportJobResult>
    def get_cloud_backup_snapshot_export_job(cluster_name: Optional[str] = None,
                                         export_job_id: Optional[str] = None,
                                         id: Optional[str] = None,
                                         project_id: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetCloudBackupSnapshotExportJobResult
def get_cloud_backup_snapshot_export_job_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                         export_job_id: Optional[pulumi.Input[str]] = None,
                                         id: Optional[pulumi.Input[str]] = None,
                                         project_id: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetCloudBackupSnapshotExportJobResult]
    func LookupCloudBackupSnapshotExportJob(ctx *Context, args *LookupCloudBackupSnapshotExportJobArgs, opts ...InvokeOption) (*LookupCloudBackupSnapshotExportJobResult, error)
func LookupCloudBackupSnapshotExportJobOutput(ctx *Context, args *LookupCloudBackupSnapshotExportJobOutputArgs, opts ...InvokeOption) LookupCloudBackupSnapshotExportJobResultOutput

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

    public static class GetCloudBackupSnapshotExportJob 
{
    public static Task<GetCloudBackupSnapshotExportJobResult> InvokeAsync(GetCloudBackupSnapshotExportJobArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupSnapshotExportJobResult> Invoke(GetCloudBackupSnapshotExportJobInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCloudBackupSnapshotExportJobResult> getCloudBackupSnapshotExportJob(GetCloudBackupSnapshotExportJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    ClusterName string
    Name of the Atlas cluster whose export job you want to retrieve.
    ExportJobId string
    Unique identifier of the export job to retrieve.
    Id string
    ProjectId string
    Unique 24-hexadecimal digit string that identifies the project which contains the Atlas cluster whose snapshot you want to retrieve.
    ClusterName string
    Name of the Atlas cluster whose export job you want to retrieve.
    ExportJobId string
    Unique identifier of the export job to retrieve.
    Id string
    ProjectId string
    Unique 24-hexadecimal digit string that identifies the project which contains the Atlas cluster whose snapshot you want to retrieve.
    clusterName String
    Name of the Atlas cluster whose export job you want to retrieve.
    exportJobId String
    Unique identifier of the export job to retrieve.
    id String
    projectId String
    Unique 24-hexadecimal digit string that identifies the project which contains the Atlas cluster whose snapshot you want to retrieve.
    clusterName string
    Name of the Atlas cluster whose export job you want to retrieve.
    exportJobId string
    Unique identifier of the export job to retrieve.
    id string
    projectId string
    Unique 24-hexadecimal digit string that identifies the project which contains the Atlas cluster whose snapshot you want to retrieve.
    cluster_name str
    Name of the Atlas cluster whose export job you want to retrieve.
    export_job_id str
    Unique identifier of the export job to retrieve.
    id str
    project_id str
    Unique 24-hexadecimal digit string that identifies the project which contains the Atlas cluster whose snapshot you want to retrieve.
    clusterName String
    Name of the Atlas cluster whose export job you want to retrieve.
    exportJobId String
    Unique identifier of the export job to retrieve.
    id String
    projectId String
    Unique 24-hexadecimal digit string that identifies the project which contains the Atlas cluster whose snapshot you want to retrieve.

    getCloudBackupSnapshotExportJob Result

    The following output properties are available:

    ClusterName string
    Components List<GetCloudBackupSnapshotExportJobComponent>
    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<GetCloudBackupSnapshotExportJobCustomData>
    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.
    Id string
    Prefix string
    ProjectId 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:
    ClusterName string
    Components []GetCloudBackupSnapshotExportJobComponent
    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 []GetCloudBackupSnapshotExportJobCustomData
    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.
    Id string
    Prefix string
    ProjectId 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:
    clusterName String
    components List<GetCloudBackupSnapshotExportJobComponent>
    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<GetCloudBackupSnapshotExportJobCustomData>
    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.
    id String
    prefix String
    projectId 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:
    clusterName string
    components GetCloudBackupSnapshotExportJobComponent[]
    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 GetCloudBackupSnapshotExportJobCustomData[]
    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.
    id string
    prefix string
    projectId 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:
    cluster_name str
    components Sequence[GetCloudBackupSnapshotExportJobComponent]
    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[GetCloudBackupSnapshotExportJobCustomData]
    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.
    id str
    prefix str
    project_id 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:
    clusterName String
    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.
    id String
    prefix String
    projectId 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:

    Supporting Types

    GetCloudBackupSnapshotExportJobComponent

    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.

    GetCloudBackupSnapshotExportJobCustomData

    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
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas