ionoscloud.logging.Pipeline
Explore with Pulumi AI
Manages a Logging pipeline.
⚠️ Only tokens are accepted for authorization in the logging_pipeline resource. Please ensure you are using tokens as other methods will not be valid.
Usage example
import * as pulumi from "@pulumi/pulumi";
import * as ionoscloud from "@ionos-cloud/sdk-pulumi";
const example = new ionoscloud.logging.Pipeline("example", {
location: "es/vit",
name: "pipelineexample",
logs: [
{
source: "kubernetes",
tag: "tagexample",
protocol: "http",
destinations: [{
type: "loki",
retentionInDays: 7,
}],
},
{
source: "kubernetes",
tag: "anothertagexample",
protocol: "tcp",
destinations: [{
type: "loki",
retentionInDays: 7,
}],
},
],
});
import pulumi
import pulumi_ionoscloud as ionoscloud
example = ionoscloud.logging.Pipeline("example",
location="es/vit",
name="pipelineexample",
logs=[
{
"source": "kubernetes",
"tag": "tagexample",
"protocol": "http",
"destinations": [{
"type": "loki",
"retention_in_days": 7,
}],
},
{
"source": "kubernetes",
"tag": "anothertagexample",
"protocol": "tcp",
"destinations": [{
"type": "loki",
"retention_in_days": 7,
}],
},
])
package main
import (
"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/logging"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := logging.NewPipeline(ctx, "example", &logging.PipelineArgs{
Location: pulumi.String("es/vit"),
Name: pulumi.String("pipelineexample"),
Logs: logging.PipelineLogArray{
&logging.PipelineLogArgs{
Source: pulumi.String("kubernetes"),
Tag: pulumi.String("tagexample"),
Protocol: pulumi.String("http"),
Destinations: logging.PipelineLogDestinationArray{
&logging.PipelineLogDestinationArgs{
Type: pulumi.String("loki"),
RetentionInDays: pulumi.Int(7),
},
},
},
&logging.PipelineLogArgs{
Source: pulumi.String("kubernetes"),
Tag: pulumi.String("anothertagexample"),
Protocol: pulumi.String("tcp"),
Destinations: logging.PipelineLogDestinationArray{
&logging.PipelineLogDestinationArgs{
Type: pulumi.String("loki"),
RetentionInDays: pulumi.Int(7),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ionoscloud = Ionoscloud.Pulumi.Ionoscloud;
return await Deployment.RunAsync(() =>
{
var example = new Ionoscloud.Logging.Pipeline("example", new()
{
Location = "es/vit",
Name = "pipelineexample",
Logs = new[]
{
new Ionoscloud.Logging.Inputs.PipelineLogArgs
{
Source = "kubernetes",
Tag = "tagexample",
Protocol = "http",
Destinations = new[]
{
new Ionoscloud.Logging.Inputs.PipelineLogDestinationArgs
{
Type = "loki",
RetentionInDays = 7,
},
},
},
new Ionoscloud.Logging.Inputs.PipelineLogArgs
{
Source = "kubernetes",
Tag = "anothertagexample",
Protocol = "tcp",
Destinations = new[]
{
new Ionoscloud.Logging.Inputs.PipelineLogDestinationArgs
{
Type = "loki",
RetentionInDays = 7,
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.logging.Pipeline;
import com.pulumi.ionoscloud.logging.PipelineArgs;
import com.pulumi.ionoscloud.logging.inputs.PipelineLogArgs;
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 Pipeline("example", PipelineArgs.builder()
.location("es/vit")
.name("pipelineexample")
.logs(
PipelineLogArgs.builder()
.source("kubernetes")
.tag("tagexample")
.protocol("http")
.destinations(PipelineLogDestinationArgs.builder()
.type("loki")
.retentionInDays(7)
.build())
.build(),
PipelineLogArgs.builder()
.source("kubernetes")
.tag("anothertagexample")
.protocol("tcp")
.destinations(PipelineLogDestinationArgs.builder()
.type("loki")
.retentionInDays(7)
.build())
.build())
.build());
}
}
resources:
example:
type: ionoscloud:logging:Pipeline
properties:
location: es/vit
name: pipelineexample
logs:
- source: kubernetes
tag: tagexample
protocol: http
destinations:
- type: loki
retentionInDays: 7
- source: kubernetes
tag: anothertagexample
protocol: tcp
destinations:
- type: loki
retentionInDays: 7
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,
logs: Optional[Sequence[PipelineLogArgs]] = None,
location: Optional[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: ionoscloud:logging:Pipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
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 Ionoscloud.Logging.Pipeline("pipelineResource", new()
{
Logs = new[]
{
new Ionoscloud.Logging.Inputs.PipelineLogArgs
{
Protocol = "string",
Source = "string",
Tag = "string",
Destinations = new[]
{
new Ionoscloud.Logging.Inputs.PipelineLogDestinationArgs
{
RetentionInDays = 0,
Type = "string",
},
},
Public = false,
},
},
Location = "string",
Name = "string",
});
example, err := logging.NewPipeline(ctx, "pipelineResource", &logging.PipelineArgs{
Logs: logging.PipelineLogArray{
&logging.PipelineLogArgs{
Protocol: pulumi.String("string"),
Source: pulumi.String("string"),
Tag: pulumi.String("string"),
Destinations: logging.PipelineLogDestinationArray{
&logging.PipelineLogDestinationArgs{
RetentionInDays: pulumi.Int(0),
Type: pulumi.String("string"),
},
},
Public: pulumi.Bool(false),
},
},
Location: pulumi.String("string"),
Name: pulumi.String("string"),
})
var pipelineResource = new Pipeline("pipelineResource", PipelineArgs.builder()
.logs(PipelineLogArgs.builder()
.protocol("string")
.source("string")
.tag("string")
.destinations(PipelineLogDestinationArgs.builder()
.retentionInDays(0)
.type("string")
.build())
.public_(false)
.build())
.location("string")
.name("string")
.build());
pipeline_resource = ionoscloud.logging.Pipeline("pipelineResource",
logs=[{
"protocol": "string",
"source": "string",
"tag": "string",
"destinations": [{
"retention_in_days": 0,
"type": "string",
}],
"public": False,
}],
location="string",
name="string")
const pipelineResource = new ionoscloud.logging.Pipeline("pipelineResource", {
logs: [{
protocol: "string",
source: "string",
tag: "string",
destinations: [{
retentionInDays: 0,
type: "string",
}],
"public": false,
}],
location: "string",
name: "string",
});
type: ionoscloud:logging:Pipeline
properties:
location: string
logs:
- destinations:
- retentionInDays: 0
type: string
protocol: string
public: false
source: string
tag: string
name: 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:
- Logs
List<Ionoscloud.
Pipeline Log> - [list] Pipeline logs, a list that contains elements with the following structure:
- Location string
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - Name string
- [string] The name of the Logging pipeline.
- Logs
[]Pipeline
Log Args - [list] Pipeline logs, a list that contains elements with the following structure:
- Location string
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - Name string
- [string] The name of the Logging pipeline.
- logs
List<Pipeline
Log> - [list] Pipeline logs, a list that contains elements with the following structure:
- location String
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - name String
- [string] The name of the Logging pipeline.
- logs
Pipeline
Log[] - [list] Pipeline logs, a list that contains elements with the following structure:
- location string
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - name string
- [string] The name of the Logging pipeline.
- logs
Sequence[Pipeline
Log Args] - [list] Pipeline logs, a list that contains elements with the following structure:
- location str
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - name str
- [string] The name of the Logging pipeline.
- logs List<Property Map>
- [list] Pipeline logs, a list that contains elements with the following structure:
- location String
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - name String
- [string] The name of the Logging pipeline.
Outputs
All input properties are implicitly available as output properties. Additionally, the Pipeline resource produces the following output properties:
- Grafana
Address string - [string] The address of the client's grafana instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Grafana
Address string - [string] The address of the client's grafana instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- grafana
Address String - [string] The address of the client's grafana instance.
- id String
- The provider-assigned unique ID for this managed resource.
- grafana
Address string - [string] The address of the client's grafana instance.
- id string
- The provider-assigned unique ID for this managed resource.
- grafana_
address str - [string] The address of the client's grafana instance.
- id str
- The provider-assigned unique ID for this managed resource.
- grafana
Address String - [string] The address of the client's grafana instance.
- 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,
grafana_address: Optional[str] = None,
location: Optional[str] = None,
logs: Optional[Sequence[PipelineLogArgs]] = 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: ionoscloud:logging:Pipeline get: 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.
- Grafana
Address string - [string] The address of the client's grafana instance.
- Location string
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - Logs
List<Ionoscloud.
Pipeline Log> - [list] Pipeline logs, a list that contains elements with the following structure:
- Name string
- [string] The name of the Logging pipeline.
- Grafana
Address string - [string] The address of the client's grafana instance.
- Location string
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - Logs
[]Pipeline
Log Args - [list] Pipeline logs, a list that contains elements with the following structure:
- Name string
- [string] The name of the Logging pipeline.
- grafana
Address String - [string] The address of the client's grafana instance.
- location String
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - logs
List<Pipeline
Log> - [list] Pipeline logs, a list that contains elements with the following structure:
- name String
- [string] The name of the Logging pipeline.
- grafana
Address string - [string] The address of the client's grafana instance.
- location string
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - logs
Pipeline
Log[] - [list] Pipeline logs, a list that contains elements with the following structure:
- name string
- [string] The name of the Logging pipeline.
- grafana_
address str - [string] The address of the client's grafana instance.
- location str
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - logs
Sequence[Pipeline
Log Args] - [list] Pipeline logs, a list that contains elements with the following structure:
- name str
- [string] The name of the Logging pipeline.
- grafana
Address String - [string] The address of the client's grafana instance.
- location String
- [string] The location of the Logging pipeline. Default:
de/txl
One ofde/fra
,de/txl
,gb/lhr
,es/vit
,fr/par
. If this is not set and if no value is provided for theIONOS_API_URL
env var, the defaultlocation
will be:de/fra
. - logs List<Property Map>
- [list] Pipeline logs, a list that contains elements with the following structure:
- name String
- [string] The name of the Logging pipeline.
Supporting Types
PipelineLog, PipelineLogArgs
- Protocol string
- [string] "Protocol to use as intake. Possible values are: http, tcp."
- Source string
- [string] The source parser to be used.
- Tag string
- [string] The tag is used to distinguish different pipelines. Must be unique amongst the pipeline's array items.
- Destinations
List<Ionoscloud.
Pipeline Log Destination> - [list] The configuration of the logs datastore, a list that contains elements with the following structure:
- Public bool
- [bool]
- Protocol string
- [string] "Protocol to use as intake. Possible values are: http, tcp."
- Source string
- [string] The source parser to be used.
- Tag string
- [string] The tag is used to distinguish different pipelines. Must be unique amongst the pipeline's array items.
- Destinations
[]Pipeline
Log Destination - [list] The configuration of the logs datastore, a list that contains elements with the following structure:
- Public bool
- [bool]
- protocol String
- [string] "Protocol to use as intake. Possible values are: http, tcp."
- source String
- [string] The source parser to be used.
- tag String
- [string] The tag is used to distinguish different pipelines. Must be unique amongst the pipeline's array items.
- destinations
List<Pipeline
Log Destination> - [list] The configuration of the logs datastore, a list that contains elements with the following structure:
- public_ Boolean
- [bool]
- protocol string
- [string] "Protocol to use as intake. Possible values are: http, tcp."
- source string
- [string] The source parser to be used.
- tag string
- [string] The tag is used to distinguish different pipelines. Must be unique amongst the pipeline's array items.
- destinations
Pipeline
Log Destination[] - [list] The configuration of the logs datastore, a list that contains elements with the following structure:
- public boolean
- [bool]
- protocol str
- [string] "Protocol to use as intake. Possible values are: http, tcp."
- source str
- [string] The source parser to be used.
- tag str
- [string] The tag is used to distinguish different pipelines. Must be unique amongst the pipeline's array items.
- destinations
Sequence[Pipeline
Log Destination] - [list] The configuration of the logs datastore, a list that contains elements with the following structure:
- public bool
- [bool]
- protocol String
- [string] "Protocol to use as intake. Possible values are: http, tcp."
- source String
- [string] The source parser to be used.
- tag String
- [string] The tag is used to distinguish different pipelines. Must be unique amongst the pipeline's array items.
- destinations List<Property Map>
- [list] The configuration of the logs datastore, a list that contains elements with the following structure:
- public Boolean
- [bool]
PipelineLogDestination, PipelineLogDestinationArgs
- Retention
In intDays - [int] Defines the number of days a log record should be kept in loki. Works with loki destination type only. Can be one of: 7, 14, 30.
- Type string
- [string] The internal output stream to send logs to.
- Retention
In intDays - [int] Defines the number of days a log record should be kept in loki. Works with loki destination type only. Can be one of: 7, 14, 30.
- Type string
- [string] The internal output stream to send logs to.
- retention
In IntegerDays - [int] Defines the number of days a log record should be kept in loki. Works with loki destination type only. Can be one of: 7, 14, 30.
- type String
- [string] The internal output stream to send logs to.
- retention
In numberDays - [int] Defines the number of days a log record should be kept in loki. Works with loki destination type only. Can be one of: 7, 14, 30.
- type string
- [string] The internal output stream to send logs to.
- retention_
in_ intdays - [int] Defines the number of days a log record should be kept in loki. Works with loki destination type only. Can be one of: 7, 14, 30.
- type str
- [string] The internal output stream to send logs to.
- retention
In NumberDays - [int] Defines the number of days a log record should be kept in loki. Works with loki destination type only. Can be one of: 7, 14, 30.
- type String
- [string] The internal output stream to send logs to.
Import
In order to import a Logging pipeline, you can define an empty Logging pipeline resource in the plan:
hcl
resource “ionoscloud_logging_pipeline” “example” {
}
The resource can be imported using the location
and pipeline_id
, for example:
$ pulumi import ionoscloud:logging/pipeline:Pipeline example location:pipeline_id
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- ionoscloud ionos-cloud/pulumi-ionoscloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ionoscloud
Terraform Provider.