Skip to content

Latest commit

 

History

History
325 lines (179 loc) · 5.15 KB

File metadata and controls

325 lines (179 loc) · 5.15 KB

README

@cloudcomponents/cdk-contentful-webhook

@cloudcomponents/cdk-contentful-webhook

Table of contents

Classes

Interfaces

Contentful Webhook

@cloudcomponents/cdk-contentful-webhook / ContentfulWebhook

Class: ContentfulWebhook

Hierarchy

  • Construct

    ContentfulWebhook

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ContentfulWebhook(scope, id, props)

Parameters

Name Type
scope Construct
id string
props ContentfulWebhookProps

Overrides

Construct.constructor

Properties

node

Readonly node: ConstructNode

The construct tree node associated with this construct.

stability stable

Inherited from

Construct.node

Methods

onPrepare

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

Returns

void

Inherited from

Construct.onPrepare


onSynthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

Construct.onSynthesize


onValidate

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

Returns

string[]

An array of validation error messages, or an empty array if the construct is valid.

Inherited from

Construct.onValidate


prepare

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

Returns

void

Inherited from

Construct.prepare


synthesize

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

Parameters

Name Type Description
session ISynthesisSession The synthesis session.

Returns

void

Inherited from

Construct.synthesize


toString

toString(): string

Returns a string representation of this construct.

stability stable

Returns

string

Inherited from

Construct.toString


validate

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

Returns

string[]

An array of validation error messages, or an empty array if the construct is valid.

Inherited from

Construct.validate


isConstruct

Static isConstruct(x): x is Construct

Return whether the given object is a Construct.

stability stable

Parameters

Name Type
x any

Returns

x is Construct

Inherited from

Construct.isConstruct

Contentful Webhook Props

@cloudcomponents/cdk-contentful-webhook / ContentfulWebhookProps

Interface: ContentfulWebhookProps

Table of contents

Properties

Properties

accessToken

Readonly accessToken: string | SecretKey


logLevel

Optional Readonly logLevel: "debug" | "info" | "warning" | "error"


name

Readonly name: string


spaceId

Readonly spaceId: string


topics

Readonly topics: string[]


url

Readonly url: string