@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class SecurityRule extends Object
A security rule is one of the items in a NetworkSecurityGroup. It is a virtual firewall rule for the VNICs in the network security group. A rule can be for either inbound (direction= INGRESS) or outbound (direction= EGRESS) IP packets.
Note: Objects should always be created or deserialized using the SecurityRule.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SecurityRule.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
SecurityRule.Builder |
static class |
SecurityRule.DestinationType
Type of destination for the rule.
|
static class |
SecurityRule.Direction
Direction of the security rule.
|
static class |
SecurityRule.SourceType
Type of source for the rule.
|
| Constructor and Description |
|---|
SecurityRule(String description,
String destination,
SecurityRule.DestinationType destinationType,
SecurityRule.Direction direction,
IcmpOptions icmpOptions,
String id,
Boolean isStateless,
Boolean isValid,
String protocol,
String source,
SecurityRule.SourceType sourceType,
TcpOptions tcpOptions,
Date timeCreated,
UdpOptions udpOptions)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static SecurityRule.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getDescription()
An optional description of your choice for the rule.
|
String |
getDestination()
Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.
|
SecurityRule.DestinationType |
getDestinationType()
Type of destination for the rule.
|
SecurityRule.Direction |
getDirection()
Direction of the security rule.
|
IcmpOptions |
getIcmpOptions()
Optional and valid only for ICMP and ICMPv6.
|
String |
getId()
An Oracle-assigned identifier for the security rule.
|
Boolean |
getIsStateless()
A stateless rule allows traffic in one direction.
|
Boolean |
getIsValid()
Whether the rule is valid.
|
String |
getProtocol()
The transport protocol.
|
String |
getSource()
Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.
|
SecurityRule.SourceType |
getSourceType()
Type of source for the rule.
|
TcpOptions |
getTcpOptions()
Optional and valid only for TCP.
|
Date |
getTimeCreated()
The date and time the security rule was created.
|
UdpOptions |
getUdpOptions()
Optional and valid only for UDP.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"description","destination","destinationType","direction","icmpOptions","id","isStateless","isValid","protocol","source","sourceType","tcpOptions","timeCreated","udpOptions"}) @Deprecated public SecurityRule(String description, String destination, SecurityRule.DestinationType destinationType, SecurityRule.Direction direction, IcmpOptions icmpOptions, String id, Boolean isStateless, Boolean isValid, String protocol, String source, SecurityRule.SourceType sourceType, TcpOptions tcpOptions, Date timeCreated, UdpOptions udpOptions)
public static SecurityRule.Builder builder()
Create a new builder.
public String getDescription()
An optional description of your choice for the rule.
public String getDestination()
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 Note that IPv6 addressing is currently supported only in the Government Cloud.
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.
public SecurityRule.DestinationType getDestinationType()
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.
public SecurityRule.Direction getDirection()
Direction of the security rule. Set to EGRESS for rules to allow outbound IP packets, or INGRESS for rules to allow inbound IP packets.
public IcmpOptions getIcmpOptions()
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 rule for each.
public String getId()
An Oracle-assigned identifier for the security rule. You specify this ID when you want to update or delete the rule.
Example: 04ABEC
public Boolean getIsStateless()
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.
public Boolean getIsValid()
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.
public String getProtocol()
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").
public String getSource()
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 Note that IPv6 addressing is currently supported only in the Government Cloud.
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.
public SecurityRule.SourceType getSourceType()
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.
public TcpOptions getTcpOptions()
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.
public Date getTimeCreated()
The date and time the security rule was created. Format defined by RFC3339.
public UdpOptions getUdpOptions()
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.
Copyright © 2016–2020. All rights reserved.