@cloudcomponents/cdk-lambda-at-edge-pattern
- CommonEdgeFunctionProps
- Configuration
- EdgeFunctionProps
- EdgeRoleProps
- HttpHeadersProps
- IEdgeLambda
- IEdgeRole
- ILambdaFunctionAssociation
- WithConfigurationProps
@cloudcomponents/cdk-lambda-at-edge-pattern / BaseEdgeConstruct
-
Construct↳
BaseEdgeConstruct↳↳
EdgeFunction↳↳
EdgeRole
- getCrossRegionSupportSynthesizer
- getOrCreateCrossRegionSupportStack
- onPrepare
- onSynthesize
- onValidate
- prepare
- requireApp
- synthesize
- toString
- validate
- isConstruct
• new BaseEdgeConstruct(scope, id)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
Construct.constructor
• Protected Readonly edgeStack: Stack
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
Construct.node
• Protected Readonly stack: Stack
▸ Private getCrossRegionSupportSynthesizer(): undefined | IStackSynthesizer
undefined | IStackSynthesizer
▸ Private getOrCreateCrossRegionSupportStack(): Stack
Stack
▸ 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
▸ Private requireApp(): App
App
▸ 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-lambda-at-edge-pattern / EdgeFunction
-
↳
EdgeFunction↳↳
HttpHeaders
• new EdgeFunction(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
EdgeFunctionProps |
• Readonly edgeRole: IEdgeRole
• Protected Readonly edgeStack: Stack
• Readonly eventType: LambdaEdgeEventType
• Readonly functionVersion: IVersion
• Readonly lambdaFunction: IVersion
ILambdaFunctionAssociation.lambdaFunction
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
• Protected Readonly stack: Stack
▸ 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
▸ 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
BaseEdgeConstruct.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.
▸ 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
▸ 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
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
▸ 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.
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
@cloudcomponents/cdk-lambda-at-edge-pattern / EdgeRole
-
↳
EdgeRole
- addToEdgeRolePolicy
- onPrepare
- onSynthesize
- onValidate
- prepare
- synthesize
- toString
- validate
- isConstruct
• new EdgeRole(scope, id, props?)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
EdgeRoleProps |
• Protected Readonly edgeStack: Stack
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
• Readonly role: IRole
• Protected Readonly stack: Stack
▸ addToEdgeRolePolicy(statement): void
| Name | Type |
|---|---|
statement |
PolicyStatement |
void
▸ 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
▸ 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
BaseEdgeConstruct.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.
▸ 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
▸ 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
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
▸ 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.
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
@cloudcomponents/cdk-lambda-at-edge-pattern / HttpHeaders
-
↳
HttpHeaders
• new HttpHeaders(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
HttpHeadersProps |
• Readonly edgeRole: IEdgeRole
• Protected Readonly edgeStack: Stack
• Readonly eventType: LambdaEdgeEventType
• Readonly functionVersion: IVersion
• Readonly lambdaFunction: IVersion
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
• Protected Readonly stack: Stack
▸ 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
▸ 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
▸ 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.
▸ 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
▸ 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
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
▸ 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.
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
@cloudcomponents/cdk-lambda-at-edge-pattern / WithConfiguration
-
Construct↳
WithConfiguration
• new WithConfiguration(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
WithConfigurationProps |
Construct.constructor
• Readonly functionVersion: IVersion
• 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-lambda-at-edge-pattern / LogLevel
• DEBUG = "debug"
• ERROR = "error"
• INFO = "info"
• NONE = "none"
• WARN = "warn"
@cloudcomponents/cdk-lambda-at-edge-pattern / CommonEdgeFunctionProps
-
CommonEdgeFunctionProps
• Optional Readonly edgeRole: IEdgeRole
• Optional Readonly parameterName: string
The name of the parameter.
@cloudcomponents/cdk-lambda-at-edge-pattern / Configuration
▪ [key: string]: unknown
• Readonly logLevel: LogLevel
@cloudcomponents/cdk-lambda-at-edge-pattern / EdgeFunctionProps
-
↳
EdgeFunctionProps
• Readonly code: Code
• Readonly configuration: Configuration
• Optional Readonly edgeRole: IEdgeRole
CommonEdgeFunctionProps.edgeRole
• Readonly eventType: LambdaEdgeEventType
• Readonly name: string
• Optional Readonly parameterName: string
The name of the parameter.
CommonEdgeFunctionProps.parameterName
@cloudcomponents/cdk-lambda-at-edge-pattern / EdgeRoleProps
• Optional Readonly roleName: string
@cloudcomponents/cdk-lambda-at-edge-pattern / HttpHeadersProps
-
↳
HttpHeadersProps
• Optional Readonly edgeRole: IEdgeRole
CommonEdgeFunctionProps.edgeRole
• Readonly httpHeaders: Record<string, string>
• Optional Readonly logLevel: LogLevel
• Optional Readonly parameterName: string
The name of the parameter.
CommonEdgeFunctionProps.parameterName
@cloudcomponents/cdk-lambda-at-edge-pattern / IEdgeLambda
• Readonly eventType: LambdaEdgeEventType
• Readonly functionVersion: IVersion
@cloudcomponents/cdk-lambda-at-edge-pattern / IEdgeRole
• Readonly role: IRole
▸ addToEdgeRolePolicy(statement): void
| Name | Type |
|---|---|
statement |
PolicyStatement |
void
@cloudcomponents/cdk-lambda-at-edge-pattern / ILambdaFunctionAssociation
• Readonly eventType: LambdaEdgeEventType
• Readonly lambdaFunction: IVersion
@cloudcomponents/cdk-lambda-at-edge-pattern / WithConfigurationProps
• Readonly configuration: Configuration
• Readonly function: IFunction