interface ConnectorOAuth2PropertiesProperty

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

OAuth2 configuration container.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-connectoroauth2properties.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 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

Name	Type	Description
oAuth2GrantType	string	The OAuth2 grant type to use.
authorizationCodeProperties?	IResolvable | ConnectorAuthorizationCodePropertiesProperty	OAuth2 authorization code configuration.
clientCredentialsProperties?	IResolvable | ClientCredentialsPropertiesProperty	OAuth2 client credentials configuration.
jwtBearerProperties?	IResolvable | JWTBearerPropertiesProperty	JWT bearer token configuration.

---

oAuth2GrantType

Type: string

The OAuth2 grant type to use.

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

---

authorizationCodeProperties?

Type: IResolvable | ConnectorAuthorizationCodePropertiesProperty (optional)

OAuth2 authorization code configuration.

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

---

clientCredentialsProperties?

Type: IResolvable | ClientCredentialsPropertiesProperty (optional)

OAuth2 client credentials configuration.

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

---

jwtBearerProperties?

Type: IResolvable | JWTBearerPropertiesProperty (optional)

JWT bearer token configuration.

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