NetworkFirewall

class oci.network_firewall.models.NetworkFirewall(**kwargs)

Bases: object

A network firewall is a security resource that exists in a subnet of your choice and controls incoming and outgoing network traffic based on a set of security rules. Each firewall is associated with a policy. Traffic is routed to and from the firewall from resources such as internet gateways and dynamic routing gateways (DRGs). For more information, see Overview of Network Firewall

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a NetworkFirewall.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a NetworkFirewall.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a NetworkFirewall.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a NetworkFirewall.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a NetworkFirewall.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a NetworkFirewall.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a NetworkFirewall.

availability_domain

Gets the availability_domain of this NetworkFirewall.

compartment_id

[Required] Gets the compartment_id of this NetworkFirewall.

defined_tags

[Required] Gets the defined_tags of this NetworkFirewall.

display_name

[Required] Gets the display_name of this NetworkFirewall.

freeform_tags

[Required] Gets the freeform_tags of this NetworkFirewall.

id

[Required] Gets the id of this NetworkFirewall.

ipv4_address

Gets the ipv4_address of this NetworkFirewall.

ipv6_address

Gets the ipv6_address of this NetworkFirewall.

lifecycle_details

Gets the lifecycle_details of this NetworkFirewall.

lifecycle_state

[Required] Gets the lifecycle_state of this NetworkFirewall.

nat_configuration

Gets the nat_configuration of this NetworkFirewall.

network_firewall_policy_id

[Required] Gets the network_firewall_policy_id of this NetworkFirewall.

network_security_group_ids

Gets the network_security_group_ids of this NetworkFirewall.

security_attributes

Gets the security_attributes of this NetworkFirewall.

shape

Gets the shape of this NetworkFirewall.

subnet_id

[Required] Gets the subnet_id of this NetworkFirewall.

system_tags

Gets the system_tags of this NetworkFirewall.

time_created

[Required] Gets the time_created of this NetworkFirewall.

time_updated

[Required] Gets the time_updated of this NetworkFirewall.

Methods:

__init__(**kwargs)

Initializes a new NetworkFirewall object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a NetworkFirewall. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a NetworkFirewall. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a NetworkFirewall. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a NetworkFirewall. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a NetworkFirewall. This constant has a value of “FAILED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

A constant which can be used with the lifecycle_state property of a NetworkFirewall. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a NetworkFirewall. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new NetworkFirewall object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this NetworkFirewall.

  • compartment_id (str) – The value to assign to the compartment_id property of this NetworkFirewall.

  • display_name (str) – The value to assign to the display_name property of this NetworkFirewall.

  • subnet_id (str) – The value to assign to the subnet_id property of this NetworkFirewall.

  • ipv4_address (str) – The value to assign to the ipv4_address property of this NetworkFirewall.

  • ipv6_address (str) – The value to assign to the ipv6_address property of this NetworkFirewall.

  • network_firewall_policy_id (str) – The value to assign to the network_firewall_policy_id property of this NetworkFirewall.

  • availability_domain (str) – The value to assign to the availability_domain property of this NetworkFirewall.

  • nat_configuration (oci.network_firewall.models.NatConfigurationResponse) – The value to assign to the nat_configuration property of this NetworkFirewall.

  • shape (str) – The value to assign to the shape property of this NetworkFirewall.

  • network_security_group_ids (list[str]) – The value to assign to the network_security_group_ids property of this NetworkFirewall.

  • time_created (datetime) – The value to assign to the time_created property of this NetworkFirewall.

  • time_updated (datetime) – The value to assign to the time_updated property of this NetworkFirewall.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this NetworkFirewall. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this NetworkFirewall.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this NetworkFirewall.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this NetworkFirewall.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this NetworkFirewall.

  • security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this NetworkFirewall.

property availability_domain

Gets the availability_domain of this NetworkFirewall. Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use the list_availability_domains() operation. Example: kIdk:PHX-AD-1

Returns

The availability_domain of this NetworkFirewall.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this NetworkFirewall. The OCID of the compartment containing the Network Firewall.

Returns

The compartment_id of this NetworkFirewall.

Return type

str

property defined_tags

[Required] Gets the defined_tags of this NetworkFirewall. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this NetworkFirewall.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this NetworkFirewall. A user-friendly name for the Network Firewall. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns

The display_name of this NetworkFirewall.

Return type

str

property freeform_tags

[Required] Gets the freeform_tags of this NetworkFirewall. 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”}

Returns

The freeform_tags of this NetworkFirewall.

Return type

dict(str, str)

property id

[Required] Gets the id of this NetworkFirewall. The OCID of the Network Firewall resource.

Returns

The id of this NetworkFirewall.

Return type

str

property ipv4_address

Gets the ipv4_address of this NetworkFirewall. IPv4 address for the Network Firewall.

Returns

The ipv4_address of this NetworkFirewall.

Return type

str

property ipv6_address

Gets the ipv6_address of this NetworkFirewall. IPv6 address for the Network Firewall.

Returns

The ipv6_address of this NetworkFirewall.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this NetworkFirewall. 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.

Returns

The lifecycle_details of this NetworkFirewall.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this NetworkFirewall. The current state of the Network Firewall.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this NetworkFirewall.

Return type

str

property nat_configuration

Gets the nat_configuration of this NetworkFirewall.

Returns

The nat_configuration of this NetworkFirewall.

Return type

oci.network_firewall.models.NatConfigurationResponse

property network_firewall_policy_id

[Required] Gets the network_firewall_policy_id of this NetworkFirewall. The OCID of the Network Firewall Policy.

Returns

The network_firewall_policy_id of this NetworkFirewall.

Return type

str

property network_security_group_ids

Gets the network_security_group_ids of this NetworkFirewall. An array of network security groups OCID associated with the Network Firewall.

Returns

The network_security_group_ids of this NetworkFirewall.

Return type

list[str]

property security_attributes

Gets the security_attributes of this NetworkFirewall. Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}

Returns

The security_attributes of this NetworkFirewall.

Return type

dict(str, dict(str, object))

property shape

Gets the shape of this NetworkFirewall. The shape of a firewall to determine the bandwidth that the firewall allows.

Returns

The shape of this NetworkFirewall.

Return type

str

property subnet_id

[Required] Gets the subnet_id of this NetworkFirewall. The OCID of the subnet associated with the Network Firewall.

Returns

The subnet_id of this NetworkFirewall.

Return type

str

property system_tags

Gets the system_tags of this NetworkFirewall. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this NetworkFirewall.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this NetworkFirewall. The time at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns

The time_created of this NetworkFirewall.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this NetworkFirewall. The time at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns

The time_updated of this NetworkFirewall.

Return type

datetime