oci_core_network_security_group_security_rule

This resource provides the Network Security Group Security Rule resource in Oracle Cloud Infrastructure Core service.

Adds a security rule to the specified network security group.

Example Usage

resource "oci_core_network_security_group_security_rule" "test_network_security_group_security_rule" {
	#Required
	network_security_group_id = oci_core_network_security_group.test_network_security_group.id
    direction = var.network_security_group_security_rule_direction
    protocol = var.network_security_group_security_rule_protocol

    #Optional
    description = var.network_security_group_security_rule_description
    destination = var.network_security_group_security_rule_destination
    destination_type = var.network_security_group_security_rule_destination_type
    icmp_options {
        #Required
        type = var.network_security_group_security_rule_icmp_options_type

        #Optional
        code = var.network_security_group_security_rule_icmp_options_code
    }
    source = var.network_security_group_security_rule_source
    source_type = var.network_security_group_security_rule_source_type
    stateless = var.network_security_group_security_rule_stateless
    tcp_options {

        #Optional
        destination_port_range {
            #Required
            max = var.network_security_group_security_rule_tcp_options_destination_port_range_max
            min = var.network_security_group_security_rule_tcp_options_destination_port_range_min
        }
        source_port_range {
            #Required
            max = var.network_security_group_security_rule_tcp_options_source_port_range_max
            min = var.network_security_group_security_rule_tcp_options_source_port_range_min
        }
    }
    udp_options {

        #Optional
        destination_port_range {
            #Required
            max = var.network_security_group_security_rule_udp_options_destination_port_range_max
            min = var.network_security_group_security_rule_udp_options_destination_port_range_min
        }
        source_port_range {
            #Required
            max = var.network_security_group_security_rule_udp_options_source_port_range_max
            min = var.network_security_group_security_rule_udp_options_source_port_range_min
        }
    }
}

Argument Reference

The following arguments are supported:

• network_security_group_id - (Required) The OCID of the network security group.

• security_rules - (Optional) The NSG security rules to add.

  • description - (Optional) An optional description of your choice for the rule. Avoid entering confidential information.

  • destination - (Optional) Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.

    Allowed values:

    • An IP address range in CIDR notation. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56 IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
    • The cidrBlock value for a Service, if you’re setting up a security rule for traffic destined for a particular Service through a service gateway. For example: oci-phx-objectstorage.
    • The OCID of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule’s intent is to control traffic between VNICs in the same NSG.

  • destination_type - (Optional) Type of destination for the rule. Required if direction = EGRESS.

    Allowed values:

    • CIDR_BLOCK: If the rule’s destination is an IP address range in CIDR notation.
    • SERVICE_CIDR_BLOCK: If the rule’s destination is the cidrBlock value for a Service (the rule is for traffic destined for a particular Service through a service gateway).
    • NETWORK_SECURITY_GROUP: If the rule’s destination is the OCID of a NetworkSecurityGroup.

  • direction - (Required) Direction of the security rule. Set to EGRESS for rules to allow outbound IP packets, or INGRESS for rules to allow inbound IP packets.

  • icmp_options - (Optional) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

    • ICMP Parameters
    • ICMPv6 Parameters

    If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (“Destination Unreachable”) code 4 (“Fragmentation Needed and Don’t Fragment was Set”). If you need to specify multiple codes for a single type, create a separate security list rule for each. * code - (Optional) The ICMP code (optional). * type - (Required) The ICMP type.

  • protocol - (Required) The transport protocol. Specify either all or an IPv4 protocol number as defined in Protocol Numbers. Options are supported only for ICMP (“1”), TCP (“6”), UDP (“17”), and ICMPv6 (“58”).

  • source - (Optional) Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.

    Allowed values:

    • An IP address range in CIDR notation. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56 IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
    • The cidrBlock value for a Service, if you’re setting up a security rule for traffic coming from a particular Service through a service gateway. For example: oci-phx-objectstorage.
    • The OCID of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule’s intent is to control traffic between VNICs in the same NSG.

  • source_type - (Optional) Type of source for the rule. Required if direction = INGRESS.

    • CIDR_BLOCK: If the rule’s source is an IP address range in CIDR notation.
    • SERVICE_CIDR_BLOCK: If the rule’s source is the cidrBlock value for a Service (the rule is for traffic coming from a particular Service through a service gateway).
    • NETWORK_SECURITY_GROUP: If the rule’s source is the OCID of a NetworkSecurityGroup.

  • stateless - (Optional) A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.

  • tcp_options - (Optional) Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

    • destination_port_range - (Optional)
      • max - (Required) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
      • min - (Required) The minimum port number, which must not be greater than the maximum port number.
    • source_port_range - (Optional)
      • max - (Required) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
      • min - (Required) The minimum port number, which must not be greater than the maximum port number.

  • udp_options - (Optional) Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

    • destination_port_range - (Optional)
      • max - (Required) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
      • min - (Required) The minimum port number, which must not be greater than the maximum port number.
    • source_port_range - (Optional)
      • max - (Required) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
      • min - (Required) The minimum port number, which must not be greater than the maximum port number.

** 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

Attributes Reference

The following attributes are exported:

• security_rules - The NSG security rules that were added.

  • description - An optional description of your choice for the rule.

  • destination - Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.

    Allowed values:

    • An IP address range in CIDR notation. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56 IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
    • The cidrBlock value for a Service, if you’re setting up a security rule for traffic destined for a particular Service through a service gateway. For example: oci-phx-objectstorage.
    • The OCID of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule’s intent is to control traffic between VNICs in the same NSG.

  • destination_type - Type of destination for the rule. Required if direction = EGRESS.

    Allowed values:

    • CIDR_BLOCK: If the rule’s destination is an IP address range in CIDR notation.
    • SERVICE_CIDR_BLOCK: If the rule’s destination is the cidrBlock value for a Service (the rule is for traffic destined for a particular Service through a service gateway).
    • NETWORK_SECURITY_GROUP: If the rule’s destination is the OCID of a NetworkSecurityGroup.

  • direction - Direction of the security rule. Set to EGRESS for rules to allow outbound IP packets, or INGRESS for rules to allow inbound IP packets.

  • icmp_options - Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

    • ICMP Parameters
    • ICMPv6 Parameters

    If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (“Destination Unreachable”) code 4 (“Fragmentation Needed and Don’t Fragment was Set”). If you need to specify multiple codes for a single type, create a separate security list rule for each. * code - The ICMP code (optional). * type - The ICMP type.

  • id - An Oracle-assigned identifier for the security rule. You specify this ID when you want to update or delete the rule. Example: 04ABEC

  • is_valid - Whether the rule is valid. The value is True when the rule is first created. If the rule’s source or destination is a network security group, the value changes to False if that network security group is deleted.

  • protocol - The transport protocol. Specify either all or an IPv4 protocol number as defined in Protocol Numbers. Options are supported only for ICMP (“1”), TCP (“6”), UDP (“17”), and ICMPv6 (“58”).

  • source - Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.

    Allowed values:

    • An IP address range in CIDR notation. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56 IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
    • The cidrBlock value for a Service, if you’re setting up a security rule for traffic coming from a particular Service through a service gateway. For example: oci-phx-objectstorage.
    • The OCID of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule’s intent is to control traffic between VNICs in the same NSG.

  • source_type - Type of source for the rule. Required if direction = INGRESS.

    • CIDR_BLOCK: If the rule’s source is an IP address range in CIDR notation.
    • SERVICE_CIDR_BLOCK: If the rule’s source is the cidrBlock value for a Service (the rule is for traffic coming from a particular Service through a service gateway).
    • NETWORK_SECURITY_GROUP: If the rule’s source is the OCID of a NetworkSecurityGroup.

  • stateless - A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.

  • tcp_options - Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

    • destination_port_range -
      • max - The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
      • min - The minimum port number, which must not be greater than the maximum port number.
    • source_port_range -
      • max - The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
      • min - The minimum port number, which must not be greater than the maximum port number.

  • time_created - The date and time the security rule was created. Format defined by RFC3339.

  • udp_options - Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

    • destination_port_range -
      • max - The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
      • min - The minimum port number, which must not be greater than the maximum port number.
    • source_port_range -
      • max - The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
      • min - The minimum port number, which must not be greater than the maximum port number.

Timeouts

The timeouts block allows you to specify timeouts for certain operations: * create - (Defaults to 20 minutes), when creating the Network Security Group Security Rule * update - (Defaults to 20 minutes), when updating the Network Security Group Security Rule * delete - (Defaults to 20 minutes), when destroying the Network Security Group Security Rule

Import

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

$ terraform import oci_core_network_security_group_security_rule.test_network_security_group_security_rule "networkSecurityGroups/{networkSecurityGroupId}/securityRules/{securityRuleId}"