aws-cdk-lib.aws_appflow.CfnConnectorProfile.CustomConnectorProfileCredentialsProperty

interface CustomConnectorProfileCredentialsProperty

LanguageType name
.NETAmazon.CDK.AWS.AppFlow.CfnConnectorProfile.CustomConnectorProfileCredentialsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappflow#CfnConnectorProfile_CustomConnectorProfileCredentialsProperty
Javasoftware.amazon.awscdk.services.appflow.CfnConnectorProfile.CustomConnectorProfileCredentialsProperty
Pythonaws_cdk.aws_appflow.CfnConnectorProfile.CustomConnectorProfileCredentialsProperty
TypeScript aws-cdk-lib » aws_appflow » CfnConnectorProfile » CustomConnectorProfileCredentialsProperty

The connector-specific profile credentials that are required when using the custom connector.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appflow as appflow } from 'aws-cdk-lib';
const customConnectorProfileCredentialsProperty: appflow.CfnConnectorProfile.CustomConnectorProfileCredentialsProperty = {
  authenticationType: 'authenticationType',

  // the properties below are optional
  apiKey: {
    apiKey: 'apiKey',

    // the properties below are optional
    apiSecretKey: 'apiSecretKey',
  },
  basic: {
    password: 'password',
    username: 'username',
  },
  custom: {
    customAuthenticationType: 'customAuthenticationType',

    // the properties below are optional
    credentialsMap: {
      credentialsMapKey: 'credentialsMap',
    },
  },
  oauth2: {
    accessToken: 'accessToken',
    clientId: 'clientId',
    clientSecret: 'clientSecret',
    oAuthRequest: {
      authCode: 'authCode',
      redirectUri: 'redirectUri',
    },
    refreshToken: 'refreshToken',
  },
};

Properties

NameTypeDescription
authenticationTypestringThe authentication type that the custom connector uses for authenticating while creating a connector profile.
apiKey?IResolvable | ApiKeyCredentialsPropertyThe API keys required for the authentication of the user.
basic?IResolvable | BasicAuthCredentialsPropertyThe basic credentials that are required for the authentication of the user.
custom?IResolvable | CustomAuthCredentialsPropertyIf the connector uses the custom authentication mechanism, this holds the required credentials.
oauth2?IResolvable | OAuth2CredentialsPropertyThe OAuth 2.0 credentials required for the authentication of the user.

authenticationType

Type: string

The authentication type that the custom connector uses for authenticating while creating a connector profile.


apiKey?

Type: IResolvable | ApiKeyCredentialsProperty (optional)

The API keys required for the authentication of the user.


basic?

Type: IResolvable | BasicAuthCredentialsProperty (optional)

The basic credentials that are required for the authentication of the user.


custom?

Type: IResolvable | CustomAuthCredentialsProperty (optional)

If the connector uses the custom authentication mechanism, this holds the required credentials.


oauth2?

Type: IResolvable | OAuth2CredentialsProperty (optional)

The OAuth 2.0 credentials required for the authentication of the user.