gcp.networkmanagement.OrganizationVpcFlowLogsConfig
Explore with Pulumi AI
VPC Flow Logs Config is a resource that lets you configure Flow Logs for Organization.
Example Usage
Network Management Org Vpc Flow Logs Config Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const org_test = new gcp.networkmanagement.OrganizationVpcFlowLogsConfig("org-test", {
vpcFlowLogsConfigId: "basic-org-test-id",
location: "global",
organization: "123456789",
});
import pulumi
import pulumi_gcp as gcp
org_test = gcp.networkmanagement.OrganizationVpcFlowLogsConfig("org-test",
vpc_flow_logs_config_id="basic-org-test-id",
location="global",
organization="123456789")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/networkmanagement"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := networkmanagement.NewOrganizationVpcFlowLogsConfig(ctx, "org-test", &networkmanagement.OrganizationVpcFlowLogsConfigArgs{
VpcFlowLogsConfigId: pulumi.String("basic-org-test-id"),
Location: pulumi.String("global"),
Organization: pulumi.String("123456789"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var org_test = new Gcp.NetworkManagement.OrganizationVpcFlowLogsConfig("org-test", new()
{
VpcFlowLogsConfigId = "basic-org-test-id",
Location = "global",
Organization = "123456789",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networkmanagement.OrganizationVpcFlowLogsConfig;
import com.pulumi.gcp.networkmanagement.OrganizationVpcFlowLogsConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var org_test = new OrganizationVpcFlowLogsConfig("org-test", OrganizationVpcFlowLogsConfigArgs.builder()
.vpcFlowLogsConfigId("basic-org-test-id")
.location("global")
.organization("123456789")
.build());
}
}
resources:
org-test:
type: gcp:networkmanagement:OrganizationVpcFlowLogsConfig
properties:
vpcFlowLogsConfigId: basic-org-test-id
location: global
organization: '123456789'
Create OrganizationVpcFlowLogsConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OrganizationVpcFlowLogsConfig(name: string, args: OrganizationVpcFlowLogsConfigArgs, opts?: CustomResourceOptions);
@overload
def OrganizationVpcFlowLogsConfig(resource_name: str,
args: OrganizationVpcFlowLogsConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OrganizationVpcFlowLogsConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
location: Optional[str] = None,
organization: Optional[str] = None,
vpc_flow_logs_config_id: Optional[str] = None,
aggregation_interval: Optional[str] = None,
cross_project_metadata: Optional[str] = None,
description: Optional[str] = None,
filter_expr: Optional[str] = None,
flow_sampling: Optional[float] = None,
labels: Optional[Mapping[str, str]] = None,
metadata: Optional[str] = None,
metadata_fields: Optional[Sequence[str]] = None,
state: Optional[str] = None)
func NewOrganizationVpcFlowLogsConfig(ctx *Context, name string, args OrganizationVpcFlowLogsConfigArgs, opts ...ResourceOption) (*OrganizationVpcFlowLogsConfig, error)
public OrganizationVpcFlowLogsConfig(string name, OrganizationVpcFlowLogsConfigArgs args, CustomResourceOptions? opts = null)
public OrganizationVpcFlowLogsConfig(String name, OrganizationVpcFlowLogsConfigArgs args)
public OrganizationVpcFlowLogsConfig(String name, OrganizationVpcFlowLogsConfigArgs args, CustomResourceOptions options)
type: gcp:networkmanagement:OrganizationVpcFlowLogsConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args OrganizationVpcFlowLogsConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OrganizationVpcFlowLogsConfigArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OrganizationVpcFlowLogsConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrganizationVpcFlowLogsConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OrganizationVpcFlowLogsConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var organizationVpcFlowLogsConfigResource = new Gcp.NetworkManagement.OrganizationVpcFlowLogsConfig("organizationVpcFlowLogsConfigResource", new()
{
Location = "string",
Organization = "string",
VpcFlowLogsConfigId = "string",
AggregationInterval = "string",
CrossProjectMetadata = "string",
Description = "string",
FilterExpr = "string",
FlowSampling = 0,
Labels =
{
{ "string", "string" },
},
Metadata = "string",
MetadataFields = new[]
{
"string",
},
State = "string",
});
example, err := networkmanagement.NewOrganizationVpcFlowLogsConfig(ctx, "organizationVpcFlowLogsConfigResource", &networkmanagement.OrganizationVpcFlowLogsConfigArgs{
Location: pulumi.String("string"),
Organization: pulumi.String("string"),
VpcFlowLogsConfigId: pulumi.String("string"),
AggregationInterval: pulumi.String("string"),
CrossProjectMetadata: pulumi.String("string"),
Description: pulumi.String("string"),
FilterExpr: pulumi.String("string"),
FlowSampling: pulumi.Float64(0),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Metadata: pulumi.String("string"),
MetadataFields: pulumi.StringArray{
pulumi.String("string"),
},
State: pulumi.String("string"),
})
var organizationVpcFlowLogsConfigResource = new OrganizationVpcFlowLogsConfig("organizationVpcFlowLogsConfigResource", OrganizationVpcFlowLogsConfigArgs.builder()
.location("string")
.organization("string")
.vpcFlowLogsConfigId("string")
.aggregationInterval("string")
.crossProjectMetadata("string")
.description("string")
.filterExpr("string")
.flowSampling(0.0)
.labels(Map.of("string", "string"))
.metadata("string")
.metadataFields("string")
.state("string")
.build());
organization_vpc_flow_logs_config_resource = gcp.networkmanagement.OrganizationVpcFlowLogsConfig("organizationVpcFlowLogsConfigResource",
location="string",
organization="string",
vpc_flow_logs_config_id="string",
aggregation_interval="string",
cross_project_metadata="string",
description="string",
filter_expr="string",
flow_sampling=0,
labels={
"string": "string",
},
metadata="string",
metadata_fields=["string"],
state="string")
const organizationVpcFlowLogsConfigResource = new gcp.networkmanagement.OrganizationVpcFlowLogsConfig("organizationVpcFlowLogsConfigResource", {
location: "string",
organization: "string",
vpcFlowLogsConfigId: "string",
aggregationInterval: "string",
crossProjectMetadata: "string",
description: "string",
filterExpr: "string",
flowSampling: 0,
labels: {
string: "string",
},
metadata: "string",
metadataFields: ["string"],
state: "string",
});
type: gcp:networkmanagement:OrganizationVpcFlowLogsConfig
properties:
aggregationInterval: string
crossProjectMetadata: string
description: string
filterExpr: string
flowSampling: 0
labels:
string: string
location: string
metadata: string
metadataFields:
- string
organization: string
state: string
vpcFlowLogsConfigId: string
OrganizationVpcFlowLogsConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OrganizationVpcFlowLogsConfig resource accepts the following input properties:
- Location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - Organization string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Vpc
Flow stringLogs Config Id - Required. ID of the
VpcFlowLogsConfig
. - Aggregation
Interval string - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- Cross
Project stringMetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - Description string
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- Filter
Expr string - Optional. Export filter used to define which VPC Flow Logs should be logged.
- Flow
Sampling double - 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.
- Labels Dictionary<string, string>
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Metadata string
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- Metadata
Fields List<string> - Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
- State string
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
- Location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - Organization string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Vpc
Flow stringLogs Config Id - Required. ID of the
VpcFlowLogsConfig
. - Aggregation
Interval string - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- Cross
Project stringMetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - Description string
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- Filter
Expr string - Optional. Export filter used to define which VPC Flow Logs should be logged.
- Flow
Sampling float64 - 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.
- Labels map[string]string
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Metadata string
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- Metadata
Fields []string - Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
- State string
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
- location String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - organization String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - vpc
Flow StringLogs Config Id - Required. ID of the
VpcFlowLogsConfig
. - aggregation
Interval String - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- cross
Project StringMetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - description String
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- filter
Expr String - Optional. Export filter used to define which VPC Flow Logs should be logged.
- flow
Sampling Double - 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.
- labels Map<String,String>
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- metadata String
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- metadata
Fields List<String> - Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
- state String
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
- location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - organization string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - vpc
Flow stringLogs Config Id - Required. ID of the
VpcFlowLogsConfig
. - aggregation
Interval string - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- cross
Project stringMetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - description string
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- filter
Expr string - Optional. Export filter used to define which VPC Flow Logs should be logged.
- flow
Sampling 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.
- labels {[key: string]: string}
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- metadata string
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- metadata
Fields string[] - Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
- state string
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
- location str
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - organization str
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - vpc_
flow_ strlogs_ config_ id - Required. ID of the
VpcFlowLogsConfig
. - aggregation_
interval str - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- cross_
project_ strmetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - description str
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- filter_
expr str - Optional. Export filter used to define which VPC Flow Logs should be logged.
- flow_
sampling 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.
- labels Mapping[str, str]
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- metadata str
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- metadata_
fields Sequence[str] - Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
- state str
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
- location String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - organization String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - vpc
Flow StringLogs Config Id - Required. ID of the
VpcFlowLogsConfig
. - aggregation
Interval String - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- cross
Project StringMetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - description String
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- filter
Expr String - Optional. Export filter used to define which VPC Flow Logs should be logged.
- flow
Sampling 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.
- labels Map<String>
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- metadata String
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- metadata
Fields List<String> - Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
- state String
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
Outputs
All input properties are implicitly available as output properties. Additionally, the OrganizationVpcFlowLogsConfig resource produces the following output properties:
- Create
Time string - Output only. The time the config was created.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Update
Time string - Output only. The time the config was updated.
- Create
Time string - Output only. The time the config was created.
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Update
Time string - Output only. The time the config was updated.
- create
Time String - Output only. The time the config was created.
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- update
Time String - Output only. The time the config was updated.
- create
Time string - Output only. The time the config was created.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- update
Time string - Output only. The time the config was updated.
- create_
time str - Output only. The time the config was created.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- update_
time str - Output only. The time the config was updated.
- create
Time String - Output only. The time the config was created.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- update
Time String - Output only. The time the config was updated.
Look up Existing OrganizationVpcFlowLogsConfig Resource
Get an existing OrganizationVpcFlowLogsConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: OrganizationVpcFlowLogsConfigState, opts?: CustomResourceOptions): OrganizationVpcFlowLogsConfig
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aggregation_interval: Optional[str] = None,
create_time: Optional[str] = None,
cross_project_metadata: Optional[str] = None,
description: Optional[str] = None,
effective_labels: Optional[Mapping[str, str]] = None,
filter_expr: Optional[str] = None,
flow_sampling: Optional[float] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
metadata: Optional[str] = None,
metadata_fields: Optional[Sequence[str]] = None,
name: Optional[str] = None,
organization: Optional[str] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
state: Optional[str] = None,
update_time: Optional[str] = None,
vpc_flow_logs_config_id: Optional[str] = None) -> OrganizationVpcFlowLogsConfig
func GetOrganizationVpcFlowLogsConfig(ctx *Context, name string, id IDInput, state *OrganizationVpcFlowLogsConfigState, opts ...ResourceOption) (*OrganizationVpcFlowLogsConfig, error)
public static OrganizationVpcFlowLogsConfig Get(string name, Input<string> id, OrganizationVpcFlowLogsConfigState? state, CustomResourceOptions? opts = null)
public static OrganizationVpcFlowLogsConfig get(String name, Output<String> id, OrganizationVpcFlowLogsConfigState state, CustomResourceOptions options)
resources: _: type: gcp:networkmanagement:OrganizationVpcFlowLogsConfig get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Aggregation
Interval string - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- Create
Time string - Output only. The time the config was created.
- Cross
Project stringMetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - Description string
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Filter
Expr string - Optional. Export filter used to define which VPC Flow Logs should be logged.
- Flow
Sampling double - 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.
- Labels Dictionary<string, string>
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - Metadata string
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- Metadata
Fields List<string> - 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
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- Organization string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- State string
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
- Update
Time string - Output only. The time the config was updated.
- Vpc
Flow stringLogs Config Id - Required. ID of the
VpcFlowLogsConfig
.
- Aggregation
Interval string - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- Create
Time string - Output only. The time the config was created.
- Cross
Project stringMetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - Description string
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Filter
Expr string - Optional. Export filter used to define which VPC Flow Logs should be logged.
- Flow
Sampling float64 - 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.
- Labels map[string]string
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - Metadata string
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- Metadata
Fields []string - 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
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- Organization string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- State string
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
- Update
Time string - Output only. The time the config was updated.
- Vpc
Flow stringLogs Config Id - Required. ID of the
VpcFlowLogsConfig
.
- aggregation
Interval String - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- create
Time String - Output only. The time the config was created.
- cross
Project StringMetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - description String
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- filter
Expr String - Optional. Export filter used to define which VPC Flow Logs should be logged.
- flow
Sampling Double - 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.
- labels Map<String,String>
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- location String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - metadata String
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- metadata
Fields List<String> - 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
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- organization String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- state String
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
- update
Time String - Output only. The time the config was updated.
- vpc
Flow StringLogs Config Id - Required. ID of the
VpcFlowLogsConfig
.
- aggregation
Interval string - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- create
Time string - Output only. The time the config was created.
- cross
Project stringMetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - description string
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- filter
Expr string - Optional. Export filter used to define which VPC Flow Logs should be logged.
- flow
Sampling 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.
- labels {[key: string]: string}
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- location string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - metadata string
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- metadata
Fields string[] - 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
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- organization string
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- state string
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
- update
Time string - Output only. The time the config was updated.
- vpc
Flow stringLogs Config Id - Required. ID of the
VpcFlowLogsConfig
.
- aggregation_
interval str - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- create_
time str - Output only. The time the config was created.
- cross_
project_ strmetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - description str
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- filter_
expr str - Optional. Export filter used to define which VPC Flow Logs should be logged.
- flow_
sampling 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.
- labels Mapping[str, str]
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- location str
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - metadata str
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- metadata_
fields Sequence[str] - Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA.
- name str
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- organization str
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- state str
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
- update_
time str - Output only. The time the config was updated.
- vpc_
flow_ strlogs_ config_ id - Required. ID of the
VpcFlowLogsConfig
.
- aggregation
Interval String - Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. Possible values: INTERVAL_5_SEC INTERVAL_30_SEC INTERVAL_1_MIN INTERVAL_5_MIN INTERVAL_10_MIN INTERVAL_15_MIN
- create
Time String - Output only. The time the config was created.
- cross
Project StringMetadata - 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.
Possible values:
CROSS_PROJECT_METADATA_ENABLED
CROSS_PROJECT_METADATA_DISABLED
Possible values are:
CROSS_PROJECT_METADATA_ENABLED
,CROSS_PROJECT_METADATA_DISABLED
. - description String
- Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- filter
Expr String - Optional. Export filter used to define which VPC Flow Logs should be logged.
- flow
Sampling 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.
- labels Map<String>
Optional. Resource labels to represent the user-provided metadata.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- location String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. See documentation for resource typenetworkmanagement.googleapis.com/VpcFlowLogsConfig
. - metadata String
- 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. Possible values: METADATA_UNSPECIFIED INCLUDE_ALL_METADATA EXCLUDE_ALL_METADATA CUSTOM_METADATA
- metadata
Fields List<String> - 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
- Identifier. Unique name of the configuration using the form:
organizations/{org_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}
- organization String
- Resource ID segment making up resource
name
. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- state String
- Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. Possible values: ENABLED DISABLED
- update
Time String - Output only. The time the config was updated.
- vpc
Flow StringLogs Config Id - Required. ID of the
VpcFlowLogsConfig
.
Import
OrganizationVpcFlowLogsConfig can be imported using any of these accepted formats:
organizations/{{organization}}/locations/{{location}}/vpcFlowLogsConfigs/{{vpc_flow_logs_config_id}}
{{organization}}/{{location}}/{{vpc_flow_logs_config_id}}
When using the pulumi import
command, OrganizationVpcFlowLogsConfig can be imported using one of the formats above. For example:
$ pulumi import gcp:networkmanagement/organizationVpcFlowLogsConfig:OrganizationVpcFlowLogsConfig default organizations/{{organization}}/locations/{{location}}/vpcFlowLogsConfigs/{{vpc_flow_logs_config_id}}
$ pulumi import gcp:networkmanagement/organizationVpcFlowLogsConfig:OrganizationVpcFlowLogsConfig default {{organization}}/{{location}}/{{vpc_flow_logs_config_id}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.