interface RestConfigurationProperty

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

Configuration for HTTP request and response handling.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-restconfiguration.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 restConfigurationProperty: glue.CfnConnectionType.RestConfigurationProperty = {
  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',
  },
};

Properties

Name	Type	Description
entityConfigurations?	IResolvable | { [string]: IResolvable | EntityConfigurationProperty }	A map of entity configurations.
globalSourceConfiguration?	IResolvable | SourceConfigurationProperty	Configuration that defines how to make requests to endpoints.
validationEndpointConfiguration?	IResolvable | ValidationEndpointConfigurationProperty	Configuration for the validation endpoint.

---

entityConfigurations?

Type: IResolvable | { [string]: IResolvable | EntityConfigurationProperty } (optional)

A map of entity configurations.

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

---

globalSourceConfiguration?

Type: IResolvable | SourceConfigurationProperty (optional)

Configuration that defines how to make requests to endpoints.

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

---

validationEndpointConfiguration?

Type: IResolvable | ValidationEndpointConfigurationProperty (optional)

Configuration for the validation endpoint.

Only supports RequestMethod and RequestPath.

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