interface ConnectorAuthenticationConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.Glue.CfnConnectionType.ConnectorAuthenticationConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsglue#CfnConnectionType_ConnectorAuthenticationConfigurationProperty
Java	software.amazon.awscdk.services.glue.CfnConnectionType.ConnectorAuthenticationConfigurationProperty
Python	aws_cdk.aws_glue.CfnConnectionType.ConnectorAuthenticationConfigurationProperty
TypeScript	aws-cdk-lib » aws_glue » CfnConnectionType » ConnectorAuthenticationConfigurationProperty

Configuration that defines supported authentication types and required properties.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-connectorauthenticationconfiguration.html

Example

// 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

Name	Type	Description
authenticationTypes	string[]	A list of authentication types supported.
basicAuthenticationProperties?	IResolvable | BasicAuthenticationPropertiesProperty	Basic authentication configuration.
customAuthenticationProperties?	IResolvable | CustomAuthenticationPropertiesProperty	Custom authentication configuration.
oAuth2Properties?	IResolvable | ConnectorOAuth2PropertiesProperty	OAuth2 configuration container.

---

authenticationTypes

Type: string[]

A list of authentication types supported.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-connectorauthenticationconfiguration.html#cfn-glue-connectiontype-connectorauthenticationconfiguration-authenticationtypes

---

basicAuthenticationProperties?

Type: IResolvable | BasicAuthenticationPropertiesProperty (optional)

Basic authentication configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-connectorauthenticationconfiguration.html#cfn-glue-connectiontype-connectorauthenticationconfiguration-basicauthenticationproperties

---

customAuthenticationProperties?

Type: IResolvable | CustomAuthenticationPropertiesProperty (optional)

Custom authentication configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-connectorauthenticationconfiguration.html#cfn-glue-connectiontype-connectorauthenticationconfiguration-customauthenticationproperties

---

oAuth2Properties?

Type: IResolvable | ConnectorOAuth2PropertiesProperty (optional)

OAuth2 configuration container.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-connectorauthenticationconfiguration.html#cfn-glue-connectiontype-connectorauthenticationconfiguration-oauth2properties