1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. Cpe
oci logo
Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.Core.Cpe

This resource provides the Cpe resource in Oracle Cloud Infrastructure Core service.

Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. 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 CPE to reside. Notice that the CPE doesn’t have to be in the same compartment as the IPSec connection or other Networking Service components. If you’re not sure which compartment to use, put the CPE in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You must provide the public IP address of your on-premises router. See CPE Configuration.

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCpe = new Oci.Core.Cpe("testCpe", new()
    {
        CompartmentId = @var.Compartment_id,
        IpAddress = @var.Cpe_ip_address,
        CpeDeviceShapeId = data.Oci_core_cpe_device_shapes.Test_cpe_device_shapes.Cpe_device_shapes[0].Cpe_device_shape_id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = @var.Cpe_display_name,
        FreeformTags = 
        {
            { "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.NewCpe(ctx, "testCpe", &Core.CpeArgs{
			CompartmentId:    pulumi.Any(_var.Compartment_id),
			IpAddress:        pulumi.Any(_var.Cpe_ip_address),
			CpeDeviceShapeId: pulumi.Any(data.Oci_core_cpe_device_shapes.Test_cpe_device_shapes.Cpe_device_shapes[0].Cpe_device_shape_id),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName: pulumi.Any(_var.Cpe_display_name),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.Cpe;
import com.pulumi.oci.Core.CpeArgs;
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 testCpe = new Cpe("testCpe", CpeArgs.builder()        
            .compartmentId(var_.compartment_id())
            .ipAddress(var_.cpe_ip_address())
            .cpeDeviceShapeId(data.oci_core_cpe_device_shapes().test_cpe_device_shapes().cpe_device_shapes()[0].cpe_device_shape_id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(var_.cpe_display_name())
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_cpe = oci.core.Cpe("testCpe",
    compartment_id=var["compartment_id"],
    ip_address=var["cpe_ip_address"],
    cpe_device_shape_id=data["oci_core_cpe_device_shapes"]["test_cpe_device_shapes"]["cpe_device_shapes"][0]["cpe_device_shape_id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=var["cpe_display_name"],
    freeform_tags={
        "Department": "Finance",
    })

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCpe = new oci.core.Cpe("testCpe", {
    compartmentId: _var.compartment_id,
    ipAddress: _var.cpe_ip_address,
    cpeDeviceShapeId: data.oci_core_cpe_device_shapes.test_cpe_device_shapes.cpe_device_shapes[0].cpe_device_shape_id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: _var.cpe_display_name,
    freeformTags: {
        Department: "Finance",
    },
});

resources:
  testCpe:
    type: oci:Core:Cpe
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      ipAddress: ${var.cpe_ip_address}
      #Optional
      cpeDeviceShapeId: ${data.oci_core_cpe_device_shapes.test_cpe_device_shapes.cpe_device_shapes[0].cpe_device_shape_id}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${var.cpe_display_name}
      freeformTags:
        Department: Finance

Create Cpe Resource

new Cpe(name: string, args: CpeArgs, opts?: CustomResourceOptions);
@overload
def Cpe(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        cpe_device_shape_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        ip_address: Optional[str] = None)
@overload
def Cpe(resource_name: str,
        args: CpeArgs,
        opts: Optional[ResourceOptions] = None)
func NewCpe(ctx *Context, name string, args CpeArgs, opts ...ResourceOption) (*Cpe, error)
public Cpe(string name, CpeArgs args, CustomResourceOptions? opts = null)
public Cpe(String name, CpeArgs args)
public Cpe(String name, CpeArgs args, CustomResourceOptions options)

type: oci:Core:Cpe
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CpeArgs
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 CpeArgs
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 CpeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CpeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CpeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Cpe 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 Cpe resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment to contain the CPE.

IpAddress string

The public IP address of the on-premises router. Example: 203.0.113.2

CpeDeviceShapeId string

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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 CPE.

IpAddress string

The public IP address of the on-premises router. Example: 203.0.113.2

CpeDeviceShapeId string

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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 CPE.

ipAddress String

The public IP address of the on-premises router. Example: 203.0.113.2

cpeDeviceShapeId String

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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 CPE.

ipAddress string

The public IP address of the on-premises router. Example: 203.0.113.2

cpeDeviceShapeId string

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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 CPE.

ip_address str

The public IP address of the on-premises router. Example: 203.0.113.2

cpe_device_shape_id str

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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 CPE.

ipAddress String

The public IP address of the on-premises router. Example: 203.0.113.2

cpeDeviceShapeId String

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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 Cpe resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

TimeCreated string

The date and time the CPE 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.

TimeCreated string

The date and time the CPE 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.

timeCreated String

The date and time the CPE 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.

timeCreated string

The date and time the CPE 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.

time_created str

The date and time the CPE 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.

timeCreated String

The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Look up Existing Cpe Resource

Get an existing Cpe 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?: CpeState, opts?: CustomResourceOptions): Cpe
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        cpe_device_shape_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        ip_address: Optional[str] = None,
        time_created: Optional[str] = None) -> Cpe
func GetCpe(ctx *Context, name string, id IDInput, state *CpeState, opts ...ResourceOption) (*Cpe, error)
public static Cpe Get(string name, Input<string> id, CpeState? state, CustomResourceOptions? opts = null)
public static Cpe get(String name, Output<String> id, CpeState 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 CPE.

CpeDeviceShapeId string

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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"}

IpAddress string

The public IP address of the on-premises router. Example: 203.0.113.2

TimeCreated string

The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

CompartmentId string

(Updatable) The OCID of the compartment to contain the CPE.

CpeDeviceShapeId string

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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"}

IpAddress string

The public IP address of the on-premises router. Example: 203.0.113.2

TimeCreated string

The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String

(Updatable) The OCID of the compartment to contain the CPE.

cpeDeviceShapeId String

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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"}

ipAddress String

The public IP address of the on-premises router. Example: 203.0.113.2

timeCreated String

The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId string

(Updatable) The OCID of the compartment to contain the CPE.

cpeDeviceShapeId string

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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"}

ipAddress string

The public IP address of the on-premises router. Example: 203.0.113.2

timeCreated string

The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartment_id str

(Updatable) The OCID of the compartment to contain the CPE.

cpe_device_shape_id str

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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"}

ip_address str

The public IP address of the on-premises router. Example: 203.0.113.2

time_created str

The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String

(Updatable) The OCID of the compartment to contain the CPE.

cpeDeviceShapeId String

(Updatable) The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call UpdateCpe later to provide a value. For a list of possible values, see ListCpeDeviceShapes.

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"}

ipAddress String

The public IP address of the on-premises router. Example: 203.0.113.2

timeCreated String

The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Import

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

 $ pulumi import oci:Core/cpe:Cpe test_cpe "id"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.