Package software.amazon.awssdk.services.appflow.model

Interface SalesforceConnectorProfileCredentials.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SalesforceConnectorProfileCredentials.Builder,SalesforceConnectorProfileCredentials>, SdkBuilder<SalesforceConnectorProfileCredentials.Builder,SalesforceConnectorProfileCredentials>, SdkPojo

Enclosing class:

SalesforceConnectorProfileCredentials

public static interface SalesforceConnectorProfileCredentials.Builder
extends SdkPojo, CopyableBuilder<SalesforceConnectorProfileCredentials.Builder,SalesforceConnectorProfileCredentials>

Method Summary

Modifier and Type	Method	Description
SalesforceConnectorProfileCredentials.Builder	accessToken(String accessToken)	The credentials used to access protected Salesforce resources.
SalesforceConnectorProfileCredentials.Builder	clientCredentialsArn(String clientCredentialsArn)	The secret manager ARN, which contains the client ID and client secret of the connected app.
SalesforceConnectorProfileCredentials.Builder	jwtToken(String jwtToken)	A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.
SalesforceConnectorProfileCredentials.Builder	oAuth2GrantType(String oAuth2GrantType)	Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce.
SalesforceConnectorProfileCredentials.Builder	oAuth2GrantType(OAuth2GrantType oAuth2GrantType)	Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce.
default SalesforceConnectorProfileCredentials.Builder	oAuthRequest(Consumer<ConnectorOAuthRequest.Builder> oAuthRequest)	The OAuth requirement needed to request security tokens from the connector endpoint.
SalesforceConnectorProfileCredentials.Builder	oAuthRequest(ConnectorOAuthRequest oAuthRequest)	The OAuth requirement needed to request security tokens from the connector endpoint.
SalesforceConnectorProfileCredentials.Builder	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 Detail

accessToken

SalesforceConnectorProfileCredentials.Builder accessToken(String 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

SalesforceConnectorProfileCredentials.Builder refreshToken(String 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

SalesforceConnectorProfileCredentials.Builder oAuthRequest(ConnectorOAuthRequest 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 the ConnectorOAuthRequest.Builder avoiding the need to create one manually via ConnectorOAuthRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to oAuthRequest(ConnectorOAuthRequest).

Parameters:

oAuthRequest - a consumer that will call methods on ConnectorOAuthRequest.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

oAuthRequest(ConnectorOAuthRequest)

clientCredentialsArn

SalesforceConnectorProfileCredentials.Builder clientCredentialsArn(String 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

SalesforceConnectorProfileCredentials.Builder oAuth2GrantType(String 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, OAuth2GrantType

oAuth2GrantType

SalesforceConnectorProfileCredentials.Builder oAuth2GrantType(OAuth2GrantType 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, OAuth2GrantType

jwtToken

SalesforceConnectorProfileCredentials.Builder jwtToken(String 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.