RegionNetworkPolicyTrafficClassificationRule class

Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.

> Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

To get more information about RegionNetworkPolicyTrafficClassificationRule, see:

API documentation

Example Usage

Region Network Policy Traffic Classification Rule Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const basicRegionalNetworkPolicy = new gcp.compute.RegionNetworkPolicy("basic_regional_network_policy", {
    name: "nw-policy",
    description: "Sample regional network firewall policy",
    project: "my-project-name",
    region: "us-west1",
});
const primary = new gcp.compute.RegionNetworkPolicyTrafficClassificationRule("primary", {
    ruleName: "test-rule",
    description: "This is a simple rule description",
    disabled: false,
    networkPolicy: basicRegionalNetworkPolicy.name,
    priority: 1000,
    region: "us-west1",
    action: {
        trafficClass: "TC1",
        dscpMode: "AUTO",
    },
    match: {
        srcIpRanges: ["10.100.0.1/32"],
        destIpRanges: ["11.100.0.1/32"],
        layer4Configs: [{
            ipProtocol: "all",
        }],
    },
});

import pulumi
import pulumi_gcp as gcp

basic_regional_network_policy = gcp.compute.RegionNetworkPolicy("basic_regional_network_policy",
    name="nw-policy",
    description="Sample regional network firewall policy",
    project="my-project-name",
    region="us-west1")
primary = gcp.compute.RegionNetworkPolicyTrafficClassificationRule("primary",
    rule_name="test-rule",
    description="This is a simple rule description",
    disabled=False,
    network_policy=basic_regional_network_policy.name,
    priority=1000,
    region="us-west1",
    action={
        "traffic_class": "TC1",
        "dscp_mode": "AUTO",
    },
    match={
        "src_ip_ranges": ["10.100.0.1/32"],
        "dest_ip_ranges": ["11.100.0.1/32"],
        "layer4_configs": [{
            "ip_protocol": "all",
        }],
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var basicRegionalNetworkPolicy = new Gcp.Compute.RegionNetworkPolicy("basic_regional_network_policy", new()
    {
        Name = "nw-policy",
        Description = "Sample regional network firewall policy",
        Project = "my-project-name",
        Region = "us-west1",
    });

    var primary = new Gcp.Compute.RegionNetworkPolicyTrafficClassificationRule("primary", new()
    {
        RuleName = "test-rule",
        Description = "This is a simple rule description",
        Disabled = false,
        NetworkPolicy = basicRegionalNetworkPolicy.Name,
        Priority = 1000,
        Region = "us-west1",
        Action = new Gcp.Compute.Inputs.RegionNetworkPolicyTrafficClassificationRuleActionArgs
        {
            TrafficClass = "TC1",
            DscpMode = "AUTO",
        },
        Match = new Gcp.Compute.Inputs.RegionNetworkPolicyTrafficClassificationRuleMatchArgs
        {
            SrcIpRanges = new[]
            {
                "10.100.0.1/32",
            },
            DestIpRanges = new[]
            {
                "11.100.0.1/32",
            },
            Layer4Configs = new[]
            {
                new Gcp.Compute.Inputs.RegionNetworkPolicyTrafficClassificationRuleMatchLayer4ConfigArgs
                {
                    IpProtocol = "all",
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		basicRegionalNetworkPolicy, err := compute.NewRegionNetworkPolicy(ctx, "basic_regional_network_policy", &compute.RegionNetworkPolicyArgs{
			Name:        pulumi.String("nw-policy"),
			Description: pulumi.String("Sample regional network firewall policy"),
			Project:     pulumi.String("my-project-name"),
			Region:      pulumi.String("us-west1"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewRegionNetworkPolicyTrafficClassificationRule(ctx, "primary", &compute.RegionNetworkPolicyTrafficClassificationRuleArgs{
			RuleName:      pulumi.String("test-rule"),
			Description:   pulumi.String("This is a simple rule description"),
			Disabled:      pulumi.Bool(false),
			NetworkPolicy: basicRegionalNetworkPolicy.Name,
			Priority:      pulumi.Int(1000),
			Region:        pulumi.String("us-west1"),
			Action: &compute.RegionNetworkPolicyTrafficClassificationRuleActionArgs{
				TrafficClass: pulumi.String("TC1"),
				DscpMode:     pulumi.String("AUTO"),
			},
			Match: &compute.RegionNetworkPolicyTrafficClassificationRuleMatchArgs{
				SrcIpRanges: pulumi.StringArray{
					pulumi.String("10.100.0.1/32"),
				},
				DestIpRanges: pulumi.StringArray{
					pulumi.String("11.100.0.1/32"),
				},
				Layer4Configs: compute.RegionNetworkPolicyTrafficClassificationRuleMatchLayer4ConfigArray{
					&compute.RegionNetworkPolicyTrafficClassificationRuleMatchLayer4ConfigArgs{
						IpProtocol: pulumi.String("all"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_compute_regionnetworkpolicy" "basic_regional_network_policy" {
  name        = "nw-policy"
  description = "Sample regional network firewall policy"
  project     = "my-project-name"
  region      = "us-west1"
}
resource "gcp_compute_regionnetworkpolicytrafficclassificationrule" "primary" {
  rule_name      = "test-rule"
  description    = "This is a simple rule description"
  disabled       = false
  network_policy = gcp_compute_regionnetworkpolicy.basic_regional_network_policy.name
  priority       = 1000
  region         = "us-west1"
  action = {
    traffic_class = "TC1"
    dscp_mode     = "AUTO"
  }
  match = {
    src_ip_ranges  = ["10.100.0.1/32"]
    dest_ip_ranges = ["11.100.0.1/32"]
    layer4_configs = [{
      "ipProtocol" = "all"
    }]
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionNetworkPolicy;
import com.pulumi.gcp.compute.RegionNetworkPolicyArgs;
import com.pulumi.gcp.compute.RegionNetworkPolicyTrafficClassificationRule;
import com.pulumi.gcp.compute.RegionNetworkPolicyTrafficClassificationRuleArgs;
import com.pulumi.gcp.compute.inputs.RegionNetworkPolicyTrafficClassificationRuleActionArgs;
import com.pulumi.gcp.compute.inputs.RegionNetworkPolicyTrafficClassificationRuleMatchArgs;
import com.pulumi.gcp.compute.inputs.RegionNetworkPolicyTrafficClassificationRuleMatchLayer4ConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 basicRegionalNetworkPolicy = new RegionNetworkPolicy("basicRegionalNetworkPolicy", RegionNetworkPolicyArgs.builder()
            .name("nw-policy")
            .description("Sample regional network firewall policy")
            .project("my-project-name")
            .region("us-west1")
            .build());

        var primary = new RegionNetworkPolicyTrafficClassificationRule("primary", RegionNetworkPolicyTrafficClassificationRuleArgs.builder()
            .ruleName("test-rule")
            .description("This is a simple rule description")
            .disabled(false)
            .networkPolicy(basicRegionalNetworkPolicy.name())
            .priority(1000)
            .region("us-west1")
            .action(RegionNetworkPolicyTrafficClassificationRuleActionArgs.builder()
                .trafficClass("TC1")
                .dscpMode("AUTO")
                .build())
            .match(RegionNetworkPolicyTrafficClassificationRuleMatchArgs.builder()
                .srcIpRanges("10.100.0.1/32")
                .destIpRanges("11.100.0.1/32")
                .layer4Configs(RegionNetworkPolicyTrafficClassificationRuleMatchLayer4ConfigArgs.builder()
                    .ipProtocol("all")
                    .build())
                .build())
            .build());

    }
}

resources:
  basicRegionalNetworkPolicy:
    type: gcp:compute:RegionNetworkPolicy
    name: basic_regional_network_policy
    properties:
      name: nw-policy
      description: Sample regional network firewall policy
      project: my-project-name
      region: us-west1
  primary:
    type: gcp:compute:RegionNetworkPolicyTrafficClassificationRule
    properties:
      ruleName: test-rule
      description: This is a simple rule description
      disabled: false
      networkPolicy: ${basicRegionalNetworkPolicy.name}
      priority: 1000
      region: us-west1
      action:
        trafficClass: TC1
        dscpMode: AUTO
      match:
        srcIpRanges:
          - 10.100.0.1/32
        destIpRanges:
          - 11.100.0.1/32
        layer4Configs:
          - ipProtocol: all

Import

RegionNetworkPolicyTrafficClassificationRule can be imported using any of these accepted formats:

projects/{{project}}/regions/{{region}}/networkPolicies/{{network_policy}}/{{priority}}
{{project}}/{{region}}/{{network_policy}}/{{priority}}
{{region}}/{{network_policy}}/{{priority}}
{{network_policy}}/{{priority}}

When using the pulumi import command, RegionNetworkPolicyTrafficClassificationRule can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/regionNetworkPolicyTrafficClassificationRule:RegionNetworkPolicyTrafficClassificationRule default projects/{{project}}/regions/{{region}}/networkPolicies/{{network_policy}}/{{priority}}
$ pulumi import gcp:compute/regionNetworkPolicyTrafficClassificationRule:RegionNetworkPolicyTrafficClassificationRule default {{project}}/{{region}}/{{network_policy}}/{{priority}}
$ pulumi import gcp:compute/regionNetworkPolicyTrafficClassificationRule:RegionNetworkPolicyTrafficClassificationRule default {{region}}/{{network_policy}}/{{priority}}
$ pulumi import gcp:compute/regionNetworkPolicyTrafficClassificationRule:RegionNetworkPolicyTrafficClassificationRule default {{network_policy}}/{{priority}}

Constructors

RegionNetworkPolicyTrafficClassificationRule(String name, {RegionNetworkPolicyTrafficClassificationRuleArgs? args, CustomResourceOptions? options}): Creates a new RegionNetworkPolicyTrafficClassificationRule. name The Pulumi resource name. args Arguments used to configure this RegionNetworkPolicyTrafficClassificationRule. The set of arguments for RegionNetworkPolicyTrafficClassificationRule. options Resource options controlling this resource's behavior.
RegionNetworkPolicyTrafficClassificationRule.reference(String urn): Creates a typed reference to an existing RegionNetworkPolicyTrafficClassificationRule resource.

Properties

action ↔ Output<RegionNetworkPolicyTrafficClassificationRuleAction?>: The Action to perform when the client connection triggers the rule. Structure is documented below.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
creationTimestamp ↔ Output<String>: Creation timestamp in RFC3339 text format.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
description ↔ Output<String?>: An optional description for this resource.
latefinal
disabled ↔ Output<bool?>: Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
kind ↔ Output<String>: Type of the resource. Alwayscompute#networkPolicyTrafficClassificationRule for network policy traffic classification rules
latefinal
match ↔ Output<RegionNetworkPolicyTrafficClassificationRuleMatch>: A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. Structure is documented below.
latefinal
networkPolicy ↔ Output<String>: The firewall policy of the resource.
latefinal
priority ↔ Output<int>: An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
region ↔ Output<String>: The location of this resource.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
ruleName ↔ Output<String?>: An optional name for the rule. This field is not a unique identifier and can be updated.
latefinal
ruleTupleCount ↔ Output<int>: Calculation of the complexity of a single network policy rule.
latefinal
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
targetSecureTags ↔ Output<List<RegionNetworkPolicyTrafficClassificationRuleTargetSecureTag>?>: A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. Structure is documented below.
latefinal
targetServiceAccounts ↔ Output<List<String>?>: A list of service accounts indicating the sets of instances that are applied with this rule.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {RegionNetworkPolicyTrafficClassificationRuleState? state, CustomResourceOptions? options}) → RegionNetworkPolicyTrafficClassificationRule: Gets an existing RegionNetworkPolicyTrafficClassificationRule resource's state with the given name and id.