feat(appsync): environmentVariables property for GraphqlApi

[go-to-k]

Reason for this change

AppSync now supports environment variables in GraphQL resolvers and functions. It would be good for GraphqlApi construct to have the property.

• https://aws.amazon.com/jp/about-aws/whats-new/2024/02/aws-appsync-environment-variables-graph-ql-resolvers-functions/
• https://docs.aws.amazon.com/en_en/appsync/latest/devguide/environmental-variables.html
• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-environmentvariables

Description of changes

The environmentVariables property is added to GraphqlApi construct. To add environment variables after the initiation, we can use addEnvironmentVariables method.

Description of how you validated changes

Both unit and integ tests.

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

[kaizencc]

Hi @go-to-k! I just have one question really. the rest looks good

[kaizencc]

why add validation to the node rather than just throwing an error here? I'm not too familiar with this method but usually we want to default to fail as early as possible and i wonder if this violates that. did you see this done elsewhere?

[go-to-k]

The addValidation (see DESIGN_GUIDELINES) method is a lazy way to delay and make decisions about processing that cannot be determined during initialization by the constructor.

For example, in this case, we get an array-type property from props and initialize an instance variable in the constructor. However, there are cases where users want to pass nothing in props and add it later with the addEnvironmentVariable method. In that case, if we check the number of elements in the array in the constructor, it will be assumed to be zero.
Because of this case, we should use this method for lazy checking instead of early checking at the constructor.

Also, if we were to check the number of elements in the array in the addEnvironmentVariable method, it would throw an error the moment the maximum number is reached, so even if users specify 60 elements for the array, they would get a message Only 50 environment variables can be set, got 51. The addValidation method is also necessary to check exactly how many elements the user has specified for the array.

Elsewhere, I saw this in CodePipeline.

https://github.com/go-to-k/aws-cdk/blob/a21731c9b1f34525433fbee668ebb2321debf5b8/packages/aws-cdk-lib/aws-codepipeline/lib/pipeline.ts#L542

[go-to-k]

I made it a little clearer.

1a100b5

[kaizencc]

thanks for the clarification. i agree that this is the right thing to do here now

[go-to-k]

@kaizencc

Thanks for your review. I have returned your comment and would like you to confirm it.

[onlybakam]

This looks great. can you add a check to make sure that environment variables are not set on a MERGED api?

[go-to-k]

@onlybakam

Thanks, nice catch. I will add the change not to set the environment variables on the Merged API.

[go-to-k]

Because Environment variables are not supported for merged API. The Cfn errors:

MergedAPI (MergedAPI08D3EAD1) Operation not allowed, Merged API resources are read-only (Service: AmazonDeepdish; Status Code: 400; Error Code: BadRequestException; Request ID: ...

[go-to-k]

@kaizencc

I have also added new commits, could you please check them?

[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).

[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).

[go-to-k]

@kaizencc

Thanks for your approval, but the merge has failed because of Queue: Embarked in merge queue.

Could you please trigger again?

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 18a0306
• 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).