1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getDataLakePipelineRuns
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.getDataLakePipelineRuns

Explore with Pulumi AI

WARNING: Data Lake is deprecated. To learn more, see https://dochub.mongodb.org/core/data-lake-deprecation

mongodbatlas.getDataLakePipelineRun describes Data Lake Pipeline Runs.

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

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.DataLakePipeline;
import com.pulumi.mongodbatlas.DataLakePipelineArgs;
import com.pulumi.mongodbatlas.inputs.DataLakePipelineSinkArgs;
import com.pulumi.mongodbatlas.inputs.DataLakePipelineSourceArgs;
import com.pulumi.mongodbatlas.inputs.DataLakePipelineTransformationArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetDataLakePipelineRunsArgs;
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 pipeline = new DataLakePipeline("pipeline", DataLakePipelineArgs.builder()
            .projectId(projectTest.projectId())
            .name("DataLakePipelineName")
            .sink(DataLakePipelineSinkArgs.builder()
                .type("DLS")
                .partitionFields(DataLakePipelineSinkPartitionFieldArgs.builder()
                    .name("access")
                    .order(0)
                    .build())
                .build())
            .source(DataLakePipelineSourceArgs.builder()
                .type("ON_DEMAND_CPS")
                .clusterName(clusterTest.name())
                .databaseName("sample_airbnb")
                .collectionName("listingsAndReviews")
                .build())
            .transformations(            
                DataLakePipelineTransformationArgs.builder()
                    .field("test")
                    .type("EXCLUDE")
                    .build(),
                DataLakePipelineTransformationArgs.builder()
                    .field("test22")
                    .type("EXCLUDE")
                    .build())
            .build());

        final var test = MongodbatlasFunctions.getDataLakePipelineRuns(GetDataLakePipelineRunsArgs.builder()
            .projectId(projectTest.projectId())
            .pipelineName(pipeline.name())
            .build());

    }
}
Copy
resources:
  pipeline:
    type: mongodbatlas:DataLakePipeline
    properties:
      projectId: ${projectTest.projectId}
      name: DataLakePipelineName
      sink:
        type: DLS
        partitionFields:
          - name: access
            order: 0
      source:
        type: ON_DEMAND_CPS
        clusterName: ${clusterTest.name}
        databaseName: sample_airbnb
        collectionName: listingsAndReviews
      transformations:
        - field: test
          type: EXCLUDE
        - field: test22
          type: EXCLUDE
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getDataLakePipelineRuns
      arguments:
        projectId: ${projectTest.projectId}
        pipelineName: ${pipeline.name}
Copy

Using getDataLakePipelineRuns

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 getDataLakePipelineRuns(args: GetDataLakePipelineRunsArgs, opts?: InvokeOptions): Promise<GetDataLakePipelineRunsResult>
function getDataLakePipelineRunsOutput(args: GetDataLakePipelineRunsOutputArgs, opts?: InvokeOptions): Output<GetDataLakePipelineRunsResult>
Copy
def get_data_lake_pipeline_runs(pipeline_name: Optional[str] = None,
                                project_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetDataLakePipelineRunsResult
def get_data_lake_pipeline_runs_output(pipeline_name: Optional[pulumi.Input[str]] = None,
                                project_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetDataLakePipelineRunsResult]
Copy
func LookupDataLakePipelineRuns(ctx *Context, args *LookupDataLakePipelineRunsArgs, opts ...InvokeOption) (*LookupDataLakePipelineRunsResult, error)
func LookupDataLakePipelineRunsOutput(ctx *Context, args *LookupDataLakePipelineRunsOutputArgs, opts ...InvokeOption) LookupDataLakePipelineRunsResultOutput
Copy

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

public static class GetDataLakePipelineRuns 
{
    public static Task<GetDataLakePipelineRunsResult> InvokeAsync(GetDataLakePipelineRunsArgs args, InvokeOptions? opts = null)
    public static Output<GetDataLakePipelineRunsResult> Invoke(GetDataLakePipelineRunsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDataLakePipelineRunsResult> getDataLakePipelineRuns(GetDataLakePipelineRunsArgs args, InvokeOptions options)
public static Output<GetDataLakePipelineRunsResult> getDataLakePipelineRuns(GetDataLakePipelineRunsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getDataLakePipelineRuns:getDataLakePipelineRuns
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PipelineName This property is required. string
Human-readable label that identifies the Data Lake Pipeline.
ProjectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project.
PipelineName This property is required. string
Human-readable label that identifies the Data Lake Pipeline.
ProjectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project.
pipelineName This property is required. String
Human-readable label that identifies the Data Lake Pipeline.
projectId This property is required. String
Unique 24-hexadecimal digit string that identifies your project.
pipelineName This property is required. string
Human-readable label that identifies the Data Lake Pipeline.
projectId This property is required. string
Unique 24-hexadecimal digit string that identifies your project.
pipeline_name This property is required. str
Human-readable label that identifies the Data Lake Pipeline.
project_id This property is required. str
Unique 24-hexadecimal digit string that identifies your project.
pipelineName This property is required. String
Human-readable label that identifies the Data Lake Pipeline.
projectId This property is required. String
Unique 24-hexadecimal digit string that identifies your project.

getDataLakePipelineRuns Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
PipelineName string
ProjectId string
Results List<GetDataLakePipelineRunsResult>
A list where each represents a Data Lake Pipeline Run.
Id string
The provider-assigned unique ID for this managed resource.
PipelineName string
ProjectId string
Results []GetDataLakePipelineRunsResult
A list where each represents a Data Lake Pipeline Run.
id String
The provider-assigned unique ID for this managed resource.
pipelineName String
projectId String
results List<GetDataLakePipelineRunsResult>
A list where each represents a Data Lake Pipeline Run.
id string
The provider-assigned unique ID for this managed resource.
pipelineName string
projectId string
results GetDataLakePipelineRunsResult[]
A list where each represents a Data Lake Pipeline Run.
id str
The provider-assigned unique ID for this managed resource.
pipeline_name str
project_id str
results Sequence[GetDataLakePipelineRunsResult]
A list where each represents a Data Lake Pipeline Run.
id String
The provider-assigned unique ID for this managed resource.
pipelineName String
projectId String
results List<Property Map>
A list where each represents a Data Lake Pipeline Run.

Supporting Types

GetDataLakePipelineRunsResult

BackupFrequencyType This property is required. string
Backup schedule interval of the Data Lake Pipeline.
CreatedDate This property is required. string
Timestamp that indicates when the pipeline run was created.
Id This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
LastUpdatedDate This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
Phase This property is required. string
Processing phase of the Data Lake Pipeline.
PipelineId This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
PipelineRunId This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
SnapshotId This property is required. string
Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
State This property is required. string
State of the pipeline run.
Stats This property is required. List<GetDataLakePipelineRunsResultStat>
Runtime statistics for this Data Lake Pipeline run.
BackupFrequencyType This property is required. string
Backup schedule interval of the Data Lake Pipeline.
CreatedDate This property is required. string
Timestamp that indicates when the pipeline run was created.
Id This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
LastUpdatedDate This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
Phase This property is required. string
Processing phase of the Data Lake Pipeline.
PipelineId This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
PipelineRunId This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
SnapshotId This property is required. string
Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
State This property is required. string
State of the pipeline run.
Stats This property is required. []GetDataLakePipelineRunsResultStat
Runtime statistics for this Data Lake Pipeline run.
backupFrequencyType This property is required. String
Backup schedule interval of the Data Lake Pipeline.
createdDate This property is required. String
Timestamp that indicates when the pipeline run was created.
id This property is required. String
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
lastUpdatedDate This property is required. String
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
phase This property is required. String
Processing phase of the Data Lake Pipeline.
pipelineId This property is required. String
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
pipelineRunId This property is required. String
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
snapshotId This property is required. String
Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
state This property is required. String
State of the pipeline run.
stats This property is required. List<GetDataLakePipelineRunsResultStat>
Runtime statistics for this Data Lake Pipeline run.
backupFrequencyType This property is required. string
Backup schedule interval of the Data Lake Pipeline.
createdDate This property is required. string
Timestamp that indicates when the pipeline run was created.
id This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
lastUpdatedDate This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
phase This property is required. string
Processing phase of the Data Lake Pipeline.
pipelineId This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
pipelineRunId This property is required. string
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
snapshotId This property is required. string
Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
state This property is required. string
State of the pipeline run.
stats This property is required. GetDataLakePipelineRunsResultStat[]
Runtime statistics for this Data Lake Pipeline run.
backup_frequency_type This property is required. str
Backup schedule interval of the Data Lake Pipeline.
created_date This property is required. str
Timestamp that indicates when the pipeline run was created.
id This property is required. str
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
last_updated_date This property is required. str
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
phase This property is required. str
Processing phase of the Data Lake Pipeline.
pipeline_id This property is required. str
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
pipeline_run_id This property is required. str
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
snapshot_id This property is required. str
Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
state This property is required. str
State of the pipeline run.
stats This property is required. Sequence[GetDataLakePipelineRunsResultStat]
Runtime statistics for this Data Lake Pipeline run.
backupFrequencyType This property is required. String
Backup schedule interval of the Data Lake Pipeline.
createdDate This property is required. String
Timestamp that indicates when the pipeline run was created.
id This property is required. String
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
lastUpdatedDate This property is required. String
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
phase This property is required. String
Processing phase of the Data Lake Pipeline.
pipelineId This property is required. String
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
pipelineRunId This property is required. String
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
snapshotId This property is required. String
Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
state This property is required. String
State of the pipeline run.
stats This property is required. List<Property Map>
Runtime statistics for this Data Lake Pipeline run.

GetDataLakePipelineRunsResultStat

BytesExported This property is required. int
Total data size in bytes exported for this pipeline run.
NumDocs This property is required. int
Number of docs ingested for a this pipeline run.
BytesExported This property is required. int
Total data size in bytes exported for this pipeline run.
NumDocs This property is required. int
Number of docs ingested for a this pipeline run.
bytesExported This property is required. Integer
Total data size in bytes exported for this pipeline run.
numDocs This property is required. Integer
Number of docs ingested for a this pipeline run.
bytesExported This property is required. number
Total data size in bytes exported for this pipeline run.
numDocs This property is required. number
Number of docs ingested for a this pipeline run.
bytes_exported This property is required. int
Total data size in bytes exported for this pipeline run.
num_docs This property is required. int
Number of docs ingested for a this pipeline run.
bytesExported This property is required. Number
Total data size in bytes exported for this pipeline run.
numDocs This property is required. Number
Number of docs ingested for a this pipeline run.

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.