CfnConnectionProps Struct
Properties for defining a CfnConnection.
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 cfnConnectionProps: events.CfnConnectionProps = {
authorizationType: 'authorizationType',
authParameters: {
apiKeyAuthParameters: {
apiKeyName: 'apiKeyName',
apiKeyValue: 'apiKeyValue',
},
basicAuthParameters: {
password: 'password',
username: 'username',
},
connectivityParameters: {
resourceParameters: {
resourceConfigurationArn: 'resourceConfigurationArn',
// the properties below are optional
resourceAssociationArn: 'resourceAssociationArn',
},
},
invocationHttpParameters: {
bodyParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
headerParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
queryStringParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
},
oAuthParameters: {
authorizationEndpoint: 'authorizationEndpoint',
clientParameters: {
clientId: 'clientId',
clientSecret: 'clientSecret',
},
httpMethod: 'httpMethod',
// the properties below are optional
oAuthHttpParameters: {
bodyParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
headerParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
queryStringParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
},
},
},
description: 'description',
invocationConnectivityParameters: {
resourceParameters: {
resourceConfigurationArn: 'resourceConfigurationArn',
// the properties below are optional
resourceAssociationArn: 'resourceAssociationArn',
},
},
kmsKeyIdentifier: 'kmsKeyIdentifier',
name: 'name',
};
Properties
authorizationTypestringauthorization_typestrauthorizationTypeStringAuthorizationTypestringAuthorizationType*string#The type of authorization to use for the connection.
OAUTH tokens are refreshed when a 401 or 407 response is returned.
authParametersIResolvable | CfnConnection.AuthParametersPropertyauth_parameterstyping.Union[IResolvable, AuthParametersProperty]authParametersIResolvableAuthParametersIResolvableAuthParametersinterface{}#The authorization parameters to use to authorize with the endpoint.
You must include only authorization parameters for the AuthorizationType you specify.
A description for the connection to create.
invocationConnectivityParametersIResolvable | CfnConnection.InvocationConnectivityParametersPropertyinvocation_connectivity_parameterstyping.Union[IResolvable, InvocationConnectivityParametersProperty]invocationConnectivityParametersIResolvableInvocationConnectivityParametersIResolvableInvocationConnectivityParametersinterface{}#For connections to private APIs, the parameters to use for invoking the API.
For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .
kmsKeyIdentifierstringkms_key_identifierstrkmsKeyIdentifierStringKmsKeyIdentifierstringKmsKeyIdentifier*string#The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection.
notes
The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt the connection.
For more information, see Identify and view keys in the AWS Key Management Service Developer Guide .
The name for the connection to create.