@resistdesign/voltra
    Preparing search index...

    Type Alias AddGatewayConfig

    Configuration for the API Gateway pack.

    type AddGatewayConfig = {
        authorizer?: AddGatewayAuthorizerConfig | boolean;
        certificateArn: CloudFormationPrimitiveValue<string>;
        cloudFunction: { id: string; region?: string };
        deploymentSuffix?: string;
        domainName: any;
        hostedZoneId: any;
        id: string;
        stageName?: any;
    }
    Index

    Properties

    authorizer? certificateArn cloudFunction deploymentSuffix? domainName hostedZoneId id stageName?

    Properties

    authorizer?: AddGatewayAuthorizerConfig | boolean

    Authorizer config or boolean to enable/disable.

    Enable this when the gateway itself must reject unauthenticated requests before they reach the cloud function. If public routes should still be reachable while authenticated requests receive identity information, leave the gateway authorizer disabled and provide the getAuthInfo argument to handleCloudFunctionEvent instead.

    certificateArn: CloudFormationPrimitiveValue<string>

    ACM certificate ARN for the API domain.

    cloudFunction: { id: string; region?: string }

    Target Lambda function information.

    deploymentSuffix?: string

    Optional manual suffix appended after the deterministic deployment hash.

    domainName: any

    Domain name for the API.

    hostedZoneId: any

    Hosted zone id for the API domain.

    id: string

    Base id for gateway resources.

    stageName?: any

    Stage name to deploy.

    Settings

    Member Visibility

    On This Page

    Properties