Package software.amazon.awscdk.services.appflow

Interface CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty.Jsii$Proxy

Enclosing class:

CfnConnectorProfile

@Stability(Stable)
public static interface CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty
extends software.amazon.jsii.JsiiSerializable

The connector-specific profile properties required when using Salesforce.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appflow.*;
 SalesforceConnectorProfilePropertiesProperty salesforceConnectorProfilePropertiesProperty = SalesforceConnectorProfilePropertiesProperty.builder()
         .instanceUrl("instanceUrl")
         .isSandboxEnvironment(false)
         .usePrivateLinkForMetadataAndAuthorization(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty.Builder	A builder for CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty
static final class	CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty.Jsii$Proxy	An implementation for CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty

Method Summary

Modifier and Type	Method	Description
static CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty.Builder	builder()
default String	getInstanceUrl()	The location of the Salesforce resource.
default Object	getIsSandboxEnvironment()	Indicates whether the connector profile applies to a sandbox or production environment.
default Object	getUsePrivateLinkForMetadataAndAuthorization()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceUrl

@Stability(Stable)
@Nullable
default String getInstanceUrl()

The location of the Salesforce resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-instanceurl

getIsSandboxEnvironment

@Stability(Stable)
@Nullable
default Object getIsSandboxEnvironment()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-issandboxenvironment

getUsePrivateLinkForMetadataAndAuthorization

@Stability(Stable)
@Nullable
default Object getUsePrivateLinkForMetadataAndAuthorization()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-useprivatelinkformetadataandauthorization

builder

@Stability(Stable)
static CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty.Builder builder()

Returns:

a CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty.Builder of CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty