1. Packages
  2. Grafana Cloud
  3. API Docs
  4. fleetManagement
  5. Pipeline
Grafana v0.16.3 published on Monday, Apr 7, 2025 by pulumiverse

grafana.fleetManagement.Pipeline

Explore with Pulumi AI

Manages Grafana Fleet Management pipelines.

Required access policy scopes:

  • fleet-management:read
  • fleet-management:write

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,
             contents: Optional[str] = None,
             enabled: Optional[bool] = None,
             matchers: Optional[Sequence[str]] = None,
             name: Optional[str] = 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: grafana:fleetManagement:Pipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PipelineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. PipelineArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PipelineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 Grafana.FleetManagement.Pipeline("pipelineResource", new()
{
    Contents = "string",
    Enabled = false,
    Matchers = new[]
    {
        "string",
    },
    Name = "string",
});
Copy
example, err := fleetManagement.NewPipeline(ctx, "pipelineResource", &fleetManagement.PipelineArgs{
	Contents: pulumi.String("string"),
	Enabled:  pulumi.Bool(false),
	Matchers: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})
Copy
var pipelineResource = new Pipeline("pipelineResource", PipelineArgs.builder()
    .contents("string")
    .enabled(false)
    .matchers("string")
    .name("string")
    .build());
Copy
pipeline_resource = grafana.fleet_management.Pipeline("pipelineResource",
    contents="string",
    enabled=False,
    matchers=["string"],
    name="string")
Copy
const pipelineResource = new grafana.fleetmanagement.Pipeline("pipelineResource", {
    contents: "string",
    enabled: false,
    matchers: ["string"],
    name: "string",
});
Copy
type: grafana:fleetManagement:Pipeline
properties:
    contents: string
    enabled: false
    matchers:
        - string
    name: string
Copy

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:

Contents This property is required. string
Configuration contents of the pipeline to be used by collectors
Enabled bool
Whether the pipeline is enabled for collectors
Matchers List<string>
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
Name string
Name of the pipeline which is the unique identifier for the pipeline
Contents This property is required. string
Configuration contents of the pipeline to be used by collectors
Enabled bool
Whether the pipeline is enabled for collectors
Matchers []string
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
Name string
Name of the pipeline which is the unique identifier for the pipeline
contents This property is required. String
Configuration contents of the pipeline to be used by collectors
enabled Boolean
Whether the pipeline is enabled for collectors
matchers List<String>
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
name String
Name of the pipeline which is the unique identifier for the pipeline
contents This property is required. string
Configuration contents of the pipeline to be used by collectors
enabled boolean
Whether the pipeline is enabled for collectors
matchers string[]
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
name string
Name of the pipeline which is the unique identifier for the pipeline
contents This property is required. str
Configuration contents of the pipeline to be used by collectors
enabled bool
Whether the pipeline is enabled for collectors
matchers Sequence[str]
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
name str
Name of the pipeline which is the unique identifier for the pipeline
contents This property is required. String
Configuration contents of the pipeline to be used by collectors
enabled Boolean
Whether the pipeline is enabled for collectors
matchers List<String>
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
name String
Name of the pipeline which is the unique identifier for the pipeline

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.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

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,
        contents: Optional[str] = None,
        enabled: Optional[bool] = None,
        matchers: Optional[Sequence[str]] = None,
        name: Optional[str] = None) -> Pipeline
func 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: grafana:fleetManagement:Pipeline    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
Contents string
Configuration contents of the pipeline to be used by collectors
Enabled bool
Whether the pipeline is enabled for collectors
Matchers List<string>
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
Name string
Name of the pipeline which is the unique identifier for the pipeline
Contents string
Configuration contents of the pipeline to be used by collectors
Enabled bool
Whether the pipeline is enabled for collectors
Matchers []string
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
Name string
Name of the pipeline which is the unique identifier for the pipeline
contents String
Configuration contents of the pipeline to be used by collectors
enabled Boolean
Whether the pipeline is enabled for collectors
matchers List<String>
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
name String
Name of the pipeline which is the unique identifier for the pipeline
contents string
Configuration contents of the pipeline to be used by collectors
enabled boolean
Whether the pipeline is enabled for collectors
matchers string[]
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
name string
Name of the pipeline which is the unique identifier for the pipeline
contents str
Configuration contents of the pipeline to be used by collectors
enabled bool
Whether the pipeline is enabled for collectors
matchers Sequence[str]
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
name str
Name of the pipeline which is the unique identifier for the pipeline
contents String
Configuration contents of the pipeline to be used by collectors
enabled Boolean
Whether the pipeline is enabled for collectors
matchers List<String>
Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
name String
Name of the pipeline which is the unique identifier for the pipeline

Import

$ pulumi import grafana:fleetManagement/pipeline:Pipeline name "{{ name }}"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
grafana pulumiverse/pulumi-grafana
License
Apache-2.0
Notes
This Pulumi package is based on the grafana Terraform Provider.