logging

class pulumi_gcp.logging.BillingAccountExclusion(resource_name, opts=None, billing_account=None, description=None, disabled=None, filter=None, name=None, __name__=None, __opts__=None)

Manages a billing account logging exclusion. For more information see the official documentation and Excluding Logs.

Note that you must have the “Logs Configuration Writer” IAM role (roles/logging.configWriter) granted to the credentials used with Terraform.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • billing_account (pulumi.Input[str]) – The billing account to create the exclusion for.
  • description (pulumi.Input[str]) – A human-readable description.
  • disabled (pulumi.Input[bool]) – Whether this exclusion rule should be disabled or not. This defaults to false.
  • filter (pulumi.Input[str]) – The filter to apply when excluding logs. Only log entries that match the filter are excluded. See Advanced Log Filters for information on how to write a filter.
  • name (pulumi.Input[str]) – The name of the logging exclusion.
billing_account = None

The billing account to create the exclusion for.

description = None

A human-readable description.

disabled = None

Whether this exclusion rule should be disabled or not. This defaults to false.

filter = None

The filter to apply when excluding logs. Only log entries that match the filter are excluded. See Advanced Log Filters for information on how to write a filter.

name = None

The name of the logging exclusion.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.logging.BillingAccountSink(resource_name, opts=None, billing_account=None, destination=None, filter=None, name=None, __name__=None, __opts__=None)

Manages a billing account logging sink. For more information see the official documentation and Exporting Logs in the API.

Note You must have the “Logs Configuration Writer” IAM role (roles/logging.configWriter) granted on the billing account to the credentials used with Terraform. IAM roles granted on a billing account are separate from the typical IAM roles granted on a project.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • billing_account (pulumi.Input[str]) – The billing account exported to the sink.
  • destination (pulumi.Input[str]) – 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: The writer associated with the sink must have access to write to the above resource.
  • filter (pulumi.Input[str]) –

    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.

  • name (pulumi.Input[str]) – The name of the logging sink.
billing_account = None

The billing account exported to the sink.

destination = None

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: The writer associated with the sink must have access to write to the above resource.

filter = None

The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.

name = None

The name of the logging sink.

writer_identity = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.logging.FolderExclusion(resource_name, opts=None, description=None, disabled=None, filter=None, folder=None, name=None, __name__=None, __opts__=None)

Manages a folder-level logging exclusion. For more information see the official documentation and Excluding Logs.

Note that you must have the “Logs Configuration Writer” IAM role (roles/logging.configWriter) granted to the credentials used with Terraform.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – A human-readable description.
  • disabled (pulumi.Input[bool]) – Whether this exclusion rule should be disabled or not. This defaults to false.
  • filter (pulumi.Input[str]) –

    The filter to apply when excluding logs. Only log entries that match the filter are excluded. See Advanced Log Filters for information on how to write a filter.

  • folder (pulumi.Input[str]) – The folder to be exported to the sink. Note that either [FOLDER_ID] or “folders/[FOLDER_ID]” is accepted.
  • name (pulumi.Input[str]) – The name of the logging exclusion.
description = None

A human-readable description.

disabled = None

Whether this exclusion rule should be disabled or not. This defaults to false.

filter = None

The filter to apply when excluding logs. Only log entries that match the filter are excluded. See Advanced Log Filters for information on how to write a filter.

folder = None

The folder to be exported to the sink. Note that either [FOLDER_ID] or “folders/[FOLDER_ID]” is accepted.

name = None

The name of the logging exclusion.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.logging.FolderSink(resource_name, opts=None, destination=None, filter=None, folder=None, include_children=None, name=None, __name__=None, __opts__=None)

Manages a folder-level logging sink. For more information see the official documentation and Exporting Logs in the API.

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

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • destination (pulumi.Input[str]) – 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: The writer associated with the sink must have access to write to the above resource.
  • filter (pulumi.Input[str]) –

    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.

  • folder (pulumi.Input[str]) – The folder to be exported to the sink. Note that either [FOLDER_ID] or “folders/[FOLDER_ID]” is accepted.
  • include_children (pulumi.Input[bool]) – 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.
  • name (pulumi.Input[str]) – The name of the logging sink.
destination = None

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: The writer associated with the sink must have access to write to the above resource.

filter = None

The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.

folder = None

The folder to be exported to the sink. Note that either [FOLDER_ID] or “folders/[FOLDER_ID]” is accepted.

include_children = None

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.

name = None

The name of the logging sink.

writer_identity = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.logging.Metric(resource_name, opts=None, bucket_options=None, description=None, filter=None, label_extractors=None, metric_descriptor=None, name=None, project=None, value_extractor=None, __name__=None, __opts__=None)

Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.

To get more information about Metric, see:

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.logging.OrganizationExclusion(resource_name, opts=None, description=None, disabled=None, filter=None, name=None, org_id=None, __name__=None, __opts__=None)

Manages an organization-level logging exclusion. For more information see the official documentation and Excluding Logs.

Note that you must have the “Logs Configuration Writer” IAM role (roles/logging.configWriter) granted to the credentials used with Terraform.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – A human-readable description.
  • disabled (pulumi.Input[bool]) – Whether this exclusion rule should be disabled or not. This defaults to false.
  • filter (pulumi.Input[str]) –

    The filter to apply when excluding logs. Only log entries that match the filter are excluded. See Advanced Log Filters for information on how to write a filter.

  • name (pulumi.Input[str]) – The name of the logging exclusion.
  • org_id (pulumi.Input[str]) – The organization to create the exclusion in.
description = None

A human-readable description.

disabled = None

Whether this exclusion rule should be disabled or not. This defaults to false.

filter = None

The filter to apply when excluding logs. Only log entries that match the filter are excluded. See Advanced Log Filters for information on how to write a filter.

name = None

The name of the logging exclusion.

org_id = None

The organization to create the exclusion in.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.logging.OrganizationSink(resource_name, opts=None, destination=None, filter=None, include_children=None, name=None, org_id=None, __name__=None, __opts__=None)

Manages a organization-level logging sink. For more information see the official documentation and Exporting Logs in the API.

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

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • destination (pulumi.Input[str]) – 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: The writer associated with the sink must have access to write to the above resource.
  • filter (pulumi.Input[str]) –

    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.

  • include_children (pulumi.Input[bool]) – Whether or not to include children organizations in the sink export. If true, logs associated with child projects are also exported; otherwise only logs relating to the provided organization are included.
  • name (pulumi.Input[str]) – The name of the logging sink.
  • org_id (pulumi.Input[str]) – The numeric ID of the organization to be exported to the sink.
destination = None

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: The writer associated with the sink must have access to write to the above resource.

filter = None

The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.

include_children = None

Whether or not to include children organizations in the sink export. If true, logs associated with child projects are also exported; otherwise only logs relating to the provided organization are included.

name = None

The name of the logging sink.

org_id = None

The numeric ID of the organization to be exported to the sink.

writer_identity = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.logging.ProjectExclusion(resource_name, opts=None, description=None, disabled=None, filter=None, name=None, project=None, __name__=None, __opts__=None)

Manages a project-level logging exclusion. For more information see the official documentation and Excluding Logs.

Note that you must have the “Logs Configuration Writer” IAM role (roles/logging.configWriter) granted to the credentials used with Terraform.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – A human-readable description.
  • disabled (pulumi.Input[bool]) – Whether this exclusion rule should be disabled or not. This defaults to false.
  • filter (pulumi.Input[str]) –

    The filter to apply when excluding logs. Only log entries that match the filter are excluded. See Advanced Log Filters for information on how to write a filter.

  • name (pulumi.Input[str]) – The name of the logging exclusion.
  • project (pulumi.Input[str]) – The project to create the exclusion in. If omitted, the project associated with the provider is used.
description = None

A human-readable description.

disabled = None

Whether this exclusion rule should be disabled or not. This defaults to false.

filter = None

The filter to apply when excluding logs. Only log entries that match the filter are excluded. See Advanced Log Filters for information on how to write a filter.

name = None

The name of the logging exclusion.

project = None

The project to create the exclusion in. If omitted, the project associated with the provider is used.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_gcp.logging.ProjectSink(resource_name, opts=None, destination=None, filter=None, name=None, project=None, unique_writer_identity=None, __name__=None, __opts__=None)

Manages a project-level logging sink. For more information see the official documentation, Exporting Logs in the API and API.

Note: You must have granted the “Logs Configuration Writer” IAM role (roles/logging.configWriter) to the credentials used with terraform.

Note You must enable the Cloud Resource Manager API

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • destination (pulumi.Input[str]) – 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: The writer associated with the sink must have access to write to the above resource.
  • filter (pulumi.Input[str]) –

    The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.

  • name (pulumi.Input[str]) – The name of the logging sink.
  • project (pulumi.Input[str]) – The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
  • unique_writer_identity (pulumi.Input[bool]) – Whether or not to create a unique identity associated with this sink. If false (the default), then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true, then a unique service account is created and used for this sink. If you wish to publish logs across projects, you must set unique_writer_identity to true.
destination = None

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: The writer associated with the sink must have access to write to the above resource.

filter = None

The filter to apply when exporting logs. Only log entries that match the filter are exported. See Advanced Log Filters for information on how to write a filter.

name = None

The name of the logging sink.

project = None

The ID of the project to create the sink in. If omitted, the project associated with the provider is used.

unique_writer_identity = None

Whether or not to create a unique identity associated with this sink. If false (the default), then the writer_identity used is serviceAccount:cloud-logs@system.gserviceaccount.com. If true, then a unique service account is created and used for this sink. If you wish to publish logs across projects, you must set unique_writer_identity to true.

writer_identity = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str