Class SecurityRule.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • description

        public SecurityRule.Builder description​(String description)
        An optional description of your choice for the rule.
        Parameters:
        description - the value to set
        Returns:
        this builder
      • destination

        public SecurityRule.Builder destination​(String 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](https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).

        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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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.

        Parameters:
        destination - the value to set
        Returns:
        this builder
      • destinationType

        public SecurityRule.Builder destinationType​(SecurityRule.DestinationType destinationType)
        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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup.

        Parameters:
        destinationType - the value to set
        Returns:
        this builder
      • direction

        public SecurityRule.Builder direction​(SecurityRule.Direction 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.

        Parameters:
        direction - the value to set
        Returns:
        this builder
      • id

        public SecurityRule.Builder id​(String id)
        An Oracle-assigned identifier for the security rule.

        You specify this ID when you want to update or delete the rule.

        Example: 04ABEC

        Parameters:
        id - the value to set
        Returns:
        this builder
      • isStateless

        public SecurityRule.Builder isStateless​(Boolean isStateless)
        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.

        Parameters:
        isStateless - the value to set
        Returns:
        this builder
      • isValid

        public SecurityRule.Builder isValid​(Boolean isValid)
        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.

        Parameters:
        isValid - the value to set
        Returns:
        this builder
      • protocol

        public SecurityRule.Builder protocol​(String 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”).

        Parameters:
        protocol - the value to set
        Returns:
        this builder
      • source

        public SecurityRule.Builder source​(String 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](https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).

        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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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.

        Parameters:
        source - the value to set
        Returns:
        this builder
      • sourceType

        public SecurityRule.Builder sourceType​(SecurityRule.SourceType sourceType)
        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](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup.

        Parameters:
        sourceType - the value to set
        Returns:
        this builder
      • timeCreated

        public SecurityRule.Builder timeCreated​(Date timeCreated)
        The date and time the security rule was created.

        Format defined by RFC3339.

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder