@Generated(value="OracleSDKGenerator",
comments="API Version: 20160918")
public final class NetworkSecurityGroup
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A network security group (NSG) provides virtual firewall rules for a specific set of Vnic in a VCN. Compare NSGs with SecurityList, which provide virtual firewall rules to
all the VNICs in a subnet.
A network security group consists of two items:
The set of Vnic that all have the same security rule needs (for example, a group of
Compute instances all running the same application) * A set of NSG SecurityRule that
apply to the VNICs in the group
After creating an NSG, you can add VNICs and security rules to it. For example, when you
create an instance, you can specify one or more NSGs to add the instance to (see createVnicDetails). Or you can add an existing
instance to an NSG with updateVnic.
To add security rules to an NSG, see addNetworkSecurityGroupSecurityRules.
To list the VNICs in an NSG, see listNetworkSecurityGroupVnics.
To list the security rules in an NSG, see listNetworkSecurityGroupSecurityRules.
For more information about network security groups, see [Network Security Groups](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm).
*Important:** Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure all of the following are set correctly:
Any security rules in any NSGs the instance's VNIC belongs to * Any SecurityList
associated with the instance's subnet * The instance's OS firewall rules
To use any of the API operations, you must be authorized in an IAM policy. If you're not
authorized, talk to an administrator. If you're an administrator who needs to write policies to
give users access, see [Getting Started with
Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Note: Objects should always be created or deserialized using the NetworkSecurityGroup.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 NetworkSecurityGroup.Builder, which maintain a
set of all explicitly set fields called NetworkSecurityGroup.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
NetworkSecurityGroup.Builder |
static class |
NetworkSecurityGroup.LifecycleState
The network security group’s current state.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
NetworkSecurityGroup(String compartmentId,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
String id,
NetworkSecurityGroup.LifecycleState lifecycleState,
Date timeCreated,
String vcnId)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static NetworkSecurityGroup.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of
the compartment the network security group is in.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getId()
The OCID of
the network security group.
|
NetworkSecurityGroup.LifecycleState |
getLifecycleState()
The network security group’s current state.
|
Date |
getTimeCreated()
The date and time the network security group was created, in the format defined by
RFC3339.
|
String |
getVcnId()
The OCID of
the network security group’s VCN.
|
int |
hashCode() |
NetworkSecurityGroup.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"compartmentId","definedTags","displayName","freeformTags","id","lifecycleState","timeCreated","vcnId"}) public NetworkSecurityGroup(String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, NetworkSecurityGroup.LifecycleState lifecycleState, Date timeCreated, String vcnId)
public static NetworkSecurityGroup.Builder builder()
Create a new builder.
public NetworkSecurityGroup.Builder toBuilder()
public String getCompartmentId()
The OCID of the compartment the network security group is in.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public NetworkSecurityGroup.LifecycleState getLifecycleState()
The network security group’s current state.
public Date getTimeCreated()
The date and time the network security group was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.