REST Resource: projects.locations.vpcFlowLogsConfigs

Resource: VpcFlowLogsConfig

A configuration to generate VPC Flow Logs.

JSON representation 
{
  "name": string,
  "metadataFields": [
    string
  ],
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "description": string,
  "state": enum (State),
  "aggregationInterval": enum (AggregationInterval),
  "flowSampling": number,
  "metadata": enum (Metadata),
  "filterExpr": string,
  "crossProjectMetadata": enum (CrossProjectMetadata),
  "targetResourceState": enum (TargetResourceState),

  // Union field target_resource can be only one of the following:
  "network": string,
  "subnet": string,
  "interconnectAttachment": string,
  "vpnTunnel": string
  // End of list of possible types for union field target_resource.
}
Fields
name

string

Identifier. Unique name of the configuration. The name can have one of the following forms:

  • For project-level configurations: projects/{projectId}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}

  • For organization-level configurations: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpcFlowLogsConfigId}
metadataFields[]

string

Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
labels

map (key: string, value: string)

Optional. Resource labels to represent user-provided metadata.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Output only. The time the config was created.

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time the config was updated.

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
description

string

Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
state

enum (State)

Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Setting state=DISABLED will pause the log generation for this config.
aggregationInterval

enum (AggregationInterval)

Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
flowSampling

number

Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.
metadata

enum (Metadata)

Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.
filterExpr

string

Optional. Export filter used to define which VPC Flow Logs should be logged.
crossProjectMetadata

enum (CrossProjectMetadata)

Optional. Determines whether to include cross project annotations in the logs. This field is available only for organization configurations. If not specified in org configs will be set to CROSS_PROJECT_METADATA_ENABLED.
targetResourceState

enum (TargetResourceState)

Output only. Describes the state of the configured target resource for diagnostic purposes.
Union field target_resource. Reference to the resource of the config scope. That is, the scope from which traffic is logged. The target resource must belong to the same project as the configuration. This field is not supported for organization level configurations. target_resource can be only one of the following:
network

string

Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{projectId}/global/networks/{name}
subnet

string

Traffic will be logged from VMs within the subnetwork. Format: projects/{projectId}/regions/{region}/subnetworks/{name}
interconnectAttachment

string

Traffic will be logged from the Interconnect Attachment. Format: projects/{projectId}/regions/{region}/interconnectAttachments/{name}
vpnTunnel

string

Traffic will be logged from the VPN Tunnel. Format: projects/{projectId}/regions/{region}/vpnTunnels/{name}

Methods

create

 Creates a new VpcFlowLogsConfig.

delete

 Deletes a specific VpcFlowLogsConfig.

get

 Gets the details of a specific VpcFlowLogsConfig.

list

 Lists all VpcFlowLogsConfigs in a given project.

patch

 Updates an existing VpcFlowLogsConfig.

queryOrgVpcFlowLogsConfigs

 QueryOrgVpcFlowLogsConfigs returns a list of all organization-level VPC Flow Logs configurations applicable to the specified project.