published on Wednesday, Jun 3, 2026 by redpanda-data
published on Wednesday, Jun 3, 2026 by redpanda-data
Pipeline represents a Redpanda Connect pipeline
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as redpanda from "@pulumi/redpanda";
const example = new redpanda.ResourceGroup("example", {name: "example-resource-group"});
const exampleNetwork = new redpanda.Network("example", {
name: "example-network",
resourceGroupId: example.id,
cloudProvider: "aws",
region: "us-west-2",
clusterType: "dedicated",
cidrBlock: "10.0.0.0/20",
});
const exampleCluster = new redpanda.Cluster("example", {
name: "example-cluster",
resourceGroupId: example.id,
networkId: exampleNetwork.id,
cloudProvider: "aws",
region: "us-west-2",
clusterType: "dedicated",
connectionType: "public",
throughputTier: "tier-1-aws-v2-arm",
zones: [
"usw2-az1",
"usw2-az2",
"usw2-az3",
],
});
const examplePipeline = new redpanda.Pipeline("example", {
clusterApiUrl: exampleCluster.clusterApiUrl,
displayName: "example-pipeline",
description: "An example Redpanda Connect pipeline",
state: "stopped",
configYaml: `input:
generate:
interval: \\"1s\\"
mapping: |
root.message = \\"hello world\\"
root.timestamp = now()
output:
stdout: {}
`,
resources: {
memoryShares: "256Mi",
cpuShares: "200m",
},
tags: {
environment: "example",
"managed-by": "terraform",
},
});
import pulumi
import pulumi_redpanda as redpanda
example = redpanda.ResourceGroup("example", name="example-resource-group")
example_network = redpanda.Network("example",
name="example-network",
resource_group_id=example.id,
cloud_provider="aws",
region="us-west-2",
cluster_type="dedicated",
cidr_block="10.0.0.0/20")
example_cluster = redpanda.Cluster("example",
name="example-cluster",
resource_group_id=example.id,
network_id=example_network.id,
cloud_provider="aws",
region="us-west-2",
cluster_type="dedicated",
connection_type="public",
throughput_tier="tier-1-aws-v2-arm",
zones=[
"usw2-az1",
"usw2-az2",
"usw2-az3",
])
example_pipeline = redpanda.Pipeline("example",
cluster_api_url=example_cluster.cluster_api_url,
display_name="example-pipeline",
description="An example Redpanda Connect pipeline",
state="stopped",
config_yaml="""input:
generate:
interval: \"1s\"
mapping: |
root.message = \"hello world\"
root.timestamp = now()
output:
stdout: {}
""",
resources={
"memory_shares": "256Mi",
"cpu_shares": "200m",
},
tags={
"environment": "example",
"managed-by": "terraform",
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/redpanda/v2/redpanda"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := redpanda.NewResourceGroup(ctx, "example", &redpanda.ResourceGroupArgs{
Name: pulumi.String("example-resource-group"),
})
if err != nil {
return err
}
exampleNetwork, err := redpanda.NewNetwork(ctx, "example", &redpanda.NetworkArgs{
Name: pulumi.String("example-network"),
ResourceGroupId: example.ID(),
CloudProvider: pulumi.String("aws"),
Region: pulumi.String("us-west-2"),
ClusterType: pulumi.String("dedicated"),
CidrBlock: pulumi.String("10.0.0.0/20"),
})
if err != nil {
return err
}
exampleCluster, err := redpanda.NewCluster(ctx, "example", &redpanda.ClusterArgs{
Name: pulumi.String("example-cluster"),
ResourceGroupId: example.ID(),
NetworkId: exampleNetwork.ID(),
CloudProvider: pulumi.String("aws"),
Region: pulumi.String("us-west-2"),
ClusterType: pulumi.String("dedicated"),
ConnectionType: pulumi.String("public"),
ThroughputTier: pulumi.String("tier-1-aws-v2-arm"),
Zones: pulumi.StringArray{
pulumi.String("usw2-az1"),
pulumi.String("usw2-az2"),
pulumi.String("usw2-az3"),
},
})
if err != nil {
return err
}
_, err = redpanda.NewPipeline(ctx, "example", &redpanda.PipelineArgs{
ClusterApiUrl: exampleCluster.ClusterApiUrl,
DisplayName: pulumi.String("example-pipeline"),
Description: pulumi.String("An example Redpanda Connect pipeline"),
State: pulumi.String("stopped"),
ConfigYaml: pulumi.String(`input:
generate:
interval: \"1s\"
mapping: |
root.message = \"hello world\"
root.timestamp = now()
output:
stdout: {}
`),
Resources: &redpanda.PipelineResourcesArgs{
MemoryShares: pulumi.String("256Mi"),
CpuShares: pulumi.String("200m"),
},
Tags: pulumi.StringMap{
"environment": pulumi.String("example"),
"managed-by": pulumi.String("terraform"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Redpanda = Pulumi.Redpanda;
return await Deployment.RunAsync(() =>
{
var example = new Redpanda.ResourceGroup("example", new()
{
Name = "example-resource-group",
});
var exampleNetwork = new Redpanda.Network("example", new()
{
Name = "example-network",
ResourceGroupId = example.Id,
CloudProvider = "aws",
Region = "us-west-2",
ClusterType = "dedicated",
CidrBlock = "10.0.0.0/20",
});
var exampleCluster = new Redpanda.Cluster("example", new()
{
Name = "example-cluster",
ResourceGroupId = example.Id,
NetworkId = exampleNetwork.Id,
CloudProvider = "aws",
Region = "us-west-2",
ClusterType = "dedicated",
ConnectionType = "public",
ThroughputTier = "tier-1-aws-v2-arm",
Zones = new[]
{
"usw2-az1",
"usw2-az2",
"usw2-az3",
},
});
var examplePipeline = new Redpanda.Pipeline("example", new()
{
ClusterApiUrl = exampleCluster.ClusterApiUrl,
DisplayName = "example-pipeline",
Description = "An example Redpanda Connect pipeline",
State = "stopped",
ConfigYaml = @"input:
generate:
interval: \""1s\""
mapping: |
root.message = \""hello world\""
root.timestamp = now()
output:
stdout: {}
",
Resources = new Redpanda.Inputs.PipelineResourcesArgs
{
MemoryShares = "256Mi",
CpuShares = "200m",
},
Tags =
{
{ "environment", "example" },
{ "managed-by", "terraform" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.redpanda.ResourceGroup;
import com.pulumi.redpanda.ResourceGroupArgs;
import com.pulumi.redpanda.Network;
import com.pulumi.redpanda.NetworkArgs;
import com.pulumi.redpanda.Cluster;
import com.pulumi.redpanda.ClusterArgs;
import com.pulumi.redpanda.Pipeline;
import com.pulumi.redpanda.PipelineArgs;
import com.pulumi.redpanda.inputs.PipelineResourcesArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resource-group")
.build());
var exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
.name("example-network")
.resourceGroupId(example.id())
.cloudProvider("aws")
.region("us-west-2")
.clusterType("dedicated")
.cidrBlock("10.0.0.0/20")
.build());
var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
.name("example-cluster")
.resourceGroupId(example.id())
.networkId(exampleNetwork.id())
.cloudProvider("aws")
.region("us-west-2")
.clusterType("dedicated")
.connectionType("public")
.throughputTier("tier-1-aws-v2-arm")
.zones(
"usw2-az1",
"usw2-az2",
"usw2-az3")
.build());
var examplePipeline = new Pipeline("examplePipeline", PipelineArgs.builder()
.clusterApiUrl(exampleCluster.clusterApiUrl())
.displayName("example-pipeline")
.description("An example Redpanda Connect pipeline")
.state("stopped")
.configYaml("""
input:
generate:
interval: \"1s\"
mapping: |
root.message = \"hello world\"
root.timestamp = now()
output:
stdout: {}
""")
.resources(PipelineResourcesArgs.builder()
.memoryShares("256Mi")
.cpuShares("200m")
.build())
.tags(Map.ofEntries(
Map.entry("environment", "example"),
Map.entry("managed-by", "terraform")
))
.build());
}
}
resources:
example:
type: redpanda:ResourceGroup
properties:
name: example-resource-group
exampleNetwork:
type: redpanda:Network
name: example
properties:
name: example-network
resourceGroupId: ${example.id}
cloudProvider: aws
region: us-west-2
clusterType: dedicated
cidrBlock: 10.0.0.0/20
exampleCluster:
type: redpanda:Cluster
name: example
properties:
name: example-cluster
resourceGroupId: ${example.id}
networkId: ${exampleNetwork.id}
cloudProvider: aws
region: us-west-2
clusterType: dedicated
connectionType: public
throughputTier: tier-1-aws-v2-arm
zones:
- usw2-az1
- usw2-az2
- usw2-az3
examplePipeline:
type: redpanda:Pipeline
name: example
properties:
clusterApiUrl: ${exampleCluster.clusterApiUrl}
displayName: example-pipeline
description: An example Redpanda Connect pipeline
state: stopped
configYaml: |
input:
generate:
interval: \"1s\"
mapping: |
root.message = \"hello world\"
root.timestamp = now()
output:
stdout: {}
resources:
memoryShares: 256Mi
cpuShares: 200m
tags:
environment: example
managed-by: terraform
Example coming soon!
API Reference
For more information, see the Redpanda Cloud Data Plane API documentation.
Create Pipeline Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Pipeline(name: string, args: PipelineArgs, opts?: CustomResourceOptions);@overload
def Pipeline(resource_name: str,
args: PipelineArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Pipeline(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_api_url: Optional[str] = None,
config_yaml: Optional[str] = None,
display_name: Optional[str] = None,
allow_deletion: Optional[bool] = None,
description: Optional[str] = None,
resources: Optional[PipelineResourcesArgs] = None,
service_account: Optional[PipelineServiceAccountArgs] = None,
state: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
timeouts: Optional[PipelineTimeoutsArgs] = None)func NewPipeline(ctx *Context, name string, args PipelineArgs, opts ...ResourceOption) (*Pipeline, error)public Pipeline(string name, PipelineArgs args, CustomResourceOptions? opts = null)
public Pipeline(String name, PipelineArgs args)
public Pipeline(String name, PipelineArgs args, CustomResourceOptions options)
type: redpanda:Pipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "redpanda_pipeline" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args PipelineArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PipelineArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PipelineArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PipelineArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PipelineArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var pipelineResource = new Redpanda.Pipeline("pipelineResource", new()
{
ClusterApiUrl = "string",
ConfigYaml = "string",
DisplayName = "string",
AllowDeletion = false,
Description = "string",
Resources = new Redpanda.Inputs.PipelineResourcesArgs
{
CpuShares = "string",
MemoryShares = "string",
},
ServiceAccount = new Redpanda.Inputs.PipelineServiceAccountArgs
{
ClientId = "string",
ClientSecret = "string",
SecretVersion = 0,
},
State = "string",
Tags =
{
{ "string", "string" },
},
Timeouts = new Redpanda.Inputs.PipelineTimeoutsArgs
{
Create = "string",
Delete = "string",
Update = "string",
},
});
example, err := redpanda.NewPipeline(ctx, "pipelineResource", &redpanda.PipelineArgs{
ClusterApiUrl: pulumi.String("string"),
ConfigYaml: pulumi.String("string"),
DisplayName: pulumi.String("string"),
AllowDeletion: pulumi.Bool(false),
Description: pulumi.String("string"),
Resources: &redpanda.PipelineResourcesArgs{
CpuShares: pulumi.String("string"),
MemoryShares: pulumi.String("string"),
},
ServiceAccount: &redpanda.PipelineServiceAccountArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
SecretVersion: pulumi.Float64(0),
},
State: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timeouts: &redpanda.PipelineTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
resource "redpanda_pipeline" "pipelineResource" {
cluster_api_url = "string"
config_yaml = "string"
display_name = "string"
allow_deletion = false
description = "string"
resources = {
cpu_shares = "string"
memory_shares = "string"
}
service_account = {
client_id = "string"
client_secret = "string"
secret_version = 0
}
state = "string"
tags = {
"string" = "string"
}
timeouts = {
create = "string"
delete = "string"
update = "string"
}
}
var pipelineResource = new Pipeline("pipelineResource", PipelineArgs.builder()
.clusterApiUrl("string")
.configYaml("string")
.displayName("string")
.allowDeletion(false)
.description("string")
.resources(PipelineResourcesArgs.builder()
.cpuShares("string")
.memoryShares("string")
.build())
.serviceAccount(PipelineServiceAccountArgs.builder()
.clientId("string")
.clientSecret("string")
.secretVersion(0.0)
.build())
.state("string")
.tags(Map.of("string", "string"))
.timeouts(PipelineTimeoutsArgs.builder()
.create("string")
.delete("string")
.update("string")
.build())
.build());
pipeline_resource = redpanda.Pipeline("pipelineResource",
cluster_api_url="string",
config_yaml="string",
display_name="string",
allow_deletion=False,
description="string",
resources={
"cpu_shares": "string",
"memory_shares": "string",
},
service_account={
"client_id": "string",
"client_secret": "string",
"secret_version": float(0),
},
state="string",
tags={
"string": "string",
},
timeouts={
"create": "string",
"delete": "string",
"update": "string",
})
const pipelineResource = new redpanda.Pipeline("pipelineResource", {
clusterApiUrl: "string",
configYaml: "string",
displayName: "string",
allowDeletion: false,
description: "string",
resources: {
cpuShares: "string",
memoryShares: "string",
},
serviceAccount: {
clientId: "string",
clientSecret: "string",
secretVersion: 0,
},
state: "string",
tags: {
string: "string",
},
timeouts: {
create: "string",
"delete": "string",
update: "string",
},
});
type: redpanda:Pipeline
properties:
allowDeletion: false
clusterApiUrl: string
configYaml: string
description: string
displayName: string
resources:
cpuShares: string
memoryShares: string
serviceAccount:
clientId: string
clientSecret: string
secretVersion: 0
state: string
tags:
string: string
timeouts:
create: string
delete: string
update: string
Pipeline Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Pipeline resource accepts the following input properties:
- Cluster
Api stringUrl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- Config
Yaml string - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- Display
Name string - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - Allow
Deletion bool - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- Description string
- Optional pipeline description. Length must be at most 256.
- Resources
Pipeline
Resources - Resources configuration
- Service
Account PipelineService Account - Service Account configuration
- State string
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- Dictionary<string, string>
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- Timeouts
Pipeline
Timeouts
- Cluster
Api stringUrl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- Config
Yaml string - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- Display
Name string - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - Allow
Deletion bool - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- Description string
- Optional pipeline description. Length must be at most 256.
- Resources
Pipeline
Resources Args - Resources configuration
- Service
Account PipelineService Account Args - Service Account configuration
- State string
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- map[string]string
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- Timeouts
Pipeline
Timeouts Args
- cluster_
api_ stringurl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- config_
yaml string - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- display_
name string - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - allow_
deletion bool - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- description string
- Optional pipeline description. Length must be at most 256.
- resources object
- Resources configuration
- service_
account object - Service Account configuration
- state string
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- map(string)
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- timeouts object
- cluster
Api StringUrl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- config
Yaml String - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- display
Name String - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - allow
Deletion Boolean - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- description String
- Optional pipeline description. Length must be at most 256.
- resources
Pipeline
Resources - Resources configuration
- service
Account PipelineService Account - Service Account configuration
- state String
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- Map<String,String>
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- timeouts
Pipeline
Timeouts
- cluster
Api stringUrl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- config
Yaml string - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- display
Name string - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - allow
Deletion boolean - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- description string
- Optional pipeline description. Length must be at most 256.
- resources
Pipeline
Resources - Resources configuration
- service
Account PipelineService Account - Service Account configuration
- state string
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- {[key: string]: string}
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- timeouts
Pipeline
Timeouts
- cluster_
api_ strurl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- config_
yaml str - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- display_
name str - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - allow_
deletion bool - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- description str
- Optional pipeline description. Length must be at most 256.
- resources
Pipeline
Resources Args - Resources configuration
- service_
account PipelineService Account Args - Service Account configuration
- state str
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- Mapping[str, str]
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- timeouts
Pipeline
Timeouts Args
- cluster
Api StringUrl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- config
Yaml String - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- display
Name String - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - allow
Deletion Boolean - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- description String
- Optional pipeline description. Length must be at most 256.
- resources Property Map
- Resources configuration
- service
Account Property Map - Service Account configuration
- state String
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- Map<String>
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the Pipeline resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Pipeline
Status - Pipeline status may contain an error message.
- Url string
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Pipeline
Status - Pipeline status may contain an error message.
- Url string
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
- id String
- The provider-assigned unique ID for this managed resource.
- status
Pipeline
Status - Pipeline status may contain an error message.
- url String
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
- id string
- The provider-assigned unique ID for this managed resource.
- status
Pipeline
Status - Pipeline status may contain an error message.
- url string
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
- id str
- The provider-assigned unique ID for this managed resource.
- status
Pipeline
Status - Pipeline status may contain an error message.
- url str
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
- id String
- The provider-assigned unique ID for this managed resource.
- status Property Map
- Pipeline status may contain an error message.
- url String
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
Look up Existing Pipeline Resource
Get an existing Pipeline resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PipelineState, opts?: CustomResourceOptions): Pipeline@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_deletion: Optional[bool] = None,
cluster_api_url: Optional[str] = None,
config_yaml: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
resources: Optional[PipelineResourcesArgs] = None,
service_account: Optional[PipelineServiceAccountArgs] = None,
state: Optional[str] = None,
status: Optional[PipelineStatusArgs] = None,
tags: Optional[Mapping[str, str]] = None,
timeouts: Optional[PipelineTimeoutsArgs] = None,
url: Optional[str] = None) -> Pipelinefunc GetPipeline(ctx *Context, name string, id IDInput, state *PipelineState, opts ...ResourceOption) (*Pipeline, error)public static Pipeline Get(string name, Input<string> id, PipelineState? state, CustomResourceOptions? opts = null)public static Pipeline get(String name, Output<String> id, PipelineState state, CustomResourceOptions options)resources: _: type: redpanda:Pipeline get: id: ${id}import {
to = redpanda_pipeline.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Allow
Deletion bool - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- Cluster
Api stringUrl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- Config
Yaml string - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- Description string
- Optional pipeline description. Length must be at most 256.
- Display
Name string - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - Resources
Pipeline
Resources - Resources configuration
- Service
Account PipelineService Account - Service Account configuration
- State string
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- Status
Pipeline
Status - Pipeline status may contain an error message.
- Dictionary<string, string>
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- Timeouts
Pipeline
Timeouts - Url string
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
- Allow
Deletion bool - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- Cluster
Api stringUrl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- Config
Yaml string - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- Description string
- Optional pipeline description. Length must be at most 256.
- Display
Name string - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - Resources
Pipeline
Resources Args - Resources configuration
- Service
Account PipelineService Account Args - Service Account configuration
- State string
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- Status
Pipeline
Status Args - Pipeline status may contain an error message.
- map[string]string
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- Timeouts
Pipeline
Timeouts Args - Url string
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
- allow_
deletion bool - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- cluster_
api_ stringurl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- config_
yaml string - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- description string
- Optional pipeline description. Length must be at most 256.
- display_
name string - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - resources object
- Resources configuration
- service_
account object - Service Account configuration
- state string
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- status object
- Pipeline status may contain an error message.
- map(string)
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- timeouts object
- url string
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
- allow
Deletion Boolean - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- cluster
Api StringUrl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- config
Yaml String - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- description String
- Optional pipeline description. Length must be at most 256.
- display
Name String - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - resources
Pipeline
Resources - Resources configuration
- service
Account PipelineService Account - Service Account configuration
- state String
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- status
Pipeline
Status - Pipeline status may contain an error message.
- Map<String,String>
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- timeouts
Pipeline
Timeouts - url String
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
- allow
Deletion boolean - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- cluster
Api stringUrl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- config
Yaml string - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- description string
- Optional pipeline description. Length must be at most 256.
- display
Name string - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - resources
Pipeline
Resources - Resources configuration
- service
Account PipelineService Account - Service Account configuration
- state string
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- status
Pipeline
Status - Pipeline status may contain an error message.
- {[key: string]: string}
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- timeouts
Pipeline
Timeouts - url string
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
- allow_
deletion bool - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- cluster_
api_ strurl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- config_
yaml str - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- description str
- Optional pipeline description. Length must be at most 256.
- display_
name str - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - resources
Pipeline
Resources Args - Resources configuration
- service_
account PipelineService Account Args - Service Account configuration
- state str
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- status
Pipeline
Status Args - Pipeline status may contain an error message.
- Mapping[str, str]
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- timeouts
Pipeline
Timeouts Args - url str
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
- allow
Deletion Boolean - Allows deletion of the pipeline. Default is false. Must be set to true to delete the resource.
- cluster
Api StringUrl - The cluster API URL. Changing this will prevent deletion of the resource on the existing cluster. It is generally a better idea to delete an existing resource and create a new one than to change this value unless you are planning to do state imports.
- config
Yaml String - The Redpanda Connect pipeline configuration in YAML format. See the Redpanda Connect Configuration documentation for more details.
- description String
- Optional pipeline description. Length must be at most 256.
- display
Name String - User-friendly pipeline name. Length must be between 3 and 128. Must match pattern
^[A-Za-z0-9-_ /]+$. - resources Property Map
- Resources configuration
- service
Account Property Map - Service Account configuration
- state String
- Desired state of the pipeline: 'running' or 'stopped'. The provider will ensure the pipeline reaches this state after create/update operations.
- status Property Map
- Pipeline status may contain an error message.
- Map<String>
- Tags are key-value pairs that can be assigned to a pipeline resource. They help organize pipelines and enable filtering when listing them. Must have at most 16 entries.
- timeouts Property Map
- url String
- URL to connect to the pipeline, for example, via httpserver. May be empty if no httpserver is used.
Supporting Types
PipelineResources, PipelineResourcesArgs
- string
cpu_sharesis a string specifying the amount of CPU to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "m" (e.g., "500m" for 500 millicores, "2" for 2 cores) CPU shares can be specified in millicores (1 core = 1000 millicores). If you don't specify a unit, the value is interpreted as the number of cores.- string
memory_sharesis a string specifying the amount of memory to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "K", "M", "G", "T", "P", "E" (e.g., "128M" for 128 megabytes) - Binary SI units: "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" (e.g., "512Mi" for 512 mebibytes) If you don't specify a unit, the value is interpreted as bytes.
- string
cpu_sharesis a string specifying the amount of CPU to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "m" (e.g., "500m" for 500 millicores, "2" for 2 cores) CPU shares can be specified in millicores (1 core = 1000 millicores). If you don't specify a unit, the value is interpreted as the number of cores.- string
memory_sharesis a string specifying the amount of memory to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "K", "M", "G", "T", "P", "E" (e.g., "128M" for 128 megabytes) - Binary SI units: "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" (e.g., "512Mi" for 512 mebibytes) If you don't specify a unit, the value is interpreted as bytes.
- string
cpu_sharesis a string specifying the amount of CPU to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "m" (e.g., "500m" for 500 millicores, "2" for 2 cores) CPU shares can be specified in millicores (1 core = 1000 millicores). If you don't specify a unit, the value is interpreted as the number of cores.- string
memory_sharesis a string specifying the amount of memory to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "K", "M", "G", "T", "P", "E" (e.g., "128M" for 128 megabytes) - Binary SI units: "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" (e.g., "512Mi" for 512 mebibytes) If you don't specify a unit, the value is interpreted as bytes.
- String
cpu_sharesis a string specifying the amount of CPU to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "m" (e.g., "500m" for 500 millicores, "2" for 2 cores) CPU shares can be specified in millicores (1 core = 1000 millicores). If you don't specify a unit, the value is interpreted as the number of cores.- String
memory_sharesis a string specifying the amount of memory to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "K", "M", "G", "T", "P", "E" (e.g., "128M" for 128 megabytes) - Binary SI units: "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" (e.g., "512Mi" for 512 mebibytes) If you don't specify a unit, the value is interpreted as bytes.
- string
cpu_sharesis a string specifying the amount of CPU to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "m" (e.g., "500m" for 500 millicores, "2" for 2 cores) CPU shares can be specified in millicores (1 core = 1000 millicores). If you don't specify a unit, the value is interpreted as the number of cores.- string
memory_sharesis a string specifying the amount of memory to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "K", "M", "G", "T", "P", "E" (e.g., "128M" for 128 megabytes) - Binary SI units: "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" (e.g., "512Mi" for 512 mebibytes) If you don't specify a unit, the value is interpreted as bytes.
- str
cpu_sharesis a string specifying the amount of CPU to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "m" (e.g., "500m" for 500 millicores, "2" for 2 cores) CPU shares can be specified in millicores (1 core = 1000 millicores). If you don't specify a unit, the value is interpreted as the number of cores.- str
memory_sharesis a string specifying the amount of memory to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "K", "M", "G", "T", "P", "E" (e.g., "128M" for 128 megabytes) - Binary SI units: "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" (e.g., "512Mi" for 512 mebibytes) If you don't specify a unit, the value is interpreted as bytes.
- String
cpu_sharesis a string specifying the amount of CPU to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "m" (e.g., "500m" for 500 millicores, "2" for 2 cores) CPU shares can be specified in millicores (1 core = 1000 millicores). If you don't specify a unit, the value is interpreted as the number of cores.- String
memory_sharesis a string specifying the amount of memory to allocate for the pipeline. This follows the Kubernetes quantity format. Acceptable units include: - Decimal SI units: "K", "M", "G", "T", "P", "E" (e.g., "128M" for 128 megabytes) - Binary SI units: "Ki", "Mi", "Gi", "Ti", "Pi", "Ei" (e.g., "512Mi" for 512 mebibytes) If you don't specify a unit, the value is interpreted as bytes.
PipelineServiceAccount, PipelineServiceAccountArgs
- Client
Id string - Client ID
- Client
Secret string - Client Secret. Must match pattern
^\$\{secrets\.[A-Za-z_][A-Za-z0-9_]*(\.[A-Za-z_][A-Za-z0-9_]*)?\}$. - Secret
Version double - Version number for client_secret. Increment to trigger a secret update.
- Client
Id string - Client ID
- Client
Secret string - Client Secret. Must match pattern
^\$\{secrets\.[A-Za-z_][A-Za-z0-9_]*(\.[A-Za-z_][A-Za-z0-9_]*)?\}$. - Secret
Version float64 - Version number for client_secret. Increment to trigger a secret update.
- client_
id string - Client ID
- client_
secret string - Client Secret. Must match pattern
^\$\{secrets\.[A-Za-z_][A-Za-z0-9_]*(\.[A-Za-z_][A-Za-z0-9_]*)?\}$. - secret_
version number - Version number for client_secret. Increment to trigger a secret update.
- client
Id String - Client ID
- client
Secret String - Client Secret. Must match pattern
^\$\{secrets\.[A-Za-z_][A-Za-z0-9_]*(\.[A-Za-z_][A-Za-z0-9_]*)?\}$. - secret
Version Double - Version number for client_secret. Increment to trigger a secret update.
- client
Id string - Client ID
- client
Secret string - Client Secret. Must match pattern
^\$\{secrets\.[A-Za-z_][A-Za-z0-9_]*(\.[A-Za-z_][A-Za-z0-9_]*)?\}$. - secret
Version number - Version number for client_secret. Increment to trigger a secret update.
- client_
id str - Client ID
- client_
secret str - Client Secret. Must match pattern
^\$\{secrets\.[A-Za-z_][A-Za-z0-9_]*(\.[A-Za-z_][A-Za-z0-9_]*)?\}$. - secret_
version float - Version number for client_secret. Increment to trigger a secret update.
- client
Id String - Client ID
- client
Secret String - Client Secret. Must match pattern
^\$\{secrets\.[A-Za-z_][A-Za-z0-9_]*(\.[A-Za-z_][A-Za-z0-9_]*)?\}$. - secret
Version Number - Version number for client_secret. Increment to trigger a secret update.
PipelineStatus, PipelineStatusArgs
- Error string
- Error
- Error string
- Error
- error string
- Error
- error String
- Error
- error string
- Error
- error str
- Error
- error String
- Error
PipelineTimeouts, PipelineTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Import
$ pulumi import redpanda:index/pipeline:Pipeline example pipelineId,clusterId
Where pipelineId is the ID of the pipeline and clusterId is the ID of the cluster in Redpanda Cloud.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- redpanda redpanda-data/terraform-provider-redpanda
- License
- Notes
- This Pulumi package is based on the
redpandaTerraform Provider.
published on Wednesday, Jun 3, 2026 by redpanda-data