> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IDataSourceDefinition

- Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/dataSources/index.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Full definition of a data source used to create it or to replace it.

**Signature:**

```typescript
export interface IDataSourceDefinition 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [alternativeDataSourceId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionalternativedatasourceid) |  | string \| null | **_(ALPHA)_** _(Optional)_ Identifier of the data source that the backend uses instead of this one. |
| [authenticationType?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionauthenticationtype) |  | [DataSourceAuthenticationType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datasourceauthenticationtype/index.md) \| null | **_(ALPHA)_** _(Optional)_ |
| [cacheRetention?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitioncacheretention) |  | [DataSourceCacheRetention](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datasourcecacheretention/index.md) \| null | **_(ALPHA)_** _(Optional)_ Use `null` to remove the cache retention policy of the data source. |
| [cacheStrategy?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitioncachestrategy) |  | [DataSourceCacheStrategy](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datasourcecachestrategy/index.md) | **_(ALPHA)_** _(Optional)_ |
| [clientId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionclientid) |  | string | **_(ALPHA)_** _(Optional)_ |
| [clientSecret?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionclientsecret) |  | string | **_(ALPHA)_** _(Optional)_ |
| [dateTimeSemantics?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitiondatetimesemantics) |  | [DataSourceDateTimeSemantics](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datasourcedatetimesemantics/index.md) \| null | **_(ALPHA)_** _(Optional)_ |
| [disableStatistics?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitiondisablestatistics) |  | boolean \| null | **_(ALPHA)_** _(Optional)_ |
| [id](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionid) |  | string | **_(ALPHA)_** |
| [ignoreJwtAud?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionignorejwtaud) |  | boolean \| null | **_(ALPHA)_** _(Optional)_ Skip the audience check of JWT tokens in the OIDC authentication. |
| [name](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionname) |  | string | **_(ALPHA)_** |
| [parameters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionparameters) |  | [IDataSourceParameter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourceparameter/index.md)[] | **_(ALPHA)_** _(Optional)_ |
| [password?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionpassword) |  | string | **_(ALPHA)_** _(Optional)_ |
| [privateKey?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionprivatekey) |  | string | **_(ALPHA)_** _(Optional)_ |
| [privateKeyPassphrase?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionprivatekeypassphrase) |  | string | **_(ALPHA)_** _(Optional)_ |
| [schema](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionschema) |  | string | **_(ALPHA)_** |
| [token?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitiontoken) |  | string | **_(ALPHA)_** _(Optional)_ |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitiontype) |  | [DataSourceType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datasourcetype/index.md) | **_(ALPHA)_** |
| [url?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionurl) |  | string | **_(ALPHA)_** _(Optional)_ |
| [username?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedefinition/index.md#idatasourcedefinitionusername) |  | string | **_(ALPHA)_** _(Optional)_ |

## Property details

### IDataSourceDefinition.alternativeDataSourceId

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Identifier of the data source that the backend uses instead of this one.

**Signature:**

```typescript
alternativeDataSourceId?: string | null;
```

### IDataSourceDefinition.authenticationType

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
authenticationType?: DataSourceAuthenticationType | null;
```

### IDataSourceDefinition.cacheRetention

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Use `null` to remove the cache retention policy of the data source.

**Signature:**

```typescript
cacheRetention?: DataSourceCacheRetention | null;
```

### IDataSourceDefinition.cacheStrategy

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
cacheStrategy?: DataSourceCacheStrategy;
```

### IDataSourceDefinition.clientId

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
clientId?: string;
```

### IDataSourceDefinition.clientSecret

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
clientSecret?: string;
```

### IDataSourceDefinition.dateTimeSemantics

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
dateTimeSemantics?: DataSourceDateTimeSemantics | null;
```

### IDataSourceDefinition.disableStatistics

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
disableStatistics?: boolean | null;
```

### IDataSourceDefinition.id

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
id: string;
```

### IDataSourceDefinition.ignoreJwtAud

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Skip the audience check of JWT tokens in the OIDC authentication.

**Signature:**

```typescript
ignoreJwtAud?: boolean | null;
```

### IDataSourceDefinition.name

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
name: string;
```

### IDataSourceDefinition.parameters

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
parameters?: IDataSourceParameter[];
```

### IDataSourceDefinition.password

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
password?: string;
```

### IDataSourceDefinition.privateKey

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
privateKey?: string;
```

### IDataSourceDefinition.privateKeyPassphrase

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
privateKeyPassphrase?: string;
```

### IDataSourceDefinition.schema

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
schema: string;
```

### IDataSourceDefinition.token

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
token?: string;
```

### IDataSourceDefinition.type

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
type: DataSourceType;
```

### IDataSourceDefinition.url

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
url?: string;
```

### IDataSourceDefinition.username

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
username?: string;
```