1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. GenerateOnPremConnectorConfiguration
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.DataSafe.GenerateOnPremConnectorConfiguration

Explore with Pulumi AI

This resource provides the Generate On Prem Connector Configuration resource in Oracle Cloud Infrastructure Data Safe service.

Creates and downloads the configuration of the specified on-premises connector.

Example Usage

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

const testGenerateOnPremConnectorConfiguration = new oci.datasafe.GenerateOnPremConnectorConfiguration("test_generate_on_prem_connector_configuration", {
    onPremConnectorId: testOnPremConnector.id,
    password: generateOnPremConnectorConfigurationPassword,
});
Copy
import pulumi
import pulumi_oci as oci

test_generate_on_prem_connector_configuration = oci.data_safe.GenerateOnPremConnectorConfiguration("test_generate_on_prem_connector_configuration",
    on_prem_connector_id=test_on_prem_connector["id"],
    password=generate_on_prem_connector_configuration_password)
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.NewGenerateOnPremConnectorConfiguration(ctx, "test_generate_on_prem_connector_configuration", &datasafe.GenerateOnPremConnectorConfigurationArgs{
			OnPremConnectorId: pulumi.Any(testOnPremConnector.Id),
			Password:          pulumi.Any(generateOnPremConnectorConfigurationPassword),
		})
		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 testGenerateOnPremConnectorConfiguration = new Oci.DataSafe.GenerateOnPremConnectorConfiguration("test_generate_on_prem_connector_configuration", new()
    {
        OnPremConnectorId = testOnPremConnector.Id,
        Password = generateOnPremConnectorConfigurationPassword,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.GenerateOnPremConnectorConfiguration;
import com.pulumi.oci.DataSafe.GenerateOnPremConnectorConfigurationArgs;
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 testGenerateOnPremConnectorConfiguration = new GenerateOnPremConnectorConfiguration("testGenerateOnPremConnectorConfiguration", GenerateOnPremConnectorConfigurationArgs.builder()
            .onPremConnectorId(testOnPremConnector.id())
            .password(generateOnPremConnectorConfigurationPassword)
            .build());

    }
}
Copy
resources:
  testGenerateOnPremConnectorConfiguration:
    type: oci:DataSafe:GenerateOnPremConnectorConfiguration
    name: test_generate_on_prem_connector_configuration
    properties:
      onPremConnectorId: ${testOnPremConnector.id}
      password: ${generateOnPremConnectorConfigurationPassword}
Copy

Create GenerateOnPremConnectorConfiguration Resource

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

Constructor syntax

new GenerateOnPremConnectorConfiguration(name: string, args: GenerateOnPremConnectorConfigurationArgs, opts?: CustomResourceOptions);
@overload
def GenerateOnPremConnectorConfiguration(resource_name: str,
                                         args: GenerateOnPremConnectorConfigurationArgs,
                                         opts: Optional[ResourceOptions] = None)

@overload
def GenerateOnPremConnectorConfiguration(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         on_prem_connector_id: Optional[str] = None,
                                         password: Optional[str] = None)
func NewGenerateOnPremConnectorConfiguration(ctx *Context, name string, args GenerateOnPremConnectorConfigurationArgs, opts ...ResourceOption) (*GenerateOnPremConnectorConfiguration, error)
public GenerateOnPremConnectorConfiguration(string name, GenerateOnPremConnectorConfigurationArgs args, CustomResourceOptions? opts = null)
public GenerateOnPremConnectorConfiguration(String name, GenerateOnPremConnectorConfigurationArgs args)
public GenerateOnPremConnectorConfiguration(String name, GenerateOnPremConnectorConfigurationArgs args, CustomResourceOptions options)
type: oci:DataSafe:GenerateOnPremConnectorConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GenerateOnPremConnectorConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GenerateOnPremConnectorConfigurationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GenerateOnPremConnectorConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GenerateOnPremConnectorConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GenerateOnPremConnectorConfigurationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var generateOnPremConnectorConfigurationResource = new Oci.DataSafe.GenerateOnPremConnectorConfiguration("generateOnPremConnectorConfigurationResource", new()
{
    OnPremConnectorId = "string",
    Password = "string",
});
Copy
example, err := DataSafe.NewGenerateOnPremConnectorConfiguration(ctx, "generateOnPremConnectorConfigurationResource", &DataSafe.GenerateOnPremConnectorConfigurationArgs{
	OnPremConnectorId: pulumi.String("string"),
	Password:          pulumi.String("string"),
})
Copy
var generateOnPremConnectorConfigurationResource = new GenerateOnPremConnectorConfiguration("generateOnPremConnectorConfigurationResource", GenerateOnPremConnectorConfigurationArgs.builder()
    .onPremConnectorId("string")
    .password("string")
    .build());
Copy
generate_on_prem_connector_configuration_resource = oci.data_safe.GenerateOnPremConnectorConfiguration("generateOnPremConnectorConfigurationResource",
    on_prem_connector_id="string",
    password="string")
Copy
const generateOnPremConnectorConfigurationResource = new oci.datasafe.GenerateOnPremConnectorConfiguration("generateOnPremConnectorConfigurationResource", {
    onPremConnectorId: "string",
    password: "string",
});
Copy
type: oci:DataSafe:GenerateOnPremConnectorConfiguration
properties:
    onPremConnectorId: string
    password: string
Copy

GenerateOnPremConnectorConfiguration Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GenerateOnPremConnectorConfiguration resource accepts the following input properties:

OnPremConnectorId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the on-premises connector.
Password
This property is required.
Changes to this property will trigger replacement.
string

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

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

OnPremConnectorId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the on-premises connector.
Password
This property is required.
Changes to this property will trigger replacement.
string

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

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

onPremConnectorId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the on-premises connector.
password
This property is required.
Changes to this property will trigger replacement.
String

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

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

onPremConnectorId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the on-premises connector.
password
This property is required.
Changes to this property will trigger replacement.
string

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

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

on_prem_connector_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the on-premises connector.
password
This property is required.
Changes to this property will trigger replacement.
str

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

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

onPremConnectorId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the on-premises connector.
password
This property is required.
Changes to this property will trigger replacement.
String

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

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

Outputs

All input properties are implicitly available as output properties. Additionally, the GenerateOnPremConnectorConfiguration resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing GenerateOnPremConnectorConfiguration Resource

Get an existing GenerateOnPremConnectorConfiguration 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?: GenerateOnPremConnectorConfigurationState, opts?: CustomResourceOptions): GenerateOnPremConnectorConfiguration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        on_prem_connector_id: Optional[str] = None,
        password: Optional[str] = None) -> GenerateOnPremConnectorConfiguration
func GetGenerateOnPremConnectorConfiguration(ctx *Context, name string, id IDInput, state *GenerateOnPremConnectorConfigurationState, opts ...ResourceOption) (*GenerateOnPremConnectorConfiguration, error)
public static GenerateOnPremConnectorConfiguration Get(string name, Input<string> id, GenerateOnPremConnectorConfigurationState? state, CustomResourceOptions? opts = null)
public static GenerateOnPremConnectorConfiguration get(String name, Output<String> id, GenerateOnPremConnectorConfigurationState state, CustomResourceOptions options)
resources:  _:    type: oci:DataSafe:GenerateOnPremConnectorConfiguration    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
OnPremConnectorId Changes to this property will trigger replacement. string
The OCID of the on-premises connector.
Password Changes to this property will trigger replacement. string

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

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

OnPremConnectorId Changes to this property will trigger replacement. string
The OCID of the on-premises connector.
Password Changes to this property will trigger replacement. string

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

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

onPremConnectorId Changes to this property will trigger replacement. String
The OCID of the on-premises connector.
password Changes to this property will trigger replacement. String

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

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

onPremConnectorId Changes to this property will trigger replacement. string
The OCID of the on-premises connector.
password Changes to this property will trigger replacement. string

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

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

on_prem_connector_id Changes to this property will trigger replacement. str
The OCID of the on-premises connector.
password Changes to this property will trigger replacement. str

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

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

onPremConnectorId Changes to this property will trigger replacement. String
The OCID of the on-premises connector.
password Changes to this property will trigger replacement. String

The password to encrypt the keys inside the wallet included as part of the configuration. The password must be between 12 and 30 characters long and must contain atleast 1 uppercase, 1 lowercase, 1 numeric, and 1 special character.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Import

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

$ pulumi import oci:DataSafe/generateOnPremConnectorConfiguration:GenerateOnPremConnectorConfiguration test_generate_on_prem_connector_configuration "id"
Copy

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.