interface CustomConnectorProfileCredentialsProperty

Language	Type name
.NET	`Amazon.CDK.CfnPropertyMixins.AWS.AppFlow.CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty`
Go	`github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsappflow#CfnConnectorProfilePropsMixin_CustomConnectorProfileCredentialsProperty`
Java	`software.amazon.awscdk.cfnpropertymixins.services.appflow.CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty`
Python	`aws_cdk.cfn_property_mixins.aws_appflow.CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty`
TypeScript	`@aws-cdk/cfn-property-mixins` » `aws_appflow` » `CfnConnectorProfilePropsMixin` » `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/cfn-property-mixins';
const customConnectorProfileCredentialsProperty: appflow.CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty = {
  apiKey: {
    apiKey: 'apiKey',
    apiSecretKey: 'apiSecretKey',
  },
  authenticationType: 'authenticationType',
  basic: {
    password: 'password',
    username: 'username',
  },
  custom: {
    credentialsMap: {
      credentialsMapKey: 'credentialsMap',
    },
    customAuthenticationType: 'customAuthenticationType',
  },
  oauth2: {
    accessToken: 'accessToken',
    clientId: 'clientId',
    clientSecret: 'clientSecret',
    oAuthRequest: {
      authCode: 'authCode',
      redirectUri: 'redirectUri',
    },
    refreshToken: 'refreshToken',
  },
};

Properties

Name	Type	Description
apiKey?	`IResolvable` `\|` `ApiKeyCredentialsProperty`	The API keys required for the authentication of the user.
authenticationType?	`string`	The authentication type that the custom connector uses for authenticating while creating a connector profile.
basic?	`IResolvable` `\|` `BasicAuthCredentialsProperty`	The basic credentials that are required for the authentication of the user.
custom?	`IResolvable` `\|` `CustomAuthCredentialsProperty`	If the connector uses the custom authentication mechanism, this holds the required credentials.
oauth2?	`IResolvable` `\|` `OAuth2CredentialsProperty`	The OAuth 2.0 credentials required for the authentication of the user.

apiKey?

Type: IResolvable | ApiKeyCredentialsProperty (optional)

The API keys required for the authentication of the user.

authenticationType?

Type: string (optional)

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

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.

AWS CDK

2.248.0