Skip to content
v2.275.0

ConnectorAuthenticationConfigurationProperty Struct ​

Configuration that defines supported authentication types and required properties.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';
const connectorAuthenticationConfigurationProperty: glue.CfnConnectionType.ConnectorAuthenticationConfigurationProperty = {
  authenticationTypes: ['authenticationTypes'],

  // the properties below are optional
  basicAuthenticationProperties: {
    password: {
      name: 'name',
      propertyType: 'propertyType',
      required: false,

      // the properties below are optional
      keyOverride: 'keyOverride',
      propertyLocation: 'propertyLocation',
    },
    username: {
      name: 'name',
      propertyType: 'propertyType',
      required: false,

      // the properties below are optional
      keyOverride: 'keyOverride',
      propertyLocation: 'propertyLocation',
    },
  },
  customAuthenticationProperties: {
    authenticationParameters: [{
      name: 'name',
      propertyType: 'propertyType',
      required: false,

      // the properties below are optional
      keyOverride: 'keyOverride',
      propertyLocation: 'propertyLocation',
    }],
  },
  oAuth2Properties: {
    oAuth2GrantType: 'oAuth2GrantType',

    // the properties below are optional
    authorizationCodeProperties: {
      authorizationCode: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      authorizationCodeUrl: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      clientId: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      clientSecret: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      contentType: 'contentType',
      prompt: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      redirectUri: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      requestMethod: 'requestMethod',
      scope: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      tokenUrl: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      tokenUrlParameters: [{
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      }],
    },
    clientCredentialsProperties: {
      clientId: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      clientSecret: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      contentType: 'contentType',
      requestMethod: 'requestMethod',
      scope: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      tokenUrl: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      tokenUrlParameters: [{
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      }],
    },
    jwtBearerProperties: {
      contentType: 'contentType',
      jwtToken: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      requestMethod: 'requestMethod',
      tokenUrl: {
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      },
      tokenUrlParameters: [{
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      }],
    },
  },
};

Properties ​

authenticationTypesstring[]authentication_typestyping.List[str]authenticationTypesList<String>AuthenticationTypesstring[]AuthenticationTypes*[]*stringrequired#
A list of authentication types supported.
basicAuthenticationPropertiesoptionalIResolvable | CfnConnectionType.BasicAuthenticationPropertiesPropertybasic_authentication_propertiesoptionaltyping.Union[IResolvable, BasicAuthenticationPropertiesProperty]basicAuthenticationPropertiesoptionalIResolvableBasicAuthenticationPropertiesoptionalIResolvableBasicAuthenticationPropertiesoptionalinterface{}#
Basic authentication configuration.
customAuthenticationPropertiesoptionalIResolvable | CfnConnectionType.CustomAuthenticationPropertiesPropertycustom_authentication_propertiesoptionaltyping.Union[IResolvable, CustomAuthenticationPropertiesProperty]customAuthenticationPropertiesoptionalIResolvableCustomAuthenticationPropertiesoptionalIResolvableCustomAuthenticationPropertiesoptionalinterface{}#
Custom authentication configuration.
oAuth2PropertiesoptionalIResolvable | CfnConnectionType.ConnectorOAuth2PropertiesPropertyo_auth2_propertiesoptionaltyping.Union[IResolvable, ConnectorOAuth2PropertiesProperty]oAuth2PropertiesoptionalIResolvableOAuth2PropertiesoptionalIResolvableOAuth2Propertiesoptionalinterface{}#
OAuth2 configuration container.