Deploy Option¶

Configuration Method¶

GenU allows you to change settings in parameter.ts or through AWS CDK context.

Since you can define settings for multiple environments, it is recommended to use parameter.ts when building a new environment. For backward compatibility, parameters are retrieved in the order of context > parameter.ts.

When using Context: While CDK context can be specified with '-c', this won't trigger frontend builds since no code changes are made. For this asset, it's recommended to change all settings in cdk.json.

How to change parameter.ts values¶

Change values in packages/cdk/parameter.ts to configure settings.

// parameter.ts
const envs: Record<string, Partial<StackInput>> = {
  dev: {
    ragEnabled: false,
    // Customize other parameters as needed
  },
  staging: {
    ragEnabled: false,
    // Customize other parameters as needed
  },
  prod: {
    ragEnabled: true,
    // Customize other parameters as needed
  },
};

If the environment specified by env in CDK context is defined in parameter.ts, the values in parameter.ts take precedence. If the specified env environment is not defined in parameter.ts, the environment is created with context values.

You can specify env in the context of packages/cdk/cdk.json or switch env with -c.

// cdk.json
{
  "context": {
    "env": "dev"
  }
}

# Deploy with the env specified in cdk.json context.env
npm run cdk:deploy

# Deploy with environment set to prod
npm run cdk:deploy -- -c env=prod

When developing locally, specify env as follows:

# Develop locally using the backend specified by cdk.json context.env
npm run web:devw

# Develop locally using the dev2 environment backend
npm run web:devw --env=dev2

How to change cdk.json values¶

Change values under the context in packages/cdk/cdk.json to configure settings. For example, setting "ragEnabled": true enables the RAG chat use case. After setting context values, redeploy with the following command to apply the settings:

npm run cdk:deploy

Use Case Configuration¶

Enabling RAG Chat (Amazon Kendra) Use Case¶

Set ragEnabled to true. (Default is false)

You can also set kendraIndexLanguage to prefered language, which may improve search performance.

Edit parameter.ts

// parameter.ts
const envs: Record<string, Partial<StackInput>> = {
  dev: {
    ragEnabled: true,
    kendraIndexLanguage: 'en',
  },
};

Deploy Option¶

Configuration Method¶

How to change parameter.ts values¶

How to change cdk.json values¶

Use Case Configuration¶

Enabling RAG Chat (Amazon Kendra) Use Case¶

Using an Existing Amazon Kendra Index¶

Enabling RAG Chat (Knowledge Base) Use Case¶

Enabling Advanced Parsing¶

Changing Chunking Strategy¶

Recreating Knowledge Base or OpenSearch Service to apply changes¶

How to check OpenSearch Service Index in the management console¶

Metadata Filter Configuration¶

Enabling Agent Chat Use Case¶

Deploying Code Interpreter Agent¶

Deploying Search Agent¶

Adding Manually Created Agents¶

Deploying Knowledge Bases for Amazon Bedrock Agent¶

Displaying Agents Inline¶

Enabling Flow Chat Use Case¶

Enabling Image Generation Use Case¶

Enabling Video Generation Use Case¶

Enabling Video Analysis Use Case¶

Enabling Prompt Optimization Tool¶

Hiding Specific Use Cases¶

Use Case Builder Configuration¶

Change Amazon Bedrock Models¶

Using Models from Multiple Regions Simultaneously¶

Example: Using Tokyo region as primary while also using the latest models from Northern Virginia and Oregon regions¶

Example: Using Amazon Bedrock Models in us-east-1 (Virginia)¶

Example: Using Amazon Bedrock Models in us-west-2 (Oregon)¶

Example: Using cross-region inference models from us (Northern Virginia or Oregon) Amazon Bedrock¶

Example: Using Amazon Bedrock Models in ap-northeast-1 (Tokyo)¶

Using Custom Models with Amazon SageMaker¶

Configuring GenU to Call Deployed Models¶

Security-Related Settings¶

Disable Self-Signup¶

Restrict Email Domains for Sign-up¶

Enable AWS WAF Restrictions¶

IP Address Restrictions¶

Geographic Restrictions¶

SAML Authentication¶

Guardrails¶

Cost-Related Settings¶

Set Schedule for Automatic Creation and Deletion of Kendra Index¶

Enabling Monitoring Dashboard¶

Using a Custom Domain¶

Using Bedrock from a Different AWS Account¶

Deploying Multiple Environments in the Same Account¶