1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. NetworkFirewall
  5. NetworkFirewall
Oracle Cloud Infrastructure v1.33.0 published on Thursday, Apr 25, 2024 by Pulumi

oci.NetworkFirewall.NetworkFirewall

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.33.0 published on Thursday, Apr 25, 2024 by Pulumi

    This resource provides the Network Firewall resource in Oracle Cloud Infrastructure Network Firewall service.

    Creates a new NetworkFirewall.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testNetworkFirewall = new oci.networkfirewall.NetworkFirewall("test_network_firewall", {
        compartmentId: compartmentId,
        networkFirewallPolicyId: testNetworkFirewallPolicy.id,
        subnetId: testSubnet.id,
        availabilityDomain: networkFirewallAvailabilityDomain,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        displayName: networkFirewallDisplayName,
        freeformTags: {
            Department: "Finance",
        },
        ipv4address: networkFirewallIpv4address,
        ipv6address: networkFirewallIpv6address,
        networkSecurityGroupIds: networkFirewallNetworkSecurityGroupIds,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_network_firewall = oci.network_firewall.NetworkFirewall("test_network_firewall",
        compartment_id=compartment_id,
        network_firewall_policy_id=test_network_firewall_policy["id"],
        subnet_id=test_subnet["id"],
        availability_domain=network_firewall_availability_domain,
        defined_tags={
            "Operations.CostCenter": "42",
        },
        display_name=network_firewall_display_name,
        freeform_tags={
            "Department": "Finance",
        },
        ipv4address=network_firewall_ipv4address,
        ipv6address=network_firewall_ipv6address,
        network_security_group_ids=network_firewall_network_security_group_ids)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/NetworkFirewall"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := NetworkFirewall.NewNetworkFirewall(ctx, "test_network_firewall", &NetworkFirewall.NetworkFirewallArgs{
    			CompartmentId:           pulumi.Any(compartmentId),
    			NetworkFirewallPolicyId: pulumi.Any(testNetworkFirewallPolicy.Id),
    			SubnetId:                pulumi.Any(testSubnet.Id),
    			AvailabilityDomain:      pulumi.Any(networkFirewallAvailabilityDomain),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			DisplayName: pulumi.Any(networkFirewallDisplayName),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    			Ipv4address:             pulumi.Any(networkFirewallIpv4address),
    			Ipv6address:             pulumi.Any(networkFirewallIpv6address),
    			NetworkSecurityGroupIds: pulumi.Any(networkFirewallNetworkSecurityGroupIds),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testNetworkFirewall = new Oci.NetworkFirewall.NetworkFirewall("test_network_firewall", new()
        {
            CompartmentId = compartmentId,
            NetworkFirewallPolicyId = testNetworkFirewallPolicy.Id,
            SubnetId = testSubnet.Id,
            AvailabilityDomain = networkFirewallAvailabilityDomain,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            DisplayName = networkFirewallDisplayName,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            Ipv4address = networkFirewallIpv4address,
            Ipv6address = networkFirewallIpv6address,
            NetworkSecurityGroupIds = networkFirewallNetworkSecurityGroupIds,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.NetworkFirewall.NetworkFirewall;
    import com.pulumi.oci.NetworkFirewall.NetworkFirewallArgs;
    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 testNetworkFirewall = new NetworkFirewall("testNetworkFirewall", NetworkFirewallArgs.builder()        
                .compartmentId(compartmentId)
                .networkFirewallPolicyId(testNetworkFirewallPolicy.id())
                .subnetId(testSubnet.id())
                .availabilityDomain(networkFirewallAvailabilityDomain)
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .displayName(networkFirewallDisplayName)
                .freeformTags(Map.of("Department", "Finance"))
                .ipv4address(networkFirewallIpv4address)
                .ipv6address(networkFirewallIpv6address)
                .networkSecurityGroupIds(networkFirewallNetworkSecurityGroupIds)
                .build());
    
        }
    }
    
    resources:
      testNetworkFirewall:
        type: oci:NetworkFirewall:NetworkFirewall
        name: test_network_firewall
        properties:
          compartmentId: ${compartmentId}
          networkFirewallPolicyId: ${testNetworkFirewallPolicy.id}
          subnetId: ${testSubnet.id}
          availabilityDomain: ${networkFirewallAvailabilityDomain}
          definedTags:
            Operations.CostCenter: '42'
          displayName: ${networkFirewallDisplayName}
          freeformTags:
            Department: Finance
          ipv4address: ${networkFirewallIpv4address}
          ipv6address: ${networkFirewallIpv6address}
          networkSecurityGroupIds: ${networkFirewallNetworkSecurityGroupIds}
    

    Create NetworkFirewall Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NetworkFirewall(name: string, args: NetworkFirewallArgs, opts?: CustomResourceOptions);
    @overload
    def NetworkFirewall(resource_name: str,
                        args: NetworkFirewallArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def NetworkFirewall(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        compartment_id: Optional[str] = None,
                        network_firewall_policy_id: Optional[str] = None,
                        subnet_id: Optional[str] = None,
                        availability_domain: Optional[str] = None,
                        defined_tags: Optional[Mapping[str, Any]] = None,
                        display_name: Optional[str] = None,
                        freeform_tags: Optional[Mapping[str, Any]] = None,
                        ipv4address: Optional[str] = None,
                        ipv6address: Optional[str] = None,
                        network_security_group_ids: Optional[Sequence[str]] = None)
    func NewNetworkFirewall(ctx *Context, name string, args NetworkFirewallArgs, opts ...ResourceOption) (*NetworkFirewall, error)
    public NetworkFirewall(string name, NetworkFirewallArgs args, CustomResourceOptions? opts = null)
    public NetworkFirewall(String name, NetworkFirewallArgs args)
    public NetworkFirewall(String name, NetworkFirewallArgs args, CustomResourceOptions options)
    
    type: oci:NetworkFirewall:NetworkFirewall
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args NetworkFirewallArgs
    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 NetworkFirewallArgs
    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 NetworkFirewallArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetworkFirewallArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetworkFirewallArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var networkFirewallResource = new Oci.NetworkFirewall.NetworkFirewall("networkFirewallResource", new()
    {
        CompartmentId = "string",
        NetworkFirewallPolicyId = "string",
        SubnetId = "string",
        AvailabilityDomain = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
        Ipv4address = "string",
        Ipv6address = "string",
        NetworkSecurityGroupIds = new[]
        {
            "string",
        },
    });
    
    example, err := NetworkFirewall.NewNetworkFirewall(ctx, "networkFirewallResource", &NetworkFirewall.NetworkFirewallArgs{
    	CompartmentId:           pulumi.String("string"),
    	NetworkFirewallPolicyId: pulumi.String("string"),
    	SubnetId:                pulumi.String("string"),
    	AvailabilityDomain:      pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	Ipv4address: pulumi.String("string"),
    	Ipv6address: pulumi.String("string"),
    	NetworkSecurityGroupIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var networkFirewallResource = new NetworkFirewall("networkFirewallResource", NetworkFirewallArgs.builder()        
        .compartmentId("string")
        .networkFirewallPolicyId("string")
        .subnetId("string")
        .availabilityDomain("string")
        .definedTags(Map.of("string", "any"))
        .displayName("string")
        .freeformTags(Map.of("string", "any"))
        .ipv4address("string")
        .ipv6address("string")
        .networkSecurityGroupIds("string")
        .build());
    
    network_firewall_resource = oci.network_firewall.NetworkFirewall("networkFirewallResource",
        compartment_id="string",
        network_firewall_policy_id="string",
        subnet_id="string",
        availability_domain="string",
        defined_tags={
            "string": "any",
        },
        display_name="string",
        freeform_tags={
            "string": "any",
        },
        ipv4address="string",
        ipv6address="string",
        network_security_group_ids=["string"])
    
    const networkFirewallResource = new oci.networkfirewall.NetworkFirewall("networkFirewallResource", {
        compartmentId: "string",
        networkFirewallPolicyId: "string",
        subnetId: "string",
        availabilityDomain: "string",
        definedTags: {
            string: "any",
        },
        displayName: "string",
        freeformTags: {
            string: "any",
        },
        ipv4address: "string",
        ipv6address: "string",
        networkSecurityGroupIds: ["string"],
    });
    
    type: oci:NetworkFirewall:NetworkFirewall
    properties:
        availabilityDomain: string
        compartmentId: string
        definedTags:
            string: any
        displayName: string
        freeformTags:
            string: any
        ipv4address: string
        ipv6address: string
        networkFirewallPolicyId: string
        networkSecurityGroupIds:
            - string
        subnetId: string
    

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

    CompartmentId string
    (Updatable) The OCID of the compartment containing the Network Firewall.
    NetworkFirewallPolicyId string
    (Updatable) The OCID of the Network Firewall Policy.
    SubnetId string

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AvailabilityDomain string
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Ipv4address string
    IPv4 address for the Network Firewall.
    Ipv6address string
    IPv6 address for the Network Firewall.
    NetworkSecurityGroupIds List<string>
    (Updatable) An array of network security groups OCID associated with the Network Firewall.
    CompartmentId string
    (Updatable) The OCID of the compartment containing the Network Firewall.
    NetworkFirewallPolicyId string
    (Updatable) The OCID of the Network Firewall Policy.
    SubnetId string

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AvailabilityDomain string
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Ipv4address string
    IPv4 address for the Network Firewall.
    Ipv6address string
    IPv6 address for the Network Firewall.
    NetworkSecurityGroupIds []string
    (Updatable) An array of network security groups OCID associated with the Network Firewall.
    compartmentId String
    (Updatable) The OCID of the compartment containing the Network Firewall.
    networkFirewallPolicyId String
    (Updatable) The OCID of the Network Firewall Policy.
    subnetId String

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    availabilityDomain String
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ipv4address String
    IPv4 address for the Network Firewall.
    ipv6address String
    IPv6 address for the Network Firewall.
    networkSecurityGroupIds List<String>
    (Updatable) An array of network security groups OCID associated with the Network Firewall.
    compartmentId string
    (Updatable) The OCID of the compartment containing the Network Firewall.
    networkFirewallPolicyId string
    (Updatable) The OCID of the Network Firewall Policy.
    subnetId string

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    availabilityDomain string
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ipv4address string
    IPv4 address for the Network Firewall.
    ipv6address string
    IPv6 address for the Network Firewall.
    networkSecurityGroupIds string[]
    (Updatable) An array of network security groups OCID associated with the Network Firewall.
    compartment_id str
    (Updatable) The OCID of the compartment containing the Network Firewall.
    network_firewall_policy_id str
    (Updatable) The OCID of the Network Firewall Policy.
    subnet_id str

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    availability_domain str
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ipv4address str
    IPv4 address for the Network Firewall.
    ipv6address str
    IPv6 address for the Network Firewall.
    network_security_group_ids Sequence[str]
    (Updatable) An array of network security groups OCID associated with the Network Firewall.
    compartmentId String
    (Updatable) The OCID of the compartment containing the Network Firewall.
    networkFirewallPolicyId String
    (Updatable) The OCID of the Network Firewall Policy.
    subnetId String

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    availabilityDomain String
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ipv4address String
    IPv4 address for the Network Firewall.
    ipv6address String
    IPv6 address for the Network Firewall.
    networkSecurityGroupIds List<String>
    (Updatable) An array of network security groups OCID associated with the Network Firewall.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    State string
    The current state of the Network Firewall.
    SystemTags Dictionary<string, object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    State string
    The current state of the Network Firewall.
    SystemTags map[string]interface{}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    state String
    The current state of the Network Firewall.
    systemTags Map<String,Object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    state string
    The current state of the Network Firewall.
    systemTags {[key: string]: any}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    state str
    The current state of the Network Firewall.
    system_tags Mapping[str, Any]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    state String
    The current state of the Network Firewall.
    systemTags Map<Any>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    Look up Existing NetworkFirewall Resource

    Get an existing NetworkFirewall 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?: NetworkFirewallState, opts?: CustomResourceOptions): NetworkFirewall
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            availability_domain: Optional[str] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            ipv4address: Optional[str] = None,
            ipv6address: Optional[str] = None,
            lifecycle_details: Optional[str] = None,
            network_firewall_policy_id: Optional[str] = None,
            network_security_group_ids: Optional[Sequence[str]] = None,
            state: Optional[str] = None,
            subnet_id: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None) -> NetworkFirewall
    func GetNetworkFirewall(ctx *Context, name string, id IDInput, state *NetworkFirewallState, opts ...ResourceOption) (*NetworkFirewall, error)
    public static NetworkFirewall Get(string name, Input<string> id, NetworkFirewallState? state, CustomResourceOptions? opts = null)
    public static NetworkFirewall get(String name, Output<String> id, NetworkFirewallState 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:
    AvailabilityDomain string
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment containing the Network Firewall.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Ipv4address string
    IPv4 address for the Network Firewall.
    Ipv6address string
    IPv6 address for the Network Firewall.
    LifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    NetworkFirewallPolicyId string
    (Updatable) The OCID of the Network Firewall Policy.
    NetworkSecurityGroupIds List<string>
    (Updatable) An array of network security groups OCID associated with the Network Firewall.
    State string
    The current state of the Network Firewall.
    SubnetId string

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    SystemTags Dictionary<string, object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    AvailabilityDomain string
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment containing the Network Firewall.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Ipv4address string
    IPv4 address for the Network Firewall.
    Ipv6address string
    IPv6 address for the Network Firewall.
    LifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    NetworkFirewallPolicyId string
    (Updatable) The OCID of the Network Firewall Policy.
    NetworkSecurityGroupIds []string
    (Updatable) An array of network security groups OCID associated with the Network Firewall.
    State string
    The current state of the Network Firewall.
    SubnetId string

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    SystemTags map[string]interface{}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain String
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment containing the Network Firewall.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ipv4address String
    IPv4 address for the Network Firewall.
    ipv6address String
    IPv6 address for the Network Firewall.
    lifecycleDetails String
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    networkFirewallPolicyId String
    (Updatable) The OCID of the Network Firewall Policy.
    networkSecurityGroupIds List<String>
    (Updatable) An array of network security groups OCID associated with the Network Firewall.
    state String
    The current state of the Network Firewall.
    subnetId String

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    systemTags Map<String,Object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain string
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    compartmentId string
    (Updatable) The OCID of the compartment containing the Network Firewall.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ipv4address string
    IPv4 address for the Network Firewall.
    ipv6address string
    IPv6 address for the Network Firewall.
    lifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    networkFirewallPolicyId string
    (Updatable) The OCID of the Network Firewall Policy.
    networkSecurityGroupIds string[]
    (Updatable) An array of network security groups OCID associated with the Network Firewall.
    state string
    The current state of the Network Firewall.
    subnetId string

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    systemTags {[key: string]: any}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    availability_domain str
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    compartment_id str
    (Updatable) The OCID of the compartment containing the Network Firewall.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ipv4address str
    IPv4 address for the Network Firewall.
    ipv6address str
    IPv6 address for the Network Firewall.
    lifecycle_details str
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    network_firewall_policy_id str
    (Updatable) The OCID of the Network Firewall Policy.
    network_security_group_ids Sequence[str]
    (Updatable) An array of network security groups OCID associated with the Network Firewall.
    state str
    The current state of the Network Firewall.
    subnet_id str

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    system_tags Mapping[str, Any]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    availabilityDomain String
    Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: kIdk:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment containing the Network Firewall.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    ipv4address String
    IPv4 address for the Network Firewall.
    ipv6address String
    IPv6 address for the Network Firewall.
    lifecycleDetails String
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state.
    networkFirewallPolicyId String
    (Updatable) The OCID of the Network Firewall Policy.
    networkSecurityGroupIds List<String>
    (Updatable) An array of network security groups OCID associated with the Network Firewall.
    state String
    The current state of the Network Firewall.
    subnetId String

    The OCID of the subnet associated with the Network Firewall.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    systemTags Map<Any>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    Import

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

    $ pulumi import oci:NetworkFirewall/networkFirewall:NetworkFirewall test_network_firewall "id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.33.0 published on Thursday, Apr 25, 2024 by Pulumi