afv-library/skills/platform-metadata-api-context-get/assets/metadata_api/InboundNetworkConnection.json

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "sub_types",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "InboundNetworkConnection - Metadata API",
  "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.",
  "file_information": ".inboundNetworkConnection",
  "directory_location": "inboundNetworkConnections",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "connectionType": {
      "type": "ExternalConnectionType (enumeration of type string)",
      "description": "Specifies the cloud provider of the connection. AwsPrivateLink DataCloudPrivateConnection (Reserved for internal use)",
      "required": true
    },
    "description": {
      "type": "string",
      "description": "A description of the connection. Maximum of 255 characters.",
      "required": true
    },
    "inboundNetworkConnProperties": {
      "type": "InboundNetworkConnProperty",
      "description": "Name-value pairs that describe the properties of the inbound network connection. Specify a name-value pair for each of the properties."
    },
    "isActive": {
      "type": "boolean",
      "description": "Specifies whether the connection is active (true) or not( false). The default value is false.",
      "required": true
    },
    "label": {
      "type": "string",
      "description": "A user-friendly label for the connection.",
      "required": true
    },
    "status": {
      "type": "ExternalConnectionStatus(enumeration of type string)",
      "description": "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",
      "required": true
    }
  },
  "sub_types": {
    "InboundNetworkConnProperty": {
      "propertyName": {
        "type": "InboundConnPropertyName(enumeration of type string)",
        "description": "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.",
        "required": true
      },
      "propertyValue": {
        "type": "string",
        "description": "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.[ { \"startIp\":\"10.10.10.0\", \"endIp\":\"10.10.10.3\"}, {\"startIp\":\"100.100.100.0\", \"endIp\":\"100.100.100.15\" } ]",
        "required": true
      }
    }
  },
  "wsdl_segment": "```xml\n<xsd:simpleType name=\"ExternalConnectionStatus\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Unprovisioned\"/>\n    <xsd:enumeration value=\"Allocating\"/>\n    <xsd:enumeration value=\"PendingAcceptance\"/>\n    <xsd:enumeration value=\"PendingActivation\"/>\n    <xsd:enumeration value=\"RejectedRemotely\"/>\n    <xsd:enumeration value=\"DeletedRemotely\"/>\n    <xsd:enumeration value=\"TeardownInProgress\"/>\n    <xsd:enumeration value=\"Ready\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"ExternalConnectionType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"AwsPrivateLink\"/>\n    <xsd:enumeration value=\"DataCloudPrivateConnection\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"InboundConnPropertyName\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Region\"/>\n    <xsd:enumeration value=\"AwsVpcEndpointId\"/>\n    <xsd:enumeration value=\"SourceIpRanges\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"InboundNetworkConnProperty\">\n  <xsd:sequence>\n    <xsd:element name=\"propertyName\" type=\"tns:InboundConnPropertyName\"/>\n    <xsd:element name=\"propertyValue\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"InboundNetworkConnection\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"connectionType\" type=\"tns:ExternalConnectionType\"/>\n        <xsd:element name=\"description\" type=\"xsd:string\"/>\n        <xsd:element name=\"inboundNetworkConnProperties\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:InboundNetworkConnProperty\"/>\n        <xsd:element name=\"isActive\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"label\" type=\"xsd:string\"/>\n        <xsd:element name=\"status\" type=\"tns:ExternalConnectionStatus\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following sample definition has the suffix .inboundNetworkConnection.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<InboundNetworkConnection xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <connectionType>AwsPrivateLink</connectionType>\n    <description>This is an Inbound Connection to make API calls into Salesforce</description>\n    <inboundNetworkConnProperties>\n        <propertyName>Region</propertyName>\n        <propertyValue>us-west-2</propertyValue>\n    </inboundNetworkConnProperties>\n    <inboundNetworkConnProperties>\n        <propertyName>AwsVpcEndpointId</propertyName>\n        <propertyValue>vpce-02ccb5fac2bacaceb</propertyValue>\n    </inboundNetworkConnProperties>\n    <inboundNetworkConnProperties>\n        <propertyName>SourceIpRanges</propertyName>\n        <propertyValue>[ { \"startIp\":\"10.10.10.0\", \"endIp\":\"10.10.10.3\" }, { \"startIp\":\"100.100.100.0\", \"endIp\":\"100.100.100.15\" } ]</propertyValue>\n    </inboundNetworkConnProperties>\n    <isActive>true</isActive>\n    <label>MyInboundConnection</label>\n    <status>Unprovisioned</status>\n</InboundNetworkConnection>"
    }
  ]
}