Skip to content
v2.274.0

ApiKeyAuthParametersProperty Struct ​

The API key authorization parameters for the connection.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
const apiKeyAuthParametersProperty: events.CfnConnection.ApiKeyAuthParametersProperty = {
  apiKeyName: 'apiKeyName',
  apiKeyValue: 'apiKeyValue',
};

Properties ​

apiKeyNamestringapi_key_namestrapiKeyNameStringApiKeyNamestringApiKeyName*stringrequired#
The name of the API key to use for authorization.
apiKeyValuestringapi_key_valuestrapiKeyValueStringApiKeyValuestringApiKeyValue*stringrequired#
The value for the API key to use for authorization.