Cutwater

Cutwater

  • Docs
  • Help
  • GitHub

›API Reference

Introduction

  • Getting Started

API Reference

  • @codification/cutwater-build-core
  • @codification/cutwater-core
  • @codification/cutwater-node-core
  • @codification/cutwater-logging
  • @codification/cutwater-aws

@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

  • API Documentation

Classes

  • LambdaEdgeUtils
  • S3Bucket

Interfaces

  • CloudFrontOriginRequestEvent
  • OriginRequestConfig

Functions

  • mockCloudFrontRequestEvent
  • withCustomOriginRequestHeaders
  • withOriginRequestResponse
  • withOriginResponseHeaders
  • withRequestHeaderConfig

Functions

<Const> mockCloudFrontRequestEvent

▸ mockCloudFrontRequestEvent(requestEvent?: Partial<CloudFrontRequestEvent>): CloudFrontRequestEvent

Defined in cloudfront/CloudFront.mock.ts:80

Parameters:

NameType
Optional requestEventPartial<CloudFrontRequestEvent>

Returns: CloudFrontRequestEvent


<Const> withCustomOriginRequestHeaders

▸ withCustomOriginRequestHeaders(customHeaderPrefix?: string): IMiddyMiddlewareObject

Defined in cloudfront/MIddyMiddlewares.ts:104

Parameters:

NameTypeDefault value
Default value customHeaderPrefixstring"x-custom-"

Returns: IMiddyMiddlewareObject


<Const> withOriginRequestResponse

▸ withOriginRequestResponse(config?: OriginRequestConfig): IMiddyMiddlewareObject

Defined in cloudfront/MIddyMiddlewares.ts:53

Parameters:

NameType
Optional configOriginRequestConfig

Returns: IMiddyMiddlewareObject


<Const> withOriginResponseHeaders

▸ withOriginResponseHeaders(config: IncomingHttpHeaders): IMiddyMiddlewareObject

Defined in cloudfront/MIddyMiddlewares.ts:155

Parameters:

NameType
configIncomingHttpHeaders

Returns: IMiddyMiddlewareObject


<Const> withRequestHeaderConfig

▸ withRequestHeaderConfig(customHeaderPrefix?: string): IMiddyMiddlewareObject

Defined in cloudfront/MIddyMiddlewares.ts:128

Parameters:

NameTypeDefault value
Default value customHeaderPrefixstring"x-config-"

Returns: IMiddyMiddlewareObject


← @codification/cutwater-logging
  • Installation
  • Documentation
    • Classes
    • Interfaces
    • Functions
  • Functions
    • `` mockCloudFrontRequestEvent
    • `` withCustomOriginRequestHeaders
    • `` withOriginRequestResponse
    • `` withOriginResponseHeaders
    • `` withRequestHeaderConfig
Cutwater
Docs
Getting Started
Community
Stack Overflow
More
GitHubStar
Copyright © 2019 Codification.org