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 Metadata and inherits its fields.

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

Introduced in API version 49.0.

• Type: ExternalConnectionType (enumeration of type string)
• Required: Yes
• Description: Required. Specifies the cloud provider of the connection.
• Possible values:
  • AwsPrivateLink
  • DataCloudPrivateConnection — (Reserved for internal use)

• Type: string
• Required: Yes
• Description: Required. A description of the connection. Maximum of 255 characters.

• Type: InboundNetworkConnProperty[]
• Required: No
• Description: Name-value pairs that describe the properties of the inbound network connection. Specify a name-value pair for each of the properties.

• Type: boolean
• Required: Yes
• Description: Required. Specifies whether the connection is active (true) or not(false). The default value is false.

• Type: string
• Required: Yes
• Description: Required. A user-friendly label for the connection.

• Type: ExternalConnectionStatus (enumeration of type string)
• Required: Yes
• 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.
• Possible values:
  • Unprovisioned
  • Allocating
  • PendingAcceptance
  • PendingActivation
  • RejectedRemotely
  • DeletedRemotely
  • TeardownInProgress
  • Ready

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

• Type: InboundConnPropertyName (enumeration of type string)
• Required: Yes
• Description: Required. The name of a property used to establish an InboundNetworkConnection.
• Possible values:
  • 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.

• Type: string

• Required: Yes

• Description: 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]

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>

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.