CfnConnectionTypeProps Struct
Properties for defining a CfnConnectionType.
| 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 cfnConnectionTypeProps: glue.CfnConnectionTypeProps = {
connectionType: 'connectionType',
restConfiguration: {
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',
},
},
// the properties below are optional
connectionProperties: {
additionalRequestParameters: [{
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
}],
url: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
},
connectorAuthenticationConfiguration: {
authenticationTypes: ['authenticationTypes'],
// the properties below are optional
basicAuthenticationProperties: {
password: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
username: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
},
customAuthenticationProperties: {
authenticationParameters: [{
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
}],
},
oAuth2Properties: {
oAuth2GrantType: 'oAuth2GrantType',
// the properties below are optional
authorizationCodeProperties: {
authorizationCode: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
authorizationCodeUrl: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
clientId: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
clientSecret: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
contentType: 'contentType',
prompt: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
redirectUri: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
requestMethod: 'requestMethod',
scope: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
tokenUrl: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
tokenUrlParameters: [{
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
}],
},
clientCredentialsProperties: {
clientId: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
clientSecret: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
contentType: 'contentType',
requestMethod: 'requestMethod',
scope: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
tokenUrl: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
tokenUrlParameters: [{
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
}],
},
jwtBearerProperties: {
contentType: 'contentType',
jwtToken: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
requestMethod: 'requestMethod',
tokenUrl: {
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
},
tokenUrlParameters: [{
name: 'name',
propertyType: 'propertyType',
required: false,
// the properties below are optional
allowedValues: ['allowedValues'],
defaultValue: 'defaultValue',
keyOverride: 'keyOverride',
propertyLocation: 'propertyLocation',
}],
},
},
},
description: 'description',
integrationType: 'integrationType',
tags: [{
key: 'key',
value: 'value',
}],
};
python
from aws_cdk import CfnTag
# 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
cfn_connection_type_props = glue.CfnConnectionTypeProps(
connection_type="connectionType",
rest_configuration=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"
)
),
# the properties below are optional
connection_properties=glue.CfnConnectionType.ConnectionPropertiesConfigurationProperty(
additional_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"
)],
url=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"
)
),
connector_authentication_configuration=glue.CfnConnectionType.ConnectorAuthenticationConfigurationProperty(
authentication_types=["authenticationTypes"],
# the properties below are optional
basic_authentication_properties=glue.CfnConnectionType.BasicAuthenticationPropertiesProperty(
password=glue.CfnConnectionType.SecretConnectorPropertyProperty(
name="name",
property_type="propertyType",
required=False,
# the properties below are optional
key_override="keyOverride",
property_location="propertyLocation"
),
username=glue.CfnConnectionType.SecretConnectorPropertyProperty(
name="name",
property_type="propertyType",
required=False,
# the properties below are optional
key_override="keyOverride",
property_location="propertyLocation"
)
),
custom_authentication_properties=glue.CfnConnectionType.CustomAuthenticationPropertiesProperty(
authentication_parameters=[glue.CfnConnectionType.SecretConnectorPropertyProperty(
name="name",
property_type="propertyType",
required=False,
# the properties below are optional
key_override="keyOverride",
property_location="propertyLocation"
)]
),
o_auth2_properties=glue.CfnConnectionType.ConnectorOAuth2PropertiesProperty(
o_auth2_grant_type="oAuth2GrantType",
# the properties below are optional
authorization_code_properties=glue.CfnConnectionType.ConnectorAuthorizationCodePropertiesProperty(
authorization_code=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"
),
authorization_code_url=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"
),
client_id=glue.CfnConnectionType.SecretConnectorPropertyProperty(
name="name",
property_type="propertyType",
required=False,
# the properties below are optional
key_override="keyOverride",
property_location="propertyLocation"
),
client_secret=glue.CfnConnectionType.SecretConnectorPropertyProperty(
name="name",
property_type="propertyType",
required=False,
# the properties below are optional
key_override="keyOverride",
property_location="propertyLocation"
),
content_type="contentType",
prompt=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"
),
redirect_uri=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_method="requestMethod",
scope=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"
),
token_url=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"
),
token_url_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"
)]
),
client_credentials_properties=glue.CfnConnectionType.ClientCredentialsPropertiesProperty(
client_id=glue.CfnConnectionType.SecretConnectorPropertyProperty(
name="name",
property_type="propertyType",
required=False,
# the properties below are optional
key_override="keyOverride",
property_location="propertyLocation"
),
client_secret=glue.CfnConnectionType.SecretConnectorPropertyProperty(
name="name",
property_type="propertyType",
required=False,
# the properties below are optional
key_override="keyOverride",
property_location="propertyLocation"
),
content_type="contentType",
request_method="requestMethod",
scope=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"
),
token_url=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"
),
token_url_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"
)]
),
jwt_bearer_properties=glue.CfnConnectionType.JWTBearerPropertiesProperty(
content_type="contentType",
jwt_token=glue.CfnConnectionType.SecretConnectorPropertyProperty(
name="name",
property_type="propertyType",
required=False,
# the properties below are optional
key_override="keyOverride",
property_location="propertyLocation"
),
request_method="requestMethod",
token_url=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"
),
token_url_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"
)]
)
)
),
description="description",
integration_type="integrationType",
tags=[CfnTag(
key="key",
value="value"
)]
)
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.*;
CfnConnectionTypeProps cfnConnectionTypeProps = CfnConnectionTypeProps.builder()
.connectionType("connectionType")
.restConfiguration(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())
// the properties below are optional
.connectionProperties(ConnectionPropertiesConfigurationProperty.builder()
.additionalRequestParameters(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()))
.url(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.build())
.connectorAuthenticationConfiguration(ConnectorAuthenticationConfigurationProperty.builder()
.authenticationTypes(List.of("authenticationTypes"))
// the properties below are optional
.basicAuthenticationProperties(BasicAuthenticationPropertiesProperty.builder()
.password(SecretConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.username(SecretConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.build())
.customAuthenticationProperties(CustomAuthenticationPropertiesProperty.builder()
.authenticationParameters(List.of(SecretConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build()))
.build())
.oAuth2Properties(ConnectorOAuth2PropertiesProperty.builder()
.oAuth2GrantType("oAuth2GrantType")
// the properties below are optional
.authorizationCodeProperties(ConnectorAuthorizationCodePropertiesProperty.builder()
.authorizationCode(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.authorizationCodeUrl(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.clientId(SecretConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.clientSecret(SecretConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.contentType("contentType")
.prompt(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.redirectUri(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.requestMethod("requestMethod")
.scope(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.tokenUrl(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.tokenUrlParameters(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()))
.build())
.clientCredentialsProperties(ClientCredentialsPropertiesProperty.builder()
.clientId(SecretConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.clientSecret(SecretConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.contentType("contentType")
.requestMethod("requestMethod")
.scope(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.tokenUrl(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.tokenUrlParameters(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()))
.build())
.jwtBearerProperties(JWTBearerPropertiesProperty.builder()
.contentType("contentType")
.jwtToken(SecretConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.requestMethod("requestMethod")
.tokenUrl(ConnectorPropertyProperty.builder()
.name("name")
.propertyType("propertyType")
.required(false)
// the properties below are optional
.allowedValues(List.of("allowedValues"))
.defaultValue("defaultValue")
.keyOverride("keyOverride")
.propertyLocation("propertyLocation")
.build())
.tokenUrlParameters(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()))
.build())
.build())
.build())
.description("description")
.integrationType("integrationType")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.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 cfnConnectionTypeProps = new CfnConnectionTypeProps {
ConnectionType = "connectionType",
RestConfiguration = 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"
}
},
// the properties below are optional
ConnectionProperties = new ConnectionPropertiesConfigurationProperty {
AdditionalRequestParameters = new [] { new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
} },
Url = new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
}
},
ConnectorAuthenticationConfiguration = new ConnectorAuthenticationConfigurationProperty {
AuthenticationTypes = new [] { "authenticationTypes" },
// the properties below are optional
BasicAuthenticationProperties = new BasicAuthenticationPropertiesProperty {
Password = new SecretConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
Username = new SecretConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
}
},
CustomAuthenticationProperties = new CustomAuthenticationPropertiesProperty {
AuthenticationParameters = new [] { new SecretConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
} }
},
OAuth2Properties = new ConnectorOAuth2PropertiesProperty {
OAuth2GrantType = "oAuth2GrantType",
// the properties below are optional
AuthorizationCodeProperties = new ConnectorAuthorizationCodePropertiesProperty {
AuthorizationCode = new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
AuthorizationCodeUrl = new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
ClientId = new SecretConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
ClientSecret = new SecretConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
ContentType = "contentType",
Prompt = new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
RedirectUri = new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
RequestMethod = "requestMethod",
Scope = new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
TokenUrl = new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
TokenUrlParameters = new [] { new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
} }
},
ClientCredentialsProperties = new ClientCredentialsPropertiesProperty {
ClientId = new SecretConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
ClientSecret = new SecretConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
ContentType = "contentType",
RequestMethod = "requestMethod",
Scope = new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
TokenUrl = new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
TokenUrlParameters = new [] { new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
} }
},
JwtBearerProperties = new JWTBearerPropertiesProperty {
ContentType = "contentType",
JwtToken = new SecretConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
RequestMethod = "requestMethod",
TokenUrl = new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
},
TokenUrlParameters = new [] { new ConnectorPropertyProperty {
Name = "name",
PropertyType = "propertyType",
Required = false,
// the properties below are optional
AllowedValues = new [] { "allowedValues" },
DefaultValue = "defaultValue",
KeyOverride = "keyOverride",
PropertyLocation = "propertyLocation"
} }
}
}
},
Description = "description",
IntegrationType = "integrationType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
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"
cfnConnectionTypeProps := &CfnConnectionTypeProps{
ConnectionType: jsii.String("connectionType"),
RestConfiguration: &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"),
},
},
// the properties below are optional
ConnectionProperties: &ConnectionPropertiesConfigurationProperty{
AdditionalRequestParameters: []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"),
},
},
Url: &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"),
},
},
ConnectorAuthenticationConfiguration: &ConnectorAuthenticationConfigurationProperty{
AuthenticationTypes: []*string{
jsii.String("authenticationTypes"),
},
// the properties below are optional
BasicAuthenticationProperties: &BasicAuthenticationPropertiesProperty{
Password: &SecretConnectorPropertyProperty{
Name: jsii.String("name"),
PropertyType: jsii.String("propertyType"),
Required: jsii.Boolean(false),
// the properties below are optional
KeyOverride: jsii.String("keyOverride"),
PropertyLocation: jsii.String("propertyLocation"),
},
Username: &SecretConnectorPropertyProperty{
Name: jsii.String("name"),
PropertyType: jsii.String("propertyType"),
Required: jsii.Boolean(false),
// the properties below are optional
KeyOverride: jsii.String("keyOverride"),
PropertyLocation: jsii.String("propertyLocation"),
},
},
CustomAuthenticationProperties: &CustomAuthenticationPropertiesProperty{
AuthenticationParameters: []interface{}{
&SecretConnectorPropertyProperty{
Name: jsii.String("name"),
PropertyType: jsii.String("propertyType"),
Required: jsii.Boolean(false),
// the properties below are optional
KeyOverride: jsii.String("keyOverride"),
PropertyLocation: jsii.String("propertyLocation"),
},
},
},
OAuth2Properties: &ConnectorOAuth2PropertiesProperty{
OAuth2GrantType: jsii.String("oAuth2GrantType"),
// the properties below are optional
AuthorizationCodeProperties: &ConnectorAuthorizationCodePropertiesProperty{
AuthorizationCode: &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"),
},
AuthorizationCodeUrl: &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"),
},
ClientId: &SecretConnectorPropertyProperty{
Name: jsii.String("name"),
PropertyType: jsii.String("propertyType"),
Required: jsii.Boolean(false),
// the properties below are optional
KeyOverride: jsii.String("keyOverride"),
PropertyLocation: jsii.String("propertyLocation"),
},
ClientSecret: &SecretConnectorPropertyProperty{
Name: jsii.String("name"),
PropertyType: jsii.String("propertyType"),
Required: jsii.Boolean(false),
// the properties below are optional
KeyOverride: jsii.String("keyOverride"),
PropertyLocation: jsii.String("propertyLocation"),
},
ContentType: jsii.String("contentType"),
Prompt: &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"),
},
RedirectUri: &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"),
},
RequestMethod: jsii.String("requestMethod"),
Scope: &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"),
},
TokenUrl: &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"),
},
TokenUrlParameters: []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"),
},
},
},
ClientCredentialsProperties: &ClientCredentialsPropertiesProperty{
ClientId: &SecretConnectorPropertyProperty{
Name: jsii.String("name"),
PropertyType: jsii.String("propertyType"),
Required: jsii.Boolean(false),
// the properties below are optional
KeyOverride: jsii.String("keyOverride"),
PropertyLocation: jsii.String("propertyLocation"),
},
ClientSecret: &SecretConnectorPropertyProperty{
Name: jsii.String("name"),
PropertyType: jsii.String("propertyType"),
Required: jsii.Boolean(false),
// the properties below are optional
KeyOverride: jsii.String("keyOverride"),
PropertyLocation: jsii.String("propertyLocation"),
},
ContentType: jsii.String("contentType"),
RequestMethod: jsii.String("requestMethod"),
Scope: &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"),
},
TokenUrl: &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"),
},
TokenUrlParameters: []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"),
},
},
},
JwtBearerProperties: &JWTBearerPropertiesProperty{
ContentType: jsii.String("contentType"),
JwtToken: &SecretConnectorPropertyProperty{
Name: jsii.String("name"),
PropertyType: jsii.String("propertyType"),
Required: jsii.Boolean(false),
// the properties below are optional
KeyOverride: jsii.String("keyOverride"),
PropertyLocation: jsii.String("propertyLocation"),
},
RequestMethod: jsii.String("requestMethod"),
TokenUrl: &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"),
},
TokenUrlParameters: []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"),
},
},
},
},
},
Description: jsii.String("description"),
IntegrationType: jsii.String("integrationType"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
connectionPropertiesoptionalIResolvable | CfnConnectionType.connection_propertiesoptionaltyping.Union[IResolvable, ConnectionPropertiesConfigurationProperty]connectionPropertiesoptionalIResolvableConnectionPropertiesoptionalIResolvableConnectionPropertiesoptionalinterface{} #Configuration that defines the base URL and additional request parameters needed during connection creation.
connectionTypestringconnection_typestrconnectionTypeStringConnectionTypestringConnectionType*string required #The name of the connection type.
Must be prefixed with REST-.
connectorAuthenticationConfigurationoptionalIResolvable | CfnConnectionType.connector_authentication_configurationoptionaltyping.Union[IResolvable, ConnectorAuthenticationConfigurationProperty]connectorAuthenticationConfigurationoptionalIResolvableConnectorAuthenticationConfigurationoptionalIResolvableConnectorAuthenticationConfigurationoptionalinterface{} #Configuration that defines supported authentication types and required properties.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #A description of the connection type.
integrationTypeoptionalstringintegration_typeoptionalstrintegrationTypeoptionalStringIntegrationTypeoptionalstringIntegrationTypeoptional*string #The integration type for the connection.
Currently only REST is supported.
restConfigurationIResolvable | CfnConnectionType.rest_configurationtyping.Union[IResolvable, RestConfigurationProperty]restConfigurationIResolvableRestConfigurationIResolvableRestConfigurationinterface{} required #Configuration for HTTP request and response handling.