Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .projenrc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ const project = new awscdk.AwsCdkConstructLibrary({

publishToGo: {
moduleName: `github.com/${PUBLICATION_NAMESPACE}/${PROJECT_NAME}-go`,
packageName: PROJECT_NAME,
packageName: PROJECT_NAME.replace(/-/g, ''),
},
codeCov: true,
codeCovTokenSecret: 'CODECOV_TOKEN',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ enable disable xray tracing
#### Default

```ts
- True
true
```

#### Inherited from
Expand Down Expand Up @@ -161,7 +161,7 @@ enable disable lambda tracing
#### Default

```ts
- Active
Active
```

#### Inherited from
Expand Down Expand Up @@ -211,7 +211,7 @@ Value will be appended to resources name.
#### Default

```ts
- _dev
_dev
```

#### Inherited from
Expand Down Expand Up @@ -272,6 +272,9 @@ Returns a string representation of this construct.

> `protected` **updateConstructUsageMetricCode**(`props`, `scope`, `lambdaFunctions`): `void`

update template description with construct usage metric and
add AWS_SDK_UA_APP_ID to user agent on aws sdk.

#### Parameters

##### props
Expand Down
8 changes: 7 additions & 1 deletion apidocs/@cdklabs/namespaces/kendra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@

## Namespaces

- [Kendra](namespaces/Kendra/README.md)
- [~~Kendra~~](namespaces/Kendra/README.md)

## Enumerations

- [KendraEdition](enumerations/KendraEdition.md)
- [KendraIndexFieldTypes](enumerations/KendraIndexFieldTypes.md)
- [KendraUserContextPolicy](enumerations/KendraUserContextPolicy.md)

## Classes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The document capacity units used for the Gen AI index

### edition

> `readonly` **edition**: [`Edition`](../namespaces/Kendra/enumerations/Edition.md) = `Kendra.Edition.GEN_AI_ENTERPRISE_EDITION`
> `readonly` **edition**: [`KendraEdition`](../enumerations/KendraEdition.md) = `KendraEdition.GEN_AI_ENTERPRISE_EDITION`

The edition of the Gen AI index

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)

***

[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [kendra](../README.md) / KendraEdition

# Enumeration: KendraEdition

Represents an Amazon Kendra Index Edition.

## Enumeration Members

### DEVELOPER\_EDITION

> **DEVELOPER\_EDITION**: `"DEVELOPER_EDITION"`

***

### ENTERPRISE\_EDITION

> **ENTERPRISE\_EDITION**: `"ENTERPRISE_EDITION"`

***

### GEN\_AI\_ENTERPRISE\_EDITION

> **GEN\_AI\_ENTERPRISE\_EDITION**: `"GEN_AI_ENTERPRISE_EDITION"`
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)

***

[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [kendra](../README.md) / KendraIndexFieldTypes

# Enumeration: KendraIndexFieldTypes

Represents an Amazon Kendra Index Field Type.

## Enumeration Members

### DATE

> **DATE**: `"DATE_VALUE"`

***

### LONG

> **LONG**: `"LONG_VALUE"`

***

### STRING

> **STRING**: `"STRING_VALUE"`

***

### STRING\_LIST

> **STRING\_LIST**: `"STRING_LIST_VALUE"`
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)

***

[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [kendra](../README.md) / KendraUserContextPolicy

# Enumeration: KendraUserContextPolicy

The different policies available to filter search results based on user context.

## Enumeration Members

### ATTRIBUTE\_FILTER

> **ATTRIBUTE\_FILTER**: `"ATTRIBUTE_FILTER"`

All indexed content is searchable and displayable for all users.
If you want to filter search results on user context, you can use
the attribute filters of _user_id and _group_ids or you can provide
user and group information in UserContext .

***

### USER\_TOKEN

> **USER\_TOKEN**: `"USER_TOKEN"`

Enables token-based user access control to filter search results on
user context. All documents with no access control and all documents
accessible to the user will be searchable and displayable.
12 changes: 8 additions & 4 deletions apidocs/@cdklabs/namespaces/kendra/namespaces/Kendra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@

[@cdklabs/generative-ai-cdk-constructs](../../../../../README.md) / [kendra](../../README.md) / Kendra

# Kendra
# ~~Kendra~~

## Deprecated

Use KendraEdition instead

## Enumerations

- [Edition](enumerations/Edition.md)
- [IndexFieldTypes](enumerations/IndexFieldTypes.md)
- [UserContextPolicy](enumerations/UserContextPolicy.md)
- [~~Edition~~](enumerations/Edition.md)
- [~~IndexFieldTypes~~](enumerations/IndexFieldTypes.md)
- [~~UserContextPolicy~~](enumerations/UserContextPolicy.md)
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,26 @@

[@cdklabs/generative-ai-cdk-constructs](../../../../../../README.md) / [kendra](../../../README.md) / [Kendra](../README.md) / Edition

# Enumeration: Edition
# ~~Enumeration: Edition~~

Represents an Amazon Kendra Index Edition.
## Deprecated

Use KendraEdition instead

## Enumeration Members

### DEVELOPER\_EDITION
### ~~DEVELOPER\_EDITION~~

> **DEVELOPER\_EDITION**: `"DEVELOPER_EDITION"`

***

### ENTERPRISE\_EDITION
### ~~ENTERPRISE\_EDITION~~

> **ENTERPRISE\_EDITION**: `"ENTERPRISE_EDITION"`

***

### GEN\_AI\_ENTERPRISE\_EDITION
### ~~GEN\_AI\_ENTERPRISE\_EDITION~~

> **GEN\_AI\_ENTERPRISE\_EDITION**: `"GEN_AI_ENTERPRISE_EDITION"`
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,32 @@

[@cdklabs/generative-ai-cdk-constructs](../../../../../../README.md) / [kendra](../../../README.md) / [Kendra](../README.md) / IndexFieldTypes

# Enumeration: IndexFieldTypes
# ~~Enumeration: IndexFieldTypes~~

Represents an Amazon Kendra Index Field Type.
## Deprecated

Use KendraIndexFieldTypes instead

## Enumeration Members

### DATE
### ~~DATE~~

> **DATE**: `"DATE_VALUE"`

***

### LONG
### ~~LONG~~

> **LONG**: `"LONG_VALUE"`

***

### STRING
### ~~STRING~~

> **STRING**: `"STRING_VALUE"`

***

### STRING\_LIST
### ~~STRING\_LIST~~

> **STRING\_LIST**: `"STRING_LIST_VALUE"`
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,20 @@

[@cdklabs/generative-ai-cdk-constructs](../../../../../../README.md) / [kendra](../../../README.md) / [Kendra](../README.md) / UserContextPolicy

# Enumeration: UserContextPolicy
# ~~Enumeration: UserContextPolicy~~

The different policies available to filter search results based on user context.
## Deprecated

Use KendraUserContextPolicy instead

## Enumeration Members

### ATTRIBUTE\_FILTER
### ~~ATTRIBUTE\_FILTER~~

> **ATTRIBUTE\_FILTER**: `"ATTRIBUTE_FILTER"`

All indexed content is searchable and displayable for all users.
If you want to filter search results on user context, you can use
the attribute filters of _user_id and _group_ids or you can provide
user and group information in UserContext .

***

### USER\_TOKEN
### ~~USER\_TOKEN~~

> **USER\_TOKEN**: `"USER_TOKEN"`

Enables token-based user access control to filter search results on
user context. All documents with no access control and all documents
accessible to the user will be searchable and displayable.
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ enable disable xray tracing
#### Default

```ts
- True
true
```

#### Inherited from
Expand Down Expand Up @@ -149,7 +149,7 @@ enable disable lambda tracing
#### Default

```ts
- Active
Active
```

#### Inherited from
Expand Down Expand Up @@ -221,7 +221,7 @@ Value will be appended to resources name.
#### Default

```ts
- _dev
_dev
```

#### Inherited from
Expand Down Expand Up @@ -334,6 +334,9 @@ Returns a string representation of this construct.

> `protected` **updateConstructUsageMetricCode**(`props`, `scope`, `lambdaFunctions`): `void`

update template description with construct usage metric and
add AWS_SDK_UA_APP_ID to user agent on aws sdk.

#### Parameters

##### props
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ enable disable xray tracing
#### Default

```ts
- True
true
```

#### Inherited from
Expand Down Expand Up @@ -145,7 +145,7 @@ enable disable lambda tracing
#### Default

```ts
- Active
Active
```

#### Inherited from
Expand Down Expand Up @@ -199,7 +199,7 @@ Value will be appended to resources name.
#### Default

```ts
- _dev
_dev
```

#### Inherited from
Expand Down Expand Up @@ -306,6 +306,9 @@ Returns a string representation of this construct.

> `protected` **updateConstructUsageMetricCode**(`props`, `scope`, `lambdaFunctions`): `void`

update template description with construct usage metric and
add AWS_SDK_UA_APP_ID to user agent on aws sdk.

#### Parameters

##### props
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ enable disable xray tracing
#### Default

```ts
- True
true
```

#### Inherited from
Expand Down Expand Up @@ -135,7 +135,7 @@ enable disable lambda tracing
#### Default

```ts
- Active
Active
```

#### Inherited from
Expand Down Expand Up @@ -189,7 +189,7 @@ Value will be appended to resources name.
#### Default

```ts
- _dev
_dev
```

#### Inherited from
Expand Down Expand Up @@ -296,6 +296,9 @@ Returns a string representation of this construct.

> `protected` **updateConstructUsageMetricCode**(`props`, `scope`, `lambdaFunctions`): `void`

update template description with construct usage metric and
add AWS_SDK_UA_APP_ID to user agent on aws sdk.

#### Parameters

##### props
Expand Down
Loading
Loading