Skip to main content

vpc_flow_logs_configs

Creates, updates, deletes, gets or lists a vpc_flow_logs_configs resource.

Overview​

Namevpc_flow_logs_configs
TypeResource
Idgoogle.networkmanagement.vpc_flow_logs_configs

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringIdentifier. 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}
aggregationIntervalstringOptional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.
createTimestring (google-datetime)Output only. The time the config was created.
crossProjectMetadatastringOptional. 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.
descriptionstringOptional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
filterExprstringOptional. Export filter used to define which VPC Flow Logs should be logged.
flowSamplingnumber (float)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.
interconnectAttachmentstringTraffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}
labelsobjectOptional. Resource labels to represent user-provided metadata.
metadatastringOptional. 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.
metadataFieldsarrayOptional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
networkstringTraffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/global/networks/{name}
statestringOptional. 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.
subnetstringTraffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/regions/{region}/subnetworks/{name}
targetResourceStatestringOutput only. Describes the state of the configured target resource for diagnostic purposes.
updateTimestring (google-datetime)Output only. The time the config was updated.
vpnTunnelstringTraffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectorganizationsId, locationsId, vpcFlowLogsConfigsIdGets the details of a specific VpcFlowLogsConfig.
listselectorganizationsId, locationsIdorderBy, filter, pageToken, pageSizeLists all VpcFlowLogsConfigs in a given organization.
query_org_vpc_flow_logs_configsselectprojectsId, locationsIdfilter, pageToken, pageSizeQueryOrgVpcFlowLogsConfigs returns a list of all organization-level VPC Flow Logs configurations applicable to the specified project.
createinsertorganizationsId, locationsIdvpcFlowLogsConfigIdCreates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description
patchupdateorganizationsId, locationsId, vpcFlowLogsConfigsIdupdateMaskUpdates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with state=DISABLED will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description
deletedeleteorganizationsId, locationsId, vpcFlowLogsConfigsIdDeletes a specific VpcFlowLogsConfig.
show_effective_flow_logs_configsexecprojectsId, locationsIdpageToken, resource, pageSize, filterShowEffectiveFlowLogsConfigs returns a list of all VPC Flow Logs configurations applicable to a specified resource.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
locationsIdstring
organizationsIdstring
projectsIdstring
vpcFlowLogsConfigsIdstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
resourcestring
updateMaskstring (google-fieldmask)
vpcFlowLogsConfigIdstring

SELECT examples​

Gets the details of a specific VpcFlowLogsConfig.

SELECT
name,
aggregationInterval,
createTime,
crossProjectMetadata,
description,
filterExpr,
flowSampling,
interconnectAttachment,
labels,
metadata,
metadataFields,
network,
state,
subnet,
targetResourceState,
updateTime,
vpnTunnel
FROM google.networkmanagement.vpc_flow_logs_configs
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND vpcFlowLogsConfigsId = '{{ vpcFlowLogsConfigsId }}' -- required
;

INSERT examples​

Creates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description

INSERT INTO google.networkmanagement.vpc_flow_logs_configs (
data__labels,
data__state,
data__metadataFields,
data__crossProjectMetadata,
data__network,
data__metadata,
data__aggregationInterval,
data__description,
data__filterExpr,
data__flowSampling,
data__interconnectAttachment,
data__vpnTunnel,
data__subnet,
data__name,
organizationsId,
locationsId,
vpcFlowLogsConfigId
)
SELECT 
'{{ labels }}',
'{{ state }}',
'{{ metadataFields }}',
'{{ crossProjectMetadata }}',
'{{ network }}',
'{{ metadata }}',
'{{ aggregationInterval }}',
'{{ description }}',
'{{ filterExpr }}',
{{ flowSampling }},
'{{ interconnectAttachment }}',
'{{ vpnTunnel }}',
'{{ subnet }}',
'{{ name }}',
'{{ organizationsId }}',
'{{ locationsId }}',
'{{ vpcFlowLogsConfigId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with state=DISABLED will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description

UPDATE google.networkmanagement.vpc_flow_logs_configs
SET 
data__labels = '{{ labels }}',
data__state = '{{ state }}',
data__metadataFields = '{{ metadataFields }}',
data__crossProjectMetadata = '{{ crossProjectMetadata }}',
data__network = '{{ network }}',
data__metadata = '{{ metadata }}',
data__aggregationInterval = '{{ aggregationInterval }}',
data__description = '{{ description }}',
data__filterExpr = '{{ filterExpr }}',
data__flowSampling = {{ flowSampling }},
data__interconnectAttachment = '{{ interconnectAttachment }}',
data__vpnTunnel = '{{ vpnTunnel }}',
data__subnet = '{{ subnet }}',
data__name = '{{ name }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND vpcFlowLogsConfigsId = '{{ vpcFlowLogsConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes a specific VpcFlowLogsConfig.

DELETE FROM google.networkmanagement.vpc_flow_logs_configs
WHERE organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND vpcFlowLogsConfigsId = '{{ vpcFlowLogsConfigsId }}' --required
;

Lifecycle Methods​

ShowEffectiveFlowLogsConfigs returns a list of all VPC Flow Logs configurations applicable to a specified resource.

EXEC google.networkmanagement.vpc_flow_logs_configs.show_effective_flow_logs_configs 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@pageToken='{{ pageToken }}', 
@resource='{{ resource }}', 
@pageSize='{{ pageSize }}', 
@filter='{{ filter }}'
;