interface CfnConnectionTypeProps

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

Properties for defining a CfnConnectionType.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connectiontype.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 cfnConnectionTypeProps: glue.CfnConnectionTypeProps = {
  connectionType: 'connectionType',
  restConfiguration: {
    entityConfigurations: {
      entityConfigurationsKey: {
        schema: {
          schemaKey: {
            fieldDataType: 'fieldDataType',
            name: 'name',

            // the properties below are optional
            filterOverrides: {
              betweenConfiguration: {
                highBoundKey: 'highBoundKey',
                lowBoundKey: 'lowBoundKey',
                template: 'template',
              },
              dateTimeFormat: 'dateTimeFormat',
              fieldName: 'fieldName',
              operatorMappings: {
                operatorMappingsKey: 'operatorMappings',
              },
            },
            isNullable: false,
            isOrderable: false,
            isPartitionable: false,
            isQueryable: false,
            responseDateFormat: 'responseDateFormat',
          },
        },
        sourceConfiguration: {
          filterConfiguration: {
            filterMode: 'filterMode',

            // the properties below are optional
            betweenConfiguration: {
              highBoundKey: 'highBoundKey',
              lowBoundKey: 'lowBoundKey',
              template: 'template',
            },
            dateTimeFormat: 'dateTimeFormat',
            filterStringConfiguration: {
              queryParameterName: 'queryParameterName',

              // the properties below are optional
              quoteCharacter: 'quoteCharacter',
              quoteStringValues: false,
            },
            operatorMappings: {
              operatorMappingsKey: 'operatorMappings',
            },
            stripQuotes: false,
          },
          paginationConfiguration: {
            cursorConfiguration: {
              nextPage: {
                defaultValue: 'defaultValue',
                key: 'key',
                propertyLocation: 'propertyLocation',
                value: {
                  contentPath: 'contentPath',
                  headerKey: 'headerKey',
                },
              },

              // the properties below are optional
              limitParameter: {
                defaultValue: 'defaultValue',
                key: 'key',
                propertyLocation: 'propertyLocation',
                value: {
                  contentPath: 'contentPath',
                  headerKey: 'headerKey',
                },
              },
            },
            offsetConfiguration: {
              limitParameter: {
                defaultValue: 'defaultValue',
                key: 'key',
                propertyLocation: 'propertyLocation',
                value: {
                  contentPath: 'contentPath',
                  headerKey: 'headerKey',
                },
              },
              offsetParameter: {
                defaultValue: 'defaultValue',
                key: 'key',
                propertyLocation: 'propertyLocation',
                value: {
                  contentPath: 'contentPath',
                  headerKey: 'headerKey',
                },
              },
            },
          },
          requestMethod: 'requestMethod',
          requestParameters: [{
            name: 'name',
            propertyType: 'propertyType',
            required: false,

            // the properties below are optional
            allowedValues: ['allowedValues'],
            defaultValue: 'defaultValue',
            keyOverride: 'keyOverride',
            propertyLocation: 'propertyLocation',
          }],
          requestPath: 'requestPath',
          responseConfiguration: {
            resultPath: 'resultPath',

            // the properties below are optional
            errorPath: 'errorPath',
          },
        },
      },
    },
    globalSourceConfiguration: {
      filterConfiguration: {
        filterMode: 'filterMode',

        // the properties below are optional
        betweenConfiguration: {
          highBoundKey: 'highBoundKey',
          lowBoundKey: 'lowBoundKey',
          template: 'template',
        },
        dateTimeFormat: 'dateTimeFormat',
        filterStringConfiguration: {
          queryParameterName: 'queryParameterName',

          // the properties below are optional
          quoteCharacter: 'quoteCharacter',
          quoteStringValues: false,
        },
        operatorMappings: {
          operatorMappingsKey: 'operatorMappings',
        },
        stripQuotes: false,
      },
      paginationConfiguration: {
        cursorConfiguration: {
          nextPage: {
            defaultValue: 'defaultValue',
            key: 'key',
            propertyLocation: 'propertyLocation',
            value: {
              contentPath: 'contentPath',
              headerKey: 'headerKey',
            },
          },

          // the properties below are optional
          limitParameter: {
            defaultValue: 'defaultValue',
            key: 'key',
            propertyLocation: 'propertyLocation',
            value: {
              contentPath: 'contentPath',
              headerKey: 'headerKey',
            },
          },
        },
        offsetConfiguration: {
          limitParameter: {
            defaultValue: 'defaultValue',
            key: 'key',
            propertyLocation: 'propertyLocation',
            value: {
              contentPath: 'contentPath',
              headerKey: 'headerKey',
            },
          },
          offsetParameter: {
            defaultValue: 'defaultValue',
            key: 'key',
            propertyLocation: 'propertyLocation',
            value: {
              contentPath: 'contentPath',
              headerKey: 'headerKey',
            },
          },
        },
      },
      requestMethod: 'requestMethod',
      requestParameters: [{
        name: 'name',
        propertyType: 'propertyType',
        required: false,

        // the properties below are optional
        allowedValues: ['allowedValues'],
        defaultValue: 'defaultValue',
        keyOverride: 'keyOverride',
        propertyLocation: 'propertyLocation',
      }],
      requestPath: 'requestPath',
      responseConfiguration: {
        resultPath: 'resultPath',

        // the properties below are optional
        errorPath: 'errorPath',
      },
    },
    validationEndpointConfiguration: {
      requestMethod: 'requestMethod',
      requestPath: 'requestPath',
    },
  },

  // the properties below are optional
  connectionProperties: {
    additionalRequestParameters: [{
      name: 'name',
      propertyType: 'propertyType',
      required: false,

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

      // the properties below are optional
      allowedValues: ['allowedValues'],
      defaultValue: 'defaultValue',
      keyOverride: 'keyOverride',
      propertyLocation: 'propertyLocation',
    },
  },
  connectorAuthenticationConfiguration: {
    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',
        }],
      },
    },
  },
  description: 'description',
  integrationType: 'integrationType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
connectionType	string	The name of the connection type.
restConfiguration	IResolvable | RestConfigurationProperty	Configuration for HTTP request and response handling.
connectionProperties?	IResolvable | ConnectionPropertiesConfigurationProperty	Configuration that defines the base URL and additional request parameters needed during connection creation.
connectorAuthenticationConfiguration?	IResolvable | ConnectorAuthenticationConfigurationProperty	Configuration that defines supported authentication types and required properties.
description?	string	A description of the connection type.
integrationType?	string	The integration type for the connection.
tags?	CfnTag[]	Tags to assign to the connection type.

---

connectionType

Type: string

The name of the connection type.

Must be prefixed with REST-.

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

---

restConfiguration

Type: IResolvable | RestConfigurationProperty

Configuration for HTTP request and response handling.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connectiontype.html#cfn-glue-connectiontype-restconfiguration

---

connectionProperties?

Type: IResolvable | ConnectionPropertiesConfigurationProperty (optional)

Configuration that defines the base URL and additional request parameters needed during connection creation.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connectiontype.html#cfn-glue-connectiontype-connectionproperties

---

connectorAuthenticationConfiguration?

Type: IResolvable | ConnectorAuthenticationConfigurationProperty (optional)

Configuration that defines supported authentication types and required properties.

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

---

description?

Type: string (optional)

A description of the connection type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connectiontype.html#cfn-glue-connectiontype-description

---

integrationType?

Type: string (optional)

The integration type for the connection.

Currently only REST is supported.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connectiontype.html#cfn-glue-connectiontype-integrationtype

---

tags?

Type: CfnTag[] (optional)

Tags to assign to the connection type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connectiontype.html#cfn-glue-connectiontype-tags