https://github.com/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.
https://github.com/gammarers/aws-codeconnections-host-custom-resource

aws cdk codeconnection construct customresource hoat

Last synced: about 2 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/gammarers/aws-codeconnections-host-custom-resource
• Owner: gammarers
• License: apache-2.0
• Created: 2024-09-10T08:53:43.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-15T16:39:43.000Z (2 months ago)
• Last Synced: 2024-10-16T22:40:43.699Z (2 months ago)
• Topics: aws, cdk, codeconnection, construct, customresource, hoat
• Language: TypeScript
• Homepage:
• Size: 1020 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AWS CodeConnections Host Custom Resource

[![GitHub](https://img.shields.io/github/license/gammarers/aws-codeconnections-host-custom-resource?style=flat-square)](https://github.com/gammarers/aws-codeconnections-host-custom-resource/blob/main/LICENSE)

[![npm (scoped)](https://img.shields.io/npm/v/@gammarers/aws-codeconnections-host-custom-resource?style=flat-square)](https://www.npmjs.com/package/@gammarers/aws-codeconnections-host-custom-resource)

[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/gammarers/aws-codeconnections-host-custom-resource/release.yml?branch=main&label=release&style=flat-square)](https://github.com/gammarers/aws-codeconnections-host-custom-resource/actions/workflows/release.yml)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/gammarers/aws-codeconnections-host-custom-resource?sort=semver&style=flat-square)](https://github.com/gammarers/aws-codeconnections-host-custom-resource/releases)

[![View on Construct Hub](https://constructs.dev/badge?package=@gammarers/aws-codeconnections-host-custom-resource)](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

```

## Example

```typescript

import { RDSDatabaseAutoRunningStopStack, 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 = codeConnectionsHostCustomResource.getResponseField('HostArn');

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.



Select the ‘Connection’ you have created to display the Connection detail screen.



You will see the ‘Pending’ status as follows. Select ‘Update pending connection’.



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



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.



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.