1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. Ipsec
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.Core.Ipsec

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    This resource provides the Ip Sec Connection resource in Oracle Cloud Infrastructure Core service.

    Creates a new IPSec connection between the specified DRG and CPE with two default static tunnels. For more information, see Site-to-Site VPN Overview.

    For the purposes of access control, you must provide the OCID of the compartment where you want the IPSec connection to reside. Notice that the IPSec connection doesn’t have to be in the same compartment as the DRG, CPE, or other Networking Service components. If you’re not sure which compartment to use, put the IPSec connection in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service.

    You may optionally specify a display name for the IPSec connection, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

    After creating the IPSec connection, you need to configure your on-premises router with tunnel-specific information. For tunnel status and the required configuration information, see:

    To configure tunnel-specific information, use oci.Core.IpsecConnectionTunnelManagement to update the tunnels. If you configure at least one tunnel to use static routing, then in the oci.Core.Ipsec request you must provide at least one valid static route (you’re allowed a maximum of 10). For example: 10.0.0.0/16. If you configure both tunnels to use BGP dynamic routing, the static routes will be ignored. However, you must provide a static route in oci.Core.Ipsec even if you plan to use BGP routing because it defaults to two static tunnels. For more information, see the important note in IPSecConnection.

    For each tunnel, you need the IP address of Oracle’s VPN headend and the shared secret (that is, the pre-shared key). For more information, see CPE Configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testIpSecConnection = new oci.core.Ipsec("testIpSecConnection", {
        compartmentId: _var.compartment_id,
        cpeId: oci_core_cpe.test_cpe.id,
        drgId: oci_core_drg.test_drg.id,
        staticRoutes: _var.ip_sec_connection_static_routes,
        cpeLocalIdentifier: _var.ip_sec_connection_cpe_local_identifier,
        cpeLocalIdentifierType: _var.ip_sec_connection_cpe_local_identifier_type,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        displayName: _var.ip_sec_connection_display_name,
        freeformTags: {
            Department: "Finance",
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_ip_sec_connection = oci.core.Ipsec("testIpSecConnection",
        compartment_id=var["compartment_id"],
        cpe_id=oci_core_cpe["test_cpe"]["id"],
        drg_id=oci_core_drg["test_drg"]["id"],
        static_routes=var["ip_sec_connection_static_routes"],
        cpe_local_identifier=var["ip_sec_connection_cpe_local_identifier"],
        cpe_local_identifier_type=var["ip_sec_connection_cpe_local_identifier_type"],
        defined_tags={
            "Operations.CostCenter": "42",
        },
        display_name=var["ip_sec_connection_display_name"],
        freeform_tags={
            "Department": "Finance",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Core.NewIpsec(ctx, "testIpSecConnection", &Core.IpsecArgs{
    			CompartmentId:          pulumi.Any(_var.Compartment_id),
    			CpeId:                  pulumi.Any(oci_core_cpe.Test_cpe.Id),
    			DrgId:                  pulumi.Any(oci_core_drg.Test_drg.Id),
    			StaticRoutes:           pulumi.Any(_var.Ip_sec_connection_static_routes),
    			CpeLocalIdentifier:     pulumi.Any(_var.Ip_sec_connection_cpe_local_identifier),
    			CpeLocalIdentifierType: pulumi.Any(_var.Ip_sec_connection_cpe_local_identifier_type),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			DisplayName: pulumi.Any(_var.Ip_sec_connection_display_name),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("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 testIpSecConnection = new Oci.Core.Ipsec("testIpSecConnection", new()
        {
            CompartmentId = @var.Compartment_id,
            CpeId = oci_core_cpe.Test_cpe.Id,
            DrgId = oci_core_drg.Test_drg.Id,
            StaticRoutes = @var.Ip_sec_connection_static_routes,
            CpeLocalIdentifier = @var.Ip_sec_connection_cpe_local_identifier,
            CpeLocalIdentifierType = @var.Ip_sec_connection_cpe_local_identifier_type,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            DisplayName = @var.Ip_sec_connection_display_name,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Core.Ipsec;
    import com.pulumi.oci.Core.IpsecArgs;
    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 testIpSecConnection = new Ipsec("testIpSecConnection", IpsecArgs.builder()        
                .compartmentId(var_.compartment_id())
                .cpeId(oci_core_cpe.test_cpe().id())
                .drgId(oci_core_drg.test_drg().id())
                .staticRoutes(var_.ip_sec_connection_static_routes())
                .cpeLocalIdentifier(var_.ip_sec_connection_cpe_local_identifier())
                .cpeLocalIdentifierType(var_.ip_sec_connection_cpe_local_identifier_type())
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .displayName(var_.ip_sec_connection_display_name())
                .freeformTags(Map.of("Department", "Finance"))
                .build());
    
        }
    }
    
    resources:
      testIpSecConnection:
        type: oci:Core:Ipsec
        properties:
          #Required
          compartmentId: ${var.compartment_id}
          cpeId: ${oci_core_cpe.test_cpe.id}
          drgId: ${oci_core_drg.test_drg.id}
          staticRoutes: ${var.ip_sec_connection_static_routes}
          #Optional
          cpeLocalIdentifier: ${var.ip_sec_connection_cpe_local_identifier}
          cpeLocalIdentifierType: ${var.ip_sec_connection_cpe_local_identifier_type}
          definedTags:
            Operations.CostCenter: '42'
          displayName: ${var.ip_sec_connection_display_name}
          freeformTags:
            Department: Finance
    

    Create Ipsec Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Ipsec(name: string, args: IpsecArgs, opts?: CustomResourceOptions);
    @overload
    def Ipsec(resource_name: str,
              args: IpsecArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Ipsec(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              compartment_id: Optional[str] = None,
              cpe_id: Optional[str] = None,
              drg_id: Optional[str] = None,
              static_routes: Optional[Sequence[str]] = None,
              cpe_local_identifier: Optional[str] = None,
              cpe_local_identifier_type: Optional[str] = None,
              defined_tags: Optional[Mapping[str, Any]] = None,
              display_name: Optional[str] = None,
              freeform_tags: Optional[Mapping[str, Any]] = None)
    func NewIpsec(ctx *Context, name string, args IpsecArgs, opts ...ResourceOption) (*Ipsec, error)
    public Ipsec(string name, IpsecArgs args, CustomResourceOptions? opts = null)
    public Ipsec(String name, IpsecArgs args)
    public Ipsec(String name, IpsecArgs args, CustomResourceOptions options)
    
    type: oci:Core:Ipsec
    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 IpsecArgs
    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 IpsecArgs
    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 IpsecArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpsecArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpsecArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var ipsecResource = new Oci.Core.Ipsec("ipsecResource", new()
    {
        CompartmentId = "string",
        CpeId = "string",
        DrgId = "string",
        StaticRoutes = new[]
        {
            "string",
        },
        CpeLocalIdentifier = "string",
        CpeLocalIdentifierType = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
    });
    
    example, err := Core.NewIpsec(ctx, "ipsecResource", &Core.IpsecArgs{
    	CompartmentId: pulumi.String("string"),
    	CpeId:         pulumi.String("string"),
    	DrgId:         pulumi.String("string"),
    	StaticRoutes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	CpeLocalIdentifier:     pulumi.String("string"),
    	CpeLocalIdentifierType: pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var ipsecResource = new Ipsec("ipsecResource", IpsecArgs.builder()        
        .compartmentId("string")
        .cpeId("string")
        .drgId("string")
        .staticRoutes("string")
        .cpeLocalIdentifier("string")
        .cpeLocalIdentifierType("string")
        .definedTags(Map.of("string", "any"))
        .displayName("string")
        .freeformTags(Map.of("string", "any"))
        .build());
    
    ipsec_resource = oci.core.Ipsec("ipsecResource",
        compartment_id="string",
        cpe_id="string",
        drg_id="string",
        static_routes=["string"],
        cpe_local_identifier="string",
        cpe_local_identifier_type="string",
        defined_tags={
            "string": "any",
        },
        display_name="string",
        freeform_tags={
            "string": "any",
        })
    
    const ipsecResource = new oci.core.Ipsec("ipsecResource", {
        compartmentId: "string",
        cpeId: "string",
        drgId: "string",
        staticRoutes: ["string"],
        cpeLocalIdentifier: "string",
        cpeLocalIdentifierType: "string",
        definedTags: {
            string: "any",
        },
        displayName: "string",
        freeformTags: {
            string: "any",
        },
    });
    
    type: oci:Core:Ipsec
    properties:
        compartmentId: string
        cpeId: string
        cpeLocalIdentifier: string
        cpeLocalIdentifierType: string
        definedTags:
            string: any
        displayName: string
        drgId: string
        freeformTags:
            string: any
        staticRoutes:
            - string
    

    Ipsec Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Ipsec resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment to contain the IPSec connection.
    CpeId string
    The OCID of the Cpe object.
    DrgId string
    The OCID of the DRG.
    StaticRoutes List<string>

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    CpeLocalIdentifier string

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    CpeLocalIdentifierType string
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    DefinedTags Dictionary<string, object>
    (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"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (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"}
    CompartmentId string
    (Updatable) The OCID of the compartment to contain the IPSec connection.
    CpeId string
    The OCID of the Cpe object.
    DrgId string
    The OCID of the DRG.
    StaticRoutes []string

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    CpeLocalIdentifier string

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    CpeLocalIdentifierType string
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    DefinedTags map[string]interface{}
    (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"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (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"}
    compartmentId String
    (Updatable) The OCID of the compartment to contain the IPSec connection.
    cpeId String
    The OCID of the Cpe object.
    drgId String
    The OCID of the DRG.
    staticRoutes List<String>

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    cpeLocalIdentifier String

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    cpeLocalIdentifierType String
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    definedTags Map<String,Object>
    (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"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (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"}
    compartmentId string
    (Updatable) The OCID of the compartment to contain the IPSec connection.
    cpeId string
    The OCID of the Cpe object.
    drgId string
    The OCID of the DRG.
    staticRoutes string[]

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    cpeLocalIdentifier string

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    cpeLocalIdentifierType string
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    definedTags {[key: string]: any}
    (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"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (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 IPSec connection.
    cpe_id str
    The OCID of the Cpe object.
    drg_id str
    The OCID of the DRG.
    static_routes Sequence[str]

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    cpe_local_identifier str

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    cpe_local_identifier_type str
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    defined_tags Mapping[str, Any]
    (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.
    freeform_tags Mapping[str, Any]
    (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"}
    compartmentId String
    (Updatable) The OCID of the compartment to contain the IPSec connection.
    cpeId String
    The OCID of the Cpe object.
    drgId String
    The OCID of the DRG.
    staticRoutes List<String>

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    cpeLocalIdentifier String

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    cpeLocalIdentifierType String
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    definedTags Map<Any>
    (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"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    (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 Ipsec resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The IPSec connection's current state.
    TimeCreated string
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TransportType string
    The transport type used for the IPSec connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The IPSec connection's current state.
    TimeCreated string
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TransportType string
    The transport type used for the IPSec connection.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The IPSec connection's current state.
    timeCreated String
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    transportType String
    The transport type used for the IPSec connection.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The IPSec connection's current state.
    timeCreated string
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    transportType string
    The transport type used for the IPSec connection.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The IPSec connection's current state.
    time_created str
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    transport_type str
    The transport type used for the IPSec connection.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The IPSec connection's current state.
    timeCreated String
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    transportType String
    The transport type used for the IPSec connection.

    Look up Existing Ipsec Resource

    Get an existing Ipsec 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?: IpsecState, opts?: CustomResourceOptions): Ipsec
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            cpe_id: Optional[str] = None,
            cpe_local_identifier: Optional[str] = None,
            cpe_local_identifier_type: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            drg_id: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            state: Optional[str] = None,
            static_routes: Optional[Sequence[str]] = None,
            time_created: Optional[str] = None,
            transport_type: Optional[str] = None) -> Ipsec
    func GetIpsec(ctx *Context, name string, id IDInput, state *IpsecState, opts ...ResourceOption) (*Ipsec, error)
    public static Ipsec Get(string name, Input<string> id, IpsecState? state, CustomResourceOptions? opts = null)
    public static Ipsec get(String name, Output<String> id, IpsecState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment to contain the IPSec connection.
    CpeId string
    The OCID of the Cpe object.
    CpeLocalIdentifier string

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    CpeLocalIdentifierType string
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    DefinedTags Dictionary<string, object>
    (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"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    DrgId string
    The OCID of the DRG.
    FreeformTags Dictionary<string, object>
    (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 IPSec connection's current state.
    StaticRoutes List<string>

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    TimeCreated string
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TransportType string
    The transport type used for the IPSec connection.
    CompartmentId string
    (Updatable) The OCID of the compartment to contain the IPSec connection.
    CpeId string
    The OCID of the Cpe object.
    CpeLocalIdentifier string

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    CpeLocalIdentifierType string
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    DefinedTags map[string]interface{}
    (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"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    DrgId string
    The OCID of the DRG.
    FreeformTags map[string]interface{}
    (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 IPSec connection's current state.
    StaticRoutes []string

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    TimeCreated string
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TransportType string
    The transport type used for the IPSec connection.
    compartmentId String
    (Updatable) The OCID of the compartment to contain the IPSec connection.
    cpeId String
    The OCID of the Cpe object.
    cpeLocalIdentifier String

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    cpeLocalIdentifierType String
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    definedTags Map<String,Object>
    (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"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    drgId String
    The OCID of the DRG.
    freeformTags Map<String,Object>
    (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 IPSec connection's current state.
    staticRoutes List<String>

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    timeCreated String
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    transportType String
    The transport type used for the IPSec connection.
    compartmentId string
    (Updatable) The OCID of the compartment to contain the IPSec connection.
    cpeId string
    The OCID of the Cpe object.
    cpeLocalIdentifier string

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    cpeLocalIdentifierType string
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    definedTags {[key: string]: any}
    (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"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    drgId string
    The OCID of the DRG.
    freeformTags {[key: string]: any}
    (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 IPSec connection's current state.
    staticRoutes string[]

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    timeCreated string
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    transportType string
    The transport type used for the IPSec connection.
    compartment_id str
    (Updatable) The OCID of the compartment to contain the IPSec connection.
    cpe_id str
    The OCID of the Cpe object.
    cpe_local_identifier str

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    cpe_local_identifier_type str
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    defined_tags Mapping[str, Any]
    (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.
    drg_id str
    The OCID of the DRG.
    freeform_tags Mapping[str, Any]
    (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 IPSec connection's current state.
    static_routes Sequence[str]

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    time_created str
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    transport_type str
    The transport type used for the IPSec connection.
    compartmentId String
    (Updatable) The OCID of the compartment to contain the IPSec connection.
    cpeId String
    The OCID of the Cpe object.
    cpeLocalIdentifier String

    (Updatable) Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

    If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

    For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

    Example IP address: 10.0.3.3

    Example hostname: cpe.example.com

    cpeLocalIdentifierType String
    (Updatable) The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.
    definedTags Map<Any>
    (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"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    drgId String
    The OCID of the DRG.
    freeformTags Map<Any>
    (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 IPSec connection's current state.
    staticRoutes List<String>

    (Updatable) Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

    Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes on update. For more information, see the important note in IPSecConnection.

    Example: 10.0.1.0/24

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

    timeCreated String
    The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    transportType String
    The transport type used for the IPSec connection.

    Import

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

    $ pulumi import oci:Core/ipsec:Ipsec test_ip_sec_connection "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 oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi