Resource: LogBucket
Describes a repository in which log entries are stored.
JSON representation |
---|
{ "name": string, "description": string, "createTime": string, "updateTime": string, "retentionDays": integer, "locked": boolean, "lifecycleState": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the bucket. For example:
For a list of supported locations, see Supported Regions For the location of After a bucket has been created, the location cannot be changed. |
description |
Optional. Describes this bucket. |
create |
Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
update |
Output only. The last update timestamp of the bucket. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
retention |
Optional. Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. |
locked |
Optional. Whether the bucket is locked. The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty. |
lifecycle |
Output only. The bucket lifecycle state. |
analytics |
Optional. Whether log analytics is enabled for this bucket. Once enabled, log analytics features cannot be disabled. |
restricted |
Optional. Log entry field paths that are denied access in this bucket. The following fields and their children are eligible: Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. |
index |
Optional. A list of indexed fields and related configuration data. |
cmek |
Optional. The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed. |
IndexConfig
Configuration for an indexed field.
JSON representation |
---|
{
"fieldPath": string,
"type": enum ( |
Fields | |
---|---|
field |
Required. The LogEntry field path to index. Note that some paths are automatically indexed, and other paths are not eligible for indexing. See [indexing documentation]( https://cloud.google.com/logging/docs/analyze/custom-index) for details. For example: |
type |
Required. The type of data in this index. |
create |
Output only. The timestamp when the index was last modified. This is used to return the timestamp, and will be ignored if supplied during update. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
IndexType
IndexType is used for custom indexing. It describes the type of an indexed field.
Enums | |
---|---|
INDEX_TYPE_UNSPECIFIED |
The index's type is unspecified. |
INDEX_TYPE_STRING |
The index is a string-type index. |
INDEX_TYPE_INTEGER |
The index is a integer-type index. |
CmekSettings
Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.
Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.
See Enabling CMEK for Log Router for more information.
JSON representation |
---|
{ "name": string, "kmsKeyName": string, "kmsKeyVersionName": string, "serviceAccountId": string } |
Fields | |
---|---|
name |
Output only. The resource name of the CMEK settings. |
kms |
Optional. The resource name for the configured Cloud KMS key. KMS key name format:
For example:
To enable CMEK for the Log Router, set this field to a valid The Cloud KMS key used by the Log Router can be updated by changing the To disable CMEK for the Log Router, set this field to an empty string. See Enabling CMEK for Log Router for more information. |
kms |
Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key. KMS key name format:
For example:
This is a read-only field used to convey the specific configured CryptoKeyVersion of If this field is populated, the |
service |
Output only. The service account that will be used by the Log Router to access your Cloud KMS key. Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use See Enabling CMEK for Log Router for more information. |
Methods |
|
---|---|
|
Creates a log bucket that can be used to store log entries. |
|
Creates a log bucket asynchronously that can be used to store log entries. |
|
Deletes a log bucket. |
|
Gets a log bucket. |
|
Lists log buckets. |
|
Updates a log bucket. |
|
Undeletes a log bucket. |
|
Updates a log bucket asynchronously. |