---
schema_version: "1"
id: ab50276529ba30cb725fc73484fa2969ede5035ed193c0c2824936df466c3ce3
title: OutboundNetworkConnection
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_outboundnetworkconnection.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_outboundnetworkconnection.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 4931aa6de9def1ed23edcc08a8e35ae50c3070d813c5b3a3b676c8998b6e3aa6
description: 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.
---
# 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

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d726698e87">Field Name</th>

              <th class="featureTableHeader  " id="d726698e90">Field Type</th>

              <th class="featureTableHeader  " id="d726698e93">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">connectionType</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">ExternalConnectionType (enumeration of type string)</td>

              <td class="entry" headers="d726698e93" data-title="Description">Required. Specifies the cloud provider of the connection. <a name="ul_hly_52w_sdc"><!-- --></a>
                <ul class="ul bulletList" id="ul_hly_52w_sdc">
                  <li class="li"><samp class="codeph nolang">AwsPrivateLink</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">DataCloudPrivateConnection</samp> (Reserved for
                    internal use)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">string</td>

              <td class="entry" headers="d726698e93" data-title="Description">A description of the connection. Maximum of 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">boolean</td>

              <td class="entry" headers="d726698e93" data-title="Description">Required. Specifies whether the connection is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">string</td>

              <td class="entry" headers="d726698e93" data-title="Description">Required. A user-friendly label for the connection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">outboundNetworkConnProperties</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">
                <a class="xref" href="#meta_outboundnetworkconnproperty">OutboundNetworkConnProperty</a>[]
              </td>

              <td class="entry" headers="d726698e93" data-title="Description">Name-value pairs that describe the properties of an outbound network
                connection. Specify a name-value pair for each of the properties.</td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e87" data-title="Field Name"><span class="keyword parmname">status</span></td>

              <td class="entry" headers="d726698e90" data-title="Field Type">ExternalConnectionStatus​(enumeration of type string)</td>

              <td class="entry" headers="d726698e93" data-title="Description">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:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Unprovisioned</samp></li>

                  <li class="li"><samp class="codeph nolang">Allocation</samp></li>

                  <li class="li"><samp class="codeph nolang">PendingAcceptance</samp></li>

                  <li class="li"><samp class="codeph nolang">PendingActivation</samp></li>

                  <li class="li"><samp class="codeph nolang">RejectedRemotely</samp></li>

                  <li class="li"><samp class="codeph nolang">DeletedRemotely</samp></li>

                  <li class="li"><samp class="codeph nolang">TeardownInProgress</samp></li>

                  <li class="li"><samp class="codeph nolang">Ready</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## OutboundNetworkConnProperty

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

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d726698e260">Field Name</th>

              <th class="featureTableHeader  " id="d726698e263">Field Type</th>

              <th class="featureTableHeader  " id="d726698e266">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d726698e260" data-title="Field Name"><span class="keyword parmname">propertyName</span></td>

              <td class="entry" headers="d726698e263" data-title="Field Type">OutboundConnPropertyName​(<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d726698e266" data-title="Description">Required. The name of a property used to establish to an
                OutboundNetworkConnection. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AwsVpcEndpointId</samp>—The unique endpoint ID
                    provided by Salesforce after an outbound AwsPrivateLink is created. The value is
                    read-only when the <span class="keyword parmname">status</span> is <samp class="codeph nolang">Ready</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AwsVpcEndpointServiceName</samp>—The name of the
                    customer’s endpoint service running in an AWS VPC that’s used for private
                    connections with Salesforce.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Region</samp>—The region in which the VPC is
                    hosted.
                  </li>

                </ul>
                Enumerated values <samp class="codeph nolang">DataCloudPrivateNetwork*</samp> are reserved for internal use.</td>

            </tr>

            <tr>
              <td class="entry" headers="d726698e260" data-title="Field Name"><span class="keyword parmname">propertyValue</span></td>

              <td class="entry" headers="d726698e263" data-title="Field Type"><samp class="codeph nolang">string</samp></td>

              <td class="entry" headers="d726698e266" data-title="Description">Required. The value of OutboundConnPropertyName. For example, the
                <span class="keyword parmname">propertyValue</span> of <samp class="codeph nolang">Region</samp>
                can be <samp class="codeph nolang">us-west-2.</samp>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following sample definition has the suffix .outboundNetworkConnection.

<?xml version="1.0" encoding="UTF-8"?>
<OutboundNetworkConnection xmlns="http://soap.sforce.com/2006/04/metadata">
    <connectionType\>AwsPrivateLink</connectionType\>
    <description\>Outbound Connection to make a callout to a Service deployed in AWS VPC</description\>
    <isActive\>true</isActive\>
    <label\>MyOutboundConnection</label\>
    <outboundNetworkConnProperties\>
        <propertyName\>Region</propertyName\>
        <propertyValue\>us-west-2</propertyValue\>
    </outboundNetworkConnProperties\>
    <outboundNetworkConnProperties\>
        <propertyName\>AwsVpcEndpointServiceName</propertyName\>
        <propertyValue\>com.amazonaws.vpce.us-west-2.vpce-svc-00d7bd6285c123b4c</propertyValue\>
    </outboundNetworkConnProperties\>
    <status\>Unprovisioned</status\>
</OutboundNetworkConnection\>

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>sampleOutboundConnection</fullName\>
    <types\>
        <members\>MyOutboundConnection</members\>
        <name\>OutboundNetworkConnection</name\>
    </types\>
    <version\>49.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).