Interface SalesforceConnectorProfileCredentials.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SalesforceConnectorProfileCredentials.Builder,
,SalesforceConnectorProfileCredentials> SdkBuilder<SalesforceConnectorProfileCredentials.Builder,
,SalesforceConnectorProfileCredentials> SdkPojo
- Enclosing class:
SalesforceConnectorProfileCredentials
-
Method Summary
Modifier and TypeMethodDescriptionaccessToken
(String accessToken) The credentials used to access protected Salesforce resources.clientCredentialsArn
(String clientCredentialsArn) The secret manager ARN, which contains the client ID and client secret of the connected app.A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.oAuth2GrantType
(String oAuth2GrantType) Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce.oAuth2GrantType
(OAuth2GrantType oAuth2GrantType) Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce.oAuthRequest
(Consumer<ConnectorOAuthRequest.Builder> oAuthRequest) The OAuth requirement needed to request security tokens from the connector endpoint.oAuthRequest
(ConnectorOAuthRequest oAuthRequest) The OAuth requirement needed to request security tokens from the connector endpoint.refreshToken
(String refreshToken) The credentials used to acquire new access tokens.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
accessToken
The credentials used to access protected Salesforce resources.
- Parameters:
accessToken
- The credentials used to access protected Salesforce resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
refreshToken
The credentials used to acquire new access tokens.
- Parameters:
refreshToken
- The credentials used to acquire new access tokens.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
oAuthRequest
The OAuth requirement needed to request security tokens from the connector endpoint.
- Parameters:
oAuthRequest
- The OAuth requirement needed to request security tokens from the connector endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
oAuthRequest
default SalesforceConnectorProfileCredentials.Builder oAuthRequest(Consumer<ConnectorOAuthRequest.Builder> oAuthRequest) The OAuth requirement needed to request security tokens from the connector endpoint.
This is a convenience method that creates an instance of theConnectorOAuthRequest.Builder
avoiding the need to create one manually viaConnectorOAuthRequest.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooAuthRequest(ConnectorOAuthRequest)
.- Parameters:
oAuthRequest
- a consumer that will call methods onConnectorOAuthRequest.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientCredentialsArn
The secret manager ARN, which contains the client ID and client secret of the connected app.
- Parameters:
clientCredentialsArn
- The secret manager ARN, which contains the client ID and client secret of the connected app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- CLIENT_CREDENTIALS
-
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
- 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.
- Parameters:
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.
- CLIENT_CREDENTIALS
-
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- CLIENT_CREDENTIALS
-
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
- 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.
- Parameters:
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.
- CLIENT_CREDENTIALS
-
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
jwtToken
A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.
- Parameters:
jwtToken
- A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-