AWS::AppFlow::ConnectorProfile SalesforceConnectorProfileProperties - AWS CloudFormation
SyntaxPropertiesSee also

AWS::AppFlow::ConnectorProfile SalesforceConnectorProfileProperties

The connector-specific profile properties required when using Salesforce.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "InstanceUrl" : String,
  "isSandboxEnvironment" : Boolean,
  "usePrivateLinkForMetadataAndAuthorization" : Boolean
}

Properties

InstanceUrl

The location of the Salesforce resource.

Required: No

Type: String

Pattern: \S+

Maximum: 256

Update requires: No interruption

isSandboxEnvironment

Indicates whether the connector profile applies to a sandbox or production environment.

Required: No

Type: Boolean

Update requires: No interruption

usePrivateLinkForMetadataAndAuthorization

If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through AWS PrivateLink. These calls travel through AWS infrastructure without being exposed to the public internet.

Set either of the following values:

true

Amazon AppFlow sends all calls to Salesforce over the private network.

These private calls are:

  • Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields.

  • Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.

  • Calls to transfer your Salesforce records as part of a flow run.

false

The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet.

The public calls are:

  • Calls to get metadata about your Salesforce records.

  • Calls to get or refresh access tokens.

The private calls are:

  • Calls to transfer your Salesforce records as part of a flow run.

Required: No

Type: Boolean

Update requires: No interruption

See also