terraform-provider-google/website/docs/r/logging_folder_sink.html.markdown

---
layout: "google"
page_title: "Google: google_logging_folder_sink"
sidebar_current: "docs-google-logging-folder-sink"
description: |-
  Manages a folder-level logging sink.
---

# google\_logging\_folder\_sink

Manages a folder-level logging sink. For more information see
[the official documentation](https://cloud.google.com/logging/docs/) and
[Exporting Logs in the API](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).

Note that you must have the "Logs Configuration Writer" IAM role (`roles/logging.configWriter`)
granted to the credentials used with terraform.

## Example Usage

```hcl
resource "google_logging_folder_sink" "my-sink" {
    name        = "my-sink"
    folder      = "${google_folder.my-folder.name}"

    # Can export to pubsub, cloud storage, or bigtable
    destination = "storage.googleapis.com/${google_storage_bucket.log-bucket.name}"

    # Log all WARN or higher severity messages relating to instances
    filter      = "resource.type = gce_instance AND severity >= WARN"
}

resource "google_storage_bucket" "log-bucket" {
    name = "folder-logging-bucket"
}

resource "google_project_iam_binding" "log-writer" {
    role    = "roles/storage.objectCreator"

    members = [
        "${google_logging_folder_sink.my-sink.writer_identity}",
    ]
}

resource "google_folder" "my-folder" {
	display_name = "My folder"
    parent       = "organizations/123456"
}
```

## Argument Reference

The following arguments are supported:

* `name` - (Required) The name of the logging sink.

* `folder` - (Required) The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is
    accepted.

* `destination` - (Required) The destination of the sink (or, in other words, where logs are written to). Can be a
    Cloud Storage bucket, a PubSub topic, or a BigQuery dataset. Examples:
```
"storage.googleapis.com/[GCS_BUCKET]"
"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
```
    The writer associated with the sink must have access to write to the above resource.

* `filter` - (Optional) The filter to apply when exporting logs. Only log entries that match the filter are exported.
    See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to
    write a filter.

* `include_children` - (Optional) Whether or not to include children folders in the sink export. If true, logs
    associated with child projects are also exported; otherwise only logs relating to the provided folder are included.

## Attributes Reference

In addition to the arguments listed above, the following computed attributes are
exported:

* `writer_identity` - The identity associated with this sink. This identity must be granted write access to the
    configured `destination`.

## Import

Folder-level logging sinks can be imported using this format:

```
$ terraform import google_logging_folder_sink.my_sink folders/{{folder_id}}/sinks/{{sink_id}}
```