OutboundNetworkConnection

Represents a private connection between a Salesforce org and a third-party data service. The connection is outbound because the callouts are going out of Salesforce. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

OutboundNetworkConnection components have the suffix .outboundNetworkConnection and are stored in the outboundNetworkConnections folder.

Version

OutboundNetworkConnection components are available in API version 49.0 and later.

Fields

Field Name	Field Type	Description
connectionType	ExternalConnectionType (enumeration of type string)	Required. Specifies the cloud provider of the connection. `AwsPrivateLink` `DataCloudPrivateConnection` (Reserved for internal use)
description	string	A description of the connection. Maximum of 255 characters.
isActive	boolean	Required. Specifies whether the connection is active (`true`) or not (`false`).
label	string	Required. A user-friendly label for the connection.
outboundNetworkConnProperties	OutboundNetworkConnProperty[]	Name-value pairs that describe the properties of an outbound network connection. Specify a name-value pair for each of the properties.
status	ExternalConnectionStatus(enumeration of type string)	Required. Connection status. The connection is initially Unprovisioned and moves through the other statuses automatically after an admin performs a Provision, Sync, or Teardown action. The valid values are: `Unprovisioned` `Allocation` `PendingAcceptance` `PendingActivation` `RejectedRemotely` `DeletedRemotely` `TeardownInProgress` `Ready`

OutboundNetworkConnProperty

Represents a name-value pair that describes the properties of an outbound network connection.

Field Name	Field Type	Description
propertyName	OutboundConnPropertyName(enumeration of type string)	Required. The name of a property used to establish to an OutboundNetworkConnection. Valid values are: `AwsVpcEndpointId`—The unique endpoint ID provided by Salesforce after an outbound AwsPrivateLink is created. The value is read-only when the status is `Ready`. `AwsVpcEndpointServiceName`—The name of the customer’s endpoint service running in an AWS VPC that’s used for private connections with Salesforce. `Region`—The region in which the VPC is hosted. Enumerated values `DataCloudPrivateNetwork*` are reserved for internal use.
propertyValue	`string`	Required. The value of OutboundConnPropertyName. For example, the propertyValue of `Region` can be `us-west-2.`

Declarative Metadata Sample Definition

The following sample definition has the suffix .outboundNetworkConnection.

1<?xml version="1.0" encoding="UTF-8"?>
2<OutboundNetworkConnection xmlns="http://soap.sforce.com/2006/04/metadata">
3    <connectionType>AwsPrivateLink</connectionType>
4    <description>Outbound Connection to make a callout to a Service deployed in AWS VPC</description>
5    <isActive>true</isActive>
6    <label>MyOutboundConnection</label>
7    <outboundNetworkConnProperties>
8        <propertyName>Region</propertyName>
9        <propertyValue>us-west-2</propertyValue>
10    </outboundNetworkConnProperties>
11    <outboundNetworkConnProperties>
12        <propertyName>AwsVpcEndpointServiceName</propertyName>
13        <propertyValue>com.amazonaws.vpce.us-west-2.vpce-svc-00d7bd6285c123b4c</propertyValue>
14    </outboundNetworkConnProperties>
15    <status>Unprovisioned</status>
16</OutboundNetworkConnection>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fullName>sampleOutboundConnection</fullName>
4    <types>
5        <members>MyOutboundConnection</members>
6        <name>OutboundNetworkConnection</name>
7    </types>
8    <version>49.0</version>
9</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide