Docs Home
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.Core.NetworkSecurityGroup
Explore with Pulumi AI
This resource provides the Network Security Group resource in Oracle Cloud Infrastructure Core service.
Creates a new network security group for the specified VCN.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testNetworkSecurityGroup = new oci.core.NetworkSecurityGroup("test_network_security_group", {
compartmentId: compartmentId,
vcnId: testVcn.id,
definedTags: {
"Operations.CostCenter": "42",
},
displayName: networkSecurityGroupDisplayName,
freeformTags: {
Department: "Finance",
},
});
import pulumi
import pulumi_oci as oci
test_network_security_group = oci.core.NetworkSecurityGroup("test_network_security_group",
compartment_id=compartment_id,
vcn_id=test_vcn["id"],
defined_tags={
"Operations.CostCenter": "42",
},
display_name=network_security_group_display_name,
freeform_tags={
"Department": "Finance",
})
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := core.NewNetworkSecurityGroup(ctx, "test_network_security_group", &core.NetworkSecurityGroupArgs{
CompartmentId: pulumi.Any(compartmentId),
VcnId: pulumi.Any(testVcn.Id),
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
DisplayName: pulumi.Any(networkSecurityGroupDisplayName),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testNetworkSecurityGroup = new Oci.Core.NetworkSecurityGroup("test_network_security_group", new()
{
CompartmentId = compartmentId,
VcnId = testVcn.Id,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
DisplayName = networkSecurityGroupDisplayName,
FreeformTags =
{
{ "Department", "Finance" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.NetworkSecurityGroup;
import com.pulumi.oci.Core.NetworkSecurityGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testNetworkSecurityGroup = new NetworkSecurityGroup("testNetworkSecurityGroup", NetworkSecurityGroupArgs.builder()
.compartmentId(compartmentId)
.vcnId(testVcn.id())
.definedTags(Map.of("Operations.CostCenter", "42"))
.displayName(networkSecurityGroupDisplayName)
.freeformTags(Map.of("Department", "Finance"))
.build());
}
}
resources:
testNetworkSecurityGroup:
type: oci:Core:NetworkSecurityGroup
name: test_network_security_group
properties:
compartmentId: ${compartmentId}
vcnId: ${testVcn.id}
definedTags:
Operations.CostCenter: '42'
displayName: ${networkSecurityGroupDisplayName}
freeformTags:
Department: Finance
Create NetworkSecurityGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NetworkSecurityGroup(name: string, args: NetworkSecurityGroupArgs, opts?: CustomResourceOptions);@overload
def NetworkSecurityGroup(resource_name: str,
args: NetworkSecurityGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NetworkSecurityGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
vcn_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None)func NewNetworkSecurityGroup(ctx *Context, name string, args NetworkSecurityGroupArgs, opts ...ResourceOption) (*NetworkSecurityGroup, error)public NetworkSecurityGroup(string name, NetworkSecurityGroupArgs args, CustomResourceOptions? opts = null)
public NetworkSecurityGroup(String name, NetworkSecurityGroupArgs args)
public NetworkSecurityGroup(String name, NetworkSecurityGroupArgs args, CustomResourceOptions options)
type: oci:Core:NetworkSecurityGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args NetworkSecurityGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args NetworkSecurityGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args NetworkSecurityGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NetworkSecurityGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NetworkSecurityGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var networkSecurityGroupResource = new Oci.Core.NetworkSecurityGroup("networkSecurityGroupResource", new()
{
CompartmentId = "string",
VcnId = "string",
DefinedTags =
{
{ "string", "string" },
},
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
});
example, err := core.NewNetworkSecurityGroup(ctx, "networkSecurityGroupResource", &core.NetworkSecurityGroupArgs{
CompartmentId: pulumi.String("string"),
VcnId: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var networkSecurityGroupResource = new NetworkSecurityGroup("networkSecurityGroupResource", NetworkSecurityGroupArgs.builder()
.compartmentId("string")
.vcnId("string")
.definedTags(Map.of("string", "string"))
.displayName("string")
.freeformTags(Map.of("string", "string"))
.build());
network_security_group_resource = oci.core.NetworkSecurityGroup("networkSecurityGroupResource",
compartment_id="string",
vcn_id="string",
defined_tags={
"string": "string",
},
display_name="string",
freeform_tags={
"string": "string",
})
const networkSecurityGroupResource = new oci.core.NetworkSecurityGroup("networkSecurityGroupResource", {
compartmentId: "string",
vcnId: "string",
definedTags: {
string: "string",
},
displayName: "string",
freeformTags: {
string: "string",
},
});
type: oci:Core:NetworkSecurityGroup
properties:
compartmentId: string
definedTags:
string: string
displayName: string
freeformTags:
string: string
vcnId: string
NetworkSecurityGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The NetworkSecurityGroup resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment to contain the network security group.
- Vcn
Id string The OCID of the VCN to create the network security group in.
** 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
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"}
- Compartment
Id string - (Updatable) The OCID of the compartment to contain the network security group.
- Vcn
Id string The OCID of the VCN to create the network security group in.
** 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
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"}
- compartment
Id String - (Updatable) The OCID of the compartment to contain the network security group.
- vcn
Id String The OCID of the VCN to create the network security group in.
** 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
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"}
- compartment
Id string - (Updatable) The OCID of the compartment to contain the network security group.
- vcn
Id string The OCID of the VCN to create the network security group in.
** 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
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"}
- compartment_
id str - (Updatable) The OCID of the compartment to contain the network security group.
- vcn_
id str The OCID of the VCN to create the network security group in.
** 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
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"}
- compartment
Id String - (Updatable) The OCID of the compartment to contain the network security group.
- vcn
Id String The OCID of the VCN to create the network security group in.
** 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
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"}
Outputs
All input properties are implicitly available as output properties. Additionally, the NetworkSecurityGroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The network security group's current state.
- Time
Created string - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Id string
- The provider-assigned unique ID for this managed resource.
- State string
- The network security group's current state.
- Time
Created string - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The network security group's current state.
- time
Created String - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- id string
- The provider-assigned unique ID for this managed resource.
- state string
- The network security group's current state.
- time
Created string - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- id str
- The provider-assigned unique ID for this managed resource.
- state str
- The network security group's current state.
- time_
created str - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- id String
- The provider-assigned unique ID for this managed resource.
- state String
- The network security group's current state.
- time
Created String - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
Look up Existing NetworkSecurityGroup Resource
Get an existing NetworkSecurityGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: NetworkSecurityGroupState, opts?: CustomResourceOptions): NetworkSecurityGroup@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
state: Optional[str] = None,
time_created: Optional[str] = None,
vcn_id: Optional[str] = None) -> NetworkSecurityGroupfunc GetNetworkSecurityGroup(ctx *Context, name string, id IDInput, state *NetworkSecurityGroupState, opts ...ResourceOption) (*NetworkSecurityGroup, error)public static NetworkSecurityGroup Get(string name, Input<string> id, NetworkSecurityGroupState? state, CustomResourceOptions? opts = null)public static NetworkSecurityGroup get(String name, Output<String> id, NetworkSecurityGroupState state, CustomResourceOptions options)resources: _: type: oci:Core:NetworkSecurityGroup get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Compartment
Id string - (Updatable) The OCID of the compartment to contain the network security group.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"} - State string
- The network security group's current state.
- Time
Created string - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Vcn
Id string The OCID of the VCN to create the network security group in.
** 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
- Compartment
Id string - (Updatable) The OCID of the compartment to contain the network security group.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"} - State string
- The network security group's current state.
- Time
Created string - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Vcn
Id string The OCID of the VCN to create the network security group in.
** 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
- compartment
Id String - (Updatable) The OCID of the compartment to contain the network security group.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"} - state String
- The network security group's current state.
- time
Created String - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - vcn
Id String The OCID of the VCN to create the network security group in.
** 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
- compartment
Id string - (Updatable) The OCID of the compartment to contain the network security group.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"} - state string
- The network security group's current state.
- time
Created string - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - vcn
Id string The OCID of the VCN to create the network security group in.
** 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
- compartment_
id str - (Updatable) The OCID of the compartment to contain the network security group.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"} - state str
- The network security group's current state.
- time_
created str - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - vcn_
id str The OCID of the VCN to create the network security group in.
** 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
- compartment
Id String - (Updatable) The OCID of the compartment to contain the network security group.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"} - state String
- The network security group's current state.
- time
Created String - The date and time the network security group was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - vcn
Id String The OCID of the VCN to create the network security group in.
** 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
Import
NetworkSecurityGroups can be imported using the id, e.g.
$ pulumi import oci:Core/networkSecurityGroup:NetworkSecurityGroup test_network_security_group "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.