View Source GoogleApi.Logging.V2.Model.Settings (google_api_logging v0.47.0)

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

Attributes

  • defaultSinkConfig (type: GoogleApi.Logging.V2.Model.DefaultSinkConfig.t, default: nil) - Optional. Overrides the built-in configuration for _Default sink.
  • disableDefaultSink (type: boolean(), default: nil) - 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.
  • kmsKeyName (type: String.t, default: nil) - 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 valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
  • kmsServiceAccountId (type: String.t, default: nil) - 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 role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that will be used to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
  • loggingServiceAccountId (type: String.t, default: nil) - Output only. The service account for the given resource container, such as project or folder. Log sinks use this service account as their writer_identity if no custom service account is provided in the request when calling the create sink method.
  • name (type: String.t, default: nil) - Output only. The resource name of the settings.
  • storageLocation (type: String.t, default: nil) - 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.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.Logging.V2.Model.Settings{
  defaultSinkConfig: GoogleApi.Logging.V2.Model.DefaultSinkConfig.t() | nil,
  disableDefaultSink: boolean() | nil,
  kmsKeyName: String.t() | nil,
  kmsServiceAccountId: String.t() | nil,
  loggingServiceAccountId: String.t() | nil,
  name: String.t() | nil,
  storageLocation: String.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.