RestConfigurationProperty Struct
Configuration for HTTP request and response handling.
| Source | |
|---|---|
| Type last changed |
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',
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_glue as glue
rest_configuration_property = glue.CfnConnectionType.RestConfigurationProperty(
entity_configurations={
"entity_configurations_key": glue.CfnConnectionType.EntityConfigurationProperty(
schema={
"schema_key": glue.CfnConnectionType.FieldDefinitionProperty(
field_data_type="fieldDataType",
name="name",
# the properties below are optional
filter_overrides=glue.CfnConnectionType.FilterOverridesProperty(
between_configuration=glue.CfnConnectionType.BetweenConfigurationProperty(
high_bound_key="highBoundKey",
low_bound_key="lowBoundKey",
template="template"
),
date_time_format="dateTimeFormat",
field_name="fieldName",
operator_mappings={
"operator_mappings_key": "operatorMappings"
}
),
is_nullable=False,
is_orderable=False,
is_partitionable=False,
is_queryable=False,
response_date_format="responseDateFormat"
)
},
source_configuration=glue.CfnConnectionType.SourceConfigurationProperty(
filter_configuration=glue.CfnConnectionType.FilterConfigurationProperty(
filter_mode="filterMode",
# the properties below are optional
between_configuration=glue.CfnConnectionType.BetweenConfigurationProperty(
high_bound_key="highBoundKey",
low_bound_key="lowBoundKey",
template="template"
),
date_time_format="dateTimeFormat",
filter_string_configuration=glue.CfnConnectionType.FilterStringConfigurationProperty(
query_parameter_name="queryParameterName",
# the properties below are optional
quote_character="quoteCharacter",
quote_string_values=False
),
operator_mappings={
"operator_mappings_key": "operatorMappings"
},
strip_quotes=False
),
pagination_configuration=glue.CfnConnectionType.PaginationConfigurationProperty(
cursor_configuration=glue.CfnConnectionType.CursorConfigurationProperty(
next_page=glue.CfnConnectionType.ExtractedParameterProperty(
default_value="defaultValue",
key="key",
property_location="propertyLocation",
value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
content_path="contentPath",
header_key="headerKey"
)
),
# the properties below are optional
limit_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
default_value="defaultValue",
key="key",
property_location="propertyLocation",
value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
content_path="contentPath",
header_key="headerKey"
)
)
),
offset_configuration=glue.CfnConnectionType.OffsetConfigurationProperty(
limit_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
default_value="defaultValue",
key="key",
property_location="propertyLocation",
value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
content_path="contentPath",
header_key="headerKey"
)
),
offset_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
default_value="defaultValue",
key="key",
property_location="propertyLocation",
value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
content_path="contentPath",
header_key="headerKey"
)
)
)
),
request_method="requestMethod",
request_parameters=[glue.CfnConnectionType.ConnectorPropertyProperty(
name="name",
property_type="propertyType",
required=False,
# the properties below are optional
allowed_values=["allowedValues"],
default_value="defaultValue",
key_override="keyOverride",
property_location="propertyLocation"
)],
request_path="requestPath",
response_configuration=glue.CfnConnectionType.ResponseConfigurationProperty(
result_path="resultPath",
# the properties below are optional
error_path="errorPath"
)
)
)
},
global_source_configuration=glue.CfnConnectionType.SourceConfigurationProperty(
filter_configuration=glue.CfnConnectionType.FilterConfigurationProperty(
filter_mode="filterMode",
# the properties below are optional
between_configuration=glue.CfnConnectionType.BetweenConfigurationProperty(
high_bound_key="highBoundKey",
low_bound_key="lowBoundKey",
template="template"
),
date_time_format="dateTimeFormat",
filter_string_configuration=glue.CfnConnectionType.FilterStringConfigurationProperty(
query_parameter_name="queryParameterName",
# the properties below are optional
quote_character="quoteCharacter",
quote_string_values=False
),
operator_mappings={
"operator_mappings_key": "operatorMappings"
},
strip_quotes=False
),
pagination_configuration=glue.CfnConnectionType.PaginationConfigurationProperty(
cursor_configuration=glue.CfnConnectionType.CursorConfigurationProperty(
next_page=glue.CfnConnectionType.ExtractedParameterProperty(
default_value="defaultValue",
key="key",
property_location="propertyLocation",
value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
content_path="contentPath",
header_key="headerKey"
)
),
# the properties below are optional
limit_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
default_value="defaultValue",
key="key",
property_location="propertyLocation",
value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
content_path="contentPath",
header_key="headerKey"
)
)
),
offset_configuration=glue.CfnConnectionType.OffsetConfigurationProperty(
limit_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
default_value="defaultValue",
key="key",
property_location="propertyLocation",
value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
content_path="contentPath",
header_key="headerKey"
)
),
offset_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
default_value="defaultValue",
key="key",
property_location="propertyLocation",
value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
content_path="contentPath",
header_key="headerKey"
)
)
)
),
request_method="requestMethod",
request_parameters=[glue.CfnConnectionType.ConnectorPropertyProperty(
name="name",
property_type="propertyType",
required=False,
# the properties below are optional
allowed_values=["allowedValues"],
default_value="defaultValue",
key_override="keyOverride",
property_location="propertyLocation"
)],
request_path="requestPath",
response_configuration=glue.CfnConnectionType.ResponseConfigurationProperty(
result_path="resultPath",
# the properties below are optional
error_path="errorPath"
)
),
validation_endpoint_configuration=glue.CfnConnectionType.ValidationEndpointConfigurationProperty(
request_method="requestMethod",
request_path="requestPath"
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.glue.*;
RestConfigurationProperty restConfigurationProperty = RestConfigurationProperty.builder()
.entityConfigurations(Map.of(
"entityConfigurationsKey", EntityConfigurationProperty.builder()
.schema(Map.of(
"schemaKey", FieldDefinitionProperty.builder()
.fieldDataType("fieldDataType")
.name("name")
// the properties below are optional
.filterOverrides(FilterOverridesProperty.builder()
.betweenConfiguration(BetweenConfigurationProperty.builder()
.highBoundKey("highBoundKey")
.lowBoundKey("lowBoundKey")
.template("template")
.build())
.dateTimeFormat("dateTimeFormat")
.fieldName("fieldName")
.operatorMappings(Map.of(
"operatorMappingsKey", "operatorMappings"))
.build())
.isNullable(false)
.isOrderable(false)
.isPartitionable(false)
.isQueryable(false)
.responseDateFormat("responseDateFormat")
.build()))
.sourceConfiguration(SourceConfigurationProperty.builder()
.filterConfiguration(FilterConfigurationProperty.builder()
.filterMode("filterMode")
// the properties below are optional
.betweenConfiguration(BetweenConfigurationProperty.builder()
.highBoundKey("highBoundKey")
.lowBoundKey("lowBoundKey")
.template("template")
.build())
.dateTimeFormat("dateTimeFormat")
.filterStringConfiguration(FilterStringConfigurationProperty.builder()
.queryParameterName("queryParameterName")
// the properties below are optional
.quoteCharacter("quoteCharacter")
.quoteStringValues(false)
.build())
.operatorMappings(Map.of(
"operatorMappingsKey", "operatorMappings"))
.stripQuotes(false)
.build())
.paginationConfiguration(PaginationConfigurationProperty.builder()
.cursorConfiguration(CursorConfigurationProperty.builder()
.nextPage(ExtractedParameterProperty.builder()
.defaultValue("defaultValue")
.key("key")
.propertyLocation("propertyLocation")
.value(ResponseExtractionMappingProperty.builder()
.contentPath("contentPath")
.headerKey("headerKey")
.build())
.build())
// the properties below are optional
.limitParameter(ExtractedParameterProperty.builder()
.defaultValue("defaultValue")
.key("key")
.propertyLocation("propertyLocation")
.value(ResponseExtractionMappingProperty.builder()
.contentPath("contentPath")
.headerKey("headerKey")
.build())
.build())
.build())
.offsetConfiguration(OffsetConfigurationProperty.builder()
.limitParameter(ExtractedParameterProperty.builder()
.defaultValue("defaultValue")
.key("key")
.propertyLocation("propertyLocation")
.value(ResponseExtractionMappingProperty.builder()
.contentPath("contentPath")
.headerKey("headerKey")
.build())
.build())
.offsetParameter(ExtractedParameterProperty.builder()
.defaultValue("defaultValue")
.key("key")
.propertyLocation("propertyLocation")
.value(ResponseExtractionMappingProperty.builder()
.contentPath("contentPath")
.headerKey("headerKey")
.build())
.build())
.build())
.build())
.requestMethod("requestMethod")
.requestParameters(List.of(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build()))
.requestPath("requestPath")
.responseConfiguration(ResponseConfigurationProperty.builder()
.resultPath("resultPath")
// the properties below are optional
.errorPath("errorPath")
.build())
.build())
.build()))
.globalSourceConfiguration(SourceConfigurationProperty.builder()
.filterConfiguration(FilterConfigurationProperty.builder()
.filterMode("filterMode")
// the properties below are optional
.betweenConfiguration(BetweenConfigurationProperty.builder()
.highBoundKey("highBoundKey")
.lowBoundKey("lowBoundKey")
.template("template")
.build())
.dateTimeFormat("dateTimeFormat")
.filterStringConfiguration(FilterStringConfigurationProperty.builder()
.queryParameterName("queryParameterName")
// the properties below are optional
.quoteCharacter("quoteCharacter")
.quoteStringValues(false)
.build())
.operatorMappings(Map.of(
"operatorMappingsKey", "operatorMappings"))
.stripQuotes(false)
.build())
.paginationConfiguration(PaginationConfigurationProperty.builder()
.cursorConfiguration(CursorConfigurationProperty.builder()
.nextPage(ExtractedParameterProperty.builder()
.defaultValue("defaultValue")
.key("key")
.propertyLocation("propertyLocation")
.value(ResponseExtractionMappingProperty.builder()
.contentPath("contentPath")
.headerKey("headerKey")
.build())
.build())
// the properties below are optional
.limitParameter(ExtractedParameterProperty.builder()
.defaultValue("defaultValue")
.key("key")
.propertyLocation("propertyLocation")
.value(ResponseExtractionMappingProperty.builder()
.contentPath("contentPath")
.headerKey("headerKey")
.build())
.build())
.build())
.offsetConfiguration(OffsetConfigurationProperty.builder()
.limitParameter(ExtractedParameterProperty.builder()
.defaultValue("defaultValue")
.key("key")
.propertyLocation("propertyLocation")
.value(ResponseExtractionMappingProperty.builder()
.contentPath("contentPath")
.headerKey("headerKey")
.build())
.build())
.offsetParameter(ExtractedParameterProperty.builder()
.defaultValue("defaultValue")
.key("key")
.propertyLocation("propertyLocation")
.value(ResponseExtractionMappingProperty.builder()
.contentPath("contentPath")
.headerKey("headerKey")
.build())
.build())
.build())
.build())
.requestMethod("requestMethod")
.requestParameters(List.of(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build()))
.requestPath("requestPath")
.responseConfiguration(ResponseConfigurationProperty.builder()
.resultPath("resultPath")
// the properties below are optional
.errorPath("errorPath")
.build())
.build())
.validationEndpointConfiguration(ValidationEndpointConfigurationProperty.builder()
.requestMethod("requestMethod")
.requestPath("requestPath")
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Glue;
var restConfigurationProperty = new RestConfigurationProperty {
EntityConfigurations = new Dictionary<string, object> {
{ "entityConfigurationsKey", new EntityConfigurationProperty {
Schema = new Dictionary<string, object> {
{ "schemaKey", new FieldDefinitionProperty {
FieldDataType = "fieldDataType",
Name = "name",
// the properties below are optional
FilterOverrides = new FilterOverridesProperty {
BetweenConfiguration = new BetweenConfigurationProperty {
HighBoundKey = "highBoundKey",
LowBoundKey = "lowBoundKey",
Template = "template"
},
DateTimeFormat = "dateTimeFormat",
FieldName = "fieldName",
OperatorMappings = new Dictionary<string, string> {
{ "operatorMappingsKey", "operatorMappings" }
}
},
IsNullable = false,
IsOrderable = false,
IsPartitionable = false,
IsQueryable = false,
ResponseDateFormat = "responseDateFormat"
} }
},
SourceConfiguration = new SourceConfigurationProperty {
FilterConfiguration = new FilterConfigurationProperty {
FilterMode = "filterMode",
// the properties below are optional
BetweenConfiguration = new BetweenConfigurationProperty {
HighBoundKey = "highBoundKey",
LowBoundKey = "lowBoundKey",
Template = "template"
},
DateTimeFormat = "dateTimeFormat",
FilterStringConfiguration = new FilterStringConfigurationProperty {
QueryParameterName = "queryParameterName",
// the properties below are optional
QuoteCharacter = "quoteCharacter",
QuoteStringValues = false
},
OperatorMappings = new Dictionary<string, string> {
{ "operatorMappingsKey", "operatorMappings" }
},
StripQuotes = false
},
PaginationConfiguration = new PaginationConfigurationProperty {
CursorConfiguration = new CursorConfigurationProperty {
NextPage = new ExtractedParameterProperty {
DefaultValue = "defaultValue",
Key = "key",
PropertyLocation = "propertyLocation",
Value = new ResponseExtractionMappingProperty {
ContentPath = "contentPath",
HeaderKey = "headerKey"
}
},
// the properties below are optional
LimitParameter = new ExtractedParameterProperty {
DefaultValue = "defaultValue",
Key = "key",
PropertyLocation = "propertyLocation",
Value = new ResponseExtractionMappingProperty {
ContentPath = "contentPath",
HeaderKey = "headerKey"
}
}
},
OffsetConfiguration = new OffsetConfigurationProperty {
LimitParameter = new ExtractedParameterProperty {
DefaultValue = "defaultValue",
Key = "key",
PropertyLocation = "propertyLocation",
Value = new ResponseExtractionMappingProperty {
ContentPath = "contentPath",
HeaderKey = "headerKey"
}
},
OffsetParameter = new ExtractedParameterProperty {
DefaultValue = "defaultValue",
Key = "key",
PropertyLocation = "propertyLocation",
Value = new ResponseExtractionMappingProperty {
ContentPath = "contentPath",
HeaderKey = "headerKey"
}
}
}
},
RequestMethod = "requestMethod",
RequestParameters = new [] { new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
} },
RequestPath = "requestPath",
ResponseConfiguration = new ResponseConfigurationProperty {
ResultPath = "resultPath",
// the properties below are optional
ErrorPath = "errorPath"
}
}
} }
},
GlobalSourceConfiguration = new SourceConfigurationProperty {
FilterConfiguration = new FilterConfigurationProperty {
FilterMode = "filterMode",
// the properties below are optional
BetweenConfiguration = new BetweenConfigurationProperty {
HighBoundKey = "highBoundKey",
LowBoundKey = "lowBoundKey",
Template = "template"
},
DateTimeFormat = "dateTimeFormat",
FilterStringConfiguration = new FilterStringConfigurationProperty {
QueryParameterName = "queryParameterName",
// the properties below are optional
QuoteCharacter = "quoteCharacter",
QuoteStringValues = false
},
OperatorMappings = new Dictionary<string, string> {
{ "operatorMappingsKey", "operatorMappings" }
},
StripQuotes = false
},
PaginationConfiguration = new PaginationConfigurationProperty {
CursorConfiguration = new CursorConfigurationProperty {
NextPage = new ExtractedParameterProperty {
DefaultValue = "defaultValue",
Key = "key",
PropertyLocation = "propertyLocation",
Value = new ResponseExtractionMappingProperty {
ContentPath = "contentPath",
HeaderKey = "headerKey"
}
},
// the properties below are optional
LimitParameter = new ExtractedParameterProperty {
DefaultValue = "defaultValue",
Key = "key",
PropertyLocation = "propertyLocation",
Value = new ResponseExtractionMappingProperty {
ContentPath = "contentPath",
HeaderKey = "headerKey"
}
}
},
OffsetConfiguration = new OffsetConfigurationProperty {
LimitParameter = new ExtractedParameterProperty {
DefaultValue = "defaultValue",
Key = "key",
PropertyLocation = "propertyLocation",
Value = new ResponseExtractionMappingProperty {
ContentPath = "contentPath",
HeaderKey = "headerKey"
}
},
OffsetParameter = new ExtractedParameterProperty {
DefaultValue = "defaultValue",
Key = "key",
PropertyLocation = "propertyLocation",
Value = new ResponseExtractionMappingProperty {
ContentPath = "contentPath",
HeaderKey = "headerKey"
}
}
}
},
RequestMethod = "requestMethod",
RequestParameters = new [] { new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
} },
RequestPath = "requestPath",
ResponseConfiguration = new ResponseConfigurationProperty {
ResultPath = "resultPath",
// the properties below are optional
ErrorPath = "errorPath"
}
},
ValidationEndpointConfiguration = new ValidationEndpointConfigurationProperty {
RequestMethod = "requestMethod",
RequestPath = "requestPath"
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
restConfigurationProperty := &RestConfigurationProperty{
EntityConfigurations: map[string]interface{}{
"entityConfigurationsKey": &EntityConfigurationProperty{
"schema": map[string]interface{}{
"schemaKey": &FieldDefinitionProperty{
"fieldDataType": jsii.String("fieldDataType"),
"name": jsii.String("name"),
// the properties below are optional
"filterOverrides": &FilterOverridesProperty{
"betweenConfiguration": &BetweenConfigurationProperty{
"highBoundKey": jsii.String("highBoundKey"),
"lowBoundKey": jsii.String("lowBoundKey"),
"template": jsii.String("template"),
},
"dateTimeFormat": jsii.String("dateTimeFormat"),
"fieldName": jsii.String("fieldName"),
"operatorMappings": map[string]*string{
"operatorMappingsKey": jsii.String("operatorMappings"),
},
},
"isNullable": jsii.Boolean(false),
"isOrderable": jsii.Boolean(false),
"isPartitionable": jsii.Boolean(false),
"isQueryable": jsii.Boolean(false),
"responseDateFormat": jsii.String("responseDateFormat"),
},
},
"sourceConfiguration": &SourceConfigurationProperty{
"filterConfiguration": &FilterConfigurationProperty{
"filterMode": jsii.String("filterMode"),
// the properties below are optional
"betweenConfiguration": &BetweenConfigurationProperty{
"highBoundKey": jsii.String("highBoundKey"),
"lowBoundKey": jsii.String("lowBoundKey"),
"template": jsii.String("template"),
},
"dateTimeFormat": jsii.String("dateTimeFormat"),
"filterStringConfiguration": &FilterStringConfigurationProperty{
"queryParameterName": jsii.String("queryParameterName"),
// the properties below are optional
"quoteCharacter": jsii.String("quoteCharacter"),
"quoteStringValues": jsii.Boolean(false),
},
"operatorMappings": map[string]*string{
"operatorMappingsKey": jsii.String("operatorMappings"),
},
"stripQuotes": jsii.Boolean(false),
},
"paginationConfiguration": &PaginationConfigurationProperty{
"cursorConfiguration": &CursorConfigurationProperty{
"nextPage": &ExtractedParameterProperty{
"defaultValue": jsii.String("defaultValue"),
"key": jsii.String("key"),
"propertyLocation": jsii.String("propertyLocation"),
"value": &ResponseExtractionMappingProperty{
"contentPath": jsii.String("contentPath"),
"headerKey": jsii.String("headerKey"),
},
},
// the properties below are optional
"limitParameter": &ExtractedParameterProperty{
"defaultValue": jsii.String("defaultValue"),
"key": jsii.String("key"),
"propertyLocation": jsii.String("propertyLocation"),
"value": &ResponseExtractionMappingProperty{
"contentPath": jsii.String("contentPath"),
"headerKey": jsii.String("headerKey"),
},
},
},
"offsetConfiguration": &OffsetConfigurationProperty{
"limitParameter": &ExtractedParameterProperty{
"defaultValue": jsii.String("defaultValue"),
"key": jsii.String("key"),
"propertyLocation": jsii.String("propertyLocation"),
"value": &ResponseExtractionMappingProperty{
"contentPath": jsii.String("contentPath"),
"headerKey": jsii.String("headerKey"),
},
},
"offsetParameter": &ExtractedParameterProperty{
"defaultValue": jsii.String("defaultValue"),
"key": jsii.String("key"),
"propertyLocation": jsii.String("propertyLocation"),
"value": &ResponseExtractionMappingProperty{
"contentPath": jsii.String("contentPath"),
"headerKey": jsii.String("headerKey"),
},
},
},
},
"requestMethod": jsii.String("requestMethod"),
"requestParameters": []interface{}{
&ConnectorPropertyProperty{
"name": jsii.String("name"),
"propertyType": jsii.String("propertyType"),
"required": jsii.Boolean(false),
// the properties below are optional
"allowedValues": []*string{
jsii.String("allowedValues"),
},
"defaultValue": jsii.String("defaultValue"),
"keyOverride": jsii.String("keyOverride"),
"propertyLocation": jsii.String("propertyLocation"),
},
},
"requestPath": jsii.String("requestPath"),
"responseConfiguration": &ResponseConfigurationProperty{
"resultPath": jsii.String("resultPath"),
// the properties below are optional
"errorPath": jsii.String("errorPath"),
},
},
},
},
GlobalSourceConfiguration: &SourceConfigurationProperty{
FilterConfiguration: &FilterConfigurationProperty{
FilterMode: jsii.String("filterMode"),
// the properties below are optional
BetweenConfiguration: &BetweenConfigurationProperty{
HighBoundKey: jsii.String("highBoundKey"),
LowBoundKey: jsii.String("lowBoundKey"),
Template: jsii.String("template"),
},
DateTimeFormat: jsii.String("dateTimeFormat"),
FilterStringConfiguration: &FilterStringConfigurationProperty{
QueryParameterName: jsii.String("queryParameterName"),
// the properties below are optional
QuoteCharacter: jsii.String("quoteCharacter"),
QuoteStringValues: jsii.Boolean(false),
},
OperatorMappings: map[string]*string{
"operatorMappingsKey": jsii.String("operatorMappings"),
},
StripQuotes: jsii.Boolean(false),
},
PaginationConfiguration: &PaginationConfigurationProperty{
CursorConfiguration: &CursorConfigurationProperty{
NextPage: &ExtractedParameterProperty{
DefaultValue: jsii.String("defaultValue"),
Key: jsii.String("key"),
PropertyLocation: jsii.String("propertyLocation"),
Value: &ResponseExtractionMappingProperty{
ContentPath: jsii.String("contentPath"),
HeaderKey: jsii.String("headerKey"),
},
},
// the properties below are optional
LimitParameter: &ExtractedParameterProperty{
DefaultValue: jsii.String("defaultValue"),
Key: jsii.String("key"),
PropertyLocation: jsii.String("propertyLocation"),
Value: &ResponseExtractionMappingProperty{
ContentPath: jsii.String("contentPath"),
HeaderKey: jsii.String("headerKey"),
},
},
},
OffsetConfiguration: &OffsetConfigurationProperty{
LimitParameter: &ExtractedParameterProperty{
DefaultValue: jsii.String("defaultValue"),
Key: jsii.String("key"),
PropertyLocation: jsii.String("propertyLocation"),
Value: &ResponseExtractionMappingProperty{
ContentPath: jsii.String("contentPath"),
HeaderKey: jsii.String("headerKey"),
},
},
OffsetParameter: &ExtractedParameterProperty{
DefaultValue: jsii.String("defaultValue"),
Key: jsii.String("key"),
PropertyLocation: jsii.String("propertyLocation"),
Value: &ResponseExtractionMappingProperty{
ContentPath: jsii.String("contentPath"),
HeaderKey: jsii.String("headerKey"),
},
},
},
},
RequestMethod: jsii.String("requestMethod"),
RequestParameters: []interface{}{
&ConnectorPropertyProperty{
Name: jsii.String("name"),
PropertyType: jsii.String("propertyType"),
Required: jsii.Boolean(false),
// the properties below are optional
AllowedValues: []*string{
jsii.String("allowedValues"),
},
DefaultValue: jsii.String("defaultValue"),
KeyOverride: jsii.String("keyOverride"),
PropertyLocation: jsii.String("propertyLocation"),
},
},
RequestPath: jsii.String("requestPath"),
ResponseConfiguration: &ResponseConfigurationProperty{
ResultPath: jsii.String("resultPath"),
// the properties below are optional
ErrorPath: jsii.String("errorPath"),
},
},
ValidationEndpointConfiguration: &ValidationEndpointConfigurationProperty{
RequestMethod: jsii.String("requestMethod"),
RequestPath: jsii.String("requestPath"),
},
}
Properties
entityConfigurationsoptionalIResolvable | { [key: string]: IResolvable | CfnConnectionType.entity_configurationsoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, EntityConfigurationProperty]]]entityConfigurationsoptionalIResolvableEntityConfigurationsoptionalIResolvableEntityConfigurationsoptionalinterface{} #A map of entity configurations.
globalSourceConfigurationoptionalIResolvable | CfnConnectionType.global_source_configurationoptionaltyping.Union[IResolvable, SourceConfigurationProperty]globalSourceConfigurationoptionalIResolvableGlobalSourceConfigurationoptionalIResolvableGlobalSourceConfigurationoptionalinterface{} #Configuration that defines how to make requests to endpoints.
validationEndpointConfigurationoptionalIResolvable | CfnConnectionType.validation_endpoint_configurationoptionaltyping.Union[IResolvable, ValidationEndpointConfigurationProperty]validationEndpointConfigurationoptionalIResolvableValidationEndpointConfigurationoptionalIResolvableValidationEndpointConfigurationoptionalinterface{} #Configuration for the validation endpoint.
Only supports RequestMethod and RequestPath.