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.

Sign up for GitHub

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

Jump to bottom

feat(pipes-targets): add API Gateway #30772

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

feat(pipes-targets): add API Gateway #30772

wants to merge 6 commits into from
+34,910 −0

Conversation

msambol
Copy link
Contributor

@msambol msambol commented Jul 6, 2024

Add API Gateway REST API as a Pipes target.

@github-actions github-actions bot added the p2 label Jul 6, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team July 6, 2024 23:41
@github-actions github-actions bot added the distinguished-contributor [Pilot] contributed 50+ PRs to the CDK label Jul 6, 2024
@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 Jul 7, 2024
nmussy
nmussy suggested changes Jul 7, 2024
View reviewed changes
Copy link
Contributor

@nmussy nmussy left a comment

Choose a reason for hiding this comment

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

The docs don't explicitly mention that the target can only be a REST API, it might work with WebSockets? If that's the case, could you add an integ and the likes?

packages/@aws-cdk/aws-pipes-targets-alpha/README.md Outdated Show resolved Hide resolved
packages/@aws-cdk/aws-pipes-targets-alpha/lib/api-gateway.ts Outdated Show resolved Hide resolved
packages/@aws-cdk/aws-pipes-targets-alpha/lib/api-gateway.ts Show resolved Hide resolved
packages/@aws-cdk/aws-pipes-targets-alpha/test/integ.api-gateway.ts Outdated Show resolved Hide resolved
@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 Jul 7, 2024
@msambol
Copy link
Contributor Author

msambol commented Jul 7, 2024 •
edited
Loading

The docs don't explicitly mention that the target can only be a REST API, it might work with WebSockets? If that's the case, could you add an integ and the likes?

Good shout about the docs. I did create a WebSocket API and it wasn't available in the Console when I tried to create a Pipe target. The CFN docs do state only REST APIs. @redwheeler3, can you confirm if REST APIs are the only type supported here?

msambol
msambol commented Jul 7, 2024
View reviewed changes
packages/@aws-cdk/aws-pipes-targets-alpha/lib/api-gateway.ts
grantPush(grantee: IRole): void {
grantee.addToPrincipalPolicy(new PolicyStatement({
resources: [this.restApiArn],
actions: ['execute-api:Invoke'],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nmussy updated this to just Invoke

msambol
msambol commented Jul 7, 2024
View reviewed changes
packages/@aws-cdk/aws-pipes-targets-alpha/test/integ.api-gateway.ts
'x-header': 'myheader',
},
queryStringParameters: { key: 'USA' },
pathParameterValues: ['fiction'],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nmussy I think this is what you're after? fiction replaces the * in path defined above. More coverage..

@github-actions github-actions bot mentioned this pull request Jul 8, 2024
Closed
@redwheeler3
Copy link

Good shout about the docs. I did create a WebSocket API and it wasn't available in the Console when I tried to create a Pipe target. The CFN docs do state only REST APIs. @redwheeler3, can you confirm if REST APIs are the only type supported here?

Pipes does not support WebSocket APIs.

@msambol
Copy link
Contributor Author

msambol commented Jul 8, 2024

Good shout about the docs. I did create a WebSocket API and it wasn't available in the Console when I tried to create a Pipe target. The CFN docs do state only REST APIs. @redwheeler3, can you confirm if REST APIs are the only type supported here?

Pipes does not support WebSocket APIs.

The ManageConnections permission can be removed from the role created by the Console.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@pahud pahud added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 22, 2024
@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 22, 2024
@pahud pahud added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jul 22, 2024
@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 Jul 22, 2024
@github-actions github-actions bot mentioned this pull request Aug 1, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nmussy nmussy nmussy requested changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
distinguished-contributor [Pilot] contributed 50+ PRs to the CDK p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@msambol @redwheeler3 @aws-cdk-automation @nmussy @pahud