Package software.amazon.awscdk.services.appflow

Interface CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty.Jsii$Proxy

Enclosing class:

CfnConnectorProfile

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

The connector-specific profile credentials 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.*;
 SalesforceConnectorProfileCredentialsProperty salesforceConnectorProfileCredentialsProperty = SalesforceConnectorProfileCredentialsProperty.builder()
         .accessToken("accessToken")
         .clientCredentialsArn("clientCredentialsArn")
         .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                 .authCode("authCode")
                 .redirectUri("redirectUri")
                 .build())
         .jwtToken("jwtToken")
         .oAuth2GrantType("oAuth2GrantType")
         .refreshToken("refreshToken")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty.Builder	builder()
default String	getAccessToken()	The credentials used to access protected Salesforce resources.
default String	getClientCredentialsArn()	The secret manager ARN, which contains the client ID and client secret of the connected app.
default Object	getConnectorOAuthRequest()	Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
default String	getJwtToken()	A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.
default String	getOAuth2GrantType()	Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce.
default String	getRefreshToken()	The credentials used to acquire new access tokens.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessToken

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

The credentials used to access protected Salesforce resources.

See Also:

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

getClientCredentialsArn

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

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

See Also:

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

getConnectorOAuthRequest

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

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

Returns union: either IResolvable or CfnConnectorProfile.ConnectorOAuthRequestProperty

See Also:

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

getJwtToken

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

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

See Also:

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

getOAuth2GrantType

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

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.

See Also:

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

getRefreshToken

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

The credentials used to acquire new access tokens.

See Also:

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

builder

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

Returns:

a CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty.Builder of CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty