@cloudcomponents/cdk-github-webhook
@cloudcomponents/cdk-github-webhook / GithubWebhook
-
Construct↳
GithubWebhook
• new GithubWebhook(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
GithubWebhookProps |
Construct.constructor
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
Construct.node
▸ Protected onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.onPrepare
▸ Protected onSynthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.onSynthesize
▸ Protected onValidate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.onValidate
▸ Protected prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.prepare
▸ Protected synthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.synthesize
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
Construct.toString
▸ Protected validate(): string[]
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.validate
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
Construct.isConstruct
@cloudcomponents/cdk-github-webhook / GithubWebhookProps
• Readonly events: string[]
Determines what events the hook is triggered for.
see https://developer.github.com/v3/activity/events/types/
• Readonly githubApiToken: string | SecretKey
The OAuth access token
• Readonly githubRepoUrl: string
The Github repo url
• Optional Readonly logLevel: "debug" | "info" | "warning" | "error"
• Readonly payloadUrl: string
The URL to which the payloads will be delivered.