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

oci.Core.getIpsecConnections

Explore with Pulumi AI

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

    This data source provides the list of Ip Sec Connections in Oracle Cloud Infrastructure Core service.

    Lists the IPSec connections for the specified compartment. You can filter the results by DRG or CPE.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testIpSecConnections = oci.Core.getIpsecConnections({
        compartmentId: _var.compartment_id,
        cpeId: oci_core_cpe.test_cpe.id,
        drgId: oci_core_drg.test_drg.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_ip_sec_connections = oci.Core.get_ipsec_connections(compartment_id=var["compartment_id"],
        cpe_id=oci_core_cpe["test_cpe"]["id"],
        drg_id=oci_core_drg["test_drg"]["id"])
    
    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.GetIpsecConnections(ctx, &core.GetIpsecConnectionsArgs{
    			CompartmentId: _var.Compartment_id,
    			CpeId:         pulumi.StringRef(oci_core_cpe.Test_cpe.Id),
    			DrgId:         pulumi.StringRef(oci_core_drg.Test_drg.Id),
    		}, nil)
    		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 testIpSecConnections = Oci.Core.GetIpsecConnections.Invoke(new()
        {
            CompartmentId = @var.Compartment_id,
            CpeId = oci_core_cpe.Test_cpe.Id,
            DrgId = oci_core_drg.Test_drg.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Core.CoreFunctions;
    import com.pulumi.oci.Core.inputs.GetIpsecConnectionsArgs;
    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) {
            final var testIpSecConnections = CoreFunctions.getIpsecConnections(GetIpsecConnectionsArgs.builder()
                .compartmentId(var_.compartment_id())
                .cpeId(oci_core_cpe.test_cpe().id())
                .drgId(oci_core_drg.test_drg().id())
                .build());
    
        }
    }
    
    variables:
      testIpSecConnections:
        fn::invoke:
          Function: oci:Core:getIpsecConnections
          Arguments:
            compartmentId: ${var.compartment_id}
            cpeId: ${oci_core_cpe.test_cpe.id}
            drgId: ${oci_core_drg.test_drg.id}
    

    Using getIpsecConnections

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIpsecConnections(args: GetIpsecConnectionsArgs, opts?: InvokeOptions): Promise<GetIpsecConnectionsResult>
    function getIpsecConnectionsOutput(args: GetIpsecConnectionsOutputArgs, opts?: InvokeOptions): Output<GetIpsecConnectionsResult>
    def get_ipsec_connections(compartment_id: Optional[str] = None,
                              cpe_id: Optional[str] = None,
                              drg_id: Optional[str] = None,
                              filters: Optional[Sequence[_core.GetIpsecConnectionsFilter]] = None,
                              opts: Optional[InvokeOptions] = None) -> GetIpsecConnectionsResult
    def get_ipsec_connections_output(compartment_id: Optional[pulumi.Input[str]] = None,
                              cpe_id: Optional[pulumi.Input[str]] = None,
                              drg_id: Optional[pulumi.Input[str]] = None,
                              filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetIpsecConnectionsFilterArgs]]]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetIpsecConnectionsResult]
    func GetIpsecConnections(ctx *Context, args *GetIpsecConnectionsArgs, opts ...InvokeOption) (*GetIpsecConnectionsResult, error)
    func GetIpsecConnectionsOutput(ctx *Context, args *GetIpsecConnectionsOutputArgs, opts ...InvokeOption) GetIpsecConnectionsResultOutput

    > Note: This function is named GetIpsecConnections in the Go SDK.

    public static class GetIpsecConnections 
    {
        public static Task<GetIpsecConnectionsResult> InvokeAsync(GetIpsecConnectionsArgs args, InvokeOptions? opts = null)
        public static Output<GetIpsecConnectionsResult> Invoke(GetIpsecConnectionsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIpsecConnectionsResult> getIpsecConnections(GetIpsecConnectionsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Core/getIpsecConnections:getIpsecConnections
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment.
    CpeId string
    The OCID of the CPE.
    DrgId string
    The OCID of the DRG.
    Filters List<GetIpsecConnectionsFilter>
    CompartmentId string
    The OCID of the compartment.
    CpeId string
    The OCID of the CPE.
    DrgId string
    The OCID of the DRG.
    Filters []GetIpsecConnectionsFilter
    compartmentId String
    The OCID of the compartment.
    cpeId String
    The OCID of the CPE.
    drgId String
    The OCID of the DRG.
    filters List<GetIpsecConnectionsFilter>
    compartmentId string
    The OCID of the compartment.
    cpeId string
    The OCID of the CPE.
    drgId string
    The OCID of the DRG.
    filters GetIpsecConnectionsFilter[]
    compartment_id str
    The OCID of the compartment.
    cpe_id str
    The OCID of the CPE.
    drg_id str
    The OCID of the DRG.
    filters Sequence[core.GetIpsecConnectionsFilter]
    compartmentId String
    The OCID of the compartment.
    cpeId String
    The OCID of the CPE.
    drgId String
    The OCID of the DRG.
    filters List<Property Map>

    getIpsecConnections Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment containing the IPSec connection.
    Connections List<GetIpsecConnectionsConnection>
    The list of connections.
    Id string
    The provider-assigned unique ID for this managed resource.
    CpeId string
    The OCID of the Cpe object.
    DrgId string
    The OCID of the DRG.
    Filters List<GetIpsecConnectionsFilter>
    CompartmentId string
    The OCID of the compartment containing the IPSec connection.
    Connections []GetIpsecConnectionsConnection
    The list of connections.
    Id string
    The provider-assigned unique ID for this managed resource.
    CpeId string
    The OCID of the Cpe object.
    DrgId string
    The OCID of the DRG.
    Filters []GetIpsecConnectionsFilter
    compartmentId String
    The OCID of the compartment containing the IPSec connection.
    connections List<GetIpsecConnectionsConnection>
    The list of connections.
    id String
    The provider-assigned unique ID for this managed resource.
    cpeId String
    The OCID of the Cpe object.
    drgId String
    The OCID of the DRG.
    filters List<GetIpsecConnectionsFilter>
    compartmentId string
    The OCID of the compartment containing the IPSec connection.
    connections GetIpsecConnectionsConnection[]
    The list of connections.
    id string
    The provider-assigned unique ID for this managed resource.
    cpeId string
    The OCID of the Cpe object.
    drgId string
    The OCID of the DRG.
    filters GetIpsecConnectionsFilter[]
    compartment_id str
    The OCID of the compartment containing the IPSec connection.
    connections Sequence[core.GetIpsecConnectionsConnection]
    The list of connections.
    id str
    The provider-assigned unique ID for this managed resource.
    cpe_id str
    The OCID of the Cpe object.
    drg_id str
    The OCID of the DRG.
    filters Sequence[core.GetIpsecConnectionsFilter]
    compartmentId String
    The OCID of the compartment containing the IPSec connection.
    connections List<Property Map>
    The list of connections.
    id String
    The provider-assigned unique ID for this managed resource.
    cpeId String
    The OCID of the Cpe object.
    drgId String
    The OCID of the DRG.
    filters List<Property Map>

    Supporting Types

    GetIpsecConnectionsConnection

    CompartmentId string
    The OCID of the compartment.
    CpeId string
    The OCID of the CPE.
    CpeLocalIdentifier string
    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 here must correspond to the value for cpeLocalIdentifierType.
    CpeLocalIdentifierType string
    The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
    DefinedTags Dictionary<string, object>
    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
    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>
    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"}
    Id string
    The IPSec connection's Oracle ID (OCID).
    State string
    The IPSec connection's current state.
    StaticRoutes List<string>
    Static routes to the CPE. The CIDR must not be a multicast address or class E address.
    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
    The OCID of the compartment.
    CpeId string
    The OCID of the CPE.
    CpeLocalIdentifier string
    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 here must correspond to the value for cpeLocalIdentifierType.
    CpeLocalIdentifierType string
    The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
    DefinedTags map[string]interface{}
    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
    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{}
    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"}
    Id string
    The IPSec connection's Oracle ID (OCID).
    State string
    The IPSec connection's current state.
    StaticRoutes []string
    Static routes to the CPE. The CIDR must not be a multicast address or class E address.
    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
    The OCID of the compartment.
    cpeId String
    The OCID of the CPE.
    cpeLocalIdentifier String
    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 here must correspond to the value for cpeLocalIdentifierType.
    cpeLocalIdentifierType String
    The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
    definedTags Map<String,Object>
    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
    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>
    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"}
    id String
    The IPSec connection's Oracle ID (OCID).
    state String
    The IPSec connection's current state.
    staticRoutes List<String>
    Static routes to the CPE. The CIDR must not be a multicast address or class E address.
    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
    The OCID of the compartment.
    cpeId string
    The OCID of the CPE.
    cpeLocalIdentifier string
    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 here must correspond to the value for cpeLocalIdentifierType.
    cpeLocalIdentifierType string
    The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
    definedTags {[key: string]: any}
    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
    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}
    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"}
    id string
    The IPSec connection's Oracle ID (OCID).
    state string
    The IPSec connection's current state.
    staticRoutes string[]
    Static routes to the CPE. The CIDR must not be a multicast address or class E address.
    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
    The OCID of the compartment.
    cpe_id str
    The OCID of the CPE.
    cpe_local_identifier str
    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 here must correspond to the value for cpeLocalIdentifierType.
    cpe_local_identifier_type str
    The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
    defined_tags Mapping[str, Any]
    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
    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]
    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"}
    id str
    The IPSec connection's Oracle ID (OCID).
    state str
    The IPSec connection's current state.
    static_routes Sequence[str]
    Static routes to the CPE. The CIDR must not be a multicast address or class E address.
    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
    The OCID of the compartment.
    cpeId String
    The OCID of the CPE.
    cpeLocalIdentifier String
    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 here must correspond to the value for cpeLocalIdentifierType.
    cpeLocalIdentifierType String
    The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
    definedTags Map<Any>
    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
    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>
    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"}
    id String
    The IPSec connection's Oracle ID (OCID).
    state String
    The IPSec connection's current state.
    staticRoutes List<String>
    Static routes to the CPE. The CIDR must not be a multicast address or class E address.
    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.

    GetIpsecConnectionsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    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