interface SourceConfigurationProperty

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

Configuration that defines how to make requests to endpoints.

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

Properties

Name	Type	Description
filterConfiguration?	IResolvable | FilterConfigurationProperty	Configuration that defines how filter predicates are applied to REST API requests, supporting both query parameter and filter string strategies.
paginationConfiguration?	IResolvable | PaginationConfigurationProperty	Configuration for handling paginated responses.
requestMethod?	string	The HTTP method to use.
requestParameters?	IResolvable | (IResolvable | ConnectorPropertyProperty)[]	Request parameters configuration.
requestPath?	string	The URL path for the REST endpoint.
responseConfiguration?	IResolvable | ResponseConfigurationProperty	Configuration for parsing JSON responses from REST API calls.

---

filterConfiguration?

Type: IResolvable | FilterConfigurationProperty (optional)

Configuration that defines how filter predicates are applied to REST API requests, supporting both query parameter and filter string strategies.

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

---

paginationConfiguration?

Type: IResolvable | PaginationConfigurationProperty (optional)

Configuration for handling paginated responses.

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

---

requestMethod?

Type: string (optional)

The HTTP method to use.

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

---

requestParameters?

Type: IResolvable | (IResolvable | ConnectorPropertyProperty)[] (optional)

Request parameters configuration.

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

---

requestPath?

Type: string (optional)

The URL path for the REST endpoint.

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

---

responseConfiguration?

Type: IResolvable | ResponseConfigurationProperty (optional)

Configuration for parsing JSON responses from REST API calls.

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