AWS solutions documentation change
Summary
Updated parameters and documentation for CloudFormation template deployment. Changes include parameter name corrections (Config instead of Config), added UseCaseUUID parameter, expanded documentation for existing API integration, and typo fixes.
Security assessment
Changes primarily involve parameter naming consistency, documentation clarifications, and configuration options. No direct evidence of addressing security vulnerabilities or weaknesses. The ExistingRestApiId documentation mentions security responsibility for API configuration but does not introduce new security controls.
Diff
diff --git a/solutions/latest/generative-ai-application-builder-on-aws/deploying-a-standalone-agent-use-case.md b/solutions/latest/generative-ai-application-builder-on-aws/deploying-a-standalone-agent-use-case.md index 480780af4..33e49dc8a 100644 --- a//solutions/latest/generative-ai-application-builder-on-aws/deploying-a-standalone-agent-use-case.md +++ b//solutions/latest/generative-ai-application-builder-on-aws/deploying-a-standalone-agent-use-case.md @@ -7 +7 @@ -Follow the step-by-step instructions in this section to configure and deploy the solution into your account. +Follow the step-by-step instructions in this section to configure and deploy the solution into your account. @@ -13 +13 @@ Follow the step-by-step instructions in this section to configure and deploy th -**BedrockAgent.template** | [  ](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?&templateURL=https://solutions-reference.s3.amazonaws.com/generative-ai-application-builder-on-aws/latest/BedrockAgent.template&redirectId=ImplementationGuide) +**BedrockAgent.template** | [  ](https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateURL=https://solutions-reference.s3.amazonaws.com/generative-ai-application-builder-on-aws/latest/BedrockAgent.template&stackName=&redirectId=ImplementationGuide) @@ -16 +16 @@ Follow the step-by-step instructions in this section to configure and deploy th - 2. The template launches in the US East (N. Virginia) Region by default. To launch the solution in a different AWS Region, use the Region selector in the console navigation bar. + 2. The template launches in the US East (N. Virginia) Region by default. To launch the solution in a different AWS Region, use the Region selector in the console navigation bar. @@ -30,2 +30,3 @@ Parameter | Default entry | Description -**UseCaseConfigRecordKey** | `<Requires input>` | Key corresponding to the record that contains configurations required by the chat provider Lambda function at runtime. The record in the table must have a **key** attribute matching this value, and a **config** attribute containing the desired configuration. This record will be populated by the deployment platform if it’s in use. For standalone deployments of this use case, a manually created entry in the table defined in **UseCaseConfigTableName** is required. -**UseCaseConfigTableName** | `<Requires input>`` | The stack will read the use case configuration from the table provided here and using the record key defined in **UseCaseConfigRecordKey**. +**UseCaseUUID** | `<_Requires input_>` | 36 character long UUIDv4 to identify this deployed use case within an application. +**UseCaseConfigRecordKey** | `<Requires input>` | Key corresponding to the record that contains configurations required by the chat provider Lambda function at runtime. The record in the table must have a **key** attribute matching this value, and a **config** attribute containing the desired configuration. This record will be populated by the deployment platform if it’s in use. For standalone deployments of this use case, a manually created entry in the table defined in **UseCaseConfigTableName** is required. +**UseCaseConfigTableName** | `<Requires input>`` | The stack will read the use case configuration from the table provided here and using the record key defined in **UseCaseConfigRecordKey**. @@ -33 +34,4 @@ Parameter | Default entry | Description -**CognitoDomainPrefix** | _(Optional input)_ | Enter a value if you want to provide a domain for the Amazon Cognito user pool client. If you don’t provide a value, the solution generates one. +**ExistingRestApiId** | _(Optional input)_ | Existing API Gateway REST API ID to use. If not provided, a new API Gateway REST API will be created. Typically provided when deploying from the Deployment dashboard. Note: Using Existing APIs can help reduce resource duplication and simplify management of APIs when you need to deploy multiple standalone use cases. When supplying existing APIs for a standalone use case, you are responsible for ensuring that the API is configured with the required route(s) with expected models. A required pre-configured /details route (fetches use case details during chat) and optionally, a /feedback route (if **FeedbackEnabled** is set to `Yes` to enable collection of feedback for LLM chat responses) must be configured. Additionally, **ExistingApiRootResourceId** , **ExistingCognitoUserPoolId** and **ExistingCognitoGroupPolicyTableName** must also be provided. +**ExistingApiRootResourceId** | _(Optional input)_ | Existing API Gateway REST API Root Resource ID to use. REST API Root Resource ID can be obtained from the AWS console by selecting the root resource (/) in the "Resources" section of the API.The Resource ID will then be displayed in the Resource details panel. You can alternatively run a describe API call on your REST API to find the Root Resource ID. +**FeedbackEnabled** | `No` | If set to No, the deployed use case stack will not have access to the feedback feature. +**CognitoDomainPrefix** | _(Optional input)_ | Enter a value if you want to provide a domain for the Amazon Cognito user pool client. If you don’t provide a value, the solution generates one. @@ -42 +46,2 @@ Parameter | Default entry | Description -**ExistingSecurityGroupIds** | _(Optional input)_ | Comma-separated list of security groups of the existing VPC to be used for configuring Lambda functions. NOTE: This parameter is only relevant if **VpcEnabled** is `Yes` and **CreateNewVpc** is `No`. +**ExistingSecurityGroupIds** | _(Optional input)_ | Comma-separated list of security groups of the existing VPC to be used for configuring Lambda functions. NOTE: This parameter is only relevant if **VpcEnabled** is `Yes` and **CreateNewVpc** is `No`. +**VpcAzs** | _(Optional input)_ | Comma separated list of AZs in which subnets of the VPCs are created Note: Only relevant if **VpcEnabled** is `Yes` and **CreateNewVpc** is `No`. @@ -49 +54 @@ Parameter | Default entry | Description - 7. On the **Configure stack options** page, choose **Next**. + 7. On the **Configure stack options** page, choose **Next**. @@ -51 +56 @@ Parameter | Default entry | Description - 8. On the **Review** page, review and confirm the settings. Select the box acknowledging that the template will create IAM resources. + 8. On the **Review** page, review and confirm the settings. Select the box acknowledging that the template will create IAM resources.