Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(appsync): add ApiCache L2 construct and addCache method #31174

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

TonySherman
Copy link

Issue # (if applicable)

#31160
Closes #.

Reason for this change

Description of changes

Adds L2 Construct for ApiCache on AppSync graphQL Apis
and a method to add a cache to existing graphQL Api constructs.

Description of how you validated changes

Checklist


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

@github-actions github-actions bot added p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Aug 21, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team August 21, 2024 19:16
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@TonySherman TonySherman changed the title feat(aws-appsync): add ApiCache L2 construct and addCache method feat(appsync): add ApiCache L2 construct and addCache method Aug 21, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review August 22, 2024 15:07

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Aug 22, 2024
pahud
pahud previously requested changes Sep 15, 2024
Copy link
Contributor

@pahud pahud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you are implementing the ApiCache L2, I suggest you first read the design guidelines here and read other existing L2 constructs to learn the patterns.

Generally, if you are creating a L2 construct called Foo. You should:

  1. Define IFoo interface for it that extends IResource.
  2. Define Foo construct class that extends Resources implements IFoo
  3. Define FooProps as the construct props for Foo

In addition to the design guides and existing L2 constructs, I would recommend you read this blog post in which I shared how I built an Agent L2 construct.

/**
* Cache for a GraphQL API
*/
export class ApiCache extends Construct {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

L2 construct should extends Resource implements IApiCache. You should export IApiCache as well.

/**
* The GraphQL API ID.
*/
readonly apiId: string;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be

readonly api: IGraphqlApi;

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Sep 15, 2024
@mergify mergify bot dismissed pahud’s stale review September 17, 2024 13:46

Pull request has been modified.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Sep 17, 2024
@pahud
Copy link
Contributor

pahud commented Oct 11, 2024

Some suggested changes here:

  • Validation for Ttl property:
  1. The CloudFormation documentation specifies that the Ttl property should be a number between 1 and 3,600 (inclusive). You can add some validation to ensure that the provided ttl value is within this range.
    You can add a check in the constructor of the ApiCache class to validate the ttl value:
constructor(scope: Construct, id: string, props: ApiCacheProps) {
  super(scope, id);

  if (props.ttl < 1 || props.ttl > 3600) {
    throw new Error('Ttl value must be between 1 and 3,600 seconds');
  }

  new CfnApiCache(this, 'Resource', {
    // Rest of the code
  });
}

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Oct 11, 2024
@TonySherman
Copy link
Author

Some suggested changes here:

  • Validation for Ttl property:
  1. The CloudFormation documentation specifies that the Ttl property should be a number between 1 and 3,600 (inclusive). You can add some validation to ensure that the provided ttl value is within this range.
    You can add a check in the constructor of the ApiCache class to validate the ttl value:
constructor(scope: Construct, id: string, props: ApiCacheProps) {
  super(scope, id);

  if (props.ttl < 1 || props.ttl > 3600) {
    throw new Error('Ttl value must be between 1 and 3,600 seconds');
  }

  new CfnApiCache(this, 'Resource', {
    // Rest of the code
  });
}

Thanks! Sorry for the delay on updates to this work. Got sidetracked with some other stuff and I'll be getting back to this shortly.

@aws-cdk-automation
Copy link
Collaborator

This PR has been in the MERGE CONFLICTS state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants