Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. getOnpremConnector
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.getOnpremConnector

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific On Prem Connector resource in Oracle Cloud Infrastructure Data Safe service.

Gets the details of the specified on-premises connector.

Example Usage

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

const testOnPremConnector = oci.DataSafe.getOnpremConnector({
    onPremConnectorId: testOnPremConnectorOciDataSafeOnPremConnector.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_on_prem_connector = oci.DataSafe.get_onprem_connector(on_prem_connector_id=test_on_prem_connector_oci_data_safe_on_prem_connector["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/datasafe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasafe.GetOnpremConnector(ctx, &datasafe.GetOnpremConnectorArgs{
			OnPremConnectorId: testOnPremConnectorOciDataSafeOnPremConnector.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testOnPremConnector = Oci.DataSafe.GetOnpremConnector.Invoke(new()
    {
        OnPremConnectorId = testOnPremConnectorOciDataSafeOnPremConnector.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.DataSafeFunctions;
import com.pulumi.oci.DataSafe.inputs.GetOnpremConnectorArgs;
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 testOnPremConnector = DataSafeFunctions.getOnpremConnector(GetOnpremConnectorArgs.builder()
            .onPremConnectorId(testOnPremConnectorOciDataSafeOnPremConnector.id())
            .build());

    }
}
Copy
variables:
  testOnPremConnector:
    fn::invoke:
      function: oci:DataSafe:getOnpremConnector
      arguments:
        onPremConnectorId: ${testOnPremConnectorOciDataSafeOnPremConnector.id}
Copy

Using getOnpremConnector

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 getOnpremConnector(args: GetOnpremConnectorArgs, opts?: InvokeOptions): Promise<GetOnpremConnectorResult>
function getOnpremConnectorOutput(args: GetOnpremConnectorOutputArgs, opts?: InvokeOptions): Output<GetOnpremConnectorResult>
Copy
def get_onprem_connector(on_prem_connector_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetOnpremConnectorResult
def get_onprem_connector_output(on_prem_connector_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetOnpremConnectorResult]
Copy
func GetOnpremConnector(ctx *Context, args *GetOnpremConnectorArgs, opts ...InvokeOption) (*GetOnpremConnectorResult, error)
func GetOnpremConnectorOutput(ctx *Context, args *GetOnpremConnectorOutputArgs, opts ...InvokeOption) GetOnpremConnectorResultOutput
Copy

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

public static class GetOnpremConnector 
{
    public static Task<GetOnpremConnectorResult> InvokeAsync(GetOnpremConnectorArgs args, InvokeOptions? opts = null)
    public static Output<GetOnpremConnectorResult> Invoke(GetOnpremConnectorInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOnpremConnectorResult> getOnpremConnector(GetOnpremConnectorArgs args, InvokeOptions options)
public static Output<GetOnpremConnectorResult> getOnpremConnector(GetOnpremConnectorArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:DataSafe/getOnpremConnector:getOnpremConnector
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

OnPremConnectorId This property is required. string
The OCID of the on-premises connector.
OnPremConnectorId This property is required. string
The OCID of the on-premises connector.
onPremConnectorId This property is required. String
The OCID of the on-premises connector.
onPremConnectorId This property is required. string
The OCID of the on-premises connector.
on_prem_connector_id This property is required. str
The OCID of the on-premises connector.
onPremConnectorId This property is required. String
The OCID of the on-premises connector.

getOnpremConnector Result

The following output properties are available:

AvailableVersion string
Latest available version of the on-premises connector.
CompartmentId string
The OCID of the compartment that contains the on-premises connector.
CreatedVersion string
Created version of the on-premises connector.
DefinedTags Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
Description string
The description of the on-premises connector.
DisplayName string
The display name of the on-premises connector.
FreeformTags Dictionary<string, string>
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 OCID of the on-premises connector.
LifecycleDetails string
Details about the current state of the on-premises connector.
OnPremConnectorId string
State string
The current state of the on-premises connector.
SystemTags Dictionary<string, string>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The date and time the on-premises connector was created, in the format defined by RFC3339.
AvailableVersion string
Latest available version of the on-premises connector.
CompartmentId string
The OCID of the compartment that contains the on-premises connector.
CreatedVersion string
Created version of the on-premises connector.
DefinedTags map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
Description string
The description of the on-premises connector.
DisplayName string
The display name of the on-premises connector.
FreeformTags map[string]string
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 OCID of the on-premises connector.
LifecycleDetails string
Details about the current state of the on-premises connector.
OnPremConnectorId string
State string
The current state of the on-premises connector.
SystemTags map[string]string
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The date and time the on-premises connector was created, in the format defined by RFC3339.
availableVersion String
Latest available version of the on-premises connector.
compartmentId String
The OCID of the compartment that contains the on-premises connector.
createdVersion String
Created version of the on-premises connector.
definedTags Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description String
The description of the on-premises connector.
displayName String
The display name of the on-premises connector.
freeformTags Map<String,String>
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 OCID of the on-premises connector.
lifecycleDetails String
Details about the current state of the on-premises connector.
onPremConnectorId String
state String
The current state of the on-premises connector.
systemTags Map<String,String>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The date and time the on-premises connector was created, in the format defined by RFC3339.
availableVersion string
Latest available version of the on-premises connector.
compartmentId string
The OCID of the compartment that contains the on-premises connector.
createdVersion string
Created version of the on-premises connector.
definedTags {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description string
The description of the on-premises connector.
displayName string
The display name of the on-premises connector.
freeformTags {[key: string]: string}
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 OCID of the on-premises connector.
lifecycleDetails string
Details about the current state of the on-premises connector.
onPremConnectorId string
state string
The current state of the on-premises connector.
systemTags {[key: string]: string}
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
The date and time the on-premises connector was created, in the format defined by RFC3339.
available_version str
Latest available version of the on-premises connector.
compartment_id str
The OCID of the compartment that contains the on-premises connector.
created_version str
Created version of the on-premises connector.
defined_tags Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description str
The description of the on-premises connector.
display_name str
The display name of the on-premises connector.
freeform_tags Mapping[str, str]
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 OCID of the on-premises connector.
lifecycle_details str
Details about the current state of the on-premises connector.
on_prem_connector_id str
state str
The current state of the on-premises connector.
system_tags Mapping[str, str]
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
The date and time the on-premises connector was created, in the format defined by RFC3339.
availableVersion String
Latest available version of the on-premises connector.
compartmentId String
The OCID of the compartment that contains the on-premises connector.
createdVersion String
Created version of the on-premises connector.
definedTags Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description String
The description of the on-premises connector.
displayName String
The display name of the on-premises connector.
freeformTags Map<String>
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 OCID of the on-premises connector.
lifecycleDetails String
Details about the current state of the on-premises connector.
onPremConnectorId String
state String
The current state of the on-premises connector.
systemTags Map<String>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The date and time the on-premises connector was created, in the format defined by RFC3339.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci