# CfnConnectionProps

Properties for defining a `CfnConnection`.

Extends: CfnConnectionProps
Used as props by: CfnConnection

- Source: Generated code
- Type last changed: v2.191.0 · 23 Apr 2025

## 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

- `authorizationType`: string — The type of authorization to use for the connection.

  > OAUTH tokens are refreshed when a 401 or 407 response is returned.

- `authParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnConnection.AuthParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_events.CfnConnection.AuthParametersProperty.html) — The authorization parameters to use to authorize with the endpoint.

  You must include only authorization parameters for the `AuthorizationType` you specify.

- `description`: string — A description for the connection to create.

- `invocationConnectivityParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnConnection.InvocationConnectivityParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_events.CfnConnection.InvocationConnectivityParametersProperty.html) — For connections to private APIs, the parameters to use for invoking the API.

  For more information, see [Connecting to private APIs](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html) in the **Amazon EventBridge User Guide** .

- `kmsKeyIdentifier`: 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.

  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](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the *AWS Key Management Service Developer Guide* .

- `name`: string — The name for the connection to create.