---
schema_version: "1"
id: eb7f7e65bd7967902d423f2b3b5e9d3dd82257368997710ba1a711cad12cfd13
title: InboundNetworkConnection
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_inboundnetworkconnection.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_inboundnetworkconnection.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: ae134c8a97dc30c133b2c296da1fcd87bc2b52b56a6200d0c1cb6ed09be0d6b7
description: Represents a private connection between a third-party data service and a Salesforce org. The connection is inbound because the callouts are coming into Salesforce.This type extends the Metadata metadata type and inherits its fullName field.
---
# InboundNetworkConnection

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

## File Suffix and Directory Location

InboundNetworkConnection components have the suffix .inboundNetworkConnection and are stored in the inboundNetworkConnections folder.

## Version

InboundNetworkConnection 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="d574737e88">Field Name</th>

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

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

            </tr>

          </thead>

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

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

              <td class="entry" headers="d574737e94" 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="d574737e88" data-title="Field Name"><span class="keyword parmname">description</span></td>

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

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

            </tr>

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

              <td class="entry" headers="d574737e91" data-title="Field Type">InboundNetworkConnProperty</td>

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

            </tr>

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

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

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

            </tr>

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

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

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

            </tr>

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

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

              <td class="entry" headers="d574737e94" data-title="Description">Required. Connection status. The connection is initially Unprovisioned and
                moves through the other states 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">Allocating</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>

## InboundNetworkConnProperty

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

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



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

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

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

            </tr>

          </thead>

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

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

              <td class="entry" headers="d574737e268" data-title="Description">Required. The name of a property used to establish an InboundNetworkConnection.
                Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AwsVpcEndpointId</samp>—The unique endpoint ID
                    for connections to an AWS Virtual Private Cloud (VPC). 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">Region</samp>—The region in which the VPC is
                    hosted.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SourceIpRanges</samp>—The ranges of source IP
                    address allocated to this inbound connection by the Salesforce-managed VPC in
                    your cloud provider.
                  </li>

                </ul>
              </td>

            </tr>

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

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

              <td class="entry" headers="d574737e268" data-title="Description">Required. The value of InboundConnPropertyName. An example of the
                <span class="keyword parmname">propertyValue</span> of <samp class="codeph nolang">Region</samp>
                is <samp class="codeph nolang">us-west-2.</samp>
                <div class="p">The
                  <span class="keyword parmname">propertyValue</span> of <samp class="codeph nolang">SourceIpRanges</samp> is a JSON string that lists the start and end IP
                  address for each range. This example shows two IP address
                  ranges.<div class="codeSection nolang">
                    <pre class="codeblock nolang">[
  {
    "startIp":"10.10.10.0",
    "endIp":"10.10.10.3"
  },
  {
    "startIp":"100.100.100.0",
    "endIp":"100.100.100.15"
  }
]</pre>
                  </div>
                </div>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following sample definition has the suffix .inboundNetworkConnection.

<?xml version="1.0" encoding="UTF-8"?>
<InboundNetworkConnection xmlns="http://soap.sforce.com/2006/04/metadata">
    <connectionType\>AwsPrivateLink</connectionType\>
    <description\>This is an Inbound Connection to make API calls into Salesforce</description\>
    <inboundNetworkConnProperties\>
        <propertyName\>Region</propertyName\>
        <propertyValue\>us-west-2</propertyValue\>
    </inboundNetworkConnProperties\>
    <inboundNetworkConnProperties\>
        <propertyName\>AwsVpcEndpointId</propertyName\>
        <propertyValue\>vpce-02ccb5fac2bacaceb</propertyValue\>
    </inboundNetworkConnProperties\>
    <inboundNetworkConnProperties\>
        <propertyName\>SourceIpRanges</propertyName\>
        <propertyValue\>\[ { "startIp":"10.10.10.0", "endIp":"10.10.10.3" }, { "startIp":"100.100.100.0", "endIp":"100.100.100.15" } \]</propertyValue\>
    </inboundNetworkConnProperties\>
    <isActive\>true</isActive\>
    <label\>MyInboundConnection</label\>
    <status\>Unprovisioned</status\>
</InboundNetworkConnection\>

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\>sampleInboundConnection</fullName\>
    <types\>
        <members\>MyInboundConnection</members\>
        <name\>InboundNetworkConnection</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).