Skip to content

fix(appsync): ttl property of CachingConfig is not required#17981

Merged
mergify[bot] merged 2 commits intomasterfrom
otaviom/appsync-ttl-required
Dec 14, 2021
Merged

fix(appsync): ttl property of CachingConfig is not required#17981
mergify[bot] merged 2 commits intomasterfrom
otaviom/appsync-ttl-required

Conversation

@otaviomacedo
Copy link
Copy Markdown
Contributor

@otaviomacedo otaviomacedo commented Dec 13, 2021 •
edited
Loading

According to the current CloudFormaton spec for AWS::AppSync::Resolver CachingConfig, the Ttl property is not required. But if it's not provided, the deploy will fail with the message:

TTL value cannot be smaller than 1 second and larger than 3600 seconds. (Service: AWSAppSync; Status Code: 400; Error Code: BadRequestException

The AppSync team has confirmed that the property is indeed required and they will push a change to the spec. This change is proactively making the property required on the CDK.

Fixes #17925.

BREAKING CHANGE: The CachingConfig#ttl property is now required.

----

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

@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Dec 13, 2021

@otaviomacedo otaviomacedo added the pr-linter/exempt-test The PR linter will not require test changes label Dec 13, 2021
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Dec 13, 2021
@github-actions github-actions bot added the @aws-cdk/aws-appsync Related to AWS AppSync label Dec 13, 2021
@otaviomacedo otaviomacedo requested a review from a team December 13, 2021 10:20
njlynch
njlynch reviewed Dec 13, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@njlynch njlynch left a comment

Choose a reason for hiding this comment

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

Two thoughts:

  1. Should we wait to make this required in the CDK until the spec change has been merged? Maybe not, but coordinating the two would make some sense.
  2. Either way, this needs to be marked as a BREAKING CHANGE.

@otaviomacedo otaviomacedo added the pr/do-not-merge This PR should not be merged at this time. label Dec 13, 2021
@otaviomacedo
Copy link
Copy Markdown
Contributor Author

otaviomacedo commented Dec 13, 2021

  1. Should we wait to make this required in the CDK until the spec change has been merged? Maybe not, but coordinating the two would make some sense.

I don't mind. We can hold this off until the new spec is out. On the other hand, if this property is left undefined, it will fail one way or the other. With this change, it will fail faster (compile time).

  1. Either way, this needs to be marked as a BREAKING CHANGE.

Done.

@otaviomacedo
Copy link
Copy Markdown
Contributor Author

otaviomacedo commented Dec 14, 2021

Latest update from the AppSync team:

The recommended workaround at this point is to include the TTL field. Our next step is to make this field required and update our docs.

Removing the pr/do-not-merge tag.

@otaviomacedo otaviomacedo removed the pr/do-not-merge This PR should not be merged at this time. label Dec 14, 2021
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Dec 14, 2021

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

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

aws-cdk-automation commented Dec 14, 2021

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: e10e993
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify mergify bot merged commit 73e5fec into master Dec 14, 2021
@mergify mergify bot deleted the otaviom/appsync-ttl-required branch December 14, 2021 20:39
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Dec 14, 2021

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

TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
@otaviomacedo @TikiTDO
fix(appsync): ttl property of CachingConfig is not required (aws#…
e44d527 
…17981)

According to the current CloudFormaton spec for [AWS::AppSync::Resolver CachingConfig][1], the `Ttl` property is not required. But if it's not provided, the deploy will fail with the message:

>  TTL value cannot be smaller than 1 second and larger than 3600 seconds. (Service: AWSAppSync; Status Code: 400; Error Code: BadRequestException

The AppSync team has confirmed that the property is indeed required and they will push a change to the spec. This change is proactively making the property required on the CDK.

Fixes aws#17925.

BREAKING CHANGE: The `CachingConfig#ttl` property is now required. 

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-cachingconfig.html#cfn-appsync-resolver-cachingconfig-ttl
----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@njlynch njlynch njlynch approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@otaviomacedo otaviomacedo

Labels

@aws-cdk/aws-appsync Related to AWS AppSync contribution/core This is a PR that came from AWS. pr-linter/exempt-test The PR linter will not require test changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

(appsync): 2.1.0 breaks deployment

3 participants

@otaviomacedo @aws-cdk-automation @njlynch