appsync: appsync.HttpDataSourceProps erroneously extends BaseDataSourceProps

[ScottRobinson03]

Describe the bug

In #11185, the HttpDataSource class was updated to extend BackedDataSource instead of BaseDataSource, however the HttpDataSourceProps type wasn't updated to reflect this change.

Regression Issue

• Select this option if this issue appears to be a regression.

Last Known Working CDK Version

No response

Expected Behavior

The HttpDataSourceProps type should extend BackendDataSourceProps

Current Behavior

The HttpDataSourceProps type erroneously extends BaseDataSourceProps

Reproduction Steps

Minimum-repro to see the type error:

import * as appsync from "aws-cdk-lib/aws-appsync";
import type { IRole } from "aws-cdk-lib/aws-iam";

declare const myApi: appsync.GraphqlApi;
declare const serviceRole: IRole;

const stepFunctionHttpDataSource = new appsync.HttpDataSource(
    myApi,
    "MyStepFunctionHTTPDataSource",
    {
        api: myApi,
        authorizationConfig: {
            signingRegion: "eu-west-1",
            signingServiceName: "states",
        },
        endpoint: `https://states.eu-west-1.amazonaws.com`,
        name: "StepFunctionHTTPDataSource",
        // Providing the `serviceRole` incorrectly throws a type error
        serviceRole,
    }
);

Possible Solution

Update the HttpDataSourceProps type to extend BackendDataSourceProps

Additional Information/Context

The only difference between BaseDataSourceProps and BackedDataSourceProps, is that BackedDataSourceProps adds an optional prop serviceRole, which is required for workflows that require custom permissions, such as the above example of starting a state machine.

The code for BaseDataSourceProps and BackedDataSourceProps is here, and shown below:

/**
 * Base properties for an AppSync datasource
 */
export interface BaseDataSourceProps {
  /**
   * The API to attach this data source to
   */
  readonly api: IGraphqlApi;
  /**
   * The name of the data source
   *
   * @default - id of data source
   */
  readonly name?: string;
  /**
   * the description of the data source
   *
   * @default - None
   */
  readonly description?: string;
}

/**
 * properties for an AppSync datasource backed by a resource
 */
export interface BackedDataSourceProps extends BaseDataSourceProps {
  /**
   * The IAM service role to be assumed by AppSync to interact with the data source
   *
   * @default -  Create a new role
   */
  readonly serviceRole?: IRole;
}

CDK CLI Version

2.139.0

Framework Version

No response

Node.js Version

20

OS

MacOS Sonoma 14.7

Language

TypeScript

Language Version

TypeScript 5.6.3

Other information

NB: #29689 would have fixed this however the PR was closed after going stale when requesting an exemption to requiring tests.

[khushail]

@ScottRobinson03 , thanks for opening the issue and providing the code links.
Yes, this observation totally makes sense and I can confirm that the error seen while trying to declare the serviceRole -

As its already pointed out, HttpDataSourceProps extends BaseDataSourceProps

aws-cdk/packages/aws-cdk-lib/aws-appsync/lib/data-source.ts

Line 258 in a21a0b1

export interface HttpDataSourceProps extends BaseDataSourceProps {

and BaseDataSourceProps has these attrtibutes-

https://github.com/aws/aws-cdk/blob/a21a0b1392faecbb0a19a6ca90b64a1da8ad5d81/packages/aws-cdk-lib/aws-appsync/lib/data-source.ts#L19C1-L36C2

export interface BaseDataSourceProps {
  /**
   * The API to attach this data source to
   */
  readonly api: IGraphqlApi;
  /**
   * The name of the data source
   *
   * @default - id of data source
   */
  readonly name?: string;
  /**
   * the description of the data source
   *
   * @default - None
   */
  readonly description?: string;
}

and HttpDataSource extends BackendDataSource-

https://github.com/aws/aws-cdk/blob/00f70f1976adf6539d909fa0a5cf583c5b5289ac/packages/aws-cdk-lib/aws-appsync/lib/data-source.ts#L276C14-L276C28

where the serviceRole is provided by BackedDataSourceProps-

aws-cdk/packages/aws-cdk-lib/aws-appsync/lib/data-source.ts

Line 41 in a21a0b1

export interface BackedDataSourceProps extends BaseDataSourceProps {

export interface BackedDataSourceProps extends BaseDataSourceProps {
  /**
   * The IAM service role to be assumed by AppSync to interact with the data source
   *
   * @default -  Create a new role
   */
  readonly serviceRole?: IRole;
}

which is the reason why the error is being seen.

[ScottRobinson03]

Thanks for looking into this @khushail.

What's the next step to get this fixed? Can #29689 be re-opened, or would I need to create a new PR?

[khushail]

@ScottRobinson03 , I think you should be able to reopen the PR. Also please link this issue in the description and update whatever is needed to get the community review done.

Let me know if you need any further help! Appreciate your contribution.

[ScottRobinson03]

@khushail Thanks, I've updated the PR description accordingly and left a comment too, however the comment didn't reopen the PR as I suspected. I assume this means I don't have permissions to reopen the PR, so are you perhaps able to do this on my behalf?

[khushail]

@ScottRobinson03 , its reopened. Please feel free to work on it now.

[ScottRobinson03]

Thanks @khushail. Afaik there's no more work to do from me (the PR is just a one-line fix), so it's just pending reviews (and an integ-test exemption approval, since it's just a type fix [there's no runtime code to actually test]).

[ScottRobinson03]

#29689 got automatically closed again, so I've replaced it with #32065.

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