FirewallPolicy class

Hierarchical firewall policy rules let you create and enforce a consistent firewall policy across your organization. Rules can explicitly allow or deny connections or delegate evaluation to lower level policies. Policies can be created within organizations or folders.

This resource should be generally be used with gcp.compute.FirewallPolicyAssociation and gcp.compute.FirewallPolicyRule

For more information see the official documentation

To get more information about FirewallPolicy, see:

• API documentation

Example Usage

Firewall Policy

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

const _default = new gcp.compute.FirewallPolicy("default", {
    parent: "organizations/123456789",
    shortName: "my-policy",
    description: "Example Resource",
});

import pulumi
import pulumi_gcp as gcp

default = gcp.compute.FirewallPolicy("default",
    parent="organizations/123456789",
    short_name="my-policy",
    description="Example Resource")

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

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.Compute.FirewallPolicy("default", new()
    {
        Parent = "organizations/123456789",
        ShortName = "my-policy",
        Description = "Example Resource",
    });

});

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 {
		_, err := compute.NewFirewallPolicy(ctx, "default", &compute.FirewallPolicyArgs{
			Parent:      pulumi.String("organizations/123456789"),
			ShortName:   pulumi.String("my-policy"),
			Description: pulumi.String("Example Resource"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_compute_firewallpolicy" "default" {
  parent      = "organizations/123456789"
  short_name  = "my-policy"
  description = "Example Resource"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.FirewallPolicy;
import com.pulumi.gcp.compute.FirewallPolicyArgs;
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 default_ = new FirewallPolicy("default", FirewallPolicyArgs.builder()
            .parent("organizations/123456789")
            .shortName("my-policy")
            .description("Example Resource")
            .build());

    }
}

resources:
  default:
    type: gcp:compute:FirewallPolicy
    properties:
      parent: organizations/123456789
      shortName: my-policy
      description: Example Resource

Import

FirewallPolicy can be imported using any of these accepted formats:

• locations/global/firewallPolicies/{{name}}
• {{name}}

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

$ pulumi import gcp:compute/firewallPolicy:FirewallPolicy default locations/global/firewallPolicies/{{name}}
$ pulumi import gcp:compute/firewallPolicy:FirewallPolicy default {{name}}

Constructors

FirewallPolicy(String name, {FirewallPolicyArgs? args, CustomResourceOptions? options})

Creates a new FirewallPolicy. name The Pulumi resource name. args Arguments used to configure this FirewallPolicy. The set of arguments for FirewallPolicy. options Resource options controlling this resource's behavior.

FirewallPolicy.reference(String urn)

Creates a typed reference to an existing FirewallPolicy resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

creationTimestamp ↔ Output<String>

Creation timestamp in RFC3339 text format.

late, final

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.

late, final

description ↔ Output<String?>

An optional description of this resource. Provide this property when you create the resource.

late, final

fingerprint ↔ Output<String>

Fingerprint of the resource. This field is used internally during updates of this resource.

late, final

firewallPolicyId ↔ Output<String>

The unique identifier for the resource. This identifier is defined by the server.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy.

late, final

parent ↔ Output<String>

The parent of the firewall policy.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

ruleTupleCount ↔ Output<int>

Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selfLink ↔ Output<String>

Server-defined URL for the resource.

late, final

selfLinkWithId ↔ Output<String>

Server-defined URL for this resource with the resource id.

late, final

shortName ↔ Output<String>

User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

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, {FirewallPolicyState? state, CustomResourceOptions? options}) → FirewallPolicy

Gets an existing FirewallPolicy resource's state with the given name and id.