AWS::AppFlow::ConnectorProfile CustomConnectorProfileCredentials

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ApiKey" : ApiKeyCredentials,
  "AuthenticationType" : String,
  "Basic" : BasicAuthCredentials,
  "Custom" : CustomAuthCredentials,
  "Oauth2" : OAuth2Credentials
}

YAML

  ApiKey: 
    ApiKeyCredentials
  AuthenticationType: String
  Basic: 
    BasicAuthCredentials
  Custom: 
    CustomAuthCredentials
  Oauth2: 
    OAuth2Credentials

Properties

ApiKey

The API keys required for the authentication of the user.

Required: No

Type: ApiKeyCredentials

Update requires: No interruption

AuthenticationType

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

Required: Yes

Type: String

Allowed values: OAUTH2 | APIKEY | BASIC | CUSTOM

Update requires: No interruption

Basic

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

Required: No

Type: BasicAuthCredentials

Update requires: No interruption

Custom

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

Required: No

Type: CustomAuthCredentials

Update requires: No interruption

Oauth2

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

Required: No

Type: OAuth2Credentials

Update requires: No interruption