Settings

Describes the settings associated with a project, folder, organization, or billing account.

JSON representation
{"name":string,"kmsKeyName":string,"kmsServiceAccountId":string,"storageLocation":string,"disableDefaultSink":boolean,"defaultSinkConfig":{object (DefaultSinkConfig)},"loggingServiceAccountId":string}
Fields
name

string

Output only. The resource name of the settings.

kmsKeyName

string

Optional. The resource name for the configured Cloud KMS key.

KMS key name format:

"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"

For example:

"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"

To enable CMEK, set this field to a validkmsKeyName for which the associated service account has the requiredroles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.

The Cloud KMS key used by the Log Router can be updated by changing thekmsKeyName to a new valid key name.

To disable CMEK for the Log Router, set this field to an empty string.

SeeEnabling CMEK for Log Router for more information.

kmsServiceAccountId

string

Output only. The service account that will be used by the Log Router to access your Cloud KMS key.

Before enabling CMEK, you must first assign the roleroles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that will be used to access your Cloud KMS key. Usev2.getSettings to obtain the service account ID.

SeeEnabling CMEK for Log Router for more information.

storageLocation

string

Optional. The storage location for the_Default and_Required log buckets of newly created projects and folders, unless the storage location is explicitly provided.

Example value:europe-west1.

Note: this setting does not affect the location of resources where a location is explicitly provided when created, such as custom log buckets.

disableDefaultSink

boolean

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.

defaultSinkConfig

object (DefaultSinkConfig)

Optional. Overrides the built-in configuration for_Default sink.

loggingServiceAccountId

string

Output only. The service account for the given resource container, such as project or folder. Log sinks use this service account as theirwriterIdentity if no custom service account is provided in the request when calling the create sink method.

DefaultSinkConfig

Describes the custom_Default sink configuration that is used to override the built-in_Default sink configuration in newly created resource containers, such as projects or folders.

JSON representation
{"filter":string,"exclusions":[{object (LogExclusion)}],"mode":enum (FilterWriteMode)}
Fields
filter

string

Optional. Anadvanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter.

For example:

logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR

To match all logs, don't add exclusions and use the following line as the value offilter:

logName:*

Cannot be empty or unset when the value ofmode isOVERWRITE.

exclusions[]

object (LogExclusion)

Optional. Specifies the set of exclusions to be added to the_Default sink in newly created resource containers.

mode

enum (FilterWriteMode)

Required. Determines the behavior to apply to the built-in_Default sink inclusion filter.

Exclusions are always appended, as built-in_Default sinks have no exclusions.

FilterWriteMode

Behavior to apply to the built-in_Default sink inclusion filter.

Enums
FILTER_WRITE_MODE_UNSPECIFIEDThe filter's write mode is unspecified. This mode must not be used.
APPENDThe contents offilter will be appended to the built-in_Default sink filter. Using the append mode with an empty filter will keep the sink inclusion filter unchanged.
OVERWRITEThe contents offilter will overwrite the built-in_Default sink filter.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-21 UTC.