@codification/cutwater-aws
@codification/cutwater-aws
A library of tools for solving common tasks when working with Amazon's AWS cloud service.
Installation
Via npm:
npm install @codification/cutwater-aws
Via yarn:
yarn add @codification/cutwater-aws
Documentation
Classes
Interfaces
Functions
- mockCloudFrontRequestEvent
- withCustomOriginRequestHeaders
- withOriginRequestResponse
- withOriginResponseHeaders
- withRequestHeaderConfig
Functions
<Const>
mockCloudFrontRequestEvent
▸ mockCloudFrontRequestEvent(requestEvent?: Partial
<CloudFrontRequestEvent
>): CloudFrontRequestEvent
Defined in cloudfront/CloudFront.mock.ts:80
Parameters:
Name | Type |
---|---|
Optional requestEvent | Partial <CloudFrontRequestEvent > |
Returns: CloudFrontRequestEvent
<Const>
withCustomOriginRequestHeaders
▸ withCustomOriginRequestHeaders(customHeaderPrefix?: string
): IMiddyMiddlewareObject
Defined in cloudfront/MIddyMiddlewares.ts:104
Parameters:
Name | Type | Default value |
---|---|---|
Default value customHeaderPrefix | string | "x-custom-" |
Returns: IMiddyMiddlewareObject
<Const>
withOriginRequestResponse
▸ withOriginRequestResponse(config?: OriginRequestConfig): IMiddyMiddlewareObject
Defined in cloudfront/MIddyMiddlewares.ts:53
Parameters:
Name | Type |
---|---|
Optional config | OriginRequestConfig |
Returns: IMiddyMiddlewareObject
<Const>
withOriginResponseHeaders
▸ withOriginResponseHeaders(config: IncomingHttpHeaders
): IMiddyMiddlewareObject
Defined in cloudfront/MIddyMiddlewares.ts:155
Parameters:
Name | Type |
---|---|
config | IncomingHttpHeaders |
Returns: IMiddyMiddlewareObject
<Const>
withRequestHeaderConfig
▸ withRequestHeaderConfig(customHeaderPrefix?: string
): IMiddyMiddlewareObject
Defined in cloudfront/MIddyMiddlewares.ts:128
Parameters:
Name | Type | Default value |
---|---|---|
Default value customHeaderPrefix | string | "x-config-" |
Returns: IMiddyMiddlewareObject