ConnectionProps Struct
An API Destination Connection.
A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
Example
ts
const connection = new events.Connection(this, 'Connection', {
authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),
description: 'Connection with API Key x-api-key',
});
const destination = new events.ApiDestination(this, 'Destination', {
connection,
endpoint: 'https://example.com',
description: 'Calling example.com with API key x-api-key',
});
const rule = new events.Rule(this, 'Rule', {
schedule: events.Schedule.rate(Duration.minutes(1)),
targets: [new targets.ApiDestination(destination)],
});
Properties
authorizationAuthorizationauthorizationAuthorizationauthorizationAuthorizationAuthorizationAuthorizationAuthorizationAuthorizationrequired#The authorization type for the connection.
bodyParametersoptional{ [key: string]: HttpParameter }body_parametersoptionaltyping.Mapping[str, HttpParameter]bodyParametersoptionalMap<String, HttpParameter>BodyParametersoptionalIDictionary<string, HttpParameter>BodyParametersoptional*map[string]HttpParameter#Additional string parameters to add to the invocation bodies.
Default: No additional parameters
connectionNameoptionalstringconnection_nameoptionalstrconnectionNameoptionalStringConnectionNameoptionalstringConnectionNameoptional*string#The name of the connection.
Default: A name is automatically generated
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= none#The name of the connection.
headerParametersoptional{ [key: string]: HttpParameter }header_parametersoptionaltyping.Mapping[str, HttpParameter]headerParametersoptionalMap<String, HttpParameter>HeaderParametersoptionalIDictionary<string, HttpParameter>HeaderParametersoptional*map[string]HttpParameter#Additional string parameters to add to the invocation headers.
Default: No additional parameters
queryStringParametersoptional{ [key: string]: HttpParameter }query_string_parametersoptionaltyping.Mapping[str, HttpParameter]queryStringParametersoptionalMap<String, HttpParameter>QueryStringParametersoptionalIDictionary<string, HttpParameter>QueryStringParametersoptional*map[string]HttpParameter#Additional string parameters to add to the invocation query strings.
Default: No additional parameters