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

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	Required. A description of the connection. Maximum of 255 characters.
inboundNetworkConnProperties	InboundNetworkConnProperty	Name-value pairs that describe the properties of the inbound network connection. Specify a name-value pair for each of the properties.
isActive	boolean	Required. Specifies whether the connection is active (`true`) or not(`false`). The default value is `false`.
label	string	Required. A user-friendly label for the connection.
status	ExternalConnectionStatus(enumeration of type string)	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: `Unprovisioned` `Allocating` `PendingAcceptance` `PendingActivation` `RejectedRemotely` `DeletedRemotely` `TeardownInProgress` `Ready`

InboundNetworkConnProperty

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

Field Name	Field Type	Description
propertyName	InboundConnPropertyName(enumeration of type string)	Required. The name of a property used to establish an InboundNetworkConnection. Valid values are: `AwsVpcEndpointId`—The unique endpoint ID for connections to an AWS Virtual Private Cloud (VPC). The value is read-only when the status is `Ready`. `Region`—The region in which the VPC is hosted. `SourceIpRanges`—The ranges of source IP address allocated to this inbound connection by the Salesforce-managed VPC in your cloud provider.
propertyValue	string	Required. The value of InboundConnPropertyName. An example of the propertyValue of `Region` is `us-west-2.` The propertyValue of `SourceIpRanges` is a JSON string that lists the start and end IP address for each range. This example shows two IP address ranges. `1[ 2 { 3 "startIp":"10.10.10.0", 4 "endIp":"10.10.10.3" 5 }, 6 { 7 "startIp":"100.100.100.0", 8 "endIp":"100.100.100.15" 9 } 10]`

Declarative Metadata Sample Definition

The following sample definition has the suffix .inboundNetworkConnection.

1<?xml version="1.0" encoding="UTF-8"?>
2<InboundNetworkConnection xmlns="http://soap.sforce.com/2006/04/metadata">
3    <connectionType>AwsPrivateLink</connectionType>
4    <description>This is an Inbound Connection to make API calls into Salesforce</description>
5    <inboundNetworkConnProperties>
6        <propertyName>Region</propertyName>
7        <propertyValue>us-west-2</propertyValue>
8    </inboundNetworkConnProperties>
9    <inboundNetworkConnProperties>
10        <propertyName>AwsVpcEndpointId</propertyName>
11        <propertyValue>vpce-02ccb5fac2bacaceb</propertyValue>
12    </inboundNetworkConnProperties>
13    <inboundNetworkConnProperties>
14        <propertyName>SourceIpRanges</propertyName>
15        <propertyValue>[ { "startIp":"10.10.10.0", "endIp":"10.10.10.3" }, { "startIp":"100.100.100.0", "endIp":"100.100.100.15" } ]</propertyValue>
16    </inboundNetworkConnProperties>
17    <isActive>true</isActive>
18    <label>MyInboundConnection</label>
19    <status>Unprovisioned</status>
20</InboundNetworkConnection>

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>sampleInboundConnection</fullName>
4    <types>
5        <members>MyInboundConnection</members>
6        <name>InboundNetworkConnection</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