Stabilize AWS AppSync module #6836

NGL321 · 2020-03-19T17:51:46Z

0xdevalias · 2020-04-08T02:27:14Z

ApiKeyConfig currently takes a string for expires, rather than a Duration.

https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-appsync.ApiKeyConfig.html

/**
 * Configuration for API Key authorization in AppSync
 */
export interface ApiKeyConfig extends AuthMode {
    /**
     * Unique description of the API key
     */
    readonly apiKeyDesc: string;
    /**
     * The time from creation time after which the API key expires, using RFC3339 representation.
     * It must be a minimum of 1 day and a maximum of 365 days from date of creation.
     * Rounded down to the nearest hour.
     * @default - 7 days from creation time
     */
    readonly expires?: string;
}

Unclear if Duration's toIsoString() is sufficient to satisfy this date format as a workaround, though this link seems to imply it is:

https://stackoverflow.com/questions/522251/whats-the-difference-between-iso-8601-and-rfc-3339-date-formats

Duration.days(365).toIsoString()

@aws-cdk/core/lib/duration.d.ts:92

/**
 * Return an ISO 8601 representation of this period
 *
 * @returns a string starting with 'PT' describing the period
 * @see https://www.iso.org/fr/standard/70907.html
 */
toIsoString(): string;

EDIT: Though attempting to pass in expires: Duration.days(365).toIsoString(), just ended up getting a null in the cloudformation template, then throwing a validation error.

Workaround:

const dateXDaysInFuture = (days: number) => {
  const now = new Date()
  now.setHours(0, 0, 0, 0)
  now.setDate(now.getDate() + days)
  return now.toISOString()
}

0xdevalias · 2020-04-08T02:52:42Z

EDIT: See also:

Implementation of an AppSync NONE DataSource :

https://docs.aws.amazon.com/appsync/latest/devguide/tutorial-local-resolvers.html

import { Construct } from '@aws-cdk/core'
import { BaseDataSource } from '@aws-cdk/aws-appsync'
import { BaseDataSourceProps } from '@aws-cdk/aws-appsync/lib/graphqlapi'

/**
 * An AppSync datasource backed by nothing
 *
 * @see https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-appsync.BaseDataSource.html
 * @see https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-appsync.BaseDataSourceProps.html
 * @see https://docs.aws.amazon.com/appsync/latest/devguide/tutorial-local-resolvers.html
 */
export class NoneDataSource extends BaseDataSource {
  constructor(scope: Construct, id: string, props: NoneDataSourceProps) {
    super(scope, id, props, {
      type: 'NONE',
    })
  }
}

/**
 * Properties for an AppSync NoneDataSource
 */
export interface NoneDataSourceProps extends BaseDataSourceProps {
  readonly serviceRole?: undefined
}

Usage:

new NoneDataSource(this, 'NoneDataSource', {
  api: graphqlApi,
  name: 'noneDataSource',
  description: 'There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.',
})

0xdevalias · 2020-04-08T04:48:36Z

GraphQLApi doesn't appear to expose any way to access the generated API Key when used in defaultAuthorization/additionalAuthorizationModes.

Workaround:

const apiKeyDesc = 'Bar'

const api = new GraphQLApi(this, 'FooApi', {
  // ..snip..
  additionalAuthorizationModes: [
    {
      apiKeyDesc,
      // ..snip..
    },
  // ..snip..
})


const cfnApiKey = myapi.node.findChild(`${apiKeyDesc}ApiKey`) as CfnApiKey
new CfnOutput(this, 'RemoteControlApiPublicApiKey', {
  value: cfnApiKey.attrApiKey,
})

MrArnoldPalmer · 2020-04-08T04:58:46Z

@0xdevalias these are all good things to add to the list. Feel free to make new issues for each one and just link to them from here. We will use this as a staging area to work these out as we develop the constructs.

0xdevalias · 2020-04-08T05:00:03Z

Feel free to make new issues for each one and just link to them from here.

The extra effort in filling out issue templates/jumping through those hoops tends to be far more than just adding a comment to an existing thread.

MrArnoldPalmer · 2020-04-10T19:04:40Z

Agreed. I'm okay with using this thread to propose new additions. Separate issues are ideal for tracking implementation and this issue can serve as a checklist that anyone can look at to see what's still in progress.

I'll work on adding these.

0xdevalias · 2020-04-10T22:08:37Z

EDIT: disregard this bit. Wasn't watching/recompiling my typescript so it was using the old value.. The notes about passing in different date types to expires are still relevant though.

~~Can't be certain just now, but the API key expiry date is seeming to be off by 72 hours:~~

https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-appsync.ApiKeyConfig.html#expires-span-class-api-icon-api-icon-experimental-title-this-api-element-is-experimental-it-may-change-without-notice-span

~~More Details~~

Initially I used my dateXDaysInFuture helper, but realised that will change the date on every deploy (not ideal until I wire the API key into my app's build/deploy automatically, doing it manually for now)

So I figured I would just statically set the value to the same one that existed currently in my template from the diff. So I set expires to new Date(1617804000 * 1000).toISOString() to match the existing deployed value, and then my diff looks like this:

[~] AWS::AppSync::ApiKey Api/PublicApiKey ApiPublicApiKeyC0492E48
 └─ [~] Expires
     ├─ [-] 1617804000
     └─ [+] 1618063200

~~Calculating those 2 values, it seems like they are 72 hours (3 days) different, which seems wrong to me? I would have expected them to remain the same.~~

new Date(1617804000*1000).toISOString()
// "2021-04-07T14:00:00.000Z"

new Date(1618063200*1000).toISOString()
// "2021-04-10T14:00:00.000Z"

(1618063200-1617804000)/60/60/24
// 3

new Date((1617804000+(3*24*60*60))*1000).toISOString() === new Date(1618063200*1000).toISOString()
// true

Cut down code:

const dateXDaysInFuture = (days: number) => {
      const now = new Date()
      now.setHours(0, 0, 0, 0)
      now.setDate(now.getDate() + days)
      return now.toISOString()
    }

const api = new GraphQLApi(this, 'Api', {
      name: 'foo-api',
      schemaDefinitionFile: '../foo/schema.graphql',
      authorizationConfig: {
        defaultAuthorization: {
          userPool,
          defaultAction: UserPoolDefaultAction.ALLOW,
        },
        additionalAuthorizationModes: [
          {
            apiKeyDesc: 'Public',
            // TODO: fix this so that we don't get a new date on every deploy, and it doesn't stay staticly hardcoded
            // expires: dateXDaysInFuture(365),
            expires: new Date(1617804000 * 1000).toISOString(),
          },
        ],
      },
      logConfig: {
        fieldLogLevel: FieldLogLevel.ALL,
        // fieldLogLevel: FieldLogLevel.ERROR,
        excludeVerboseContent: true,
      },
    })

It would be nice if we could pass more than just a string into the expires field as well. Eg. Being able to pass a Date object directly would be nice. Or even the number timestamp. Basically, anything that can be turned into a Date (or already is one) would be ideal. Or a Duration representing how long the key should be valid for.

~~I think that~~ my schema (set with schemaDefinitionFile: '../foo/schema.graphql') is showing as changed on every diff too, even though the file ~~shouldn't have been~~ hasn't changed ~~(need to actually confirm this).~~ It's kind of hard to tell for sure with the current diffing mechanisms, as it just shows a giant block of removed + a giant block of added. There are some nice diff libs out there that give finer grained results which could be good to use here, eg.

https://www.npmjs.com/package/jest-diff

BryanPan342 · 2020-07-28T21:59:10Z

@0xdevalias @MrArnoldPalmer added these all to the issue list to keep track of which ones are completed. also marked 🚀 when they are complete.

0xdevalias · 2020-07-28T22:14:18Z

@BryanPan342 i see code first schema definition in the list at the top, but nothing about improving the current diff'ing. Personally I don't need the code first schema, but a usable diff would be invaluable.

BryanPan342 · 2020-07-28T22:20:02Z

@0xdevalias apologies i only read the edit section so i didnt see that part of the comment! ill add it to the issue list and make an issue for it

alan-cooney · 2021-02-03T11:59:27Z

Has this been put on hold - I can see that the project board is now closed?

I'm keen to submit a few PRs with regards to the MappingTemplate improvements suggested (particularly KeyCondition improvements and DynamoDB pagination).

romanfq · 2021-06-15T12:02:20Z

Is this missing a data source for a lambda alias?

michaelbrewer · 2021-08-16T06:48:07Z

Add AWS_LAMBDA for AppySync authorization mode is a big one too.

revmischa · 2021-09-07T07:19:03Z

By the way I am using https://prisma-appsync.vercel.app/ (CDK integration demo here) and it is really really cool for creating an AppSync API out of my postgres database schema with TypeScript. It is a bit rough around the edges though and I hope integrating a solution like this in the future could be a little smoother, requiring less boilerplate.

Change stability and maturity of `@aws-cdk/aws-appsync` constructs to stable. Fixes: #6836

Change stability and maturity of `@aws-cdk/aws-appsync` constructs to stable. Fixes: #6836 ---- ### All Submissions: * [X] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Construct Runtime Dependencies: * [ ] This PR adds new construct runtime dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-construct-runtime-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

github-actions · 2023-01-10T21:44:21Z

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

NGL321 added management/tracking Issues that track a subject or multiple issues @aws-cdk/aws-appsync Related to AWS AppSync labels Mar 19, 2020

NGL321 assigned MrArnoldPalmer Mar 19, 2020

0xdevalias mentioned this issue Apr 8, 2020

Appsync datasource none #7145

Merged

MrArnoldPalmer removed their assignment Jun 21, 2021

github-actions bot assigned otaviomacedo Aug 20, 2021

otaviomacedo removed their assignment Nov 5, 2021

evgenyka changed the title ~~📊Tracking: AWS AppSync~~ Stabilize AWS AppSync module Sep 14, 2022

evgenyka added maturity/experimental Label for the modules that are in experimental maturity state and removed management/tracking Issues that track a subject or multiple issues labels Sep 14, 2022

MrArnoldPalmer added a commit that referenced this issue Jan 10, 2023

chore: stabilize appsync module

3416da0

Change stability and maturity of `@aws-cdk/aws-appsync` constructs to stable. Fixes: #6836

MrArnoldPalmer mentioned this issue Jan 10, 2023

feat(appsync): stabilize appsync module 🎆🎆 🎆 #23633

Merged

4 tasks

mergify bot closed this as completed in #23633 Jan 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Stabilize AWS AppSync module #6836

Stabilize AWS AppSync module #6836

NGL321 commented Mar 19, 2020 •

edited by evgenyka

Loading

0xdevalias commented Apr 8, 2020 •

edited

Loading

0xdevalias commented Apr 8, 2020 •

edited

Loading

0xdevalias commented Apr 8, 2020 •

edited

Loading

MrArnoldPalmer commented Apr 8, 2020

0xdevalias commented Apr 8, 2020

MrArnoldPalmer commented Apr 10, 2020

0xdevalias commented Apr 10, 2020 •

edited

Loading

BryanPan342 commented Jul 28, 2020 •

edited

Loading

0xdevalias commented Jul 28, 2020

BryanPan342 commented Jul 28, 2020

alan-cooney commented Feb 3, 2021

romanfq commented Jun 15, 2021

michaelbrewer commented Aug 16, 2021

revmischa commented Sep 7, 2021 •

edited

Loading

github-actions bot commented Jan 10, 2023

Stabilize AWS AppSync module #6836

Stabilize AWS AppSync module #6836

Comments

NGL321 commented Mar 19, 2020 • edited by evgenyka Loading

Add your +1 👍 to help us prioritize high-level constructs for this service

Overview:

Maturity: Experimental

Implementation:

Issue list:

0xdevalias commented Apr 8, 2020 • edited Loading

0xdevalias commented Apr 8, 2020 • edited Loading

0xdevalias commented Apr 8, 2020 • edited Loading

MrArnoldPalmer commented Apr 8, 2020

0xdevalias commented Apr 8, 2020

MrArnoldPalmer commented Apr 10, 2020

0xdevalias commented Apr 10, 2020 • edited Loading

BryanPan342 commented Jul 28, 2020 • edited Loading

0xdevalias commented Jul 28, 2020

BryanPan342 commented Jul 28, 2020

alan-cooney commented Feb 3, 2021

romanfq commented Jun 15, 2021

michaelbrewer commented Aug 16, 2021

revmischa commented Sep 7, 2021 • edited Loading

github-actions bot commented Jan 10, 2023

⚠️COMMENT VISIBILITY WARNING⚠️

NGL321 commented Mar 19, 2020 •

edited by evgenyka

Loading

0xdevalias commented Apr 8, 2020 •

edited

Loading

0xdevalias commented Apr 8, 2020 •

edited

Loading

0xdevalias commented Apr 8, 2020 •

edited

Loading

0xdevalias commented Apr 10, 2020 •

edited

Loading

BryanPan342 commented Jul 28, 2020 •

edited

Loading

revmischa commented Sep 7, 2021 •

edited

Loading