interface CustomConnectorProfileCredentialsProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppFlow.CfnConnectorProfile.CustomConnectorProfileCredentialsProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappflow#CfnConnectorProfile_CustomConnectorProfileCredentialsProperty |
![]() | software.amazon.awscdk.services.appflow.CfnConnectorProfile.CustomConnectorProfileCredentialsProperty |
![]() | aws_cdk.aws_appflow.CfnConnectorProfile.CustomConnectorProfileCredentialsProperty |
![]() | 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
Name | Type | Description |
---|---|---|
authentication | string | The authentication type that the custom connector uses for authenticating while creating a connector profile. |
api | IResolvable | Api | The API keys required for the authentication of the user. |
basic? | IResolvable | Basic | The basic credentials that are required for the authentication of the user. |
custom? | IResolvable | Custom | If the connector uses the custom authentication mechanism, this holds the required credentials. |
oauth2? | IResolvable | OAuth2 | The 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
|
Api
(optional)
The API keys required for the authentication of the user.
basic?
Type:
IResolvable
|
Basic
(optional)
The basic credentials that are required for the authentication of the user.
custom?
Type:
IResolvable
|
Custom
(optional)
If the connector uses the custom authentication mechanism, this holds the required credentials.
oauth2?
Type:
IResolvable
|
OAuth2
(optional)
The OAuth 2.0 credentials required for the authentication of the user.