tim-finnigan
commented
2 years ago Hi @jackson-theisen thanks for the feature request. I think the console step may be required due to GitHub’s OAuth connection workflow. And that’s why the warning is called out in the documentation you referenced and here as well:
You must use the console to update a pending connection. You cannot update a pending connection using the AWS CLI.
But I will reach out to the CodeStar team and see if there is any possibility of working around this.
rpstreef
jackson-theisen
evgenygigi
github-actions[bot]
jesseadams
carlosjgp
Describe the feature
Note: This request pertains specifically to the GitHub provider type, but may be applicable for other supported types.
The current process for creating a connection to GitHub supports programmatic creation of a connection resource. If the connection is created programmatically (AWS CLI, CloudFormation, Terraform, etc.), it is automatically left in a
PENDINGstate. To complete aPENDINGconnection, you must use the console. Using the console does make sense for the initial one-time authorization and handshake to the provider for creating installations. If the AWS Connector for GitHub App already exists, I would like the ability to programmatically create my connections in anAvailablestate. This could be achieved by supporting an argument for the GitHub App ID. To reap the benefits of this feature, we will also need a way to query GitHub App IDs for a given account/region.Use Case
In the context of a large, multi-account, environment where everything is managed in code within the same GitHub organization, it is extremely painful to have a required manual step to visit the console and complete a connection. I understand the need for this manual step during the initial one-time installation of AWS Connector for GitHub app, but subsequent connections should not require the manual step if they plan to leverage the existing app (at the time of writing, only one AWS Connector may exist per GitHub Organization). This pain point is further exacerbated by the fact that your standard developer more than likely does not have the proper permissions to perform the connection completion (both on the AWS and GitHub side).
Proposed Solution
The API should support the ability to query for the existence of (and return their IDs if true) GitHub Apps which are already installed and configured. This would allow someone to determine whether creating a connection will require manual steps from an admin to complete the initialization. Furthermore, the creation of a connection for the GitHub App could support an argument that allows you to specify an existing GitHub App ID. This would result in connections being created in the
Availablestate right out of the box.Other Information
No response
Acknowledgements
CLI version used
aws-cli/2.5.4 Python/3.9.12
Environment details (OS name and version, etc.)
Ubuntu >=20.04, AL2, macOS Monterey >=12.3