Documentation
¶
Index ¶
- type BillingAccountExclusion
- func (r *BillingAccountExclusion) BillingAccount() pulumi.StringOutput
- func (r *BillingAccountExclusion) Description() pulumi.StringOutput
- func (r *BillingAccountExclusion) Disabled() pulumi.BoolOutput
- func (r *BillingAccountExclusion) Filter() pulumi.StringOutput
- func (r *BillingAccountExclusion) ID() pulumi.IDOutput
- func (r *BillingAccountExclusion) Name() pulumi.StringOutput
- func (r *BillingAccountExclusion) URN() pulumi.URNOutput
- type BillingAccountExclusionArgs
- type BillingAccountExclusionState
- type BillingAccountSink
- func (r *BillingAccountSink) BillingAccount() pulumi.StringOutput
- func (r *BillingAccountSink) Destination() pulumi.StringOutput
- func (r *BillingAccountSink) Filter() pulumi.StringOutput
- func (r *BillingAccountSink) ID() pulumi.IDOutput
- func (r *BillingAccountSink) Name() pulumi.StringOutput
- func (r *BillingAccountSink) URN() pulumi.URNOutput
- func (r *BillingAccountSink) WriterIdentity() pulumi.StringOutput
- type BillingAccountSinkArgs
- type BillingAccountSinkState
- type FolderExclusion
- func (r *FolderExclusion) Description() pulumi.StringOutput
- func (r *FolderExclusion) Disabled() pulumi.BoolOutput
- func (r *FolderExclusion) Filter() pulumi.StringOutput
- func (r *FolderExclusion) Folder() pulumi.StringOutput
- func (r *FolderExclusion) ID() pulumi.IDOutput
- func (r *FolderExclusion) Name() pulumi.StringOutput
- func (r *FolderExclusion) URN() pulumi.URNOutput
- type FolderExclusionArgs
- type FolderExclusionState
- type FolderSink
- func (r *FolderSink) Destination() pulumi.StringOutput
- func (r *FolderSink) Filter() pulumi.StringOutput
- func (r *FolderSink) Folder() pulumi.StringOutput
- func (r *FolderSink) ID() pulumi.IDOutput
- func (r *FolderSink) IncludeChildren() pulumi.BoolOutput
- func (r *FolderSink) Name() pulumi.StringOutput
- func (r *FolderSink) URN() pulumi.URNOutput
- func (r *FolderSink) WriterIdentity() pulumi.StringOutput
- type FolderSinkArgs
- type FolderSinkState
- type Metric
- func (r *Metric) BucketOptions() pulumi.Output
- func (r *Metric) Description() pulumi.StringOutput
- func (r *Metric) Filter() pulumi.StringOutput
- func (r *Metric) ID() pulumi.IDOutput
- func (r *Metric) LabelExtractors() pulumi.MapOutput
- func (r *Metric) MetricDescriptor() pulumi.Output
- func (r *Metric) Name() pulumi.StringOutput
- func (r *Metric) Project() pulumi.StringOutput
- func (r *Metric) URN() pulumi.URNOutput
- func (r *Metric) ValueExtractor() pulumi.StringOutput
- type MetricArgs
- type MetricState
- type OrganizationExclusion
- func (r *OrganizationExclusion) Description() pulumi.StringOutput
- func (r *OrganizationExclusion) Disabled() pulumi.BoolOutput
- func (r *OrganizationExclusion) Filter() pulumi.StringOutput
- func (r *OrganizationExclusion) ID() pulumi.IDOutput
- func (r *OrganizationExclusion) Name() pulumi.StringOutput
- func (r *OrganizationExclusion) OrgId() pulumi.StringOutput
- func (r *OrganizationExclusion) URN() pulumi.URNOutput
- type OrganizationExclusionArgs
- type OrganizationExclusionState
- type OrganizationSink
- func (r *OrganizationSink) Destination() pulumi.StringOutput
- func (r *OrganizationSink) Filter() pulumi.StringOutput
- func (r *OrganizationSink) ID() pulumi.IDOutput
- func (r *OrganizationSink) IncludeChildren() pulumi.BoolOutput
- func (r *OrganizationSink) Name() pulumi.StringOutput
- func (r *OrganizationSink) OrgId() pulumi.StringOutput
- func (r *OrganizationSink) URN() pulumi.URNOutput
- func (r *OrganizationSink) WriterIdentity() pulumi.StringOutput
- type OrganizationSinkArgs
- type OrganizationSinkState
- type ProjectExclusion
- func (r *ProjectExclusion) Description() pulumi.StringOutput
- func (r *ProjectExclusion) Disabled() pulumi.BoolOutput
- func (r *ProjectExclusion) Filter() pulumi.StringOutput
- func (r *ProjectExclusion) ID() pulumi.IDOutput
- func (r *ProjectExclusion) Name() pulumi.StringOutput
- func (r *ProjectExclusion) Project() pulumi.StringOutput
- func (r *ProjectExclusion) URN() pulumi.URNOutput
- type ProjectExclusionArgs
- type ProjectExclusionState
- type ProjectSink
- func (r *ProjectSink) Destination() pulumi.StringOutput
- func (r *ProjectSink) Filter() pulumi.StringOutput
- func (r *ProjectSink) ID() pulumi.IDOutput
- func (r *ProjectSink) Name() pulumi.StringOutput
- func (r *ProjectSink) Project() pulumi.StringOutput
- func (r *ProjectSink) URN() pulumi.URNOutput
- func (r *ProjectSink) UniqueWriterIdentity() pulumi.BoolOutput
- func (r *ProjectSink) WriterIdentity() pulumi.StringOutput
- type ProjectSinkArgs
- type ProjectSinkState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BillingAccountExclusion ¶ added in v0.15.0
type BillingAccountExclusion struct {
// contains filtered or unexported fields
}
Manages a billing account logging exclusion. For more information see [the official documentation](https://cloud.google.com/logging/docs/) and [Excluding Logs](https://cloud.google.com/logging/docs/exclusions).
Note that you must have the "Logs Configuration Writer" IAM role (`roles/logging.configWriter`) granted to the credentials used with this provider.
> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/logging_billing_account_exclusion.html.markdown.
func GetBillingAccountExclusion ¶ added in v0.15.0
func GetBillingAccountExclusion(ctx *pulumi.Context, name string, id pulumi.ID, state *BillingAccountExclusionState, opts ...pulumi.ResourceOpt) (*BillingAccountExclusion, error)
GetBillingAccountExclusion gets an existing BillingAccountExclusion resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewBillingAccountExclusion ¶ added in v0.15.0
func NewBillingAccountExclusion(ctx *pulumi.Context, name string, args *BillingAccountExclusionArgs, opts ...pulumi.ResourceOpt) (*BillingAccountExclusion, error)
NewBillingAccountExclusion registers a new resource with the given unique name, arguments, and options.
func (*BillingAccountExclusion) BillingAccount ¶ added in v0.15.0
func (r *BillingAccountExclusion) BillingAccount() pulumi.StringOutput
The billing account to create the exclusion for.
func (*BillingAccountExclusion) Description ¶ added in v0.15.0
func (r *BillingAccountExclusion) Description() pulumi.StringOutput
A human-readable description.
func (*BillingAccountExclusion) Disabled ¶ added in v0.15.0
func (r *BillingAccountExclusion) Disabled() pulumi.BoolOutput
Whether this exclusion rule should be disabled or not. This defaults to false.
func (*BillingAccountExclusion) Filter ¶ added in v0.15.0
func (r *BillingAccountExclusion) Filter() pulumi.StringOutput
The filter to apply when excluding logs. Only log entries that match the filter are excluded. See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to write a filter.
func (*BillingAccountExclusion) ID ¶ added in v0.15.0
func (r *BillingAccountExclusion) ID() pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*BillingAccountExclusion) Name ¶ added in v0.15.0
func (r *BillingAccountExclusion) Name() pulumi.StringOutput
The name of the logging exclusion.
func (*BillingAccountExclusion) URN ¶ added in v0.15.0
func (r *BillingAccountExclusion) URN() pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type BillingAccountExclusionArgs ¶ added in v0.15.0
type BillingAccountExclusionArgs struct { // The billing account to create the exclusion for. BillingAccount interface{} // A human-readable description. Description interface{} // Whether this exclusion rule should be disabled or not. This defaults to // false. Disabled interface{} // The filter to apply when excluding logs. Only log entries that match the filter are excluded. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to // write a filter. Filter interface{} // The name of the logging exclusion. Name interface{} }
The set of arguments for constructing a BillingAccountExclusion resource.
type BillingAccountExclusionState ¶ added in v0.15.0
type BillingAccountExclusionState struct { // The billing account to create the exclusion for. BillingAccount interface{} // A human-readable description. Description interface{} // Whether this exclusion rule should be disabled or not. This defaults to // false. Disabled interface{} // The filter to apply when excluding logs. Only log entries that match the filter are excluded. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to // write a filter. Filter interface{} // The name of the logging exclusion. Name interface{} }
Input properties used for looking up and filtering BillingAccountExclusion resources.
type BillingAccountSink ¶
type BillingAccountSink struct {
// contains filtered or unexported fields
}
Manages a billing account logging sink. For more information see [the official documentation](https://cloud.google.com/logging/docs/) and [Exporting Logs in the API](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
> **Note** You must have the "Logs Configuration Writer" IAM role (`roles/logging.configWriter`) [granted on the billing account](https://cloud.google.com/billing/reference/rest/v1/billingAccounts/getIamPolicy) to the credentials used with this provider. [IAM roles granted on a billing account](https://cloud.google.com/billing/docs/how-to/billing-access) are separate from the typical IAM roles granted on a project.
> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/logging_billing_account_sink.html.markdown.
func GetBillingAccountSink ¶
func GetBillingAccountSink(ctx *pulumi.Context, name string, id pulumi.ID, state *BillingAccountSinkState, opts ...pulumi.ResourceOpt) (*BillingAccountSink, error)
GetBillingAccountSink gets an existing BillingAccountSink resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewBillingAccountSink ¶
func NewBillingAccountSink(ctx *pulumi.Context, name string, args *BillingAccountSinkArgs, opts ...pulumi.ResourceOpt) (*BillingAccountSink, error)
NewBillingAccountSink registers a new resource with the given unique name, arguments, and options.
func (*BillingAccountSink) BillingAccount ¶
func (r *BillingAccountSink) BillingAccount() pulumi.StringOutput
The billing account exported to the sink.
func (*BillingAccountSink) Destination ¶
func (r *BillingAccountSink) Destination() pulumi.StringOutput
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.
func (*BillingAccountSink) Filter ¶
func (r *BillingAccountSink) Filter() pulumi.StringOutput
The filter to apply when exporting logs. Only log entries that match the filter are exported. See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to write a filter.
func (*BillingAccountSink) ID ¶
func (r *BillingAccountSink) ID() pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*BillingAccountSink) Name ¶
func (r *BillingAccountSink) Name() pulumi.StringOutput
The name of the logging sink.
func (*BillingAccountSink) URN ¶
func (r *BillingAccountSink) URN() pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
func (*BillingAccountSink) WriterIdentity ¶
func (r *BillingAccountSink) WriterIdentity() pulumi.StringOutput
The identity associated with this sink. This identity must be granted write access to the configured `destination`.
type BillingAccountSinkArgs ¶
type BillingAccountSinkArgs struct { // The billing account exported to the sink. BillingAccount interface{} // 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. Destination interface{} // The filter to apply when exporting logs. Only log entries that match the filter are exported. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to // write a filter. Filter interface{} // The name of the logging sink. Name interface{} }
The set of arguments for constructing a BillingAccountSink resource.
type BillingAccountSinkState ¶
type BillingAccountSinkState struct { // The billing account exported to the sink. BillingAccount interface{} // 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. Destination interface{} // The filter to apply when exporting logs. Only log entries that match the filter are exported. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to // write a filter. Filter interface{} // The name of the logging sink. Name interface{} // The identity associated with this sink. This identity must be granted write access to the // configured `destination`. WriterIdentity interface{} }
Input properties used for looking up and filtering BillingAccountSink resources.
type FolderExclusion ¶ added in v0.15.0
type FolderExclusion struct {
// contains filtered or unexported fields
}
Manages a folder-level logging exclusion. For more information see [the official documentation](https://cloud.google.com/logging/docs/) and [Excluding Logs](https://cloud.google.com/logging/docs/exclusions).
Note that you must have the "Logs Configuration Writer" IAM role (`roles/logging.configWriter`) granted to the credentials used with this provider.
> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/logging_folder_exclusion.html.markdown.
func GetFolderExclusion ¶ added in v0.15.0
func GetFolderExclusion(ctx *pulumi.Context, name string, id pulumi.ID, state *FolderExclusionState, opts ...pulumi.ResourceOpt) (*FolderExclusion, error)
GetFolderExclusion gets an existing FolderExclusion resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewFolderExclusion ¶ added in v0.15.0
func NewFolderExclusion(ctx *pulumi.Context, name string, args *FolderExclusionArgs, opts ...pulumi.ResourceOpt) (*FolderExclusion, error)
NewFolderExclusion registers a new resource with the given unique name, arguments, and options.
func (*FolderExclusion) Description ¶ added in v0.15.0
func (r *FolderExclusion) Description() pulumi.StringOutput
A human-readable description.
func (*FolderExclusion) Disabled ¶ added in v0.15.0
func (r *FolderExclusion) Disabled() pulumi.BoolOutput
Whether this exclusion rule should be disabled or not. This defaults to false.
func (*FolderExclusion) Filter ¶ added in v0.15.0
func (r *FolderExclusion) Filter() pulumi.StringOutput
The filter to apply when excluding logs. Only log entries that match the filter are excluded. See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to write a filter.
func (*FolderExclusion) Folder ¶ added in v0.15.0
func (r *FolderExclusion) Folder() pulumi.StringOutput
The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is accepted.
func (*FolderExclusion) ID ¶ added in v0.15.0
func (r *FolderExclusion) ID() pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*FolderExclusion) Name ¶ added in v0.15.0
func (r *FolderExclusion) Name() pulumi.StringOutput
The name of the logging exclusion.
func (*FolderExclusion) URN ¶ added in v0.15.0
func (r *FolderExclusion) URN() pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type FolderExclusionArgs ¶ added in v0.15.0
type FolderExclusionArgs struct { // A human-readable description. Description interface{} // Whether this exclusion rule should be disabled or not. This defaults to // false. Disabled interface{} // The filter to apply when excluding logs. Only log entries that match the filter are excluded. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to // write a filter. Filter interface{} // The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is // accepted. Folder interface{} // The name of the logging exclusion. Name interface{} }
The set of arguments for constructing a FolderExclusion resource.
type FolderExclusionState ¶ added in v0.15.0
type FolderExclusionState struct { // A human-readable description. Description interface{} // Whether this exclusion rule should be disabled or not. This defaults to // false. Disabled interface{} // The filter to apply when excluding logs. Only log entries that match the filter are excluded. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to // write a filter. Filter interface{} // The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is // accepted. Folder interface{} // The name of the logging exclusion. Name interface{} }
Input properties used for looking up and filtering FolderExclusion resources.
type FolderSink ¶
type FolderSink struct {
// contains filtered or unexported fields
}
> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/logging_folder_sink.html.markdown.
func GetFolderSink ¶
func GetFolderSink(ctx *pulumi.Context, name string, id pulumi.ID, state *FolderSinkState, opts ...pulumi.ResourceOpt) (*FolderSink, error)
GetFolderSink gets an existing FolderSink resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewFolderSink ¶
func NewFolderSink(ctx *pulumi.Context, name string, args *FolderSinkArgs, opts ...pulumi.ResourceOpt) (*FolderSink, error)
NewFolderSink registers a new resource with the given unique name, arguments, and options.
func (*FolderSink) Destination ¶
func (r *FolderSink) Destination() pulumi.StringOutput
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.
func (*FolderSink) Filter ¶
func (r *FolderSink) Filter() pulumi.StringOutput
The filter to apply when exporting logs. Only log entries that match the filter are exported. See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to write a filter.
func (*FolderSink) Folder ¶
func (r *FolderSink) Folder() pulumi.StringOutput
The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is accepted.
func (*FolderSink) ID ¶
func (r *FolderSink) ID() pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*FolderSink) IncludeChildren ¶
func (r *FolderSink) IncludeChildren() pulumi.BoolOutput
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.
func (*FolderSink) Name ¶
func (r *FolderSink) Name() pulumi.StringOutput
The name of the logging sink.
func (*FolderSink) URN ¶
func (r *FolderSink) URN() pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
func (*FolderSink) WriterIdentity ¶
func (r *FolderSink) WriterIdentity() pulumi.StringOutput
The identity associated with this sink. This identity must be granted write access to the configured `destination`.
type FolderSinkArgs ¶
type FolderSinkArgs struct { // 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. Destination interface{} // The filter to apply when exporting logs. Only log entries that match the filter are exported. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to // write a filter. Filter interface{} // The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is // accepted. Folder interface{} // 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. IncludeChildren interface{} // The name of the logging sink. Name interface{} }
The set of arguments for constructing a FolderSink resource.
type FolderSinkState ¶
type FolderSinkState struct { // 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. Destination interface{} // The filter to apply when exporting logs. Only log entries that match the filter are exported. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to // write a filter. Filter interface{} // The folder to be exported to the sink. Note that either [FOLDER_ID] or "folders/[FOLDER_ID]" is // accepted. Folder interface{} // 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. IncludeChildren interface{} // The name of the logging sink. Name interface{} // The identity associated with this sink. This identity must be granted write access to the // configured `destination`. WriterIdentity interface{} }
Input properties used for looking up and filtering FolderSink resources.
type Metric ¶ added in v0.18.6
type Metric struct {
// contains filtered or unexported fields
}
> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/logging_metric.html.markdown.
func GetMetric ¶ added in v0.18.6
func GetMetric(ctx *pulumi.Context, name string, id pulumi.ID, state *MetricState, opts ...pulumi.ResourceOpt) (*Metric, error)
GetMetric gets an existing Metric resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewMetric ¶ added in v0.18.6
func NewMetric(ctx *pulumi.Context, name string, args *MetricArgs, opts ...pulumi.ResourceOpt) (*Metric, error)
NewMetric registers a new resource with the given unique name, arguments, and options.
func (*Metric) BucketOptions ¶ added in v0.18.6
The bucketOptions are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.
func (*Metric) Description ¶ added in v0.18.6
func (r *Metric) Description() pulumi.StringOutput
A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.
func (*Metric) Filter ¶ added in v0.18.6
func (r *Metric) Filter() pulumi.StringOutput
An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-filters) which is used to match log entries.
func (*Metric) ID ¶ added in v0.18.6
ID is this resource's unique identifier assigned by its provider.
func (*Metric) LabelExtractors ¶ added in v0.18.6
A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the valueExtractor field.
func (*Metric) MetricDescriptor ¶ added in v0.18.6
The metric descriptor associated with the logs-based metric.
func (*Metric) Name ¶ added in v0.18.6
func (r *Metric) Name() pulumi.StringOutput
The client-assigned metric identifier. Examples - "error_count", "nginx/requests". Metric identifiers are limited to 100 characters and can include only the following characters A-Z, a-z, 0-9, and the special characters _-.,+!*',()%!/(MISSING). The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
func (*Metric) Project ¶ added in v0.18.6
func (r *Metric) Project() pulumi.StringOutput
func (*Metric) ValueExtractor ¶ added in v0.18.6
func (r *Metric) ValueExtractor() pulumi.StringOutput
A valueExtractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction - EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are 1. field - The name of the log entry field from which the value is to be extracted. 2. regex - A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.
type MetricArgs ¶ added in v0.18.6
type MetricArgs struct { // The bucketOptions are required when the logs-based metric is using a DISTRIBUTION value type and it describes the // bucket boundaries used to create a histogram of the extracted values. BucketOptions interface{} // A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters. Description interface{} // An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-filters) which is used to match log // entries. Filter interface{} // A map from a label key string to an extractor expression which is used to extract data from a log entry field and // assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression // in this map. The syntax of the extractor expression is the same as for the valueExtractor field. LabelExtractors interface{} // The metric descriptor associated with the logs-based metric. MetricDescriptor interface{} // The client-assigned metric identifier. Examples - "error_count", "nginx/requests". Metric identifiers are limited to // 100 characters and can include only the following characters A-Z, a-z, 0-9, and the special characters _-.,+!*',()%!/(MISSING). // The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name. Name interface{} Project interface{} // A valueExtractor is required when using a distribution logs-based metric to extract the values to record from a log // entry. Two functions are supported for value extraction - EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument // are 1. field - The name of the log entry field from which the value is to be extracted. 2. regex - A regular expression // using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data // from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an // error to specify a regex that does not include exactly one capture group. ValueExtractor interface{} }
The set of arguments for constructing a Metric resource.
type MetricState ¶ added in v0.18.6
type MetricState struct { // The bucketOptions are required when the logs-based metric is using a DISTRIBUTION value type and it describes the // bucket boundaries used to create a histogram of the extracted values. BucketOptions interface{} // A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters. Description interface{} // An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-filters) which is used to match log // entries. Filter interface{} // A map from a label key string to an extractor expression which is used to extract data from a log entry field and // assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression // in this map. The syntax of the extractor expression is the same as for the valueExtractor field. LabelExtractors interface{} // The metric descriptor associated with the logs-based metric. MetricDescriptor interface{} // The client-assigned metric identifier. Examples - "error_count", "nginx/requests". Metric identifiers are limited to // 100 characters and can include only the following characters A-Z, a-z, 0-9, and the special characters _-.,+!*',()%!/(MISSING). // The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name. Name interface{} Project interface{} // A valueExtractor is required when using a distribution logs-based metric to extract the values to record from a log // entry. Two functions are supported for value extraction - EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument // are 1. field - The name of the log entry field from which the value is to be extracted. 2. regex - A regular expression // using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data // from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an // error to specify a regex that does not include exactly one capture group. ValueExtractor interface{} }
Input properties used for looking up and filtering Metric resources.
type OrganizationExclusion ¶ added in v0.15.0
type OrganizationExclusion struct {
// contains filtered or unexported fields
}
Manages an organization-level logging exclusion. For more information see [the official documentation](https://cloud.google.com/logging/docs/) and [Excluding Logs](https://cloud.google.com/logging/docs/exclusions).
Note that you must have the "Logs Configuration Writer" IAM role (`roles/logging.configWriter`) granted to the credentials used with this provider.
> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/logging_organization_exclusion.html.markdown.
func GetOrganizationExclusion ¶ added in v0.15.0
func GetOrganizationExclusion(ctx *pulumi.Context, name string, id pulumi.ID, state *OrganizationExclusionState, opts ...pulumi.ResourceOpt) (*OrganizationExclusion, error)
GetOrganizationExclusion gets an existing OrganizationExclusion resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewOrganizationExclusion ¶ added in v0.15.0
func NewOrganizationExclusion(ctx *pulumi.Context, name string, args *OrganizationExclusionArgs, opts ...pulumi.ResourceOpt) (*OrganizationExclusion, error)
NewOrganizationExclusion registers a new resource with the given unique name, arguments, and options.
func (*OrganizationExclusion) Description ¶ added in v0.15.0
func (r *OrganizationExclusion) Description() pulumi.StringOutput
A human-readable description.
func (*OrganizationExclusion) Disabled ¶ added in v0.15.0
func (r *OrganizationExclusion) Disabled() pulumi.BoolOutput
Whether this exclusion rule should be disabled or not. This defaults to false.
func (*OrganizationExclusion) Filter ¶ added in v0.15.0
func (r *OrganizationExclusion) Filter() pulumi.StringOutput
The filter to apply when excluding logs. Only log entries that match the filter are excluded. See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to write a filter.
func (*OrganizationExclusion) ID ¶ added in v0.15.0
func (r *OrganizationExclusion) ID() pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*OrganizationExclusion) Name ¶ added in v0.15.0
func (r *OrganizationExclusion) Name() pulumi.StringOutput
The name of the logging exclusion.
func (*OrganizationExclusion) OrgId ¶ added in v0.15.0
func (r *OrganizationExclusion) OrgId() pulumi.StringOutput
The organization to create the exclusion in.
func (*OrganizationExclusion) URN ¶ added in v0.15.0
func (r *OrganizationExclusion) URN() pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type OrganizationExclusionArgs ¶ added in v0.15.0
type OrganizationExclusionArgs struct { // A human-readable description. Description interface{} // Whether this exclusion rule should be disabled or not. This defaults to // false. Disabled interface{} // The filter to apply when excluding logs. Only log entries that match the filter are excluded. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to // write a filter. Filter interface{} // The name of the logging exclusion. Name interface{} // The organization to create the exclusion in. OrgId interface{} }
The set of arguments for constructing a OrganizationExclusion resource.
type OrganizationExclusionState ¶ added in v0.15.0
type OrganizationExclusionState struct { // A human-readable description. Description interface{} // Whether this exclusion rule should be disabled or not. This defaults to // false. Disabled interface{} // The filter to apply when excluding logs. Only log entries that match the filter are excluded. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to // write a filter. Filter interface{} // The name of the logging exclusion. Name interface{} // The organization to create the exclusion in. OrgId interface{} }
Input properties used for looking up and filtering OrganizationExclusion resources.
type OrganizationSink ¶
type OrganizationSink struct {
// contains filtered or unexported fields
}
> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/logging_organization_sink.html.markdown.
func GetOrganizationSink ¶
func GetOrganizationSink(ctx *pulumi.Context, name string, id pulumi.ID, state *OrganizationSinkState, opts ...pulumi.ResourceOpt) (*OrganizationSink, error)
GetOrganizationSink gets an existing OrganizationSink resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewOrganizationSink ¶
func NewOrganizationSink(ctx *pulumi.Context, name string, args *OrganizationSinkArgs, opts ...pulumi.ResourceOpt) (*OrganizationSink, error)
NewOrganizationSink registers a new resource with the given unique name, arguments, and options.
func (*OrganizationSink) Destination ¶
func (r *OrganizationSink) Destination() pulumi.StringOutput
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.
func (*OrganizationSink) Filter ¶
func (r *OrganizationSink) Filter() pulumi.StringOutput
The filter to apply when exporting logs. Only log entries that match the filter are exported. See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to write a filter.
func (*OrganizationSink) ID ¶
func (r *OrganizationSink) ID() pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*OrganizationSink) IncludeChildren ¶
func (r *OrganizationSink) IncludeChildren() pulumi.BoolOutput
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.
func (*OrganizationSink) Name ¶
func (r *OrganizationSink) Name() pulumi.StringOutput
The name of the logging sink.
func (*OrganizationSink) OrgId ¶
func (r *OrganizationSink) OrgId() pulumi.StringOutput
The numeric ID of the organization to be exported to the sink.
func (*OrganizationSink) URN ¶
func (r *OrganizationSink) URN() pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
func (*OrganizationSink) WriterIdentity ¶
func (r *OrganizationSink) WriterIdentity() pulumi.StringOutput
The identity associated with this sink. This identity must be granted write access to the configured `destination`.
type OrganizationSinkArgs ¶
type OrganizationSinkArgs struct { // 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. Destination interface{} // The filter to apply when exporting logs. Only log entries that match the filter are exported. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to // write a filter. Filter interface{} // 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. IncludeChildren interface{} // The name of the logging sink. Name interface{} // The numeric ID of the organization to be exported to the sink. OrgId interface{} }
The set of arguments for constructing a OrganizationSink resource.
type OrganizationSinkState ¶
type OrganizationSinkState struct { // 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. Destination interface{} // The filter to apply when exporting logs. Only log entries that match the filter are exported. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to // write a filter. Filter interface{} // 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. IncludeChildren interface{} // The name of the logging sink. Name interface{} // The numeric ID of the organization to be exported to the sink. OrgId interface{} // The identity associated with this sink. This identity must be granted write access to the // configured `destination`. WriterIdentity interface{} }
Input properties used for looking up and filtering OrganizationSink resources.
type ProjectExclusion ¶ added in v0.15.0
type ProjectExclusion struct {
// contains filtered or unexported fields
}
Manages a project-level logging exclusion. For more information see [the official documentation](https://cloud.google.com/logging/docs/) and [Excluding Logs](https://cloud.google.com/logging/docs/exclusions).
Note that you must have the "Logs Configuration Writer" IAM role (`roles/logging.configWriter`) granted to the credentials used with this provider.
> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/logging_project_exclusion.html.markdown.
func GetProjectExclusion ¶ added in v0.15.0
func GetProjectExclusion(ctx *pulumi.Context, name string, id pulumi.ID, state *ProjectExclusionState, opts ...pulumi.ResourceOpt) (*ProjectExclusion, error)
GetProjectExclusion gets an existing ProjectExclusion resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewProjectExclusion ¶ added in v0.15.0
func NewProjectExclusion(ctx *pulumi.Context, name string, args *ProjectExclusionArgs, opts ...pulumi.ResourceOpt) (*ProjectExclusion, error)
NewProjectExclusion registers a new resource with the given unique name, arguments, and options.
func (*ProjectExclusion) Description ¶ added in v0.15.0
func (r *ProjectExclusion) Description() pulumi.StringOutput
A human-readable description.
func (*ProjectExclusion) Disabled ¶ added in v0.15.0
func (r *ProjectExclusion) Disabled() pulumi.BoolOutput
Whether this exclusion rule should be disabled or not. This defaults to false.
func (*ProjectExclusion) Filter ¶ added in v0.15.0
func (r *ProjectExclusion) Filter() pulumi.StringOutput
The filter to apply when excluding logs. Only log entries that match the filter are excluded. See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to write a filter.
func (*ProjectExclusion) ID ¶ added in v0.15.0
func (r *ProjectExclusion) ID() pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*ProjectExclusion) Name ¶ added in v0.15.0
func (r *ProjectExclusion) Name() pulumi.StringOutput
The name of the logging exclusion.
func (*ProjectExclusion) Project ¶ added in v0.15.0
func (r *ProjectExclusion) Project() pulumi.StringOutput
The project to create the exclusion in. If omitted, the project associated with the provider is used.
func (*ProjectExclusion) URN ¶ added in v0.15.0
func (r *ProjectExclusion) URN() pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type ProjectExclusionArgs ¶ added in v0.15.0
type ProjectExclusionArgs struct { // A human-readable description. Description interface{} // Whether this exclusion rule should be disabled or not. This defaults to // false. Disabled interface{} // The filter to apply when excluding logs. Only log entries that match the filter are excluded. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to // write a filter. Filter interface{} // The name of the logging exclusion. Name interface{} // The project to create the exclusion in. If omitted, the project associated with the provider is // used. Project interface{} }
The set of arguments for constructing a ProjectExclusion resource.
type ProjectExclusionState ¶ added in v0.15.0
type ProjectExclusionState struct { // A human-readable description. Description interface{} // Whether this exclusion rule should be disabled or not. This defaults to // false. Disabled interface{} // The filter to apply when excluding logs. Only log entries that match the filter are excluded. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to // write a filter. Filter interface{} // The name of the logging exclusion. Name interface{} // The project to create the exclusion in. If omitted, the project associated with the provider is // used. Project interface{} }
Input properties used for looking up and filtering ProjectExclusion resources.
type ProjectSink ¶
type ProjectSink struct {
// contains filtered or unexported fields
}
> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/logging_project_sink.html.markdown.
func GetProjectSink ¶
func GetProjectSink(ctx *pulumi.Context, name string, id pulumi.ID, state *ProjectSinkState, opts ...pulumi.ResourceOpt) (*ProjectSink, error)
GetProjectSink gets an existing ProjectSink resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewProjectSink ¶
func NewProjectSink(ctx *pulumi.Context, name string, args *ProjectSinkArgs, opts ...pulumi.ResourceOpt) (*ProjectSink, error)
NewProjectSink registers a new resource with the given unique name, arguments, and options.
func (*ProjectSink) Destination ¶
func (r *ProjectSink) Destination() pulumi.StringOutput
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.
func (*ProjectSink) Filter ¶
func (r *ProjectSink) Filter() pulumi.StringOutput
The filter to apply when exporting logs. Only log entries that match the filter are exported. See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to write a filter.
func (*ProjectSink) ID ¶
func (r *ProjectSink) ID() pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*ProjectSink) Name ¶
func (r *ProjectSink) Name() pulumi.StringOutput
The name of the logging sink.
func (*ProjectSink) Project ¶
func (r *ProjectSink) Project() pulumi.StringOutput
The ID of the project to create the sink in. If omitted, the project associated with the provider is used.
func (*ProjectSink) URN ¶
func (r *ProjectSink) URN() pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
func (*ProjectSink) UniqueWriterIdentity ¶
func (r *ProjectSink) UniqueWriterIdentity() pulumi.BoolOutput
Whether or not to create a unique identity associated with this sink. If `false` (the default), then the `writerIdentity` 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 `uniqueWriterIdentity` to true.
func (*ProjectSink) WriterIdentity ¶
func (r *ProjectSink) WriterIdentity() pulumi.StringOutput
The identity associated with this sink. This identity must be granted write access to the configured `destination`.
type ProjectSinkArgs ¶
type ProjectSinkArgs struct { // 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. Destination interface{} // The filter to apply when exporting logs. Only log entries that match the filter are exported. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to // write a filter. Filter interface{} // The name of the logging sink. Name interface{} // The ID of the project to create the sink in. If omitted, the project associated with the provider is // used. Project interface{} // Whether or not to create a unique identity associated with this sink. If `false` // (the default), then the `writerIdentity` 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 `uniqueWriterIdentity` to true. UniqueWriterIdentity interface{} }
The set of arguments for constructing a ProjectSink resource.
type ProjectSinkState ¶
type ProjectSinkState struct { // 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. Destination interface{} // The filter to apply when exporting logs. Only log entries that match the filter are exported. // See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced_filters) for information on how to // write a filter. Filter interface{} // The name of the logging sink. Name interface{} // The ID of the project to create the sink in. If omitted, the project associated with the provider is // used. Project interface{} // Whether or not to create a unique identity associated with this sink. If `false` // (the default), then the `writerIdentity` 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 `uniqueWriterIdentity` to true. UniqueWriterIdentity interface{} // The identity associated with this sink. This identity must be granted write access to the // configured `destination`. WriterIdentity interface{} }
Input properties used for looking up and filtering ProjectSink resources.