Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FileStorage
  5. OutboundConnector
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

oci.FileStorage.OutboundConnector

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Outbound Connector resource in Oracle Cloud Infrastructure File Storage service.

Creates a new outbound connector in the specified compartment. You can associate an outbound connector with a mount target only when they exist in the same availability domain.

For information about access control and compartments, see Overview of the IAM Service.

For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API.

All Oracle Cloud Infrastructure Services resources, including outbound connectors, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

Example Usage

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

const testOutboundConnector = new oci.filestorage.OutboundConnector("test_outbound_connector", {
    availabilityDomain: outboundConnectorAvailabilityDomain,
    bindDistinguishedName: outboundConnectorBindDistinguishedName,
    compartmentId: compartmentId,
    connectorType: outboundConnectorConnectorType,
    endpoints: [{
        hostname: outboundConnectorEndpointsHostname,
        port: outboundConnectorEndpointsPort,
    }],
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: outboundConnectorDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    locks: [{
        type: outboundConnectorLocksType,
        message: outboundConnectorLocksMessage,
        relatedResourceId: testResource.id,
        timeCreated: outboundConnectorLocksTimeCreated,
    }],
    passwordSecretId: testSecret.id,
    passwordSecretVersion: outboundConnectorPasswordSecretVersion,
});
Copy
import pulumi
import pulumi_oci as oci

test_outbound_connector = oci.file_storage.OutboundConnector("test_outbound_connector",
    availability_domain=outbound_connector_availability_domain,
    bind_distinguished_name=outbound_connector_bind_distinguished_name,
    compartment_id=compartment_id,
    connector_type=outbound_connector_connector_type,
    endpoints=[{
        "hostname": outbound_connector_endpoints_hostname,
        "port": outbound_connector_endpoints_port,
    }],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=outbound_connector_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    locks=[{
        "type": outbound_connector_locks_type,
        "message": outbound_connector_locks_message,
        "related_resource_id": test_resource["id"],
        "time_created": outbound_connector_locks_time_created,
    }],
    password_secret_id=test_secret["id"],
    password_secret_version=outbound_connector_password_secret_version)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filestorage.NewOutboundConnector(ctx, "test_outbound_connector", &filestorage.OutboundConnectorArgs{
			AvailabilityDomain:    pulumi.Any(outboundConnectorAvailabilityDomain),
			BindDistinguishedName: pulumi.Any(outboundConnectorBindDistinguishedName),
			CompartmentId:         pulumi.Any(compartmentId),
			ConnectorType:         pulumi.Any(outboundConnectorConnectorType),
			Endpoints: filestorage.OutboundConnectorEndpointArray{
				&filestorage.OutboundConnectorEndpointArgs{
					Hostname: pulumi.Any(outboundConnectorEndpointsHostname),
					Port:     pulumi.Any(outboundConnectorEndpointsPort),
				},
			},
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(outboundConnectorDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			Locks: filestorage.OutboundConnectorLockArray{
				&filestorage.OutboundConnectorLockArgs{
					Type:              pulumi.Any(outboundConnectorLocksType),
					Message:           pulumi.Any(outboundConnectorLocksMessage),
					RelatedResourceId: pulumi.Any(testResource.Id),
					TimeCreated:       pulumi.Any(outboundConnectorLocksTimeCreated),
				},
			},
			PasswordSecretId:      pulumi.Any(testSecret.Id),
			PasswordSecretVersion: pulumi.Any(outboundConnectorPasswordSecretVersion),
		})
		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 testOutboundConnector = new Oci.FileStorage.OutboundConnector("test_outbound_connector", new()
    {
        AvailabilityDomain = outboundConnectorAvailabilityDomain,
        BindDistinguishedName = outboundConnectorBindDistinguishedName,
        CompartmentId = compartmentId,
        ConnectorType = outboundConnectorConnectorType,
        Endpoints = new[]
        {
            new Oci.FileStorage.Inputs.OutboundConnectorEndpointArgs
            {
                Hostname = outboundConnectorEndpointsHostname,
                Port = outboundConnectorEndpointsPort,
            },
        },
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = outboundConnectorDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        Locks = new[]
        {
            new Oci.FileStorage.Inputs.OutboundConnectorLockArgs
            {
                Type = outboundConnectorLocksType,
                Message = outboundConnectorLocksMessage,
                RelatedResourceId = testResource.Id,
                TimeCreated = outboundConnectorLocksTimeCreated,
            },
        },
        PasswordSecretId = testSecret.Id,
        PasswordSecretVersion = outboundConnectorPasswordSecretVersion,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FileStorage.OutboundConnector;
import com.pulumi.oci.FileStorage.OutboundConnectorArgs;
import com.pulumi.oci.FileStorage.inputs.OutboundConnectorEndpointArgs;
import com.pulumi.oci.FileStorage.inputs.OutboundConnectorLockArgs;
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 testOutboundConnector = new OutboundConnector("testOutboundConnector", OutboundConnectorArgs.builder()
            .availabilityDomain(outboundConnectorAvailabilityDomain)
            .bindDistinguishedName(outboundConnectorBindDistinguishedName)
            .compartmentId(compartmentId)
            .connectorType(outboundConnectorConnectorType)
            .endpoints(OutboundConnectorEndpointArgs.builder()
                .hostname(outboundConnectorEndpointsHostname)
                .port(outboundConnectorEndpointsPort)
                .build())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(outboundConnectorDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .locks(OutboundConnectorLockArgs.builder()
                .type(outboundConnectorLocksType)
                .message(outboundConnectorLocksMessage)
                .relatedResourceId(testResource.id())
                .timeCreated(outboundConnectorLocksTimeCreated)
                .build())
            .passwordSecretId(testSecret.id())
            .passwordSecretVersion(outboundConnectorPasswordSecretVersion)
            .build());

    }
}
Copy
resources:
  testOutboundConnector:
    type: oci:FileStorage:OutboundConnector
    name: test_outbound_connector
    properties:
      availabilityDomain: ${outboundConnectorAvailabilityDomain}
      bindDistinguishedName: ${outboundConnectorBindDistinguishedName}
      compartmentId: ${compartmentId}
      connectorType: ${outboundConnectorConnectorType}
      endpoints:
        - hostname: ${outboundConnectorEndpointsHostname}
          port: ${outboundConnectorEndpointsPort}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${outboundConnectorDisplayName}
      freeformTags:
        Department: Finance
      locks:
        - type: ${outboundConnectorLocksType}
          message: ${outboundConnectorLocksMessage}
          relatedResourceId: ${testResource.id}
          timeCreated: ${outboundConnectorLocksTimeCreated}
      passwordSecretId: ${testSecret.id}
      passwordSecretVersion: ${outboundConnectorPasswordSecretVersion}
Copy

Create OutboundConnector Resource

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

Constructor syntax

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

@overload
def OutboundConnector(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      availability_domain: Optional[str] = None,
                      bind_distinguished_name: Optional[str] = None,
                      compartment_id: Optional[str] = None,
                      connector_type: Optional[str] = None,
                      endpoints: Optional[Sequence[_filestorage.OutboundConnectorEndpointArgs]] = None,
                      defined_tags: Optional[Mapping[str, str]] = None,
                      display_name: Optional[str] = None,
                      freeform_tags: Optional[Mapping[str, str]] = None,
                      is_lock_override: Optional[bool] = None,
                      locks: Optional[Sequence[_filestorage.OutboundConnectorLockArgs]] = None,
                      password_secret_id: Optional[str] = None,
                      password_secret_version: Optional[int] = None)
func NewOutboundConnector(ctx *Context, name string, args OutboundConnectorArgs, opts ...ResourceOption) (*OutboundConnector, error)
public OutboundConnector(string name, OutboundConnectorArgs args, CustomResourceOptions? opts = null)
public OutboundConnector(String name, OutboundConnectorArgs args)
public OutboundConnector(String name, OutboundConnectorArgs args, CustomResourceOptions options)

type: oci:FileStorage:OutboundConnector
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. OutboundConnectorArgs
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. OutboundConnectorArgs
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. OutboundConnectorArgs
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. OutboundConnectorArgs
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. OutboundConnectorArgs
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 outboundConnectorResource = new Oci.FileStorage.OutboundConnector("outboundConnectorResource", new()
{
    AvailabilityDomain = "string",
    BindDistinguishedName = "string",
    CompartmentId = "string",
    ConnectorType = "string",
    Endpoints = new[]
    {
        new Oci.FileStorage.Inputs.OutboundConnectorEndpointArgs
        {
            Hostname = "string",
            Port = "string",
        },
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsLockOverride = false,
    Locks = new[]
    {
        new Oci.FileStorage.Inputs.OutboundConnectorLockArgs
        {
            Type = "string",
            Message = "string",
            RelatedResourceId = "string",
            TimeCreated = "string",
        },
    },
    PasswordSecretId = "string",
    PasswordSecretVersion = 0,
});
Copy
example, err := FileStorage.NewOutboundConnector(ctx, "outboundConnectorResource", &FileStorage.OutboundConnectorArgs{
	AvailabilityDomain:    pulumi.String("string"),
	BindDistinguishedName: pulumi.String("string"),
	CompartmentId:         pulumi.String("string"),
	ConnectorType:         pulumi.String("string"),
	Endpoints: filestorage.OutboundConnectorEndpointArray{
		&filestorage.OutboundConnectorEndpointArgs{
			Hostname: pulumi.String("string"),
			Port:     pulumi.String("string"),
		},
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsLockOverride: pulumi.Bool(false),
	Locks: filestorage.OutboundConnectorLockArray{
		&filestorage.OutboundConnectorLockArgs{
			Type:              pulumi.String("string"),
			Message:           pulumi.String("string"),
			RelatedResourceId: pulumi.String("string"),
			TimeCreated:       pulumi.String("string"),
		},
	},
	PasswordSecretId:      pulumi.String("string"),
	PasswordSecretVersion: pulumi.Int(0),
})
Copy
var outboundConnectorResource = new OutboundConnector("outboundConnectorResource", OutboundConnectorArgs.builder()
    .availabilityDomain("string")
    .bindDistinguishedName("string")
    .compartmentId("string")
    .connectorType("string")
    .endpoints(OutboundConnectorEndpointArgs.builder()
        .hostname("string")
        .port("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .isLockOverride(false)
    .locks(OutboundConnectorLockArgs.builder()
        .type("string")
        .message("string")
        .relatedResourceId("string")
        .timeCreated("string")
        .build())
    .passwordSecretId("string")
    .passwordSecretVersion(0)
    .build());
Copy
outbound_connector_resource = oci.file_storage.OutboundConnector("outboundConnectorResource",
    availability_domain="string",
    bind_distinguished_name="string",
    compartment_id="string",
    connector_type="string",
    endpoints=[{
        "hostname": "string",
        "port": "string",
    }],
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    is_lock_override=False,
    locks=[{
        "type": "string",
        "message": "string",
        "related_resource_id": "string",
        "time_created": "string",
    }],
    password_secret_id="string",
    password_secret_version=0)
Copy
const outboundConnectorResource = new oci.filestorage.OutboundConnector("outboundConnectorResource", {
    availabilityDomain: "string",
    bindDistinguishedName: "string",
    compartmentId: "string",
    connectorType: "string",
    endpoints: [{
        hostname: "string",
        port: "string",
    }],
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    isLockOverride: false,
    locks: [{
        type: "string",
        message: "string",
        relatedResourceId: "string",
        timeCreated: "string",
    }],
    passwordSecretId: "string",
    passwordSecretVersion: 0,
});
Copy
type: oci:FileStorage:OutboundConnector
properties:
    availabilityDomain: string
    bindDistinguishedName: string
    compartmentId: string
    connectorType: string
    definedTags:
        string: string
    displayName: string
    endpoints:
        - hostname: string
          port: string
    freeformTags:
        string: string
    isLockOverride: false
    locks:
        - message: string
          relatedResourceId: string
          timeCreated: string
          type: string
    passwordSecretId: string
    passwordSecretVersion: 0
Copy

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

AvailabilityDomain
This property is required.
Changes to this property will trigger replacement.
string
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
BindDistinguishedName
This property is required.
Changes to this property will trigger replacement.
string
The LDAP Distinguished Name of the bind account.
CompartmentId This property is required. string
(Updatable) The OCID of the compartment that contains the outbound connector.
ConnectorType
This property is required.
Changes to this property will trigger replacement.
string
The account type of this outbound connector.
Endpoints
This property is required.
Changes to this property will trigger replacement.
List<OutboundConnectorEndpoint>
Array of server endpoints to use when connecting with the LDAP bind account.
DefinedTags Dictionary<string, string>
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
FreeformTags Dictionary<string, string>
(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"}
IsLockOverride bool
Locks Changes to this property will trigger replacement. List<OutboundConnectorLock>
Locks associated with this resource.
PasswordSecretId Changes to this property will trigger replacement. string
The OCID of the password for the LDAP bind account in the Vault.
PasswordSecretVersion Changes to this property will trigger replacement. int

Version of the password secret in the Vault to use.

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

AvailabilityDomain
This property is required.
Changes to this property will trigger replacement.
string
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
BindDistinguishedName
This property is required.
Changes to this property will trigger replacement.
string
The LDAP Distinguished Name of the bind account.
CompartmentId This property is required. string
(Updatable) The OCID of the compartment that contains the outbound connector.
ConnectorType
This property is required.
Changes to this property will trigger replacement.
string
The account type of this outbound connector.
Endpoints
This property is required.
Changes to this property will trigger replacement.
[]OutboundConnectorEndpointArgs
Array of server endpoints to use when connecting with the LDAP bind account.
DefinedTags map[string]string
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
FreeformTags map[string]string
(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"}
IsLockOverride bool
Locks Changes to this property will trigger replacement. []OutboundConnectorLockArgs
Locks associated with this resource.
PasswordSecretId Changes to this property will trigger replacement. string
The OCID of the password for the LDAP bind account in the Vault.
PasswordSecretVersion Changes to this property will trigger replacement. int

Version of the password secret in the Vault to use.

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

availabilityDomain
This property is required.
Changes to this property will trigger replacement.
String
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
bindDistinguishedName
This property is required.
Changes to this property will trigger replacement.
String
The LDAP Distinguished Name of the bind account.
compartmentId This property is required. String
(Updatable) The OCID of the compartment that contains the outbound connector.
connectorType
This property is required.
Changes to this property will trigger replacement.
String
The account type of this outbound connector.
endpoints
This property is required.
Changes to this property will trigger replacement.
List<OutboundConnectorEndpoint>
Array of server endpoints to use when connecting with the LDAP bind account.
definedTags Map<String,String>
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
freeformTags Map<String,String>
(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"}
isLockOverride Boolean
locks Changes to this property will trigger replacement. List<OutboundConnectorLock>
Locks associated with this resource.
passwordSecretId Changes to this property will trigger replacement. String
The OCID of the password for the LDAP bind account in the Vault.
passwordSecretVersion Changes to this property will trigger replacement. Integer

Version of the password secret in the Vault to use.

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

availabilityDomain
This property is required.
Changes to this property will trigger replacement.
string
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
bindDistinguishedName
This property is required.
Changes to this property will trigger replacement.
string
The LDAP Distinguished Name of the bind account.
compartmentId This property is required. string
(Updatable) The OCID of the compartment that contains the outbound connector.
connectorType
This property is required.
Changes to this property will trigger replacement.
string
The account type of this outbound connector.
endpoints
This property is required.
Changes to this property will trigger replacement.
OutboundConnectorEndpoint[]
Array of server endpoints to use when connecting with the LDAP bind account.
definedTags {[key: string]: string}
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
freeformTags {[key: string]: string}
(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"}
isLockOverride boolean
locks Changes to this property will trigger replacement. OutboundConnectorLock[]
Locks associated with this resource.
passwordSecretId Changes to this property will trigger replacement. string
The OCID of the password for the LDAP bind account in the Vault.
passwordSecretVersion Changes to this property will trigger replacement. number

Version of the password secret in the Vault to use.

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

availability_domain
This property is required.
Changes to this property will trigger replacement.
str
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
bind_distinguished_name
This property is required.
Changes to this property will trigger replacement.
str
The LDAP Distinguished Name of the bind account.
compartment_id This property is required. str
(Updatable) The OCID of the compartment that contains the outbound connector.
connector_type
This property is required.
Changes to this property will trigger replacement.
str
The account type of this outbound connector.
endpoints
This property is required.
Changes to this property will trigger replacement.
Sequence[filestorage.OutboundConnectorEndpointArgs]
Array of server endpoints to use when connecting with the LDAP bind account.
defined_tags Mapping[str, str]
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
freeform_tags Mapping[str, str]
(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"}
is_lock_override bool
locks Changes to this property will trigger replacement. Sequence[filestorage.OutboundConnectorLockArgs]
Locks associated with this resource.
password_secret_id Changes to this property will trigger replacement. str
The OCID of the password for the LDAP bind account in the Vault.
password_secret_version Changes to this property will trigger replacement. int

Version of the password secret in the Vault to use.

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

availabilityDomain
This property is required.
Changes to this property will trigger replacement.
String
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
bindDistinguishedName
This property is required.
Changes to this property will trigger replacement.
String
The LDAP Distinguished Name of the bind account.
compartmentId This property is required. String
(Updatable) The OCID of the compartment that contains the outbound connector.
connectorType
This property is required.
Changes to this property will trigger replacement.
String
The account type of this outbound connector.
endpoints
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
Array of server endpoints to use when connecting with the LDAP bind account.
definedTags Map<String>
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
freeformTags Map<String>
(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"}
isLockOverride Boolean
locks Changes to this property will trigger replacement. List<Property Map>
Locks associated with this resource.
passwordSecretId Changes to this property will trigger replacement. String
The OCID of the password for the LDAP bind account in the Vault.
passwordSecretVersion Changes to this property will trigger replacement. Number

Version of the password secret in the Vault to use.

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

Id string
The provider-assigned unique ID for this managed resource.
State string
The current state of this outbound connector.
SystemTags Dictionary<string, string>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
Id string
The provider-assigned unique ID for this managed resource.
State string
The current state of this outbound connector.
SystemTags map[string]string
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
id String
The provider-assigned unique ID for this managed resource.
state String
The current state of this outbound connector.
systemTags Map<String,String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
id string
The provider-assigned unique ID for this managed resource.
state string
The current state of this outbound connector.
systemTags {[key: string]: string}
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated string
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
id str
The provider-assigned unique ID for this managed resource.
state str
The current state of this outbound connector.
system_tags Mapping[str, str]
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
time_created str
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
id String
The provider-assigned unique ID for this managed resource.
state String
The current state of this outbound connector.
systemTags Map<String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

Look up Existing OutboundConnector Resource

Get an existing OutboundConnector 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?: OutboundConnectorState, opts?: CustomResourceOptions): OutboundConnector
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_domain: Optional[str] = None,
        bind_distinguished_name: Optional[str] = None,
        compartment_id: Optional[str] = None,
        connector_type: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        endpoints: Optional[Sequence[_filestorage.OutboundConnectorEndpointArgs]] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_lock_override: Optional[bool] = None,
        locks: Optional[Sequence[_filestorage.OutboundConnectorLockArgs]] = None,
        password_secret_id: Optional[str] = None,
        password_secret_version: Optional[int] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None) -> OutboundConnector
func GetOutboundConnector(ctx *Context, name string, id IDInput, state *OutboundConnectorState, opts ...ResourceOption) (*OutboundConnector, error)
public static OutboundConnector Get(string name, Input<string> id, OutboundConnectorState? state, CustomResourceOptions? opts = null)
public static OutboundConnector get(String name, Output<String> id, OutboundConnectorState state, CustomResourceOptions options)
resources:  _:    type: oci:FileStorage:OutboundConnector    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:
AvailabilityDomain Changes to this property will trigger replacement. string
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
BindDistinguishedName Changes to this property will trigger replacement. string
The LDAP Distinguished Name of the bind account.
CompartmentId string
(Updatable) The OCID of the compartment that contains the outbound connector.
ConnectorType Changes to this property will trigger replacement. string
The account type of this outbound connector.
DefinedTags Dictionary<string, string>
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
Endpoints Changes to this property will trigger replacement. List<OutboundConnectorEndpoint>
Array of server endpoints to use when connecting with the LDAP bind account.
FreeformTags Dictionary<string, string>
(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"}
IsLockOverride bool
Locks Changes to this property will trigger replacement. List<OutboundConnectorLock>
Locks associated with this resource.
PasswordSecretId Changes to this property will trigger replacement. string
The OCID of the password for the LDAP bind account in the Vault.
PasswordSecretVersion Changes to this property will trigger replacement. int

Version of the password secret in the Vault to use.

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

State string
The current state of this outbound connector.
SystemTags Dictionary<string, string>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
AvailabilityDomain Changes to this property will trigger replacement. string
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
BindDistinguishedName Changes to this property will trigger replacement. string
The LDAP Distinguished Name of the bind account.
CompartmentId string
(Updatable) The OCID of the compartment that contains the outbound connector.
ConnectorType Changes to this property will trigger replacement. string
The account type of this outbound connector.
DefinedTags map[string]string
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
Endpoints Changes to this property will trigger replacement. []OutboundConnectorEndpointArgs
Array of server endpoints to use when connecting with the LDAP bind account.
FreeformTags map[string]string
(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"}
IsLockOverride bool
Locks Changes to this property will trigger replacement. []OutboundConnectorLockArgs
Locks associated with this resource.
PasswordSecretId Changes to this property will trigger replacement. string
The OCID of the password for the LDAP bind account in the Vault.
PasswordSecretVersion Changes to this property will trigger replacement. int

Version of the password secret in the Vault to use.

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

State string
The current state of this outbound connector.
SystemTags map[string]string
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
TimeCreated string
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
availabilityDomain Changes to this property will trigger replacement. String
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
bindDistinguishedName Changes to this property will trigger replacement. String
The LDAP Distinguished Name of the bind account.
compartmentId String
(Updatable) The OCID of the compartment that contains the outbound connector.
connectorType Changes to this property will trigger replacement. String
The account type of this outbound connector.
definedTags Map<String,String>
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
endpoints Changes to this property will trigger replacement. List<OutboundConnectorEndpoint>
Array of server endpoints to use when connecting with the LDAP bind account.
freeformTags Map<String,String>
(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"}
isLockOverride Boolean
locks Changes to this property will trigger replacement. List<OutboundConnectorLock>
Locks associated with this resource.
passwordSecretId Changes to this property will trigger replacement. String
The OCID of the password for the LDAP bind account in the Vault.
passwordSecretVersion Changes to this property will trigger replacement. Integer

Version of the password secret in the Vault to use.

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

state String
The current state of this outbound connector.
systemTags Map<String,String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
availabilityDomain Changes to this property will trigger replacement. string
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
bindDistinguishedName Changes to this property will trigger replacement. string
The LDAP Distinguished Name of the bind account.
compartmentId string
(Updatable) The OCID of the compartment that contains the outbound connector.
connectorType Changes to this property will trigger replacement. string
The account type of this outbound connector.
definedTags {[key: string]: string}
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
endpoints Changes to this property will trigger replacement. OutboundConnectorEndpoint[]
Array of server endpoints to use when connecting with the LDAP bind account.
freeformTags {[key: string]: string}
(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"}
isLockOverride boolean
locks Changes to this property will trigger replacement. OutboundConnectorLock[]
Locks associated with this resource.
passwordSecretId Changes to this property will trigger replacement. string
The OCID of the password for the LDAP bind account in the Vault.
passwordSecretVersion Changes to this property will trigger replacement. number

Version of the password secret in the Vault to use.

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

state string
The current state of this outbound connector.
systemTags {[key: string]: string}
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated string
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
availability_domain Changes to this property will trigger replacement. str
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
bind_distinguished_name Changes to this property will trigger replacement. str
The LDAP Distinguished Name of the bind account.
compartment_id str
(Updatable) The OCID of the compartment that contains the outbound connector.
connector_type Changes to this property will trigger replacement. str
The account type of this outbound connector.
defined_tags Mapping[str, str]
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
endpoints Changes to this property will trigger replacement. Sequence[filestorage.OutboundConnectorEndpointArgs]
Array of server endpoints to use when connecting with the LDAP bind account.
freeform_tags Mapping[str, str]
(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"}
is_lock_override bool
locks Changes to this property will trigger replacement. Sequence[filestorage.OutboundConnectorLockArgs]
Locks associated with this resource.
password_secret_id Changes to this property will trigger replacement. str
The OCID of the password for the LDAP bind account in the Vault.
password_secret_version Changes to this property will trigger replacement. int

Version of the password secret in the Vault to use.

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

state str
The current state of this outbound connector.
system_tags Mapping[str, str]
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
time_created str
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
availabilityDomain Changes to this property will trigger replacement. String
The availability domain the outbound connector is in. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-1
bindDistinguishedName Changes to this property will trigger replacement. String
The LDAP Distinguished Name of the bind account.
compartmentId String
(Updatable) The OCID of the compartment that contains the outbound connector.
connectorType Changes to this property will trigger replacement. String
The account type of this outbound connector.
definedTags Map<String>
(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. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: My outbound connector
endpoints Changes to this property will trigger replacement. List<Property Map>
Array of server endpoints to use when connecting with the LDAP bind account.
freeformTags Map<String>
(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"}
isLockOverride Boolean
locks Changes to this property will trigger replacement. List<Property Map>
Locks associated with this resource.
passwordSecretId Changes to this property will trigger replacement. String
The OCID of the password for the LDAP bind account in the Vault.
passwordSecretVersion Changes to this property will trigger replacement. Number

Version of the password secret in the Vault to use.

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

state String
The current state of this outbound connector.
systemTags Map<String>
System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services.
timeCreated String
The date and time the outbound connector was created in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

Supporting Types

OutboundConnectorEndpoint
, OutboundConnectorEndpointArgs

Hostname
This property is required.
Changes to this property will trigger replacement.
string
Name of the DNS server.
Port
This property is required.
Changes to this property will trigger replacement.
string
Port of the DNS server.
Hostname
This property is required.
Changes to this property will trigger replacement.
string
Name of the DNS server.
Port
This property is required.
Changes to this property will trigger replacement.
string
Port of the DNS server.
hostname
This property is required.
Changes to this property will trigger replacement.
String
Name of the DNS server.
port
This property is required.
Changes to this property will trigger replacement.
String
Port of the DNS server.
hostname
This property is required.
Changes to this property will trigger replacement.
string
Name of the DNS server.
port
This property is required.
Changes to this property will trigger replacement.
string
Port of the DNS server.
hostname
This property is required.
Changes to this property will trigger replacement.
str
Name of the DNS server.
port
This property is required.
Changes to this property will trigger replacement.
str
Port of the DNS server.
hostname
This property is required.
Changes to this property will trigger replacement.
String
Name of the DNS server.
port
This property is required.
Changes to this property will trigger replacement.
String
Port of the DNS server.

OutboundConnectorLock
, OutboundConnectorLockArgs

Type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
Message Changes to this property will trigger replacement. string
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId Changes to this property will trigger replacement. string
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated Changes to this property will trigger replacement. string
When the lock was created.
Type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
Message Changes to this property will trigger replacement. string
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId Changes to this property will trigger replacement. string
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated Changes to this property will trigger replacement. string
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of the lock.
message Changes to this property will trigger replacement. String
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId Changes to this property will trigger replacement. String
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated Changes to this property will trigger replacement. String
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
message Changes to this property will trigger replacement. string
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId Changes to this property will trigger replacement. string
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated Changes to this property will trigger replacement. string
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
str
Type of the lock.
message Changes to this property will trigger replacement. str
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
related_resource_id Changes to this property will trigger replacement. str
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created Changes to this property will trigger replacement. str
When the lock was created.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of the lock.
message Changes to this property will trigger replacement. String
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId Changes to this property will trigger replacement. String
The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated Changes to this property will trigger replacement. String
When the lock was created.

Import

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

$ pulumi import oci:FileStorage/outboundConnector:OutboundConnector test_outbound_connector "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.
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci