Skip to content

Commit 1675d5c

Browse files
feat(codestarconnection): add grants methods (#5)
* feat(codestarconnection): grant methods to easly add policy statements This grant specific permission to the code star connection * docs(codestarconnection): add how to use it in readme file It adds the basic instrucction of how to create a code star connection * test(codestarconnection): remove console log it removes unncessary console.log function in a test * docs(codestarconnection): update api documentation This is use by contruct hub to show all methods available
1 parent 7d93f20 commit 1675d5c

File tree

4 files changed

+592
-6
lines changed

4 files changed

+592
-6
lines changed

API.md

Lines changed: 288 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
1-
# AWS CodeStar Connection
1+
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
2+
![npm](https://img.shields.io/npm/v/%40jttc%2Faws-codestarconnection)
3+
4+
# AWS CodeStar Connection Construct Library
5+
6+
This package contains constructs for working with Amazon CodeStar Connection.
7+
8+
## CodeStar Connection
9+
Define a Codestar Connection by creating a new instance of CodeStarConnection. You can create a connection for different providers
10+
11+
``` typescript
12+
const codestartConnection = new CodeStarConnection(
13+
this,
14+
'CodeStarConnection',
15+
{
16+
connectionName: 'github-connection',
17+
providerType: CodeStarConnectionProviderType.GITHUB,
18+
}
19+
);
20+
```
21+
22+
23+
24+
25+

0 commit comments

Comments
 (0)