1. Packages
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. getPipelineSink
Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi
cloudflare logo
Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi

    Accepted Permissions

    • Pipelines Read
    • Pipelines Write

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const examplePipelineSink = cloudflare.getPipelineSink({
        accountId: "0123105f4ecef8ad9ca31a8372d0c353",
        sinkId: "0223105f4ecef8ad9ca31a8372d0c353",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_pipeline_sink = cloudflare.get_pipeline_sink(account_id="0123105f4ecef8ad9ca31a8372d0c353",
        sink_id="0223105f4ecef8ad9ca31a8372d0c353")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.GetPipelineSink(ctx, &cloudflare.LookupPipelineSinkArgs{
    			AccountId: pulumi.StringRef("0123105f4ecef8ad9ca31a8372d0c353"),
    			SinkId:    pulumi.StringRef("0223105f4ecef8ad9ca31a8372d0c353"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var examplePipelineSink = Cloudflare.Index.GetPipelineSink.Invoke(new()
        {
            AccountId = "0123105f4ecef8ad9ca31a8372d0c353",
            SinkId = "0223105f4ecef8ad9ca31a8372d0c353",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.CloudflareFunctions;
    import com.pulumi.cloudflare.inputs.GetPipelineSinkArgs;
    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) {
            final var examplePipelineSink = CloudflareFunctions.getPipelineSink(GetPipelineSinkArgs.builder()
                .accountId("0123105f4ecef8ad9ca31a8372d0c353")
                .sinkId("0223105f4ecef8ad9ca31a8372d0c353")
                .build());
    
        }
    }
    
    variables:
      examplePipelineSink:
        fn::invoke:
          function: cloudflare:getPipelineSink
          arguments:
            accountId: 0123105f4ecef8ad9ca31a8372d0c353
            sinkId: 0223105f4ecef8ad9ca31a8372d0c353
    

    Using getPipelineSink

    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 getPipelineSink(args: GetPipelineSinkArgs, opts?: InvokeOptions): Promise<GetPipelineSinkResult>
    function getPipelineSinkOutput(args: GetPipelineSinkOutputArgs, opts?: InvokeOptions): Output<GetPipelineSinkResult>
    def get_pipeline_sink(account_id: Optional[str] = None,
                          filter: Optional[GetPipelineSinkFilter] = None,
                          sink_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPipelineSinkResult
    def get_pipeline_sink_output(account_id: Optional[pulumi.Input[str]] = None,
                          filter: Optional[pulumi.Input[GetPipelineSinkFilterArgs]] = None,
                          sink_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPipelineSinkResult]
    func LookupPipelineSink(ctx *Context, args *LookupPipelineSinkArgs, opts ...InvokeOption) (*LookupPipelineSinkResult, error)
    func LookupPipelineSinkOutput(ctx *Context, args *LookupPipelineSinkOutputArgs, opts ...InvokeOption) LookupPipelineSinkResultOutput

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

    public static class GetPipelineSink 
    {
        public static Task<GetPipelineSinkResult> InvokeAsync(GetPipelineSinkArgs args, InvokeOptions? opts = null)
        public static Output<GetPipelineSinkResult> Invoke(GetPipelineSinkInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPipelineSinkResult> getPipelineSink(GetPipelineSinkArgs args, InvokeOptions options)
    public static Output<GetPipelineSinkResult> getPipelineSink(GetPipelineSinkArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getPipelineSink:getPipelineSink
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    Specifies the public ID of the account.
    Filter GetPipelineSinkFilter
    SinkId string
    Specifies the publid ID of the sink.
    AccountId string
    Specifies the public ID of the account.
    Filter GetPipelineSinkFilter
    SinkId string
    Specifies the publid ID of the sink.
    accountId String
    Specifies the public ID of the account.
    filter GetPipelineSinkFilter
    sinkId String
    Specifies the publid ID of the sink.
    accountId string
    Specifies the public ID of the account.
    filter GetPipelineSinkFilter
    sinkId string
    Specifies the publid ID of the sink.
    account_id str
    Specifies the public ID of the account.
    filter GetPipelineSinkFilter
    sink_id str
    Specifies the publid ID of the sink.
    accountId String
    Specifies the public ID of the account.
    filter Property Map
    sinkId String
    Specifies the publid ID of the sink.

    getPipelineSink Result

    The following output properties are available:

    Config GetPipelineSinkConfig
    Defines the configuration of the R2 Sink.
    CreatedAt string
    Format GetPipelineSinkFormat
    Id string
    Specifies the publid ID of the sink.
    ModifiedAt string
    Name string
    Defines the name of the Sink.
    Schema GetPipelineSinkSchema
    Type string
    Specifies the type of sink. Available values: "r2", "r2datacatalog".
    AccountId string
    Specifies the public ID of the account.
    Filter GetPipelineSinkFilter
    SinkId string
    Specifies the publid ID of the sink.
    Config GetPipelineSinkConfig
    Defines the configuration of the R2 Sink.
    CreatedAt string
    Format GetPipelineSinkFormat
    Id string
    Specifies the publid ID of the sink.
    ModifiedAt string
    Name string
    Defines the name of the Sink.
    Schema GetPipelineSinkSchema
    Type string
    Specifies the type of sink. Available values: "r2", "r2datacatalog".
    AccountId string
    Specifies the public ID of the account.
    Filter GetPipelineSinkFilter
    SinkId string
    Specifies the publid ID of the sink.
    config GetPipelineSinkConfig
    Defines the configuration of the R2 Sink.
    createdAt String
    format GetPipelineSinkFormat
    id String
    Specifies the publid ID of the sink.
    modifiedAt String
    name String
    Defines the name of the Sink.
    schema GetPipelineSinkSchema
    type String
    Specifies the type of sink. Available values: "r2", "r2datacatalog".
    accountId String
    Specifies the public ID of the account.
    filter GetPipelineSinkFilter
    sinkId String
    Specifies the publid ID of the sink.
    config GetPipelineSinkConfig
    Defines the configuration of the R2 Sink.
    createdAt string
    format GetPipelineSinkFormat
    id string
    Specifies the publid ID of the sink.
    modifiedAt string
    name string
    Defines the name of the Sink.
    schema GetPipelineSinkSchema
    type string
    Specifies the type of sink. Available values: "r2", "r2datacatalog".
    accountId string
    Specifies the public ID of the account.
    filter GetPipelineSinkFilter
    sinkId string
    Specifies the publid ID of the sink.
    config GetPipelineSinkConfig
    Defines the configuration of the R2 Sink.
    created_at str
    format GetPipelineSinkFormat
    id str
    Specifies the publid ID of the sink.
    modified_at str
    name str
    Defines the name of the Sink.
    schema GetPipelineSinkSchema
    type str
    Specifies the type of sink. Available values: "r2", "r2datacatalog".
    account_id str
    Specifies the public ID of the account.
    filter GetPipelineSinkFilter
    sink_id str
    Specifies the publid ID of the sink.
    config Property Map
    Defines the configuration of the R2 Sink.
    createdAt String
    format Property Map
    id String
    Specifies the publid ID of the sink.
    modifiedAt String
    name String
    Defines the name of the Sink.
    schema Property Map
    type String
    Specifies the type of sink. Available values: "r2", "r2datacatalog".
    accountId String
    Specifies the public ID of the account.
    filter Property Map
    sinkId String
    Specifies the publid ID of the sink.

    Supporting Types

    GetPipelineSinkConfig

    AccountId string
    Cloudflare Account ID for the bucket
    Bucket string
    R2 Bucket to write to
    FileNaming GetPipelineSinkConfigFileNaming
    Controls filename prefix/suffix and strategy.
    Jurisdiction string
    Jurisdiction this bucket is hosted in
    Namespace string
    Table namespace
    Partitioning GetPipelineSinkConfigPartitioning
    Data-layout partitioning for sinks.
    Path string
    Subpath within the bucket to write to
    RollingPolicy GetPipelineSinkConfigRollingPolicy
    Rolling policy for file sinks (when & why to close a file and open a new one).
    TableName string
    Table name
    AccountId string
    Cloudflare Account ID for the bucket
    Bucket string
    R2 Bucket to write to
    FileNaming GetPipelineSinkConfigFileNaming
    Controls filename prefix/suffix and strategy.
    Jurisdiction string
    Jurisdiction this bucket is hosted in
    Namespace string
    Table namespace
    Partitioning GetPipelineSinkConfigPartitioning
    Data-layout partitioning for sinks.
    Path string
    Subpath within the bucket to write to
    RollingPolicy GetPipelineSinkConfigRollingPolicy
    Rolling policy for file sinks (when & why to close a file and open a new one).
    TableName string
    Table name
    accountId String
    Cloudflare Account ID for the bucket
    bucket String
    R2 Bucket to write to
    fileNaming GetPipelineSinkConfigFileNaming
    Controls filename prefix/suffix and strategy.
    jurisdiction String
    Jurisdiction this bucket is hosted in
    namespace String
    Table namespace
    partitioning GetPipelineSinkConfigPartitioning
    Data-layout partitioning for sinks.
    path String
    Subpath within the bucket to write to
    rollingPolicy GetPipelineSinkConfigRollingPolicy
    Rolling policy for file sinks (when & why to close a file and open a new one).
    tableName String
    Table name
    accountId string
    Cloudflare Account ID for the bucket
    bucket string
    R2 Bucket to write to
    fileNaming GetPipelineSinkConfigFileNaming
    Controls filename prefix/suffix and strategy.
    jurisdiction string
    Jurisdiction this bucket is hosted in
    namespace string
    Table namespace
    partitioning GetPipelineSinkConfigPartitioning
    Data-layout partitioning for sinks.
    path string
    Subpath within the bucket to write to
    rollingPolicy GetPipelineSinkConfigRollingPolicy
    Rolling policy for file sinks (when & why to close a file and open a new one).
    tableName string
    Table name
    account_id str
    Cloudflare Account ID for the bucket
    bucket str
    R2 Bucket to write to
    file_naming GetPipelineSinkConfigFileNaming
    Controls filename prefix/suffix and strategy.
    jurisdiction str
    Jurisdiction this bucket is hosted in
    namespace str
    Table namespace
    partitioning GetPipelineSinkConfigPartitioning
    Data-layout partitioning for sinks.
    path str
    Subpath within the bucket to write to
    rolling_policy GetPipelineSinkConfigRollingPolicy
    Rolling policy for file sinks (when & why to close a file and open a new one).
    table_name str
    Table name
    accountId String
    Cloudflare Account ID for the bucket
    bucket String
    R2 Bucket to write to
    fileNaming Property Map
    Controls filename prefix/suffix and strategy.
    jurisdiction String
    Jurisdiction this bucket is hosted in
    namespace String
    Table namespace
    partitioning Property Map
    Data-layout partitioning for sinks.
    path String
    Subpath within the bucket to write to
    rollingPolicy Property Map
    Rolling policy for file sinks (when & why to close a file and open a new one).
    tableName String
    Table name

    GetPipelineSinkConfigFileNaming

    Prefix string
    The prefix to use in file name. i.e prefix-\n\n.parquet
    Strategy string
    Filename generation strategy. Available values: "serial", "uuid", "uuidV7", "ulid".
    Suffix string
    This will overwrite the default file suffix. i.e .parquet, use with caution
    Prefix string
    The prefix to use in file name. i.e prefix-\n\n.parquet
    Strategy string
    Filename generation strategy. Available values: "serial", "uuid", "uuidV7", "ulid".
    Suffix string
    This will overwrite the default file suffix. i.e .parquet, use with caution
    prefix String
    The prefix to use in file name. i.e prefix-\n\n.parquet
    strategy String
    Filename generation strategy. Available values: "serial", "uuid", "uuidV7", "ulid".
    suffix String
    This will overwrite the default file suffix. i.e .parquet, use with caution
    prefix string
    The prefix to use in file name. i.e prefix-\n\n.parquet
    strategy string
    Filename generation strategy. Available values: "serial", "uuid", "uuidV7", "ulid".
    suffix string
    This will overwrite the default file suffix. i.e .parquet, use with caution
    prefix str
    The prefix to use in file name. i.e prefix-\n\n.parquet
    strategy str
    Filename generation strategy. Available values: "serial", "uuid", "uuidV7", "ulid".
    suffix str
    This will overwrite the default file suffix. i.e .parquet, use with caution
    prefix String
    The prefix to use in file name. i.e prefix-\n\n.parquet
    strategy String
    Filename generation strategy. Available values: "serial", "uuid", "uuidV7", "ulid".
    suffix String
    This will overwrite the default file suffix. i.e .parquet, use with caution

    GetPipelineSinkConfigPartitioning

    TimePattern string
    The pattern of the date string
    TimePattern string
    The pattern of the date string
    timePattern String
    The pattern of the date string
    timePattern string
    The pattern of the date string
    time_pattern str
    The pattern of the date string
    timePattern String
    The pattern of the date string

    GetPipelineSinkConfigRollingPolicy

    FileSizeBytes int
    Files will be rolled after reaching this number of bytes
    InactivitySeconds int
    Number of seconds of inactivity to wait before rolling over to a new file
    IntervalSeconds int
    Number of seconds to wait before rolling over to a new file
    FileSizeBytes int
    Files will be rolled after reaching this number of bytes
    InactivitySeconds int
    Number of seconds of inactivity to wait before rolling over to a new file
    IntervalSeconds int
    Number of seconds to wait before rolling over to a new file
    fileSizeBytes Integer
    Files will be rolled after reaching this number of bytes
    inactivitySeconds Integer
    Number of seconds of inactivity to wait before rolling over to a new file
    intervalSeconds Integer
    Number of seconds to wait before rolling over to a new file
    fileSizeBytes number
    Files will be rolled after reaching this number of bytes
    inactivitySeconds number
    Number of seconds of inactivity to wait before rolling over to a new file
    intervalSeconds number
    Number of seconds to wait before rolling over to a new file
    file_size_bytes int
    Files will be rolled after reaching this number of bytes
    inactivity_seconds int
    Number of seconds of inactivity to wait before rolling over to a new file
    interval_seconds int
    Number of seconds to wait before rolling over to a new file
    fileSizeBytes Number
    Files will be rolled after reaching this number of bytes
    inactivitySeconds Number
    Number of seconds of inactivity to wait before rolling over to a new file
    intervalSeconds Number
    Number of seconds to wait before rolling over to a new file

    GetPipelineSinkFilter

    PipelineId string
    PipelineId string
    pipelineId String
    pipelineId string
    pipelineId String

    GetPipelineSinkFormat

    Compression string
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    DecimalEncoding string
    Available values: "number", "string", "bytes".
    RowGroupBytes int
    TimestampFormat string
    Available values: "rfc3339", "unixMillis".
    Type string
    Available values: "json", "parquet".
    Unstructured bool
    Compression string
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    DecimalEncoding string
    Available values: "number", "string", "bytes".
    RowGroupBytes int
    TimestampFormat string
    Available values: "rfc3339", "unixMillis".
    Type string
    Available values: "json", "parquet".
    Unstructured bool
    compression String
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    decimalEncoding String
    Available values: "number", "string", "bytes".
    rowGroupBytes Integer
    timestampFormat String
    Available values: "rfc3339", "unixMillis".
    type String
    Available values: "json", "parquet".
    unstructured Boolean
    compression string
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    decimalEncoding string
    Available values: "number", "string", "bytes".
    rowGroupBytes number
    timestampFormat string
    Available values: "rfc3339", "unixMillis".
    type string
    Available values: "json", "parquet".
    unstructured boolean
    compression str
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    decimal_encoding str
    Available values: "number", "string", "bytes".
    row_group_bytes int
    timestamp_format str
    Available values: "rfc3339", "unixMillis".
    type str
    Available values: "json", "parquet".
    unstructured bool
    compression String
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    decimalEncoding String
    Available values: "number", "string", "bytes".
    rowGroupBytes Number
    timestampFormat String
    Available values: "rfc3339", "unixMillis".
    type String
    Available values: "json", "parquet".
    unstructured Boolean

    GetPipelineSinkSchema

    GetPipelineSinkSchemaField

    MetadataKey string
    Name string
    Required bool
    SqlName string
    Type string
    Available values: "int32", "int64", "float32", "float64", "bool", "string", "binary", "timestamp", "json".
    Unit string
    Available values: "second", "millisecond", "microsecond", "nanosecond".
    MetadataKey string
    Name string
    Required bool
    SqlName string
    Type string
    Available values: "int32", "int64", "float32", "float64", "bool", "string", "binary", "timestamp", "json".
    Unit string
    Available values: "second", "millisecond", "microsecond", "nanosecond".
    metadataKey String
    name String
    required Boolean
    sqlName String
    type String
    Available values: "int32", "int64", "float32", "float64", "bool", "string", "binary", "timestamp", "json".
    unit String
    Available values: "second", "millisecond", "microsecond", "nanosecond".
    metadataKey string
    name string
    required boolean
    sqlName string
    type string
    Available values: "int32", "int64", "float32", "float64", "bool", "string", "binary", "timestamp", "json".
    unit string
    Available values: "second", "millisecond", "microsecond", "nanosecond".
    metadata_key str
    name str
    required bool
    sql_name str
    type str
    Available values: "int32", "int64", "float32", "float64", "bool", "string", "binary", "timestamp", "json".
    unit str
    Available values: "second", "millisecond", "microsecond", "nanosecond".
    metadataKey String
    name String
    required Boolean
    sqlName String
    type String
    Available values: "int32", "int64", "float32", "float64", "bool", "string", "binary", "timestamp", "json".
    unit String
    Available values: "second", "millisecond", "microsecond", "nanosecond".

    GetPipelineSinkSchemaFormat

    Compression string
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    DecimalEncoding string
    Available values: "number", "string", "bytes".
    RowGroupBytes int
    TimestampFormat string
    Available values: "rfc3339", "unixMillis".
    Type string
    Available values: "json", "parquet".
    Unstructured bool
    Compression string
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    DecimalEncoding string
    Available values: "number", "string", "bytes".
    RowGroupBytes int
    TimestampFormat string
    Available values: "rfc3339", "unixMillis".
    Type string
    Available values: "json", "parquet".
    Unstructured bool
    compression String
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    decimalEncoding String
    Available values: "number", "string", "bytes".
    rowGroupBytes Integer
    timestampFormat String
    Available values: "rfc3339", "unixMillis".
    type String
    Available values: "json", "parquet".
    unstructured Boolean
    compression string
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    decimalEncoding string
    Available values: "number", "string", "bytes".
    rowGroupBytes number
    timestampFormat string
    Available values: "rfc3339", "unixMillis".
    type string
    Available values: "json", "parquet".
    unstructured boolean
    compression str
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    decimal_encoding str
    Available values: "number", "string", "bytes".
    row_group_bytes int
    timestamp_format str
    Available values: "rfc3339", "unixMillis".
    type str
    Available values: "json", "parquet".
    unstructured bool
    compression String
    Available values: "uncompressed", "snappy", "gzip", "zstd", "lz4".
    decimalEncoding String
    Available values: "number", "string", "bytes".
    rowGroupBytes Number
    timestampFormat String
    Available values: "rfc3339", "unixMillis".
    type String
    Available values: "json", "parquet".
    unstructured Boolean

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Viewing docs for Cloudflare v6.15.0
    published on Saturday, May 2, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.