interface EntityConfigurationProperty

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

Configuration for interacting with a specific data entity.

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

Properties

Name	Type	Description
schema?	IResolvable | { [string]: IResolvable | FieldDefinitionProperty }	The schema definition for this entity.
sourceConfiguration?	IResolvable | SourceConfigurationProperty	Configuration that defines how to make requests to endpoints.

---

schema?

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

The schema definition for this entity.

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

---

sourceConfiguration?

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-entityconfiguration.html#cfn-glue-connectiontype-entityconfiguration-sourceconfiguration