AWS::AppFlow::ConnectorProfile SalesforceConnectorProfileCredentials
The connector-specific profile credentials required when using Salesforce.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AccessToken" :
String
, "ClientCredentialsArn" :String
, "ConnectorOAuthRequest" :ConnectorOAuthRequest
, "JwtToken" :String
, "OAuth2GrantType" :String
, "RefreshToken" :String
}
YAML
AccessToken:
String
ClientCredentialsArn:String
ConnectorOAuthRequest:ConnectorOAuthRequest
JwtToken:String
OAuth2GrantType:String
RefreshToken:String
Properties
AccessToken
-
The credentials used to access protected Salesforce resources.
Required: No
Type: String
Pattern:
\S+
Maximum:
4096
Update requires: No interruption
ClientCredentialsArn
-
The secret manager ARN, which contains the client ID and client secret of the connected app.
Required: No
Type: String
Pattern:
arn:aws:secretsmanager:.*:[0-9]+:.*
Maximum:
2048
Update requires: No interruption
ConnectorOAuthRequest
-
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
Required: No
Type: ConnectorOAuthRequest
Update requires: No interruption
JwtToken
-
A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.
Required: No
Type: String
Pattern:
^[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.[A-Za-z0-9-_.+/=]*$
Maximum:
8000
Update requires: No interruption
OAuth2GrantType
-
Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
You can specify one of the following values:
- AUTHORIZATION_CODE
-
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
- JWT_BEARER
-
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
Note
The CLIENT_CREDENTIALS value is not supported for Salesforce.
Required: No
Type: String
Allowed values:
CLIENT_CREDENTIALS | AUTHORIZATION_CODE | JWT_BEARER
Update requires: No interruption
RefreshToken
-
The credentials used to acquire new access tokens.
Required: No
Type: String
Pattern:
\S+
Maximum:
4096
Update requires: No interruption
See also
-
SalesforceConnectorProfileCredentials in the Amazon AppFlow API Reference.