Class: Aws::Appflow::Types::SalesforceConnectorProfileCredentials

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb

Overview

The connector-specific profile credentials required when using Salesforce.

See Also:

Constant Summary collapse

SENSITIVE = 
[:access_token, :client_credentials_arn, :jwt_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

The credentials used to access protected Salesforce resources.

Returns:

  • (String) 


4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4381

class SalesforceConnectorProfileCredentials < Struct.new(
  :access_token,
  :refresh_token,
  :o_auth_request,
  :client_credentials_arn,
  :o_auth_2_grant_type,
  :jwt_token)
  SENSITIVE = [:access_token, :client_credentials_arn, :jwt_token]
  include Aws::Structure
end

#client_credentials_arn ⇒ String

The secret manager ARN, which contains the client ID and client secret of the connected app.

Returns:

  • (String) 


4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4381

class SalesforceConnectorProfileCredentials < Struct.new(
  :access_token,
  :refresh_token,
  :o_auth_request,
  :client_credentials_arn,
  :o_auth_2_grant_type,
  :jwt_token)
  SENSITIVE = [:access_token, :client_credentials_arn, :jwt_token]
  include Aws::Structure
end

#jwt_token ⇒ String

A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.

Returns:

  • (String) 


4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4381

class SalesforceConnectorProfileCredentials < Struct.new(
  :access_token,
  :refresh_token,
  :o_auth_request,
  :client_credentials_arn,
  :o_auth_2_grant_type,
  :jwt_token)
  SENSITIVE = [:access_token, :client_credentials_arn, :jwt_token]
  include Aws::Structure
end

#o_auth_2_grant_type ⇒ String

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.

The CLIENT_CREDENTIALS value is not supported for Salesforce.

Returns:

  • (String) 


4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4381

class SalesforceConnectorProfileCredentials < Struct.new(
  :access_token,
  :refresh_token,
  :o_auth_request,
  :client_credentials_arn,
  :o_auth_2_grant_type,
  :jwt_token)
  SENSITIVE = [:access_token, :client_credentials_arn, :jwt_token]
  include Aws::Structure
end

#o_auth_request ⇒ Types::ConnectorOAuthRequest

The OAuth requirement needed to request security tokens from the connector endpoint.

Returns:



4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4381

class SalesforceConnectorProfileCredentials < Struct.new(
  :access_token,
  :refresh_token,
  :o_auth_request,
  :client_credentials_arn,
  :o_auth_2_grant_type,
  :jwt_token)
  SENSITIVE = [:access_token, :client_credentials_arn, :jwt_token]
  include Aws::Structure
end

#refresh_token ⇒ String

The credentials used to acquire new access tokens.

Returns:

  • (String) 


4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 4381

class SalesforceConnectorProfileCredentials < Struct.new(
  :access_token,
  :refresh_token,
  :o_auth_request,
  :client_credentials_arn,
  :o_auth_2_grant_type,
  :jwt_token)
  SENSITIVE = [:access_token, :client_credentials_arn, :jwt_token]
  include Aws::Structure
end