Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aptible Provider
  3. API Docs
  4. LogDrain
aptible 0.9.12 published on Monday, Apr 14, 2025 by aptible
aptible/terraform-provider-aptible

aptible.LogDrain

Explore with Pulumi AI

aptible 0.9.12 published on Monday, Apr 14, 2025 by aptible
aptible/terraform-provider-aptible

# Aptible Log Drain Resource

This resource is used to create and manage Log Drains running on Aptible Deploy.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aptible from "@pulumi/aptible";

const syslogLogDrain = new aptible.LogDrain("syslogLogDrain", {
    drainHost: "syslog.aptible.com",
    drainPort: 1234,
    drainType: "syslog_tls_tcp",
    envId: 123,
    handle: "syslog_log_drain",
});
Copy
import pulumi
import pulumi_aptible as aptible

syslog_log_drain = aptible.LogDrain("syslogLogDrain",
    drain_host="syslog.aptible.com",
    drain_port=1234,
    drain_type="syslog_tls_tcp",
    env_id=123,
    handle="syslog_log_drain")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/aptible/aptible"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aptible.NewLogDrain(ctx, "syslogLogDrain", &aptible.LogDrainArgs{
			DrainHost: pulumi.String("syslog.aptible.com"),
			DrainPort: pulumi.Float64(1234),
			DrainType: pulumi.String("syslog_tls_tcp"),
			EnvId:     pulumi.Float64(123),
			Handle:    pulumi.String("syslog_log_drain"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aptible = Pulumi.Aptible;

return await Deployment.RunAsync(() => 
{
    var syslogLogDrain = new Aptible.LogDrain("syslogLogDrain", new()
    {
        DrainHost = "syslog.aptible.com",
        DrainPort = 1234,
        DrainType = "syslog_tls_tcp",
        EnvId = 123,
        Handle = "syslog_log_drain",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aptible.LogDrain;
import com.pulumi.aptible.LogDrainArgs;
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 syslogLogDrain = new LogDrain("syslogLogDrain", LogDrainArgs.builder()
            .drainHost("syslog.aptible.com")
            .drainPort("1234")
            .drainType("syslog_tls_tcp")
            .envId(123)
            .handle("syslog_log_drain")
            .build());

    }
}
Copy
resources:
  syslogLogDrain:
    type: aptible:LogDrain
    properties:
      drainHost: syslog.aptible.com
      drainPort: '1234'
      drainType: syslog_tls_tcp
      envId: 123
      handle: syslog_log_drain
Copy
import * as pulumi from "@pulumi/pulumi";
import * as aptible from "@pulumi/aptible";

const httpLogDrain = new aptible.LogDrain("httpLogDrain", {
    drainApps: false,
    drainProxies: true,
    drainType: "https_post",
    envId: 123,
    handle: "http_log_drain",
    url: "https://test.aptible.com",
});
Copy
import pulumi
import pulumi_aptible as aptible

http_log_drain = aptible.LogDrain("httpLogDrain",
    drain_apps=False,
    drain_proxies=True,
    drain_type="https_post",
    env_id=123,
    handle="http_log_drain",
    url="https://test.aptible.com")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/aptible/aptible"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aptible.NewLogDrain(ctx, "httpLogDrain", &aptible.LogDrainArgs{
			DrainApps:    pulumi.Bool(false),
			DrainProxies: pulumi.Bool(true),
			DrainType:    pulumi.String("https_post"),
			EnvId:        pulumi.Float64(123),
			Handle:       pulumi.String("http_log_drain"),
			Url:          pulumi.String("https://test.aptible.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aptible = Pulumi.Aptible;

return await Deployment.RunAsync(() => 
{
    var httpLogDrain = new Aptible.LogDrain("httpLogDrain", new()
    {
        DrainApps = false,
        DrainProxies = true,
        DrainType = "https_post",
        EnvId = 123,
        Handle = "http_log_drain",
        Url = "https://test.aptible.com",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aptible.LogDrain;
import com.pulumi.aptible.LogDrainArgs;
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 httpLogDrain = new LogDrain("httpLogDrain", LogDrainArgs.builder()
            .drainApps(false)
            .drainProxies(true)
            .drainType("https_post")
            .envId(123)
            .handle("http_log_drain")
            .url("https://test.aptible.com")
            .build());

    }
}
Copy
resources:
  httpLogDrain:
    type: aptible:LogDrain
    properties:
      drainApps: false
      drainProxies: true
      drainType: https_post
      envId: 123
      handle: http_log_drain
      url: https://test.aptible.com
Copy

Create LogDrain Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new LogDrain(name: string, args: LogDrainArgs, opts?: CustomResourceOptions);
@overload
def LogDrain(resource_name: str,
             args: LogDrainArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def LogDrain(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             drain_type: Optional[str] = None,
             handle: Optional[str] = None,
             env_id: Optional[float] = None,
             drain_ephemeral_sessions: Optional[bool] = None,
             drain_username: Optional[str] = None,
             drain_host: Optional[str] = None,
             drain_password: Optional[str] = None,
             drain_port: Optional[float] = None,
             drain_proxies: Optional[bool] = None,
             drain_databases: Optional[bool] = None,
             aptible_log_drain_id: Optional[str] = None,
             drain_apps: Optional[bool] = None,
             database_id: Optional[float] = None,
             logging_token: Optional[str] = None,
             pipeline: Optional[str] = None,
             tags: Optional[str] = None,
             token: Optional[str] = None,
             url: Optional[str] = None)
func NewLogDrain(ctx *Context, name string, args LogDrainArgs, opts ...ResourceOption) (*LogDrain, error)
public LogDrain(string name, LogDrainArgs args, CustomResourceOptions? opts = null)
public LogDrain(String name, LogDrainArgs args)
public LogDrain(String name, LogDrainArgs args, CustomResourceOptions options)

type: aptible:LogDrain
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. LogDrainArgs
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. LogDrainArgs
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. LogDrainArgs
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. LogDrainArgs
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. LogDrainArgs
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 logDrainResource = new Aptible.LogDrain("logDrainResource", new()
{
    DrainType = "string",
    Handle = "string",
    EnvId = 0,
    DrainEphemeralSessions = false,
    DrainUsername = "string",
    DrainHost = "string",
    DrainPassword = "string",
    DrainPort = 0,
    DrainProxies = false,
    DrainDatabases = false,
    AptibleLogDrainId = "string",
    DrainApps = false,
    DatabaseId = 0,
    LoggingToken = "string",
    Pipeline = "string",
    Tags = "string",
    Token = "string",
    Url = "string",
});
Copy
example, err := aptible.NewLogDrain(ctx, "logDrainResource", &aptible.LogDrainArgs{
DrainType: pulumi.String("string"),
Handle: pulumi.String("string"),
EnvId: pulumi.Float64(0),
DrainEphemeralSessions: pulumi.Bool(false),
DrainUsername: pulumi.String("string"),
DrainHost: pulumi.String("string"),
DrainPassword: pulumi.String("string"),
DrainPort: pulumi.Float64(0),
DrainProxies: pulumi.Bool(false),
DrainDatabases: pulumi.Bool(false),
AptibleLogDrainId: pulumi.String("string"),
DrainApps: pulumi.Bool(false),
DatabaseId: pulumi.Float64(0),
LoggingToken: pulumi.String("string"),
Pipeline: pulumi.String("string"),
Tags: pulumi.String("string"),
Token: pulumi.String("string"),
Url: pulumi.String("string"),
})
Copy
var logDrainResource = new LogDrain("logDrainResource", LogDrainArgs.builder()
    .drainType("string")
    .handle("string")
    .envId(0)
    .drainEphemeralSessions(false)
    .drainUsername("string")
    .drainHost("string")
    .drainPassword("string")
    .drainPort(0)
    .drainProxies(false)
    .drainDatabases(false)
    .aptibleLogDrainId("string")
    .drainApps(false)
    .databaseId(0)
    .loggingToken("string")
    .pipeline("string")
    .tags("string")
    .token("string")
    .url("string")
    .build());
Copy
log_drain_resource = aptible.LogDrain("logDrainResource",
    drain_type="string",
    handle="string",
    env_id=0,
    drain_ephemeral_sessions=False,
    drain_username="string",
    drain_host="string",
    drain_password="string",
    drain_port=0,
    drain_proxies=False,
    drain_databases=False,
    aptible_log_drain_id="string",
    drain_apps=False,
    database_id=0,
    logging_token="string",
    pipeline="string",
    tags="string",
    token="string",
    url="string")
Copy
const logDrainResource = new aptible.LogDrain("logDrainResource", {
    drainType: "string",
    handle: "string",
    envId: 0,
    drainEphemeralSessions: false,
    drainUsername: "string",
    drainHost: "string",
    drainPassword: "string",
    drainPort: 0,
    drainProxies: false,
    drainDatabases: false,
    aptibleLogDrainId: "string",
    drainApps: false,
    databaseId: 0,
    loggingToken: "string",
    pipeline: "string",
    tags: "string",
    token: "string",
    url: "string",
});
Copy
type: aptible:LogDrain
properties:
    aptibleLogDrainId: string
    databaseId: 0
    drainApps: false
    drainDatabases: false
    drainEphemeralSessions: false
    drainHost: string
    drainPassword: string
    drainPort: 0
    drainProxies: false
    drainType: string
    drainUsername: string
    envId: 0
    handle: string
    loggingToken: string
    pipeline: string
    tags: string
    token: string
    url: string
Copy

LogDrain 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 LogDrain resource accepts the following input properties:

DrainType This property is required. string
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
EnvId This property is required. double
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
Handle This property is required. string
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
AptibleLogDrainId string
DatabaseId double
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
DrainApps bool
If the drain should collect logs from apps.
DrainDatabases bool
If the drain should collect logs from databases.
DrainEphemeralSessions bool
If the drain should collect logs from SSH sessions.
DrainHost string
The host name of the destination to send logs to.
DrainPassword string
DrainPort double
The port for the destination where logs drains will be sent.
DrainProxies bool
If the drain should collect logs from Endpoints.
DrainUsername string
LoggingToken string
The logging token prepended to logs by syslog and papertrail drains.
Pipeline string
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
Tags string
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
Token string
The API token used by logdna and datadog drains.
Url string
The destination url where the logs will be sent.
DrainType This property is required. string
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
EnvId This property is required. float64
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
Handle This property is required. string
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
AptibleLogDrainId string
DatabaseId float64
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
DrainApps bool
If the drain should collect logs from apps.
DrainDatabases bool
If the drain should collect logs from databases.
DrainEphemeralSessions bool
If the drain should collect logs from SSH sessions.
DrainHost string
The host name of the destination to send logs to.
DrainPassword string
DrainPort float64
The port for the destination where logs drains will be sent.
DrainProxies bool
If the drain should collect logs from Endpoints.
DrainUsername string
LoggingToken string
The logging token prepended to logs by syslog and papertrail drains.
Pipeline string
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
Tags string
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
Token string
The API token used by logdna and datadog drains.
Url string
The destination url where the logs will be sent.
drainType This property is required. String
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
envId This property is required. Double
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
handle This property is required. String
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
aptibleLogDrainId String
databaseId Double
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
drainApps Boolean
If the drain should collect logs from apps.
drainDatabases Boolean
If the drain should collect logs from databases.
drainEphemeralSessions Boolean
If the drain should collect logs from SSH sessions.
drainHost String
The host name of the destination to send logs to.
drainPassword String
drainPort Double
The port for the destination where logs drains will be sent.
drainProxies Boolean
If the drain should collect logs from Endpoints.
drainUsername String
loggingToken String
The logging token prepended to logs by syslog and papertrail drains.
pipeline String
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
tags String
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
token String
The API token used by logdna and datadog drains.
url String
The destination url where the logs will be sent.
drainType This property is required. string
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
envId This property is required. number
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
handle This property is required. string
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
aptibleLogDrainId string
databaseId number
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
drainApps boolean
If the drain should collect logs from apps.
drainDatabases boolean
If the drain should collect logs from databases.
drainEphemeralSessions boolean
If the drain should collect logs from SSH sessions.
drainHost string
The host name of the destination to send logs to.
drainPassword string
drainPort number
The port for the destination where logs drains will be sent.
drainProxies boolean
If the drain should collect logs from Endpoints.
drainUsername string
loggingToken string
The logging token prepended to logs by syslog and papertrail drains.
pipeline string
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
tags string
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
token string
The API token used by logdna and datadog drains.
url string
The destination url where the logs will be sent.
drain_type This property is required. str
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
env_id This property is required. float
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
handle This property is required. str
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
aptible_log_drain_id str
database_id float
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
drain_apps bool
If the drain should collect logs from apps.
drain_databases bool
If the drain should collect logs from databases.
drain_ephemeral_sessions bool
If the drain should collect logs from SSH sessions.
drain_host str
The host name of the destination to send logs to.
drain_password str
drain_port float
The port for the destination where logs drains will be sent.
drain_proxies bool
If the drain should collect logs from Endpoints.
drain_username str
logging_token str
The logging token prepended to logs by syslog and papertrail drains.
pipeline str
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
tags str
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
token str
The API token used by logdna and datadog drains.
url str
The destination url where the logs will be sent.
drainType This property is required. String
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
envId This property is required. Number
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
handle This property is required. String
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
aptibleLogDrainId String
databaseId Number
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
drainApps Boolean
If the drain should collect logs from apps.
drainDatabases Boolean
If the drain should collect logs from databases.
drainEphemeralSessions Boolean
If the drain should collect logs from SSH sessions.
drainHost String
The host name of the destination to send logs to.
drainPassword String
drainPort Number
The port for the destination where logs drains will be sent.
drainProxies Boolean
If the drain should collect logs from Endpoints.
drainUsername String
loggingToken String
The logging token prepended to logs by syslog and papertrail drains.
pipeline String
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
tags String
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
token String
The API token used by logdna and datadog drains.
url String
The destination url where the logs will be sent.

Outputs

All input properties are implicitly available as output properties. Additionally, the LogDrain resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
LogDrainId double
The unique ID for the log drain.
Id string
The provider-assigned unique ID for this managed resource.
LogDrainId float64
The unique ID for the log drain.
id String
The provider-assigned unique ID for this managed resource.
logDrainId Double
The unique ID for the log drain.
id string
The provider-assigned unique ID for this managed resource.
logDrainId number
The unique ID for the log drain.
id str
The provider-assigned unique ID for this managed resource.
log_drain_id float
The unique ID for the log drain.
id String
The provider-assigned unique ID for this managed resource.
logDrainId Number
The unique ID for the log drain.

Look up Existing LogDrain Resource

Get an existing LogDrain 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?: LogDrainState, opts?: CustomResourceOptions): LogDrain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aptible_log_drain_id: Optional[str] = None,
        database_id: Optional[float] = None,
        drain_apps: Optional[bool] = None,
        drain_databases: Optional[bool] = None,
        drain_ephemeral_sessions: Optional[bool] = None,
        drain_host: Optional[str] = None,
        drain_password: Optional[str] = None,
        drain_port: Optional[float] = None,
        drain_proxies: Optional[bool] = None,
        drain_type: Optional[str] = None,
        drain_username: Optional[str] = None,
        env_id: Optional[float] = None,
        handle: Optional[str] = None,
        log_drain_id: Optional[float] = None,
        logging_token: Optional[str] = None,
        pipeline: Optional[str] = None,
        tags: Optional[str] = None,
        token: Optional[str] = None,
        url: Optional[str] = None) -> LogDrain
func GetLogDrain(ctx *Context, name string, id IDInput, state *LogDrainState, opts ...ResourceOption) (*LogDrain, error)
public static LogDrain Get(string name, Input<string> id, LogDrainState? state, CustomResourceOptions? opts = null)
public static LogDrain get(String name, Output<String> id, LogDrainState state, CustomResourceOptions options)
resources:  _:    type: aptible:LogDrain    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:
AptibleLogDrainId string
DatabaseId double
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
DrainApps bool
If the drain should collect logs from apps.
DrainDatabases bool
If the drain should collect logs from databases.
DrainEphemeralSessions bool
If the drain should collect logs from SSH sessions.
DrainHost string
The host name of the destination to send logs to.
DrainPassword string
DrainPort double
The port for the destination where logs drains will be sent.
DrainProxies bool
If the drain should collect logs from Endpoints.
DrainType string
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
DrainUsername string
EnvId double
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
Handle string
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
LogDrainId double
The unique ID for the log drain.
LoggingToken string
The logging token prepended to logs by syslog and papertrail drains.
Pipeline string
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
Tags string
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
Token string
The API token used by logdna and datadog drains.
Url string
The destination url where the logs will be sent.
AptibleLogDrainId string
DatabaseId float64
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
DrainApps bool
If the drain should collect logs from apps.
DrainDatabases bool
If the drain should collect logs from databases.
DrainEphemeralSessions bool
If the drain should collect logs from SSH sessions.
DrainHost string
The host name of the destination to send logs to.
DrainPassword string
DrainPort float64
The port for the destination where logs drains will be sent.
DrainProxies bool
If the drain should collect logs from Endpoints.
DrainType string
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
DrainUsername string
EnvId float64
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
Handle string
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
LogDrainId float64
The unique ID for the log drain.
LoggingToken string
The logging token prepended to logs by syslog and papertrail drains.
Pipeline string
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
Tags string
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
Token string
The API token used by logdna and datadog drains.
Url string
The destination url where the logs will be sent.
aptibleLogDrainId String
databaseId Double
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
drainApps Boolean
If the drain should collect logs from apps.
drainDatabases Boolean
If the drain should collect logs from databases.
drainEphemeralSessions Boolean
If the drain should collect logs from SSH sessions.
drainHost String
The host name of the destination to send logs to.
drainPassword String
drainPort Double
The port for the destination where logs drains will be sent.
drainProxies Boolean
If the drain should collect logs from Endpoints.
drainType String
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
drainUsername String
envId Double
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
handle String
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
logDrainId Double
The unique ID for the log drain.
loggingToken String
The logging token prepended to logs by syslog and papertrail drains.
pipeline String
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
tags String
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
token String
The API token used by logdna and datadog drains.
url String
The destination url where the logs will be sent.
aptibleLogDrainId string
databaseId number
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
drainApps boolean
If the drain should collect logs from apps.
drainDatabases boolean
If the drain should collect logs from databases.
drainEphemeralSessions boolean
If the drain should collect logs from SSH sessions.
drainHost string
The host name of the destination to send logs to.
drainPassword string
drainPort number
The port for the destination where logs drains will be sent.
drainProxies boolean
If the drain should collect logs from Endpoints.
drainType string
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
drainUsername string
envId number
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
handle string
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
logDrainId number
The unique ID for the log drain.
loggingToken string
The logging token prepended to logs by syslog and papertrail drains.
pipeline string
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
tags string
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
token string
The API token used by logdna and datadog drains.
url string
The destination url where the logs will be sent.
aptible_log_drain_id str
database_id float
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
drain_apps bool
If the drain should collect logs from apps.
drain_databases bool
If the drain should collect logs from databases.
drain_ephemeral_sessions bool
If the drain should collect logs from SSH sessions.
drain_host str
The host name of the destination to send logs to.
drain_password str
drain_port float
The port for the destination where logs drains will be sent.
drain_proxies bool
If the drain should collect logs from Endpoints.
drain_type str
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
drain_username str
env_id float
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
handle str
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
log_drain_id float
The unique ID for the log drain.
logging_token str
The logging token prepended to logs by syslog and papertrail drains.
pipeline str
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
tags str
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
token str
The API token used by logdna and datadog drains.
url str
The destination url where the logs will be sent.
aptibleLogDrainId String
databaseId Number
The ID of the elasticsearch database that elasticsearch_database drains should send logs to.
drainApps Boolean
If the drain should collect logs from apps.
drainDatabases Boolean
If the drain should collect logs from databases.
drainEphemeralSessions Boolean
If the drain should collect logs from SSH sessions.
drainHost String
The host name of the destination to send logs to.
drainPassword String
drainPort Number
The port for the destination where logs drains will be sent.
drainProxies Boolean
If the drain should collect logs from Endpoints.
drainType String
The type of log drain: syslog_tls_tcp, elasticsearch_database, https_post, sumologic, logdna, datadog, papertrail.
drainUsername String
envId Number
The ID of the environment you would like to create your Log Drain in. See main provider documentation for more on how to determine what you should use for env_id.
handle String
The handle for the log drain. This must be all lower case, and only contain letters, numbers, -, _, or ..
logDrainId Number
The unique ID for the log drain.
loggingToken String
The logging token prepended to logs by syslog and papertrail drains.
pipeline String
The ID of the elasticsearch ingest pipeline to use with elasticsearch_database drains.
tags String
A comma-separated list of additional tags to apply logs collected by logdna and datadog drains.
token String
The API token used by logdna and datadog drains.
url String
The destination url where the logs will be sent.

Import

Existing log drains can be imported using the log drain ID. For example:

bash

$ pulumi import aptible:index/logDrain:LogDrain example-log-drain <ID>
Copy

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

Package Details

Repository
aptible aptible/terraform-provider-aptible
License
Notes
This Pulumi package is based on the aptible Terraform Provider.
aptible 0.9.12 published on Monday, Apr 14, 2025 by aptible
aptible/terraform-provider-aptible