SourceConfigurationProperty Struct
Configuration that defines how to make requests to endpoints.
| 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 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',
},
};
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
source_configuration_property = 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"
)
)
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.*;
SourceConfigurationProperty sourceConfigurationProperty = 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();
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 sourceConfigurationProperty = 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"
}
};
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"
sourceConfigurationProperty := &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"),
},
}
Properties
filterConfigurationoptionalIResolvable | CfnConnectionType.filter_configurationoptionaltyping.Union[IResolvable, FilterConfigurationProperty]filterConfigurationoptionalIResolvableFilterConfigurationoptionalIResolvableFilterConfigurationoptionalinterface{} #Configuration that defines how filter predicates are applied to REST API requests, supporting both query parameter and filter string strategies.
paginationConfigurationoptionalIResolvable | CfnConnectionType.pagination_configurationoptionaltyping.Union[IResolvable, PaginationConfigurationProperty]paginationConfigurationoptionalIResolvablePaginationConfigurationoptionalIResolvablePaginationConfigurationoptionalinterface{} #Configuration for handling paginated responses.
requestMethodoptionalstringrequest_methodoptionalstrrequestMethodoptionalStringRequestMethodoptionalstringRequestMethodoptional*string #The HTTP method to use.
requestParametersoptionalIResolvable | IResolvable | CfnConnectionType.request_parametersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ConnectorPropertyProperty]]]requestParametersoptionalIResolvableRequestParametersoptionalIResolvableRequestParametersoptionalinterface{} #Request parameters configuration.
requestPathoptionalstringrequest_pathoptionalstrrequestPathoptionalStringRequestPathoptionalstringRequestPathoptional*string #The URL path for the REST endpoint.
responseConfigurationoptionalIResolvable | CfnConnectionType.response_configurationoptionaltyping.Union[IResolvable, ResponseConfigurationProperty]responseConfigurationoptionalIResolvableResponseConfigurationoptionalIResolvableResponseConfigurationoptionalinterface{} #Configuration for parsing JSON responses from REST API calls.