# AuthParametersProperty

Tthe authorization parameters to use for the connection.

- Source: Generated code
- Type last changed: v2.172.0 · 7 Dec 2024

## 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 authParametersProperty: events.CfnConnection.AuthParametersProperty = {
  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,
      }],
    },
  },
};
```

## Properties

- `apiKeyAuthParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnConnection.ApiKeyAuthParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_events.CfnConnection.ApiKeyAuthParametersProperty.html) — The API Key parameters to use for authorization.

- `basicAuthParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnConnection.BasicAuthParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_events.CfnConnection.BasicAuthParametersProperty.html) — The authorization parameters for Basic authorization.

- `connectivityParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnConnection.ConnectivityParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_events.CfnConnection.ConnectivityParametersProperty.html) — For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

  For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** .

- `invocationHttpParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnConnection.ConnectionHttpParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_events.CfnConnection.ConnectionHttpParametersProperty.html) — Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

- `oAuthParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnConnection.OAuthParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_events.CfnConnection.OAuthParametersProperty.html) — The OAuth parameters to use for authorization.