Skip to content

Commit f279b3d

Browse files
committed
feat(docs): update readme(add Update a pending connection)
1 parent aa85fe6 commit f279b3d

File tree

6 files changed

+43
-0
lines changed

6 files changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
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.
44

5+
## Install
6+
7+
### TypeScript
8+
9+
#### install by npm
10+
11+
```shell
12+
npm install @gammarers/aws-codeconnections-host-custom-resource
13+
```
14+
15+
#### install by yarn
16+
17+
```shell
18+
yarn add @gammarers/aws-codeconnections-host-custom-resource
19+
```
520

621
## Example
722

@@ -24,6 +39,34 @@ new codeconnections.CfnConnection(this, 'Connection', {
2439

2540
```
2641

42+
## How to complete (Update a pending connection)
43+
44+
Deploy completed after being configured in EXAMPLE.
45+
At this point, the status is ‘Pending’ as shown below because authentication has not yet been completed.
46+
47+
<img alt="CodeConnection Setup 01" src="images/CodeConnection-Setup-01.png" width="800" />
48+
49+
Select the ‘Connection’ you have created to display the Connection detail screen.
50+
51+
<img alt="CodeConnection Setup 02" src="images/CodeConnection-Setup-02.png" width="800" />
52+
53+
You will see the ‘Pending’ status as follows. Select ‘Update pending connection’.
54+
55+
<img alt="CodeConnection Setup 03" src="images/CodeConnection-Setup-03.png" width="800" />
56+
57+
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’.
58+
59+
<img alt="CodeConnection Setup 04" src="images/CodeConnection-Setup-04.png" width="500" />
60+
61+
The host authorisation screen will appear as shown below, select ‘Authorise’ (the screen will pop up).
62+
> If you have not logged in, a login screen will be displayed, please log in.
63+
64+
<img alt="CodeConnection Setup 05" src="images/CodeConnection-Setup-05.png" width="800" />
65+
66+
When completed, the status will change to ‘Available’ as follows. This completes all Connection settings.
67+
68+
69+
2770
## License
2871

2972
This project is licensed under the Apache-2.0 License.

images/CodeConnection-Setup-01.png

82.4 KB
Loading

images/CodeConnection-Setup-02.png

95.8 KB
Loading

images/CodeConnection-Setup-03.png

44.5 KB
Loading

images/CodeConnection-Setup-04.png

105 KB
Loading

images/CodeConnection-Setup-05.png

67.4 KB
Loading

0 commit comments

Comments
 (0)