netlify 0.2.2, Mar 7 25

netlify 0.2.2 published on Friday, Mar 7, 2025 by netlify

netlify.LogDrain

Explore with Pulumi AI

netlify 0.2.2 published on Friday, Mar 7, 2025 by netlify

Example Usage

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

const blog = new netlify.LogDrain("blog", {
    siteId: data.netlify_site.blog.id,
    destination: "http",
    logTypes: [
        "user_traffic",
        "deploys",
        "edge_functions",
        "functions",
    ],
    format: "ndjson",
    excludePii: true,
    serviceConfig: {
        url: "https://destinationurl/",
    },
});

import pulumi
import pulumi_netlify as netlify

blog = netlify.LogDrain("blog",
    site_id=data["netlify_site"]["blog"]["id"],
    destination="http",
    log_types=[
        "user_traffic",
        "deploys",
        "edge_functions",
        "functions",
    ],
    format="ndjson",
    exclude_pii=True,
    service_config={
        "url": "https://destinationurl/",
    })

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netlify.NewLogDrain(ctx, "blog", &netlify.LogDrainArgs{
			SiteId:      pulumi.Any(data.Netlify_site.Blog.Id),
			Destination: pulumi.String("http"),
			LogTypes: pulumi.StringArray{
				pulumi.String("user_traffic"),
				pulumi.String("deploys"),
				pulumi.String("edge_functions"),
				pulumi.String("functions"),
			},
			Format:     pulumi.String("ndjson"),
			ExcludePii: pulumi.Bool(true),
			ServiceConfig: &netlify.LogDrainServiceConfigArgs{
				Url: pulumi.String("https://destinationurl/"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netlify = Pulumi.Netlify;

return await Deployment.RunAsync(() => 
{
    var blog = new Netlify.LogDrain("blog", new()
    {
        SiteId = data.Netlify_site.Blog.Id,
        Destination = "http",
        LogTypes = new[]
        {
            "user_traffic",
            "deploys",
            "edge_functions",
            "functions",
        },
        Format = "ndjson",
        ExcludePii = true,
        ServiceConfig = new Netlify.Inputs.LogDrainServiceConfigArgs
        {
            Url = "https://destinationurl/",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netlify.LogDrain;
import com.pulumi.netlify.LogDrainArgs;
import com.pulumi.netlify.inputs.LogDrainServiceConfigArgs;
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 blog = new LogDrain("blog", LogDrainArgs.builder()
            .siteId(data.netlify_site().blog().id())
            .destination("http")
            .logTypes(            
                "user_traffic",
                "deploys",
                "edge_functions",
                "functions")
            .format("ndjson")
            .excludePii(true)
            .serviceConfig(LogDrainServiceConfigArgs.builder()
                .url("https://destinationurl/")
                .build())
            .build());

    }
}

resources:
  blog:
    type: netlify:LogDrain
    properties:
      siteId: ${data.netlify_site.blog.id}
      destination: http
      logTypes:
        - user_traffic
        - deploys
        - edge_functions
        - functions
      format: ndjson
      excludePii: true
      serviceConfig:
        url: https://destinationurl/

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,
             destination: Optional[str] = None,
             exclude_pii: Optional[bool] = None,
             log_types: Optional[Sequence[str]] = None,
             service_config: Optional[LogDrainServiceConfigArgs] = None,
             site_id: Optional[str] = None,
             format: 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: netlify:LogDrain
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 LogDrainArgs: 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 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 string: The unique name of the resource.
args LogDrainArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args LogDrainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args 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 Netlify.LogDrain("logDrainResource", new()
{
    Destination = "string",
    ExcludePii = false,
    LogTypes = new[]
    {
        "string",
    },
    ServiceConfig = new Netlify.Inputs.LogDrainServiceConfigArgs
    {
        AuthorizationHeader = "string",
        BucketName = "string",
        BucketRegion = "string",
        IntegrationName = "string",
        Path = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Url = "string",
        VerificationFilename = "string",
    },
    SiteId = "string",
    Format = "string",
});

example, err := netlify.NewLogDrain(ctx, "logDrainResource", &netlify.LogDrainArgs{
Destination: pulumi.String("string"),
ExcludePii: pulumi.Bool(false),
LogTypes: pulumi.StringArray{
pulumi.String("string"),
},
ServiceConfig: &.LogDrainServiceConfigArgs{
AuthorizationHeader: pulumi.String("string"),
BucketName: pulumi.String("string"),
BucketRegion: pulumi.String("string"),
IntegrationName: pulumi.String("string"),
Path: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Url: pulumi.String("string"),
VerificationFilename: pulumi.String("string"),
},
SiteId: pulumi.String("string"),
Format: pulumi.String("string"),
})

var logDrainResource = new LogDrain("logDrainResource", LogDrainArgs.builder()
    .destination("string")
    .excludePii(false)
    .logTypes("string")
    .serviceConfig(LogDrainServiceConfigArgs.builder()
        .authorizationHeader("string")
        .bucketName("string")
        .bucketRegion("string")
        .integrationName("string")
        .path("string")
        .tags(Map.of("string", "string"))
        .url("string")
        .verificationFilename("string")
        .build())
    .siteId("string")
    .format("string")
    .build());

log_drain_resource = netlify.LogDrain("logDrainResource",
    destination="string",
    exclude_pii=False,
    log_types=["string"],
    service_config={
        "authorization_header": "string",
        "bucket_name": "string",
        "bucket_region": "string",
        "integration_name": "string",
        "path": "string",
        "tags": {
            "string": "string",
        },
        "url": "string",
        "verification_filename": "string",
    },
    site_id="string",
    format="string")

const logDrainResource = new netlify.LogDrain("logDrainResource", {
    destination: "string",
    excludePii: false,
    logTypes: ["string"],
    serviceConfig: {
        authorizationHeader: "string",
        bucketName: "string",
        bucketRegion: "string",
        integrationName: "string",
        path: "string",
        tags: {
            string: "string",
        },
        url: "string",
        verificationFilename: "string",
    },
    siteId: "string",
    format: "string",
});

type: netlify:LogDrain
properties:
    destination: string
    excludePii: false
    format: string
    logTypes:
        - string
    serviceConfig:
        authorizationHeader: string
        bucketName: string
        bucketRegion: string
        integrationName: string
        path: string
        tags:
            string: string
        url: string
        verificationFilename: string
    siteId: string

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:

Destination string: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
ExcludePii bool
LogTypes List<string>: One or more of usertraffic, functions, edgefunctions, and deploys
ServiceConfig LogDrainServiceConfig
SiteId string
Format string: json or ndjson

Destination string: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
ExcludePii bool
LogTypes []string: One or more of usertraffic, functions, edgefunctions, and deploys
ServiceConfig LogDrainServiceConfigArgs
SiteId string
Format string: json or ndjson

destination String: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
excludePii Boolean
logTypes List<String>: One or more of usertraffic, functions, edgefunctions, and deploys
serviceConfig LogDrainServiceConfig
siteId String
format String: json or ndjson

destination string: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
excludePii boolean
logTypes string[]: One or more of usertraffic, functions, edgefunctions, and deploys
serviceConfig LogDrainServiceConfig
siteId string
format string: json or ndjson

destination str: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
exclude_pii bool
log_types Sequence[str]: One or more of usertraffic, functions, edgefunctions, and deploys
service_config LogDrainServiceConfigArgs
site_id str
format str: json or ndjson

destination String: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
excludePii Boolean
logTypes List<String>: One or more of usertraffic, functions, edgefunctions, and deploys
serviceConfig Property Map
siteId String
format String: json or ndjson

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.
LastUpdated string

Id string: The provider-assigned unique ID for this managed resource.
LastUpdated string

id String: The provider-assigned unique ID for this managed resource.
lastUpdated String

id string: The provider-assigned unique ID for this managed resource.
lastUpdated string

id str: The provider-assigned unique ID for this managed resource.
last_updated str

id String: The provider-assigned unique ID for this managed resource.
lastUpdated String

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,
        destination: Optional[str] = None,
        exclude_pii: Optional[bool] = None,
        format: Optional[str] = None,
        last_updated: Optional[str] = None,
        log_types: Optional[Sequence[str]] = None,
        service_config: Optional[LogDrainServiceConfigArgs] = None,
        site_id: 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: netlify:LogDrain    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.

The following state arguments are supported:

Destination string: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
ExcludePii bool
Format string: json or ndjson
LastUpdated string
LogTypes List<string>: One or more of usertraffic, functions, edgefunctions, and deploys
ServiceConfig LogDrainServiceConfig
SiteId string

Destination string: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
ExcludePii bool
Format string: json or ndjson
LastUpdated string
LogTypes []string: One or more of usertraffic, functions, edgefunctions, and deploys
ServiceConfig LogDrainServiceConfigArgs
SiteId string

destination String: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
excludePii Boolean
format String: json or ndjson
lastUpdated String
logTypes List<String>: One or more of usertraffic, functions, edgefunctions, and deploys
serviceConfig LogDrainServiceConfig
siteId String

destination string: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
excludePii boolean
format string: json or ndjson
lastUpdated string
logTypes string[]: One or more of usertraffic, functions, edgefunctions, and deploys
serviceConfig LogDrainServiceConfig
siteId string

destination str: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
exclude_pii bool
format str: json or ndjson
last_updated str
log_types Sequence[str]: One or more of usertraffic, functions, edgefunctions, and deploys
service_config LogDrainServiceConfigArgs
site_id str

destination String: One of datadog, newrelic, logflare, s3, splunkcloud, http, axiom, or azure
excludePii Boolean
format String: json or ndjson
lastUpdated String
logTypes List<String>: One or more of usertraffic, functions, edgefunctions, and deploys
serviceConfig Property Map
siteId String

Supporting Types

LogDrainServiceConfig, LogDrainServiceConfigArgs

AuthorizationHeader string
BucketName string
BucketRegion string
IntegrationName string
Path string
Tags Dictionary<string, string>
Url string
VerificationFilename string

AuthorizationHeader string
BucketName string
BucketRegion string
IntegrationName string
Path string
Tags map[string]string
Url string
VerificationFilename string

authorizationHeader String
bucketName String
bucketRegion String
integrationName String
path String
tags Map<String,String>
url String
verificationFilename String

authorizationHeader string
bucketName string
bucketRegion string
integrationName string
path string
tags {[key: string]: string}
url string
verificationFilename string

authorization_header str
bucket_name str
bucket_region str
integration_name str
path str
tags Mapping[str, str]
url str
verification_filename str

authorizationHeader String
bucketName String
bucketRegion String
integrationName String
path String
tags Map<String>
url String
verificationFilename String

Import

Import a log drain by its site ID and the log drain ID

$ pulumi import netlify:index/logDrain:LogDrain http 12345667-0000-0000-0000-abcdef012345:12345667-0000-0000-0000-abcdef012345

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

Package Details

Repository: netlify netlify/terraform-provider-netlify
License
Notes: This Pulumi package is based on the netlify Terraform Provider.

netlify 0.2.2 published on Friday, Mar 7, 2025 by netlify

netlify/terraform-provider-netlify

netlify.LogDrain

On this page

On this page

Example Usage

Create LogDrain Resource

Constructor syntax

Parameters

Constructor example

LogDrain Resource Properties

Inputs

Outputs

Look up Existing LogDrain Resource

Supporting Types

LogDrainServiceConfig, LogDrainServiceConfigArgs

Import

Package Details

On this page

On this page