Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. FirewallPolicyRule
Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-gcp

gcp.compute.FirewallPolicyRule

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-gcp

    The Compute FirewallPolicyRule resource

    Example Usage

    Basic_fir_sec_rule

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

return await Deployment.RunAsync(() => 
{
    var basicGlobalNetworksecurityAddressGroup = new Gcp.NetworkSecurity.AddressGroup("basicGlobalNetworksecurityAddressGroup", new()
    {
        Parent = "organizations/123456789",
        Description = "Sample global networksecurity_address_group",
        Location = "global",
        Items = new[]
        {
            "208.80.154.224/32",
        },
        Type = "IPV4",
        Capacity = 100,
    });

    var folder = new Gcp.Organizations.Folder("folder", new()
    {
        DisplayName = "policy",
        Parent = "organizations/123456789",
    });

    var @default = new Gcp.Compute.FirewallPolicy("default", new()
    {
        Parent = folder.Id,
        ShortName = "policy",
        Description = "Resource created for Terraform acceptance testing",
    });

    var primary = new Gcp.Compute.FirewallPolicyRule("primary", new()
    {
        FirewallPolicy = @default.Name,
        Description = "Resource created for Terraform acceptance testing",
        Priority = 9000,
        EnableLogging = true,
        Action = "allow",
        Direction = "EGRESS",
        Disabled = false,
        Match = new Gcp.Compute.Inputs.FirewallPolicyRuleMatchArgs
        {
            Layer4Configs = new[]
            {
                new Gcp.Compute.Inputs.FirewallPolicyRuleMatchLayer4ConfigArgs
                {
                    IpProtocol = "tcp",
                    Ports = new[]
                    {
                        "8080",
                    },
                },
                new Gcp.Compute.Inputs.FirewallPolicyRuleMatchLayer4ConfigArgs
                {
                    IpProtocol = "udp",
                    Ports = new[]
                    {
                        "22",
                    },
                },
            },
            DestIpRanges = new[]
            {
                "11.100.0.1/32",
            },
            DestFqdns = new[] {},
            DestRegionCodes = new[]
            {
                "US",
            },
            DestThreatIntelligences = new[]
            {
                "iplist-known-malicious-ips",
            },
            SrcAddressGroups = new[] {},
            DestAddressGroups = new[]
            {
                basicGlobalNetworksecurityAddressGroup.Id,
            },
        },
        TargetServiceAccounts = new[]
        {
            "my@service-account.com",
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/networksecurity"
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		basicGlobalNetworksecurityAddressGroup, err := networksecurity.NewAddressGroup(ctx, "basicGlobalNetworksecurityAddressGroup", &networksecurity.AddressGroupArgs{
			Parent:      pulumi.String("organizations/123456789"),
			Description: pulumi.String("Sample global networksecurity_address_group"),
			Location:    pulumi.String("global"),
			Items: pulumi.StringArray{
				pulumi.String("208.80.154.224/32"),
			},
			Type:     pulumi.String("IPV4"),
			Capacity: pulumi.Int(100),
		})
		if err != nil {
			return err
		}
		folder, err := organizations.NewFolder(ctx, "folder", &organizations.FolderArgs{
			DisplayName: pulumi.String("policy"),
			Parent:      pulumi.String("organizations/123456789"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewFirewallPolicy(ctx, "default", &compute.FirewallPolicyArgs{
			Parent:      folder.ID(),
			ShortName:   pulumi.String("policy"),
			Description: pulumi.String("Resource created for Terraform acceptance testing"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewFirewallPolicyRule(ctx, "primary", &compute.FirewallPolicyRuleArgs{
			FirewallPolicy: _default.Name,
			Description:    pulumi.String("Resource created for Terraform acceptance testing"),
			Priority:       pulumi.Int(9000),
			EnableLogging:  pulumi.Bool(true),
			Action:         pulumi.String("allow"),
			Direction:      pulumi.String("EGRESS"),
			Disabled:       pulumi.Bool(false),
			Match: &compute.FirewallPolicyRuleMatchArgs{
				Layer4Configs: compute.FirewallPolicyRuleMatchLayer4ConfigArray{
					&compute.FirewallPolicyRuleMatchLayer4ConfigArgs{
						IpProtocol: pulumi.String("tcp"),
						Ports: pulumi.StringArray{
							pulumi.String("8080"),
						},
					},
					&compute.FirewallPolicyRuleMatchLayer4ConfigArgs{
						IpProtocol: pulumi.String("udp"),
						Ports: pulumi.StringArray{
							pulumi.String("22"),
						},
					},
				},
				DestIpRanges: pulumi.StringArray{
					pulumi.String("11.100.0.1/32"),
				},
				DestFqdns: pulumi.StringArray{},
				DestRegionCodes: pulumi.StringArray{
					pulumi.String("US"),
				},
				DestThreatIntelligences: pulumi.StringArray{
					pulumi.String("iplist-known-malicious-ips"),
				},
				SrcAddressGroups: pulumi.StringArray{},
				DestAddressGroups: pulumi.StringArray{
					basicGlobalNetworksecurityAddressGroup.ID(),
				},
			},
			TargetServiceAccounts: pulumi.StringArray{
				pulumi.String("my@service-account.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networksecurity.AddressGroup;
import com.pulumi.gcp.networksecurity.AddressGroupArgs;
import com.pulumi.gcp.organizations.Folder;
import com.pulumi.gcp.organizations.FolderArgs;
import com.pulumi.gcp.compute.FirewallPolicy;
import com.pulumi.gcp.compute.FirewallPolicyArgs;
import com.pulumi.gcp.compute.FirewallPolicyRule;
import com.pulumi.gcp.compute.FirewallPolicyRuleArgs;
import com.pulumi.gcp.compute.inputs.FirewallPolicyRuleMatchArgs;
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 basicGlobalNetworksecurityAddressGroup = new AddressGroup("basicGlobalNetworksecurityAddressGroup", AddressGroupArgs.builder()        
            .parent("organizations/123456789")
            .description("Sample global networksecurity_address_group")
            .location("global")
            .items("208.80.154.224/32")
            .type("IPV4")
            .capacity(100)
            .build());

        var folder = new Folder("folder", FolderArgs.builder()        
            .displayName("policy")
            .parent("organizations/123456789")
            .build());

        var default_ = new FirewallPolicy("default", FirewallPolicyArgs.builder()        
            .parent(folder.id())
            .shortName("policy")
            .description("Resource created for Terraform acceptance testing")
            .build());

        var primary = new FirewallPolicyRule("primary", FirewallPolicyRuleArgs.builder()        
            .firewallPolicy(default_.name())
            .description("Resource created for Terraform acceptance testing")
            .priority(9000)
            .enableLogging(true)
            .action("allow")
            .direction("EGRESS")
            .disabled(false)
            .match(FirewallPolicyRuleMatchArgs.builder()
                .layer4Configs(                
                    FirewallPolicyRuleMatchLayer4ConfigArgs.builder()
                        .ipProtocol("tcp")
                        .ports(8080)
                        .build(),
                    FirewallPolicyRuleMatchLayer4ConfigArgs.builder()
                        .ipProtocol("udp")
                        .ports(22)
                        .build())
                .destIpRanges("11.100.0.1/32")
                .destFqdns()
                .destRegionCodes("US")
                .destThreatIntelligences("iplist-known-malicious-ips")
                .srcAddressGroups()
                .destAddressGroups(basicGlobalNetworksecurityAddressGroup.id())
                .build())
            .targetServiceAccounts("my@service-account.com")
            .build());

    }
}

    import pulumi
import pulumi_gcp as gcp

basic_global_networksecurity_address_group = gcp.networksecurity.AddressGroup("basicGlobalNetworksecurityAddressGroup",
    parent="organizations/123456789",
    description="Sample global networksecurity_address_group",
    location="global",
    items=["208.80.154.224/32"],
    type="IPV4",
    capacity=100)
folder = gcp.organizations.Folder("folder",
    display_name="policy",
    parent="organizations/123456789")
default = gcp.compute.FirewallPolicy("default",
    parent=folder.id,
    short_name="policy",
    description="Resource created for Terraform acceptance testing")
primary = gcp.compute.FirewallPolicyRule("primary",
    firewall_policy=default.name,
    description="Resource created for Terraform acceptance testing",
    priority=9000,
    enable_logging=True,
    action="allow",
    direction="EGRESS",
    disabled=False,
    match=gcp.compute.FirewallPolicyRuleMatchArgs(
        layer4_configs=[
            gcp.compute.FirewallPolicyRuleMatchLayer4ConfigArgs(
                ip_protocol="tcp",
                ports=["8080"],
            ),
            gcp.compute.FirewallPolicyRuleMatchLayer4ConfigArgs(
                ip_protocol="udp",
                ports=["22"],
            ),
        ],
        dest_ip_ranges=["11.100.0.1/32"],
        dest_fqdns=[],
        dest_region_codes=["US"],
        dest_threat_intelligences=["iplist-known-malicious-ips"],
        src_address_groups=[],
        dest_address_groups=[basic_global_networksecurity_address_group.id],
    ),
    target_service_accounts=["my@service-account.com"])

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

const basicGlobalNetworksecurityAddressGroup = new gcp.networksecurity.AddressGroup("basicGlobalNetworksecurityAddressGroup", {
    parent: "organizations/123456789",
    description: "Sample global networksecurity_address_group",
    location: "global",
    items: ["208.80.154.224/32"],
    type: "IPV4",
    capacity: 100,
});
const folder = new gcp.organizations.Folder("folder", {
    displayName: "policy",
    parent: "organizations/123456789",
});
const _default = new gcp.compute.FirewallPolicy("default", {
    parent: folder.id,
    shortName: "policy",
    description: "Resource created for Terraform acceptance testing",
});
const primary = new gcp.compute.FirewallPolicyRule("primary", {
    firewallPolicy: _default.name,
    description: "Resource created for Terraform acceptance testing",
    priority: 9000,
    enableLogging: true,
    action: "allow",
    direction: "EGRESS",
    disabled: false,
    match: {
        layer4Configs: [
            {
                ipProtocol: "tcp",
                ports: ["8080"],
            },
            {
                ipProtocol: "udp",
                ports: ["22"],
            },
        ],
        destIpRanges: ["11.100.0.1/32"],
        destFqdns: [],
        destRegionCodes: ["US"],
        destThreatIntelligences: ["iplist-known-malicious-ips"],
        srcAddressGroups: [],
        destAddressGroups: [basicGlobalNetworksecurityAddressGroup.id],
    },
    targetServiceAccounts: ["my@service-account.com"],
});

    resources:
  basicGlobalNetworksecurityAddressGroup:
    type: gcp:networksecurity:AddressGroup
    properties:
      parent: organizations/123456789
      description: Sample global networksecurity_address_group
      location: global
      items:
        - 208.80.154.224/32
      type: IPV4
      capacity: 100
  folder:
    type: gcp:organizations:Folder
    properties:
      displayName: policy
      parent: organizations/123456789
  default:
    type: gcp:compute:FirewallPolicy
    properties:
      parent: ${folder.id}
      shortName: policy
      description: Resource created for Terraform acceptance testing
  primary:
    type: gcp:compute:FirewallPolicyRule
    properties:
      firewallPolicy: ${default.name}
      description: Resource created for Terraform acceptance testing
      priority: 9000
      enableLogging: true
      action: allow
      direction: EGRESS
      disabled: false
      match:
        layer4Configs:
          - ipProtocol: tcp
            ports:
              - 8080
          - ipProtocol: udp
            ports:
              - 22
        destIpRanges:
          - 11.100.0.1/32
        destFqdns: []
        destRegionCodes:
          - US
        destThreatIntelligences:
          - iplist-known-malicious-ips
        srcAddressGroups: []
        destAddressGroups:
          - ${basicGlobalNetworksecurityAddressGroup.id}
      targetServiceAccounts:
        - my@service-account.com

    Create FirewallPolicyRule Resource

    new FirewallPolicyRule(name: string, args: FirewallPolicyRuleArgs, opts?: CustomResourceOptions);
    @overload
def FirewallPolicyRule(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       action: Optional[str] = None,
                       description: Optional[str] = None,
                       direction: Optional[str] = None,
                       disabled: Optional[bool] = None,
                       enable_logging: Optional[bool] = None,
                       firewall_policy: Optional[str] = None,
                       match: Optional[FirewallPolicyRuleMatchArgs] = None,
                       priority: Optional[int] = None,
                       target_resources: Optional[Sequence[str]] = None,
                       target_service_accounts: Optional[Sequence[str]] = None)
@overload
def FirewallPolicyRule(resource_name: str,
                       args: FirewallPolicyRuleArgs,
                       opts: Optional[ResourceOptions] = None)
    func NewFirewallPolicyRule(ctx *Context, name string, args FirewallPolicyRuleArgs, opts ...ResourceOption) (*FirewallPolicyRule, error)
    public FirewallPolicyRule(string name, FirewallPolicyRuleArgs args, CustomResourceOptions? opts = null)
    public FirewallPolicyRule(String name, FirewallPolicyRuleArgs args)
public FirewallPolicyRule(String name, FirewallPolicyRuleArgs args, CustomResourceOptions options)

    type: gcp:compute:FirewallPolicyRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FirewallPolicyRuleArgs
    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 FirewallPolicyRuleArgs
    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 FirewallPolicyRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FirewallPolicyRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FirewallPolicyRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    FirewallPolicyRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FirewallPolicyRule resource accepts the following input properties:

    Action string

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    Direction string

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    FirewallPolicy string

    The firewall policy of the resource.

    Match FirewallPolicyRuleMatch

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    Priority int

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    Description string

    An optional description for this resource.

    Disabled bool

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    EnableLogging bool

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    TargetResources List<string>

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    TargetServiceAccounts List<string>

    A list of service accounts indicating the sets of instances that are applied with this rule.

    Action string

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    Direction string

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    FirewallPolicy string

    The firewall policy of the resource.

    Match FirewallPolicyRuleMatchArgs

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    Priority int

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    Description string

    An optional description for this resource.

    Disabled bool

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    EnableLogging bool

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    TargetResources []string

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    TargetServiceAccounts []string

    A list of service accounts indicating the sets of instances that are applied with this rule.

    action String

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    direction String

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    firewallPolicy String

    The firewall policy of the resource.

    match FirewallPolicyRuleMatch

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    priority Integer

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    description String

    An optional description for this resource.

    disabled Boolean

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    enableLogging Boolean

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    targetResources List<String>

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    targetServiceAccounts List<String>

    A list of service accounts indicating the sets of instances that are applied with this rule.

    action string

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    direction string

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    firewallPolicy string

    The firewall policy of the resource.

    match FirewallPolicyRuleMatch

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    priority number

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    description string

    An optional description for this resource.

    disabled boolean

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    enableLogging boolean

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    targetResources string[]

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    targetServiceAccounts string[]

    A list of service accounts indicating the sets of instances that are applied with this rule.

    action str

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    direction str

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    firewall_policy str

    The firewall policy of the resource.

    match FirewallPolicyRuleMatchArgs

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    priority int

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    description str

    An optional description for this resource.

    disabled bool

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    enable_logging bool

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    target_resources Sequence[str]

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    target_service_accounts Sequence[str]

    A list of service accounts indicating the sets of instances that are applied with this rule.

    action String

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    direction String

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    firewallPolicy String

    The firewall policy of the resource.

    match Property Map

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    priority Number

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    description String

    An optional description for this resource.

    disabled Boolean

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    enableLogging Boolean

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    targetResources List<String>

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    targetServiceAccounts List<String>

    A list of service accounts indicating the sets of instances that are applied with this rule.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FirewallPolicyRule resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    Kind string

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    RuleTupleCount int

    Calculation of the complexity of a single firewall policy rule.

    Id string

    The provider-assigned unique ID for this managed resource.

    Kind string

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    RuleTupleCount int

    Calculation of the complexity of a single firewall policy rule.

    id String

    The provider-assigned unique ID for this managed resource.

    kind String

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    ruleTupleCount Integer

    Calculation of the complexity of a single firewall policy rule.

    id string

    The provider-assigned unique ID for this managed resource.

    kind string

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    ruleTupleCount number

    Calculation of the complexity of a single firewall policy rule.

    id str

    The provider-assigned unique ID for this managed resource.

    kind str

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    rule_tuple_count int

    Calculation of the complexity of a single firewall policy rule.

    id String

    The provider-assigned unique ID for this managed resource.

    kind String

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    ruleTupleCount Number

    Calculation of the complexity of a single firewall policy rule.

    Look up Existing FirewallPolicyRule Resource

    Get an existing FirewallPolicyRule 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?: FirewallPolicyRuleState, opts?: CustomResourceOptions): FirewallPolicyRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        description: Optional[str] = None,
        direction: Optional[str] = None,
        disabled: Optional[bool] = None,
        enable_logging: Optional[bool] = None,
        firewall_policy: Optional[str] = None,
        kind: Optional[str] = None,
        match: Optional[FirewallPolicyRuleMatchArgs] = None,
        priority: Optional[int] = None,
        rule_tuple_count: Optional[int] = None,
        target_resources: Optional[Sequence[str]] = None,
        target_service_accounts: Optional[Sequence[str]] = None) -> FirewallPolicyRule
    func GetFirewallPolicyRule(ctx *Context, name string, id IDInput, state *FirewallPolicyRuleState, opts ...ResourceOption) (*FirewallPolicyRule, error)
    public static FirewallPolicyRule Get(string name, Input<string> id, FirewallPolicyRuleState? state, CustomResourceOptions? opts = null)
    public static FirewallPolicyRule get(String name, Output<String> id, FirewallPolicyRuleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    Action string

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    Description string

    An optional description for this resource.

    Direction string

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    Disabled bool

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    EnableLogging bool

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    FirewallPolicy string

    The firewall policy of the resource.

    Kind string

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    Match FirewallPolicyRuleMatch

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    Priority int

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    RuleTupleCount int

    Calculation of the complexity of a single firewall policy rule.

    TargetResources List<string>

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    TargetServiceAccounts List<string>

    A list of service accounts indicating the sets of instances that are applied with this rule.

    Action string

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    Description string

    An optional description for this resource.

    Direction string

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    Disabled bool

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    EnableLogging bool

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    FirewallPolicy string

    The firewall policy of the resource.

    Kind string

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    Match FirewallPolicyRuleMatchArgs

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    Priority int

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    RuleTupleCount int

    Calculation of the complexity of a single firewall policy rule.

    TargetResources []string

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    TargetServiceAccounts []string

    A list of service accounts indicating the sets of instances that are applied with this rule.

    action String

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    description String

    An optional description for this resource.

    direction String

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    disabled Boolean

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    enableLogging Boolean

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    firewallPolicy String

    The firewall policy of the resource.

    kind String

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    match FirewallPolicyRuleMatch

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    priority Integer

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    ruleTupleCount Integer

    Calculation of the complexity of a single firewall policy rule.

    targetResources List<String>

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    targetServiceAccounts List<String>

    A list of service accounts indicating the sets of instances that are applied with this rule.

    action string

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    description string

    An optional description for this resource.

    direction string

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    disabled boolean

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    enableLogging boolean

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    firewallPolicy string

    The firewall policy of the resource.

    kind string

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    match FirewallPolicyRuleMatch

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    priority number

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    ruleTupleCount number

    Calculation of the complexity of a single firewall policy rule.

    targetResources string[]

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    targetServiceAccounts string[]

    A list of service accounts indicating the sets of instances that are applied with this rule.

    action str

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    description str

    An optional description for this resource.

    direction str

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    disabled bool

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    enable_logging bool

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    firewall_policy str

    The firewall policy of the resource.

    kind str

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    match FirewallPolicyRuleMatchArgs

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    priority int

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    rule_tuple_count int

    Calculation of the complexity of a single firewall policy rule.

    target_resources Sequence[str]

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    target_service_accounts Sequence[str]

    A list of service accounts indicating the sets of instances that are applied with this rule.

    action String

    The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".

    description String

    An optional description for this resource.

    direction String

    The direction in which this rule applies. Possible values: INGRESS, EGRESS

    disabled Boolean

    Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

    enableLogging Boolean

    Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

    firewallPolicy String

    The firewall policy of the resource.

    kind String

    Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

    match Property Map

    A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

    priority Number

    An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

    ruleTupleCount Number

    Calculation of the complexity of a single firewall policy rule.

    targetResources List<String>

    A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

    targetServiceAccounts List<String>

    A list of service accounts indicating the sets of instances that are applied with this rule.

    Supporting Types

    FirewallPolicyRuleMatch, FirewallPolicyRuleMatchArgs

    Layer4Configs List<FirewallPolicyRuleMatchLayer4Config>

    Pairs of IP protocols and ports that the rule should match.

    DestAddressGroups List<string>

    Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules.

    DestFqdns List<string>

    Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress.

    DestIpRanges List<string>

    CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

    DestRegionCodes List<string>

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress.

    DestThreatIntelligences List<string>

    Name of the Google Cloud Threat Intelligence list.

    SrcAddressGroups List<string>

    Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules.

    SrcFqdns List<string>

    Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress.

    SrcIpRanges List<string>

    CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

    SrcRegionCodes List<string>

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress.

    SrcThreatIntelligences List<string>

    Name of the Google Cloud Threat Intelligence list.

    The layer4_configs block supports:

    Layer4Configs []FirewallPolicyRuleMatchLayer4Config

    Pairs of IP protocols and ports that the rule should match.

    DestAddressGroups []string

    Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules.

    DestFqdns []string

    Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress.

    DestIpRanges []string

    CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

    DestRegionCodes []string

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress.

    DestThreatIntelligences []string

    Name of the Google Cloud Threat Intelligence list.

    SrcAddressGroups []string

    Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules.

    SrcFqdns []string

    Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress.

    SrcIpRanges []string

    CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

    SrcRegionCodes []string

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress.

    SrcThreatIntelligences []string

    Name of the Google Cloud Threat Intelligence list.

    The layer4_configs block supports:

    layer4Configs List<FirewallPolicyRuleMatchLayer4Config>

    Pairs of IP protocols and ports that the rule should match.

    destAddressGroups List<String>

    Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules.

    destFqdns List<String>

    Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress.

    destIpRanges List<String>

    CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

    destRegionCodes List<String>

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress.

    destThreatIntelligences List<String>

    Name of the Google Cloud Threat Intelligence list.

    srcAddressGroups List<String>

    Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules.

    srcFqdns List<String>

    Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress.

    srcIpRanges List<String>

    CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

    srcRegionCodes List<String>

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress.

    srcThreatIntelligences List<String>

    Name of the Google Cloud Threat Intelligence list.

    The layer4_configs block supports:

    layer4Configs FirewallPolicyRuleMatchLayer4Config[]

    Pairs of IP protocols and ports that the rule should match.

    destAddressGroups string[]

    Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules.

    destFqdns string[]

    Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress.

    destIpRanges string[]

    CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

    destRegionCodes string[]

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress.

    destThreatIntelligences string[]

    Name of the Google Cloud Threat Intelligence list.

    srcAddressGroups string[]

    Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules.

    srcFqdns string[]

    Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress.

    srcIpRanges string[]

    CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

    srcRegionCodes string[]

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress.

    srcThreatIntelligences string[]

    Name of the Google Cloud Threat Intelligence list.

    The layer4_configs block supports:

    layer4_configs Sequence[FirewallPolicyRuleMatchLayer4Config]

    Pairs of IP protocols and ports that the rule should match.

    dest_address_groups Sequence[str]

    Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules.

    dest_fqdns Sequence[str]

    Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress.

    dest_ip_ranges Sequence[str]

    CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

    dest_region_codes Sequence[str]

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress.

    dest_threat_intelligences Sequence[str]

    Name of the Google Cloud Threat Intelligence list.

    src_address_groups Sequence[str]

    Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules.

    src_fqdns Sequence[str]

    Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress.

    src_ip_ranges Sequence[str]

    CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

    src_region_codes Sequence[str]

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress.

    src_threat_intelligences Sequence[str]

    Name of the Google Cloud Threat Intelligence list.

    The layer4_configs block supports:

    layer4Configs List<Property Map>

    Pairs of IP protocols and ports that the rule should match.

    destAddressGroups List<String>

    Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules.

    destFqdns List<String>

    Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress.

    destIpRanges List<String>

    CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

    destRegionCodes List<String>

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress.

    destThreatIntelligences List<String>

    Name of the Google Cloud Threat Intelligence list.

    srcAddressGroups List<String>

    Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules.

    srcFqdns List<String>

    Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress.

    srcIpRanges List<String>

    CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

    srcRegionCodes List<String>

    The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress.

    srcThreatIntelligences List<String>

    Name of the Google Cloud Threat Intelligence list.

    The layer4_configs block supports:

    FirewallPolicyRuleMatchLayer4Config, FirewallPolicyRuleMatchLayer4ConfigArgs

    IpProtocol string

    The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

    Ports List<string>

    An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ``.

    IpProtocol string

    The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

    Ports []string

    An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ``.

    ipProtocol String

    The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

    ports List<String>

    An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ``.

    ipProtocol string

    The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

    ports string[]

    An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ``.

    ip_protocol str

    The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

    ports Sequence[str]

    An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ``.

    ipProtocol String

    The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

    ports List<String>

    An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ``.

    Import

    FirewallPolicyRule can be imported using any of these accepted formats

     $ pulumi import gcp:compute/firewallPolicyRule:FirewallPolicyRule default locations/global/firewallPolicies/{{firewall_policy}}/rules/{{priority}}

     $ pulumi import gcp:compute/firewallPolicyRule:FirewallPolicyRule default {{firewall_policy}}/{{priority}}

    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.

    gcp logo
    Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi
    pulumi/pulumi-gcp