docs(appsync): clarify the structure of apiKeys object

[tmokmss]

Issue # (if applicable)

n/a

Reason for this change

I found it is not clear how api keys are stored in the apiKey object. e.g. how can we get an api key from the object?

Description of changes

I added a description about the object structure from the below implementation.

aws-cdk/packages/aws-cdk-lib/aws-appsync/lib/eventapi.ts

Line 493 in 27e854f

this.apiKeys[mode.apiKeyConfig?.name ?? 'Default'] = createAPIKey(this, this.apiId, mode.apiKeyConfig);

I confirmed this implementation also aligns with id naming rule.

aws-cdk/packages/aws-cdk-lib/aws-appsync/lib/auth-config.ts

Line 192 in 9ae1d34

return new CfnApiKey(scope, `${config?.name || 'Default'}ApiKey`, {

Describe any new or updated permissions being added

none

Description of how you validated changes

n/a

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.00%. Comparing base (331d7a5) to head (b614e01).

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #33424   +/-   ##
=======================================
  Coverage   81.00%   81.00%           
=======================================
  Files         238      238           
  Lines       14269    14269           
  Branches     2492     2492           
=======================================
  Hits        11558    11558           
  Misses       2425     2425           
  Partials      286      286           

Flag	Coverage Δ
suite.unit	81.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	79.92% <ø> (ø)
packages/aws-cdk-lib/core	82.16% <ø> (ø)

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: b614e01
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.