1. Packages
  2. OpenStack
  3. API Docs
  4. firewall
  5. Firewall
OpenStack v3.15.1 published on Thursday, Feb 1, 2024 by Pulumi

openstack.firewall.Firewall

Explore with Pulumi AI

openstack logo
OpenStack v3.15.1 published on Thursday, Feb 1, 2024 by Pulumi

    Manages a v1 firewall resource within OpenStack.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using OpenStack = Pulumi.OpenStack;
    
    return await Deployment.RunAsync(() => 
    {
        var rule1 = new OpenStack.Firewall.Rule("rule1", new()
        {
            Description = "drop TELNET traffic",
            Action = "deny",
            Protocol = "tcp",
            DestinationPort = "23",
            Enabled = true,
        });
    
        var rule2 = new OpenStack.Firewall.Rule("rule2", new()
        {
            Description = "drop NTP traffic",
            Action = "deny",
            Protocol = "udp",
            DestinationPort = "123",
            Enabled = false,
        });
    
        var policy1 = new OpenStack.Firewall.Policy("policy1", new()
        {
            Rules = new[]
            {
                rule1.Id,
                rule2.Id,
            },
        });
    
        var firewall1 = new OpenStack.Firewall.Firewall("firewall1", new()
        {
            PolicyId = policy1.Id,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-openstack/sdk/v3/go/openstack/firewall"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		rule1, err := firewall.NewRule(ctx, "rule1", &firewall.RuleArgs{
    			Description:     pulumi.String("drop TELNET traffic"),
    			Action:          pulumi.String("deny"),
    			Protocol:        pulumi.String("tcp"),
    			DestinationPort: pulumi.String("23"),
    			Enabled:         pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		rule2, err := firewall.NewRule(ctx, "rule2", &firewall.RuleArgs{
    			Description:     pulumi.String("drop NTP traffic"),
    			Action:          pulumi.String("deny"),
    			Protocol:        pulumi.String("udp"),
    			DestinationPort: pulumi.String("123"),
    			Enabled:         pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		policy1, err := firewall.NewPolicy(ctx, "policy1", &firewall.PolicyArgs{
    			Rules: pulumi.StringArray{
    				rule1.ID(),
    				rule2.ID(),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = firewall.NewFirewall(ctx, "firewall1", &firewall.FirewallArgs{
    			PolicyId: policy1.ID(),
    		})
    		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.openstack.firewall.Rule;
    import com.pulumi.openstack.firewall.RuleArgs;
    import com.pulumi.openstack.firewall.Policy;
    import com.pulumi.openstack.firewall.PolicyArgs;
    import com.pulumi.openstack.firewall.Firewall;
    import com.pulumi.openstack.firewall.FirewallArgs;
    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 rule1 = new Rule("rule1", RuleArgs.builder()        
                .description("drop TELNET traffic")
                .action("deny")
                .protocol("tcp")
                .destinationPort("23")
                .enabled("true")
                .build());
    
            var rule2 = new Rule("rule2", RuleArgs.builder()        
                .description("drop NTP traffic")
                .action("deny")
                .protocol("udp")
                .destinationPort("123")
                .enabled("false")
                .build());
    
            var policy1 = new Policy("policy1", PolicyArgs.builder()        
                .rules(            
                    rule1.id(),
                    rule2.id())
                .build());
    
            var firewall1 = new Firewall("firewall1", FirewallArgs.builder()        
                .policyId(policy1.id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_openstack as openstack
    
    rule1 = openstack.firewall.Rule("rule1",
        description="drop TELNET traffic",
        action="deny",
        protocol="tcp",
        destination_port="23",
        enabled=True)
    rule2 = openstack.firewall.Rule("rule2",
        description="drop NTP traffic",
        action="deny",
        protocol="udp",
        destination_port="123",
        enabled=False)
    policy1 = openstack.firewall.Policy("policy1", rules=[
        rule1.id,
        rule2.id,
    ])
    firewall1 = openstack.firewall.Firewall("firewall1", policy_id=policy1.id)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as openstack from "@pulumi/openstack";
    
    const rule1 = new openstack.firewall.Rule("rule1", {
        description: "drop TELNET traffic",
        action: "deny",
        protocol: "tcp",
        destinationPort: "23",
        enabled: true,
    });
    const rule2 = new openstack.firewall.Rule("rule2", {
        description: "drop NTP traffic",
        action: "deny",
        protocol: "udp",
        destinationPort: "123",
        enabled: false,
    });
    const policy1 = new openstack.firewall.Policy("policy1", {rules: [
        rule1.id,
        rule2.id,
    ]});
    const firewall1 = new openstack.firewall.Firewall("firewall1", {policyId: policy1.id});
    
    resources:
      rule1:
        type: openstack:firewall:Rule
        properties:
          description: drop TELNET traffic
          action: deny
          protocol: tcp
          destinationPort: '23'
          enabled: 'true'
      rule2:
        type: openstack:firewall:Rule
        properties:
          description: drop NTP traffic
          action: deny
          protocol: udp
          destinationPort: '123'
          enabled: 'false'
      policy1:
        type: openstack:firewall:Policy
        properties:
          rules:
            - ${rule1.id}
            - ${rule2.id}
      firewall1:
        type: openstack:firewall:Firewall
        properties:
          policyId: ${policy1.id}
    

    Create Firewall Resource

    new Firewall(name: string, args: FirewallArgs, opts?: CustomResourceOptions);
    @overload
    def Firewall(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 admin_state_up: Optional[bool] = None,
                 associated_routers: Optional[Sequence[str]] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None,
                 no_routers: Optional[bool] = None,
                 policy_id: Optional[str] = None,
                 region: Optional[str] = None,
                 tenant_id: Optional[str] = None,
                 value_specs: Optional[Mapping[str, Any]] = None)
    @overload
    def Firewall(resource_name: str,
                 args: FirewallArgs,
                 opts: Optional[ResourceOptions] = None)
    func NewFirewall(ctx *Context, name string, args FirewallArgs, opts ...ResourceOption) (*Firewall, error)
    public Firewall(string name, FirewallArgs args, CustomResourceOptions? opts = null)
    public Firewall(String name, FirewallArgs args)
    public Firewall(String name, FirewallArgs args, CustomResourceOptions options)
    
    type: openstack:firewall:Firewall
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args FirewallArgs
    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 FirewallArgs
    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 FirewallArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FirewallArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FirewallArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Firewall 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 Firewall resource accepts the following input properties:

    PolicyId string
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    AdminStateUp bool
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    AssociatedRouters List<string>
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    Description string
    A description for the firewall. Changing this updates the description of an existing firewall.
    Name string
    A name for the firewall. Changing this updates the name of an existing firewall.
    NoRouters bool
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    Region string
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    TenantId string
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    ValueSpecs Dictionary<string, object>
    Map of additional options.
    PolicyId string
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    AdminStateUp bool
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    AssociatedRouters []string
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    Description string
    A description for the firewall. Changing this updates the description of an existing firewall.
    Name string
    A name for the firewall. Changing this updates the name of an existing firewall.
    NoRouters bool
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    Region string
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    TenantId string
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    ValueSpecs map[string]interface{}
    Map of additional options.
    policyId String
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    adminStateUp Boolean
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    associatedRouters List<String>
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    description String
    A description for the firewall. Changing this updates the description of an existing firewall.
    name String
    A name for the firewall. Changing this updates the name of an existing firewall.
    noRouters Boolean
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    region String
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    tenantId String
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    valueSpecs Map<String,Object>
    Map of additional options.
    policyId string
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    adminStateUp boolean
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    associatedRouters string[]
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    description string
    A description for the firewall. Changing this updates the description of an existing firewall.
    name string
    A name for the firewall. Changing this updates the name of an existing firewall.
    noRouters boolean
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    region string
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    tenantId string
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    valueSpecs {[key: string]: any}
    Map of additional options.
    policy_id str
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    admin_state_up bool
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    associated_routers Sequence[str]
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    description str
    A description for the firewall. Changing this updates the description of an existing firewall.
    name str
    A name for the firewall. Changing this updates the name of an existing firewall.
    no_routers bool
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    region str
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    tenant_id str
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    value_specs Mapping[str, Any]
    Map of additional options.
    policyId String
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    adminStateUp Boolean
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    associatedRouters List<String>
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    description String
    A description for the firewall. Changing this updates the description of an existing firewall.
    name String
    A name for the firewall. Changing this updates the name of an existing firewall.
    noRouters Boolean
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    region String
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    tenantId String
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    valueSpecs Map<Any>
    Map of additional options.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Firewall Resource

    Get an existing Firewall 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?: FirewallState, opts?: CustomResourceOptions): Firewall
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            admin_state_up: Optional[bool] = None,
            associated_routers: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            no_routers: Optional[bool] = None,
            policy_id: Optional[str] = None,
            region: Optional[str] = None,
            tenant_id: Optional[str] = None,
            value_specs: Optional[Mapping[str, Any]] = None) -> Firewall
    func GetFirewall(ctx *Context, name string, id IDInput, state *FirewallState, opts ...ResourceOption) (*Firewall, error)
    public static Firewall Get(string name, Input<string> id, FirewallState? state, CustomResourceOptions? opts = null)
    public static Firewall get(String name, Output<String> id, FirewallState 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:
    AdminStateUp bool
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    AssociatedRouters List<string>
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    Description string
    A description for the firewall. Changing this updates the description of an existing firewall.
    Name string
    A name for the firewall. Changing this updates the name of an existing firewall.
    NoRouters bool
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    PolicyId string
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    Region string
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    TenantId string
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    ValueSpecs Dictionary<string, object>
    Map of additional options.
    AdminStateUp bool
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    AssociatedRouters []string
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    Description string
    A description for the firewall. Changing this updates the description of an existing firewall.
    Name string
    A name for the firewall. Changing this updates the name of an existing firewall.
    NoRouters bool
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    PolicyId string
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    Region string
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    TenantId string
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    ValueSpecs map[string]interface{}
    Map of additional options.
    adminStateUp Boolean
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    associatedRouters List<String>
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    description String
    A description for the firewall. Changing this updates the description of an existing firewall.
    name String
    A name for the firewall. Changing this updates the name of an existing firewall.
    noRouters Boolean
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    policyId String
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    region String
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    tenantId String
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    valueSpecs Map<String,Object>
    Map of additional options.
    adminStateUp boolean
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    associatedRouters string[]
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    description string
    A description for the firewall. Changing this updates the description of an existing firewall.
    name string
    A name for the firewall. Changing this updates the name of an existing firewall.
    noRouters boolean
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    policyId string
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    region string
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    tenantId string
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    valueSpecs {[key: string]: any}
    Map of additional options.
    admin_state_up bool
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    associated_routers Sequence[str]
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    description str
    A description for the firewall. Changing this updates the description of an existing firewall.
    name str
    A name for the firewall. Changing this updates the name of an existing firewall.
    no_routers bool
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    policy_id str
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    region str
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    tenant_id str
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    value_specs Mapping[str, Any]
    Map of additional options.
    adminStateUp Boolean
    Administrative up/down status for the firewall (must be "true" or "false" if provided - defaults to "true"). Changing this updates the admin_state_up of an existing firewall.
    associatedRouters List<String>
    Router(s) to associate this firewall instance with. Must be a list of strings. Changing this updates the associated routers of an existing firewall. Conflicts with no_routers.
    description String
    A description for the firewall. Changing this updates the description of an existing firewall.
    name String
    A name for the firewall. Changing this updates the name of an existing firewall.
    noRouters Boolean
    Should this firewall not be associated with any routers (must be "true" or "false" if provide - defaults to "false"). Conflicts with associated_routers.
    policyId String
    The policy resource id for the firewall. Changing this updates the policy_id of an existing firewall.
    region String
    The region in which to obtain the v1 networking client. A networking client is needed to create a firewall. If omitted, the region argument of the provider is used. Changing this creates a new firewall.
    tenantId String
    The owner of the floating IP. Required if admin wants to create a firewall for another tenant. Changing this creates a new firewall.
    valueSpecs Map<Any>
    Map of additional options.

    Import

    Firewalls can be imported using the id, e.g.

     $ pulumi import openstack:firewall/firewall:Firewall firewall_1 c9e39fb2-ce20-46c8-a964-25f3898c7a97
    

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v3.15.1 published on Thursday, Feb 1, 2024 by Pulumi