RestConfigurationProperty Struct
Configuration for HTTP request and response handling.
Example
ts
// 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
entityConfigurationsIResolvable | { [key: string]: IResolvable | CfnConnectionType.EntityConfigurationProperty }entity_configurationstyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, EntityConfigurationProperty]]]entityConfigurationsIResolvableEntityConfigurationsIResolvableEntityConfigurationsinterface{}#A map of entity configurations.
globalSourceConfigurationIResolvable | CfnConnectionType.SourceConfigurationPropertyglobal_source_configurationtyping.Union[IResolvable, SourceConfigurationProperty]globalSourceConfigurationIResolvableGlobalSourceConfigurationIResolvableGlobalSourceConfigurationinterface{}#Configuration that defines how to make requests to endpoints.
validationEndpointConfigurationIResolvable | CfnConnectionType.ValidationEndpointConfigurationPropertyvalidation_endpoint_configurationtyping.Union[IResolvable, ValidationEndpointConfigurationProperty]validationEndpointConfigurationIResolvableValidationEndpointConfigurationIResolvableValidationEndpointConfigurationinterface{}#Configuration for the validation endpoint.
Only supports RequestMethod and RequestPath.