@guardian/cdk
    Preparing search index...

    Interface GuApiGatewayWithLambdaByPathProps

    interface GuApiGatewayWithLambdaByPathProps {
        apiKeySourceType?: ApiKeySourceType;
        app: string;
        binaryMediaTypes?: string[];
        cloneFrom?: IRestApi;
        cloudWatchRole?: boolean;
        cloudWatchRoleRemovalPolicy?: RemovalPolicy;
        defaultCorsPreflightOptions?: CorsOptions;
        defaultIntegration?: Integration;
        defaultMethodOptions?: MethodOptions;
        deploy?: boolean;
        deployOptions?: StageOptions;
        description?: string;
        disableExecuteApiEndpoint?: boolean;
        domainName?: DomainNameOptions;
        endpointConfiguration?: EndpointConfiguration;
        endpointExportName?: string;
        endpointTypes?: EndpointType[];
        failOnWarnings?: boolean;
        minCompressionSize?: Size;
        minimumCompressionSize?: number;
        monitoringConfiguration: NoMonitoring | ApiGatewayAlarms;
        parameters?: { [key: string]: string };
        policy?: PolicyDocument;
        restApiName?: string;
        retainDeployments?: boolean;
        targets: ApiTarget[];
    }

    Hierarchy (View Summary)

    • RestApiProps
    • AppIdentity
      • GuApiGatewayWithLambdaByPathProps
    Index

    Properties

    apiKeySourceType? app binaryMediaTypes? cloneFrom? cloudWatchRole? cloudWatchRoleRemovalPolicy? defaultCorsPreflightOptions? defaultIntegration? defaultMethodOptions? deploy? deployOptions? description? disableExecuteApiEndpoint? domainName? endpointConfiguration? endpointExportName? endpointTypes? failOnWarnings? minCompressionSize? minimumCompressionSize? monitoringConfiguration parameters? policy? restApiName? retainDeployments? targets

    Properties

    apiKeySourceType?: ApiKeySourceType

    The source of the API key for metering requests according to a usage plan.

    - Metering is disabled.
    app: string
    binaryMediaTypes?: string[]

    The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream"

    - RestApi supports only UTF-8-encoded text payloads.
    cloneFrom?: IRestApi

    The ID of the API Gateway RestApi resource that you want to clone.

    - None.
    cloudWatchRole?: boolean

    Automatically configure an AWS CloudWatch role for API Gateway.

    • false if @aws-cdk/aws-apigateway:disableCloudWatchRole is enabled, true otherwise
    cloudWatchRoleRemovalPolicy?: RemovalPolicy

    The removal policy applied to the AWS CloudWatch role when this resource is removed from the application. Requires cloudWatchRole to be enabled.

    - RemovalPolicy.RETAIN
    defaultCorsPreflightOptions?: CorsOptions

    Adds a CORS preflight OPTIONS method to this resource and all child resources.

    You can add CORS at the resource-level using addCorsPreflight.

    - CORS is disabled
    defaultIntegration?: Integration

    An integration to use as a default for all methods created within this API unless an integration is specified.

    - Inherited from parent.
    defaultMethodOptions?: MethodOptions

    Method options to use as a default for all methods created within this API unless custom options are specified.

    - Inherited from parent.
    deploy?: boolean

    Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.

    Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.

    If this is set, latestDeployment will refer to the Deployment object and deploymentStage will refer to a Stage that points to this deployment. To customize the stage options, use the deployOptions property.

    A CloudFormation Output will also be defined with the root URL endpoint of this REST API.

    true
    deployOptions?: StageOptions

    Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled. If deploy is disabled, this value cannot be set.

    • Based on defaults of StageOptions.
    description?: string

    A description of the RestApi construct.

    - 'Automatically created by the RestApi construct'
    disableExecuteApiEndpoint?: boolean

    Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint.

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html

    false
    domainName?: DomainNameOptions

    Configure a custom domain name and map it to this API.

    • no domain name is defined, use addDomainName or directly define a DomainName.
    endpointConfiguration?: EndpointConfiguration

    The EndpointConfiguration property type specifies the endpoint types of a REST API

    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html

    EndpointType.EDGE
    endpointExportName?: string

    Export name for the CfnOutput containing the API endpoint

    - when no export name is given, output will be created without export
    endpointTypes?: EndpointType[]

    A list of the endpoint types of the API. Use this property when creating an API.

    EndpointType.EDGE
    failOnWarnings?: boolean

    Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

    false
    minCompressionSize?: Size

    A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

    - Compression is disabled.
    minimumCompressionSize?: number

    A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

    - Compression is disabled.
    • superseded by minCompressionSize
    monitoringConfiguration: NoMonitoring | ApiGatewayAlarms

    Alarm configuration for your API. For more details, see [[ApiGatewayAlarms]].

    If your team do not use CloudWatch, it's possible to opt-out with the following configuration:

     monitoringConfiguration: { noMonitoring: true }
    parameters?: { [key: string]: string }

    Custom header parameters for the request.

    https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html

    - No parameters.
    policy?: PolicyDocument

    A policy document that contains the permissions for this RestApi

    - No policy.
    restApiName?: string

    A name for the API Gateway RestApi resource.

    - ID of the RestApi construct.
    retainDeployments?: boolean

    Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console.

    false
    targets: ApiTarget[]

    A list of [[ApiTarget]]s to configure for the API Gateway instance.

    Settings

    Member Visibility

    On This Page

    Properties