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

mongodbatlas.getDataLakePipelines

Explore with Pulumi AI

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

    mongodbatlas.getDataLakePipelines describes Data Lake Pipelines.

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

    Example Usage

    Using getDataLakePipelines

    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 getDataLakePipelines(args: GetDataLakePipelinesArgs, opts?: InvokeOptions): Promise<GetDataLakePipelinesResult>
function getDataLakePipelinesOutput(args: GetDataLakePipelinesOutputArgs, opts?: InvokeOptions): Output<GetDataLakePipelinesResult>
    def get_data_lake_pipelines(project_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetDataLakePipelinesResult
def get_data_lake_pipelines_output(project_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetDataLakePipelinesResult]
    func LookupDataLakePipelines(ctx *Context, args *LookupDataLakePipelinesArgs, opts ...InvokeOption) (*LookupDataLakePipelinesResult, error)
func LookupDataLakePipelinesOutput(ctx *Context, args *LookupDataLakePipelinesOutputArgs, opts ...InvokeOption) LookupDataLakePipelinesResultOutput

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

    public static class GetDataLakePipelines 
{
    public static Task<GetDataLakePipelinesResult> InvokeAsync(GetDataLakePipelinesArgs args, InvokeOptions? opts = null)
    public static Output<GetDataLakePipelinesResult> Invoke(GetDataLakePipelinesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDataLakePipelinesResult> getDataLakePipelines(GetDataLakePipelinesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    ProjectId string
    The unique ID for the project to create a data lake pipeline.
    ProjectId string
    The unique ID for the project to create a data lake pipeline.
    projectId String
    The unique ID for the project to create a data lake pipeline.
    projectId string
    The unique ID for the project to create a data lake pipeline.
    project_id str
    The unique ID for the project to create a data lake pipeline.
    projectId String
    The unique ID for the project to create a data lake pipeline.

    getDataLakePipelines Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Unique 24-hexadecimal character string that identifies the project.
    Results List<GetDataLakePipelinesResult>
    A list where each represents a Data Lake Pipeline.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Unique 24-hexadecimal character string that identifies the project.
    Results []GetDataLakePipelinesResult
    A list where each represents a Data Lake Pipeline.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    Unique 24-hexadecimal character string that identifies the project.
    results List<GetDataLakePipelinesResult>
    A list where each represents a Data Lake Pipeline.
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    Unique 24-hexadecimal character string that identifies the project.
    results GetDataLakePipelinesResult[]
    A list where each represents a Data Lake Pipeline.
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    Unique 24-hexadecimal character string that identifies the project.
    results Sequence[GetDataLakePipelinesResult]
    A list where each represents a Data Lake Pipeline.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    Unique 24-hexadecimal character string that identifies the project.
    results List<Property Map>
    A list where each represents a Data Lake Pipeline.

    Supporting Types

    GetDataLakePipelinesResult

    CreatedDate string
    Timestamp that indicates when the Data Lake Pipeline was created.
    Id string
    Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
    LastUpdatedDate string
    Timestamp that indicates the last time that the Data Lake Pipeline was updated.
    Name string
    ProjectId string
    The unique ID for the project to create a data lake pipeline.
    Sinks List<GetDataLakePipelinesResultSink>
    Sources List<GetDataLakePipelinesResultSource>
    State string
    State of this Data Lake Pipeline.
    Transformations List<GetDataLakePipelinesResultTransformation>
    Fields to be excluded for this Data Lake Pipeline.

    • transformations.#.field - Key in the document.
    • transformations.#.type - Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
    CreatedDate string
    Timestamp that indicates when the Data Lake Pipeline was created.
    Id string
    Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
    LastUpdatedDate string
    Timestamp that indicates the last time that the Data Lake Pipeline was updated.
    Name string
    ProjectId string
    The unique ID for the project to create a data lake pipeline.
    Sinks []GetDataLakePipelinesResultSink
    Sources []GetDataLakePipelinesResultSource
    State string
    State of this Data Lake Pipeline.
    Transformations []GetDataLakePipelinesResultTransformation
    Fields to be excluded for this Data Lake Pipeline.

    • transformations.#.field - Key in the document.
    • transformations.#.type - Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
    createdDate String
    Timestamp that indicates when the Data Lake Pipeline was created.
    id String
    Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
    lastUpdatedDate String
    Timestamp that indicates the last time that the Data Lake Pipeline was updated.
    name String
    projectId String
    The unique ID for the project to create a data lake pipeline.
    sinks List<GetDataLakePipelinesResultSink>
    sources List<GetDataLakePipelinesResultSource>
    state String
    State of this Data Lake Pipeline.
    transformations List<GetDataLakePipelinesResultTransformation>
    Fields to be excluded for this Data Lake Pipeline.

    • transformations.#.field - Key in the document.
    • transformations.#.type - Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
    createdDate string
    Timestamp that indicates when the Data Lake Pipeline was created.
    id string
    Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
    lastUpdatedDate string
    Timestamp that indicates the last time that the Data Lake Pipeline was updated.
    name string
    projectId string
    The unique ID for the project to create a data lake pipeline.
    sinks GetDataLakePipelinesResultSink[]
    sources GetDataLakePipelinesResultSource[]
    state string
    State of this Data Lake Pipeline.
    transformations GetDataLakePipelinesResultTransformation[]
    Fields to be excluded for this Data Lake Pipeline.

    • transformations.#.field - Key in the document.
    • transformations.#.type - Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
    created_date str
    Timestamp that indicates when the Data Lake Pipeline was created.
    id str
    Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
    last_updated_date str
    Timestamp that indicates the last time that the Data Lake Pipeline was updated.
    name str
    project_id str
    The unique ID for the project to create a data lake pipeline.
    sinks Sequence[GetDataLakePipelinesResultSink]
    sources Sequence[GetDataLakePipelinesResultSource]
    state str
    State of this Data Lake Pipeline.
    transformations Sequence[GetDataLakePipelinesResultTransformation]
    Fields to be excluded for this Data Lake Pipeline.

    • transformations.#.field - Key in the document.
    • transformations.#.type - Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
    createdDate String
    Timestamp that indicates when the Data Lake Pipeline was created.
    id String
    Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
    lastUpdatedDate String
    Timestamp that indicates the last time that the Data Lake Pipeline was updated.
    name String
    projectId String
    The unique ID for the project to create a data lake pipeline.
    sinks List<Property Map>
    sources List<Property Map>
    state String
    State of this Data Lake Pipeline.
    transformations List<Property Map>
    Fields to be excluded for this Data Lake Pipeline.

    • transformations.#.field - Key in the document.
    • transformations.#.type - Type of transformation applied during the export of the namespace in a Data Lake Pipeline.

    GetDataLakePipelinesResultSink

    PartitionFields List<GetDataLakePipelinesResultSinkPartitionField>
    Ordered fields used to physically organize data in the destination.

    • partition_fields.#.field_name - Human-readable label that identifies the field name used to partition data.
    • partition_fields.#.order - Sequence in which MongoDB Atlas slices the collection data to create partitions. The resource expresses this sequence starting with zero.
    Provider string
    Target cloud provider for this Data Lake Pipeline.
    Region string
    Target cloud provider region for this Data Lake Pipeline. Supported cloud provider regions.
    Type string
    Type of ingestion source of this Data Lake Pipeline.
    PartitionFields []GetDataLakePipelinesResultSinkPartitionField
    Ordered fields used to physically organize data in the destination.

    • partition_fields.#.field_name - Human-readable label that identifies the field name used to partition data.
    • partition_fields.#.order - Sequence in which MongoDB Atlas slices the collection data to create partitions. The resource expresses this sequence starting with zero.
    Provider string
    Target cloud provider for this Data Lake Pipeline.
    Region string
    Target cloud provider region for this Data Lake Pipeline. Supported cloud provider regions.
    Type string
    Type of ingestion source of this Data Lake Pipeline.
    partitionFields List<GetDataLakePipelinesResultSinkPartitionField>
    Ordered fields used to physically organize data in the destination.

    • partition_fields.#.field_name - Human-readable label that identifies the field name used to partition data.
    • partition_fields.#.order - Sequence in which MongoDB Atlas slices the collection data to create partitions. The resource expresses this sequence starting with zero.
    provider String
    Target cloud provider for this Data Lake Pipeline.
    region String
    Target cloud provider region for this Data Lake Pipeline. Supported cloud provider regions.
    type String
    Type of ingestion source of this Data Lake Pipeline.
    partitionFields GetDataLakePipelinesResultSinkPartitionField[]
    Ordered fields used to physically organize data in the destination.

    • partition_fields.#.field_name - Human-readable label that identifies the field name used to partition data.
    • partition_fields.#.order - Sequence in which MongoDB Atlas slices the collection data to create partitions. The resource expresses this sequence starting with zero.
    provider string
    Target cloud provider for this Data Lake Pipeline.
    region string
    Target cloud provider region for this Data Lake Pipeline. Supported cloud provider regions.
    type string
    Type of ingestion source of this Data Lake Pipeline.
    partition_fields Sequence[GetDataLakePipelinesResultSinkPartitionField]
    Ordered fields used to physically organize data in the destination.

    • partition_fields.#.field_name - Human-readable label that identifies the field name used to partition data.
    • partition_fields.#.order - Sequence in which MongoDB Atlas slices the collection data to create partitions. The resource expresses this sequence starting with zero.
    provider str
    Target cloud provider for this Data Lake Pipeline.
    region str
    Target cloud provider region for this Data Lake Pipeline. Supported cloud provider regions.
    type str
    Type of ingestion source of this Data Lake Pipeline.
    partitionFields List<Property Map>
    Ordered fields used to physically organize data in the destination.

    • partition_fields.#.field_name - Human-readable label that identifies the field name used to partition data.
    • partition_fields.#.order - Sequence in which MongoDB Atlas slices the collection data to create partitions. The resource expresses this sequence starting with zero.
    provider String
    Target cloud provider for this Data Lake Pipeline.
    region String
    Target cloud provider region for this Data Lake Pipeline. Supported cloud provider regions.
    type String
    Type of ingestion source of this Data Lake Pipeline.

    GetDataLakePipelinesResultSinkPartitionField

    FieldName string
    Order int
    FieldName string
    Order int
    fieldName String
    order Integer
    fieldName string
    order number
    fieldName String
    order Number

    GetDataLakePipelinesResultSource

    ClusterName string
    Human-readable name that identifies the cluster.
    CollectionName string
    Human-readable name that identifies the collection.
    DatabaseName string
    Human-readable name that identifies the database.
    ProjectId string
    The unique ID for the project to create a data lake pipeline.
    Type string
    Type of ingestion source of this Data Lake Pipeline.
    ClusterName string
    Human-readable name that identifies the cluster.
    CollectionName string
    Human-readable name that identifies the collection.
    DatabaseName string
    Human-readable name that identifies the database.
    ProjectId string
    The unique ID for the project to create a data lake pipeline.
    Type string
    Type of ingestion source of this Data Lake Pipeline.
    clusterName String
    Human-readable name that identifies the cluster.
    collectionName String
    Human-readable name that identifies the collection.
    databaseName String
    Human-readable name that identifies the database.
    projectId String
    The unique ID for the project to create a data lake pipeline.
    type String
    Type of ingestion source of this Data Lake Pipeline.
    clusterName string
    Human-readable name that identifies the cluster.
    collectionName string
    Human-readable name that identifies the collection.
    databaseName string
    Human-readable name that identifies the database.
    projectId string
    The unique ID for the project to create a data lake pipeline.
    type string
    Type of ingestion source of this Data Lake Pipeline.
    cluster_name str
    Human-readable name that identifies the cluster.
    collection_name str
    Human-readable name that identifies the collection.
    database_name str
    Human-readable name that identifies the database.
    project_id str
    The unique ID for the project to create a data lake pipeline.
    type str
    Type of ingestion source of this Data Lake Pipeline.
    clusterName String
    Human-readable name that identifies the cluster.
    collectionName String
    Human-readable name that identifies the collection.
    databaseName String
    Human-readable name that identifies the database.
    projectId String
    The unique ID for the project to create a data lake pipeline.
    type String
    Type of ingestion source of this Data Lake Pipeline.

    GetDataLakePipelinesResultTransformation

    Field string
    Type string
    Type of ingestion source of this Data Lake Pipeline.
    Field string
    Type string
    Type of ingestion source of this Data Lake Pipeline.
    field String
    type String
    Type of ingestion source of this Data Lake Pipeline.
    field string
    type string
    Type of ingestion source of this Data Lake Pipeline.
    field str
    type str
    Type of ingestion source of this Data Lake Pipeline.
    field String
    type String
    Type of ingestion source of this Data Lake Pipeline.

    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