v5.18.0/website/docs/r/logging_folder_settings.html.markdown

---
# ----------------------------------------------------------------------------
#
#     ***     AUTO GENERATED CODE    ***    Type: MMv1     ***
#
# ----------------------------------------------------------------------------
#
#     This file is automatically generated by Magic Modules and manual
#     changes will be clobbered when the file is regenerated.
#
#     Please read more about how to change this file in
#     .github/CONTRIBUTING.md.
#
# ----------------------------------------------------------------------------
subcategory: "Cloud (Stackdriver) Logging"
description: |-
  Default resource settings control whether CMEK is required for new log buckets.
---

# google\_logging\_folder\_settings

Default resource settings control whether CMEK is required for new log buckets. These settings also determine the storage location for the _Default and _Required log buckets, and whether the _Default sink is enabled or disabled.


To get more information about FolderSettings, see:

* [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/TopLevel/getSettings)
* How-to Guides
    * [Configure default settings for organizations and folders](https://cloud.google.com/logging/docs/default-settings)

## Example Usage - Logging Folder Settings All


```hcl
resource "google_logging_folder_settings" "example" {
  disable_default_sink = true
  folder               = google_folder.my_folder.folder_id
  kms_key_name         = "kms-key"
  storage_location     = "us-central1"
  depends_on           = [ google_kms_crypto_key_iam_member.iam ]
}

resource "google_folder" "my_folder" {
  display_name = "folder-name"
  parent       = "organizations/123456789"
}

data "google_logging_folder_settings" "settings" {
  folder = google_folder.my_folder.folder_id
}

resource "google_kms_crypto_key_iam_member" "iam" {
  crypto_key_id = "kms-key"
  role          = "roles/cloudkms.cryptoKeyEncrypterDecrypter"
  member        = "serviceAccount:${data.google_logging_folder_settings.settings.kms_service_account_id}"
}
```

## Argument Reference

The following arguments are supported:


* `folder` -
  (Required)
  The folder for which to retrieve settings.


- - -


* `kms_key_name` -
  (Optional)
  The resource name for the configured Cloud KMS key.

* `storage_location` -
  (Optional)
  The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided.

* `disable_default_sink` -
  (Optional)
  If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.


## Attributes Reference

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

* `id` - an identifier for the resource with format `folders/{{folder}}/settings`

* `name` -
  The resource name of the settings.

* `kms_service_account_id` -
  The service account that will be used by the Log Router to access your Cloud KMS key.

* `logging_service_account_id` -
  The service account for the given container. Sinks use this service account as their writerIdentity if no custom service account is provided.


## Timeouts

This resource provides the following
[Timeouts](https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/retries-and-customizable-timeouts) configuration options:

- `create` - Default is 20 minutes.
- `update` - Default is 20 minutes.
- `delete` - Default is 20 minutes.

## Import


FolderSettings can be imported using any of these accepted formats:

* `folders/{{folder}}/settings`
* `{{folder}}`


In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import FolderSettings using one of the formats above. For example:

```tf
import {
  id = "folders/{{folder}}/settings"
  to = google_logging_folder_settings.default
}
```

When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), FolderSettings can be imported using one of the formats above. For example:

```
$ terraform import google_logging_folder_settings.default folders/{{folder}}/settings
$ terraform import google_logging_folder_settings.default {{folder}}
```