# AWS CodeConnections Host Custom Resource
[](https://github.com/gammarers/aws-codeconnections-host-custom-resource/blob/main/LICENSE)
[](https://www.npmjs.com/package/@gammarers/aws-codeconnections-host-custom-resource)
[](https://github.com/gammarers/aws-codeconnections-host-custom-resource/actions/workflows/release.yml)
[](https://github.com/gammarers/aws-codeconnections-host-custom-resource/releases)
[](https://constructs.dev/packages/@gammarers/aws-codeconnections-host-custom-resource)
This AWS CDK Construct provides a custom resource (Lambda Function) to create a connection host for Self-Managed GitLab, which is not yet supported by CloudFormation. Additionally, even after creating the Host and the connection, authentication must be done via a browser.
## Install
### TypeScript
#### install by npm
```shell
npm install @gammarers/aws-codeconnections-host-custom-resource
```
#### install by yarn
```shell
yarn add @gammarers/aws-codeconnections-host-custom-resource
```
### Python
#### install by pip
```shell
pip install gammarers.aws-budgets-notification
```
## Example
```python
import { CodeConnectionsHostCustomResource, CodeConnectionsHostProviderType } from '@gammarers/aws-codeconnections-host-custom-resource';
const codeConnectionsHostCustomResource = new CodeConnectionsHostCustomResource(this, 'CodeConnectionsHost', {
name: 'gitlab.example.com', // required, connection host name (Minimum length of 1. Maximum length of 64.)
providerEndpoint: 'https://gitlab.example.com', // required, your provider endpoint (Minimum length of 1. Maximum length of 512.)
providerType: CodeConnectionsHostProviderType.GIT_LAB_SELF_MANAGED,
});
// get host arn
const hostArn = gitLabSelfManagedConnectionHostCustomResource.findHostArn();
new codeconnections.CfnConnection(this, 'Connection', {
connectionName: 'example-gitlab-connection',
hostArn,
});
```
## How to complete (Update a pending connection)
Deploy completed after being configured in EXAMPLE.
At this point, the status is ‘Pending’ as shown below because authentication has not yet been completed.
<img alt="CodeConnection Setup 01" src="images/CodeConnection-Setup-01.png" width="800" />
Select the ‘Connection’ you have created to display the Connection detail screen.
<img alt="CodeConnection Setup 02" src="images/CodeConnection-Setup-02.png" width="800" />
You will see the ‘Pending’ status as follows. Select ‘Update pending connection’.
<img alt="CodeConnection Setup 03" src="images/CodeConnection-Setup-03.png" width="800" />
A screen to enter the Provide personal access token (pat) will be displayed; the pat should be created in the target host environment (only api should be enabled). Enter the pat and select ‘Continue’.
<img alt="CodeConnection Setup 04" src="images/CodeConnection-Setup-04.png" width="500" />
The host authorisation screen will appear as shown below, select ‘Authorise’ (the screen will pop up).
> If you have not logged in, a login screen will be displayed, please log in.
<img alt="CodeConnection Setup 05" src="images/CodeConnection-Setup-05.png" width="800" />
When completed, the status will change to ‘Available’ as follows. This completes all Connection settings.
## License
This project is licensed under the Apache-2.0 License.
Raw data
{
"_id": null,
"home_page": "https://github.com/gammarers/aws-codeconnections-host-custom-resource.git",
"name": "gammarers.aws-codeconnections-host-custom-resource",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.9",
"maintainer_email": null,
"keywords": null,
"author": "yicr<yicr@users.noreply.github.com>",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a3/6b/32d3d6f68caaad7b01107cf152275e05e4d039d4c242b96ca8d81ecf7d82/gammarers_aws_codeconnections_host_custom_resource-0.7.15.tar.gz",
"platform": null,
"description": "# AWS CodeConnections Host Custom Resource\n\n[](https://github.com/gammarers/aws-codeconnections-host-custom-resource/blob/main/LICENSE)\n[](https://www.npmjs.com/package/@gammarers/aws-codeconnections-host-custom-resource)\n[](https://github.com/gammarers/aws-codeconnections-host-custom-resource/actions/workflows/release.yml)\n[](https://github.com/gammarers/aws-codeconnections-host-custom-resource/releases)\n\n[](https://constructs.dev/packages/@gammarers/aws-codeconnections-host-custom-resource)\n\nThis AWS CDK Construct provides a custom resource (Lambda Function) to create a connection host for Self-Managed GitLab, which is not yet supported by CloudFormation. Additionally, even after creating the Host and the connection, authentication must be done via a browser.\n\n## Install\n\n### TypeScript\n\n#### install by npm\n\n```shell\nnpm install @gammarers/aws-codeconnections-host-custom-resource\n```\n\n#### install by yarn\n\n```shell\nyarn add @gammarers/aws-codeconnections-host-custom-resource\n```\n\n### Python\n\n#### install by pip\n\n```shell\npip install gammarers.aws-budgets-notification\n```\n\n## Example\n\n```python\nimport { CodeConnectionsHostCustomResource, CodeConnectionsHostProviderType } from '@gammarers/aws-codeconnections-host-custom-resource';\n\nconst codeConnectionsHostCustomResource = new CodeConnectionsHostCustomResource(this, 'CodeConnectionsHost', {\n name: 'gitlab.example.com', // required, connection host name (Minimum length of 1. Maximum length of 64.)\n providerEndpoint: 'https://gitlab.example.com', // required, your provider endpoint (Minimum length of 1. Maximum length of 512.)\n providerType: CodeConnectionsHostProviderType.GIT_LAB_SELF_MANAGED,\n});\n\n// get host arn\nconst hostArn = gitLabSelfManagedConnectionHostCustomResource.findHostArn();\n\nnew codeconnections.CfnConnection(this, 'Connection', {\n connectionName: 'example-gitlab-connection',\n hostArn,\n});\n```\n\n## How to complete (Update a pending connection)\n\nDeploy completed after being configured in EXAMPLE.\nAt this point, the status is \u2018Pending\u2019 as shown below because authentication has not yet been completed.\n\n<img alt=\"CodeConnection Setup 01\" src=\"images/CodeConnection-Setup-01.png\" width=\"800\" />\n\nSelect the \u2018Connection\u2019 you have created to display the Connection detail screen.\n\n<img alt=\"CodeConnection Setup 02\" src=\"images/CodeConnection-Setup-02.png\" width=\"800\" />\n\nYou will see the \u2018Pending\u2019 status as follows. Select \u2018Update pending connection\u2019.\n\n<img alt=\"CodeConnection Setup 03\" src=\"images/CodeConnection-Setup-03.png\" width=\"800\" />\n\nA screen to enter the Provide personal access token (pat) will be displayed; the pat should be created in the target host environment (only api should be enabled). Enter the pat and select \u2018Continue\u2019.\n\n<img alt=\"CodeConnection Setup 04\" src=\"images/CodeConnection-Setup-04.png\" width=\"500\" />\n\nThe host authorisation screen will appear as shown below, select \u2018Authorise\u2019 (the screen will pop up).\n\n> If you have not logged in, a login screen will be displayed, please log in.\n\n<img alt=\"CodeConnection Setup 05\" src=\"images/CodeConnection-Setup-05.png\" width=\"800\" />\n\nWhen completed, the status will change to \u2018Available\u2019 as follows. This completes all Connection settings.\n\n## License\n\nThis project is licensed under the Apache-2.0 License.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "This AWS CDK Construct provides a custom resource (Lambda Function) to create a connection host for Self-Managed GitLab, which is not yet supported by CloudFormation. Additionally, even after creating the Host and the connection, authentication must be done via a browser.",
"version": "0.7.15",
"project_urls": {
"Homepage": "https://github.com/gammarers/aws-codeconnections-host-custom-resource.git",
"Source": "https://github.com/gammarers/aws-codeconnections-host-custom-resource.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "99b31345bf4c4cf42c192fa2908ad771255edacd9e3eb1f2082fc81f236afdc9",
"md5": "dd9f1247d8594ad52ae018ad27432de6",
"sha256": "2ba29f5cfc8792ca1212c9852c20fc4795f8944534652c3efa626b111b7fde59"
},
"downloads": -1,
"filename": "gammarers_aws_codeconnections_host_custom_resource-0.7.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dd9f1247d8594ad52ae018ad27432de6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.9",
"size": 412595,
"upload_time": "2025-09-02T16:44:20",
"upload_time_iso_8601": "2025-09-02T16:44:20.194193Z",
"url": "https://files.pythonhosted.org/packages/99/b3/1345bf4c4cf42c192fa2908ad771255edacd9e3eb1f2082fc81f236afdc9/gammarers_aws_codeconnections_host_custom_resource-0.7.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a36b32d3d6f68caaad7b01107cf152275e05e4d039d4c242b96ca8d81ecf7d82",
"md5": "bf5965af4b1d5dd70b904fdd4f91e212",
"sha256": "76306c8ebfd3e3c5f9308e4fa60d42822d5d3dd9bdaf9664cd02e03450dc5a2c"
},
"downloads": -1,
"filename": "gammarers_aws_codeconnections_host_custom_resource-0.7.15.tar.gz",
"has_sig": false,
"md5_digest": "bf5965af4b1d5dd70b904fdd4f91e212",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.9",
"size": 413660,
"upload_time": "2025-09-02T16:44:21",
"upload_time_iso_8601": "2025-09-02T16:44:21.703243Z",
"url": "https://files.pythonhosted.org/packages/a3/6b/32d3d6f68caaad7b01107cf152275e05e4d039d4c242b96ca8d81ecf7d82/gammarers_aws_codeconnections_host_custom_resource-0.7.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-02 16:44:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gammarers",
"github_project": "aws-codeconnections-host-custom-resource",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gammarers.aws-codeconnections-host-custom-resource"
}
JSON
