VpcFlowLogsConfig

import type { VpcFlowLogsConfig } from "https://googleapis.deno.dev/v1/networkmanagement:v1.ts";

A configuration to generate VPC Flow Logs.

interface VpcFlowLogsConfig {

aggregationInterval?:

| "AGGREGATION_INTERVAL_UNSPECIFIED"

| "INTERVAL_5_SEC"

| "INTERVAL_30_SEC"

| "INTERVAL_1_MIN"

| "INTERVAL_5_MIN"

| "INTERVAL_10_MIN"

| "INTERVAL_15_MIN";

readonly createTime?: Date;

crossProjectMetadata?: "CROSS_PROJECT_METADATA_UNSPECIFIED" | "CROSS_PROJECT_METADATA_ENABLED" | "CROSS_PROJECT_METADATA_DISABLED";

description?: string;

filterExpr?: string;

flowSampling?: number;

interconnectAttachment?: string;

labels?: {

[key: string]: string;

};

metadata?:

| "METADATA_UNSPECIFIED"

| "INCLUDE_ALL_METADATA"

| "EXCLUDE_ALL_METADATA"

| "CUSTOM_METADATA";

metadataFields?: string[];

name?: string;

network?: string;

state?: "STATE_UNSPECIFIED" | "ENABLED" | "DISABLED";

subnet?: string;

readonly targetResourceState?: "TARGET_RESOURCE_STATE_UNSPECIFIED" | "TARGET_RESOURCE_EXISTS" | "TARGET_RESOURCE_DOES_NOT_EXIST";

readonly updateTime?: Date;

vpnTunnel?: string;

}

§Properties

[src]

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

readonly createTime?: Date

[src]

Output only. The time the config was created.

crossProjectMetadata?: "CROSS_PROJECT_METADATA_UNSPECIFIED" | "CROSS_PROJECT_METADATA_ENABLED" | "CROSS_PROJECT_METADATA_DISABLED"

[src]

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.

description?: string

[src]

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

filterExpr?: string

[src]

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

flowSampling?: number

[src]

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.

interconnectAttachment?: string

[src]

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

labels?: {

[key: string]: string;

}

[src]

Optional. Resource labels to represent user-provided metadata.

metadata?: "METADATA_UNSPECIFIED" | "INCLUDE_ALL_METADATA" | "EXCLUDE_ALL_METADATA" | "CUSTOM_METADATA"

[src]

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.

metadataFields?: string[]

[src]

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

name?: string

[src]

Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}

For organization-level configurations: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}

network?: string

[src]

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

state?: "STATE_UNSPECIFIED" | "ENABLED" | "DISABLED"

[src]

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.

subnet?: string

[src]

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

readonly targetResourceState?: "TARGET_RESOURCE_STATE_UNSPECIFIED" | "TARGET_RESOURCE_EXISTS" | "TARGET_RESOURCE_DOES_NOT_EXIST"

[src]

Output only. Describes the state of the configured target resource for diagnostic purposes.

readonly updateTime?: Date

[src]

Output only. The time the config was updated.

vpnTunnel?: string

[src]

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