Docs Home
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.NetworkFirewall.NetworkFirewallPolicy
Explore with Pulumi AI
Import
NetworkFirewallPolicies can be imported using the id, e.g.
$ pulumi import oci:NetworkFirewall/networkFirewallPolicy:NetworkFirewallPolicy test_network_firewall_policy "id"
Create NetworkFirewallPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NetworkFirewallPolicy(name: string, args: NetworkFirewallPolicyArgs, opts?: CustomResourceOptions);@overload
def NetworkFirewallPolicy(resource_name: str,
args: NetworkFirewallPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NetworkFirewallPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None)func NewNetworkFirewallPolicy(ctx *Context, name string, args NetworkFirewallPolicyArgs, opts ...ResourceOption) (*NetworkFirewallPolicy, error)public NetworkFirewallPolicy(string name, NetworkFirewallPolicyArgs args, CustomResourceOptions? opts = null)
public NetworkFirewallPolicy(String name, NetworkFirewallPolicyArgs args)
public NetworkFirewallPolicy(String name, NetworkFirewallPolicyArgs args, CustomResourceOptions options)
type: oci:NetworkFirewall:NetworkFirewallPolicy
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 NetworkFirewallPolicyArgs
- 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 NetworkFirewallPolicyArgs
- 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 NetworkFirewallPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NetworkFirewallPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NetworkFirewallPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var networkFirewallPolicyResource = new Oci.NetworkFirewall.NetworkFirewallPolicy("networkFirewallPolicyResource", new()
{
CompartmentId = "string",
DefinedTags =
{
{ "string", "string" },
},
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
});
example, err := networkfirewall.NewNetworkFirewallPolicy(ctx, "networkFirewallPolicyResource", &networkfirewall.NetworkFirewallPolicyArgs{
CompartmentId: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var networkFirewallPolicyResource = new NetworkFirewallPolicy("networkFirewallPolicyResource", NetworkFirewallPolicyArgs.builder()
.compartmentId("string")
.definedTags(Map.of("string", "string"))
.displayName("string")
.freeformTags(Map.of("string", "string"))
.build());
network_firewall_policy_resource = oci.network_firewall.NetworkFirewallPolicy("networkFirewallPolicyResource",
compartment_id="string",
defined_tags={
"string": "string",
},
display_name="string",
freeform_tags={
"string": "string",
})
const networkFirewallPolicyResource = new oci.networkfirewall.NetworkFirewallPolicy("networkFirewallPolicyResource", {
compartmentId: "string",
definedTags: {
string: "string",
},
displayName: "string",
freeformTags: {
string: "string",
},
});
type: oci:NetworkFirewall:NetworkFirewallPolicy
properties:
compartmentId: string
definedTags:
string: string
displayName: string
freeformTags:
string: string
NetworkFirewallPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The NetworkFirewallPolicy resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- Dictionary<string, string>
- (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 string - (Updatable) A user-friendly optional name for the firewall policy. Avoid entering confidential information.
- Dictionary<string, string>
(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"}** 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
- Compartment
Id string - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- map[string]string
- (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 string - (Updatable) A user-friendly optional name for the firewall policy. Avoid entering confidential information.
- map[string]string
(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"}** 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
- compartment
Id String - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- Map<String,String>
- (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 String - (Updatable) A user-friendly optional name for the firewall policy. Avoid entering confidential information.
- Map<String,String>
(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"}** 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
- compartment
Id string - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- {[key: string]: string}
- (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 string - (Updatable) A user-friendly optional name for the firewall policy. Avoid entering confidential information.
- {[key: string]: string}
(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"}** 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
- compartment_
id str - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- Mapping[str, str]
- (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 optional name for the firewall policy. Avoid entering confidential information.
- Mapping[str, str]
(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"}** 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
- compartment
Id String - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- Map<String>
- (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 String - (Updatable) A user-friendly optional name for the firewall policy. Avoid entering confidential information.
- Map<String>
(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"}** 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
Outputs
All input properties are implicitly available as output properties. Additionally, the NetworkFirewallPolicy resource produces the following output properties:
- Attached
Network intFirewall Count - Count of number of Network Firewall attached to the Policy.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- State string
- The current state of the Network Firewall Policy.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Attached
Network intFirewall Count - Count of number of Network Firewall attached to the Policy.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- State string
- The current state of the Network Firewall Policy.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- attached
Network IntegerFirewall Count - Count of number of Network Firewall attached to the Policy.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state String
- The current state of the Network Firewall Policy.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- attached
Network numberFirewall Count - Count of number of Network Firewall attached to the Policy.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state string
- The current state of the Network Firewall Policy.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Updated string - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- attached_
network_ intfirewall_ count - Count of number of Network Firewall attached to the Policy.
- 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, can be used to provide actionable information for a resource in Failed state.
- state str
- The current state of the Network Firewall Policy.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time_
created str - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time_
updated str - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- attached
Network NumberFirewall Count - Count of number of Network Firewall attached to the Policy.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state String
- The current state of the Network Firewall Policy.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
Look up Existing NetworkFirewallPolicy Resource
Get an existing NetworkFirewallPolicy 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?: NetworkFirewallPolicyState, opts?: CustomResourceOptions): NetworkFirewallPolicy@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
attached_network_firewall_count: Optional[int] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
lifecycle_details: Optional[str] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> NetworkFirewallPolicyfunc GetNetworkFirewallPolicy(ctx *Context, name string, id IDInput, state *NetworkFirewallPolicyState, opts ...ResourceOption) (*NetworkFirewallPolicy, error)public static NetworkFirewallPolicy Get(string name, Input<string> id, NetworkFirewallPolicyState? state, CustomResourceOptions? opts = null)public static NetworkFirewallPolicy get(String name, Output<String> id, NetworkFirewallPolicyState state, CustomResourceOptions options)resources: _: type: oci:NetworkFirewall:NetworkFirewallPolicy get: id: ${id}- 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.
- Attached
Network intFirewall Count - Count of number of Network Firewall attached to the Policy.
- Compartment
Id string - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- Dictionary<string, string>
- (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 string - (Updatable) A user-friendly optional name for the firewall policy. Avoid entering confidential information.
- Dictionary<string, string>
(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"}** 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
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- State string
- The current state of the Network Firewall Policy.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Attached
Network intFirewall Count - Count of number of Network Firewall attached to the Policy.
- Compartment
Id string - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- map[string]string
- (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 string - (Updatable) A user-friendly optional name for the firewall policy. Avoid entering confidential information.
- map[string]string
(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"}** 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
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- State string
- The current state of the Network Firewall Policy.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Time
Updated string - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- attached
Network IntegerFirewall Count - Count of number of Network Firewall attached to the Policy.
- compartment
Id String - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- Map<String,String>
- (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 String - (Updatable) A user-friendly optional name for the firewall policy. Avoid entering confidential information.
- Map<String,String>
(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"}** 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
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state String
- The current state of the Network Firewall Policy.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- attached
Network numberFirewall Count - Count of number of Network Firewall attached to the Policy.
- compartment
Id string - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- {[key: string]: string}
- (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 string - (Updatable) A user-friendly optional name for the firewall policy. Avoid entering confidential information.
- {[key: string]: string}
(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"}** 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
- lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state string
- The current state of the Network Firewall Policy.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Updated string - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- attached_
network_ intfirewall_ count - Count of number of Network Firewall attached to the Policy.
- compartment_
id str - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- Mapping[str, str]
- (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 optional name for the firewall policy. Avoid entering confidential information.
- Mapping[str, str]
(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"}** 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
- lifecycle_
details str - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state str
- The current state of the Network Firewall Policy.
- Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time_
created str - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time_
updated str - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- attached
Network NumberFirewall Count - Count of number of Network Firewall attached to the Policy.
- compartment
Id String - (Updatable) The OCID of the compartment containing the NetworkFirewall Policy.
- Map<String>
- (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 String - (Updatable) A user-friendly optional name for the firewall policy. Avoid entering confidential information.
- Map<String>
(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"}** 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
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state String
- The current state of the Network Firewall Policy.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The time instant at which the Network Firewall Policy was created in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - time
Updated String - The time instant at which the Network Firewall Policy was updated in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.