@types/aws-cloudfront-function

Installation

npm install --save @types/aws-cloudfront-function

Summary

This package contains type definitions for AWS CloudFront Functions (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-event-structure.html).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/aws-cloudfront-function.

index.d.ts

// Type definitions for non-npm package AWS CloudFront Functions 1.0
// Project: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-event-structure.html
// Definitions by: Jakub Zelenka <https://github.com/bukka>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.0

export interface CloudFrontFunctionEvent {
    version: "1.0";
    context: CloudFrontFunctionContext;
    viewer: CloudFrontFunctionViewer;
    request: CloudFrontFunctionRequest;
    response: CloudFrontFunctionResponse;
}

export interface CloudFrontFunctionContext {
    distributionDomainName: string;
    distributionID: string;
    eventType: "viewer-request" | "viewer-response";
    requestId: string;
}

export interface CloudFrontFunctionViewer {
    ip: string;
}

export interface CloudFrontFunctionRequest {
    method: string;
    uri: string;
    querystring: CloudFrontFunctionValueObject;
    headers: CloudFrontFunctionValueObject;
    cookies: CloudFrontFunctionValueObject;
}

export interface CloudFrontFunctionResponse {
    statusCode: number;
    statusDescription?: string;
    headers: CloudFrontFunctionValueObject;
    cookies: CloudFrontFunctionResponseCookie;
}

export interface CloudFrontFunctionValueObject {
    [name: string]: {
        value: string;
        multiValue?: Array<{
            value: string;
        }>;
    };
}

export interface CloudFrontFunctionResponseCookie {
    [name: string]: {
        value: string;
        attributes: string;
        multiValue?: Array<{
            value: string;
            attributes: string;
        }>;
    };
}

Additional Details

• Last updated: Tue, 10 Aug 2021 02:01:26 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Jakub Zelenka.