Skip to content
v2.275.0

ConnectorOAuth2PropertiesProperty Struct ​

OAuth2 configuration container.

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 connectorOAuth2PropertiesProperty: glue.CfnConnectionType.ConnectorOAuth2PropertiesProperty = {
  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 ​

authorizationCodePropertiesoptionalIResolvable | CfnConnectionType.ConnectorAuthorizationCodePropertiesPropertyauthorization_code_propertiesoptionaltyping.Union[IResolvable, ConnectorAuthorizationCodePropertiesProperty]authorizationCodePropertiesoptionalIResolvableAuthorizationCodePropertiesoptionalIResolvableAuthorizationCodePropertiesoptionalinterface{}#
OAuth2 authorization code configuration.
clientCredentialsPropertiesoptionalIResolvable | CfnConnectionType.ClientCredentialsPropertiesPropertyclient_credentials_propertiesoptionaltyping.Union[IResolvable, ClientCredentialsPropertiesProperty]clientCredentialsPropertiesoptionalIResolvableClientCredentialsPropertiesoptionalIResolvableClientCredentialsPropertiesoptionalinterface{}#
OAuth2 client credentials configuration.
jwtBearerPropertiesoptionalIResolvable | CfnConnectionType.JWTBearerPropertiesPropertyjwt_bearer_propertiesoptionaltyping.Union[IResolvable, JWTBearerPropertiesProperty]jwtBearerPropertiesoptionalIResolvableJwtBearerPropertiesoptionalIResolvableJwtBearerPropertiesoptionalinterface{}#
JWT bearer token configuration.
oAuth2GrantTypestringo_auth2_grant_typestroAuth2GrantTypeStringOAuth2GrantTypestringOAuth2GrantType*stringrequired#
The OAuth2 grant type to use.