@stackspot/cdk-api-gateway v0.3.0

Api Gateway

Component to manage an API Gateway.

It is mandatory to add at least one integration.

How to use

Below are all languages supported by the AWS CDK.

C

Install the dependency:

dotnet add package StackSpot.Cdk.ApiGateway

Import the construct into your project, for example:

using Amazon.CDK;
using Amazon.CDK.AWS.APIGateway;
using Constructs;
using StackSpot.Cdk.ApiGateway;

namespace MyStack
{
    public class MyStack : Stack
    {
        internal MyStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
        {
            EndpointType[] endpointTypes = new EndpointType[1] { EndpointType.EDGE };

            new ApiGateway(this, "MyApiGateway", new ApiGatewayProps{
                EndpointTypes = endpointTypes,
                RestApiName = "MyRestApi"
            });
        }
    }
}

F

Not yet supported.

Go

Not yet supported.

Java

Not yet supported.

JavaScript

Install the dependency:

npm install --save @stackspot/cdk-api-gateway

Import the construct into your project, for example:

const { Stack } = require('aws-cdk-lib');
const { EndpointType } = require('aws-cdk-lib/aws-apigateway');
const { ApiGateway } = require('@stackspot/cdk-api-gateway');

class MyStack extends Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    new ApiGateway(this, 'MyApiGateway', {
      endpointTypes: [EndpointType.EDGE],
      restApiName: 'MyRestApi',
    });
  }
}

module.exports = { MyStack };

Python

Not yet supported.

TypeScript

Install the dependency:

npm install --save @stackspot/cdk-api-gateway

Import the construct into your project, for example:

import { Stack, StackProps } from 'aws-cdk-lib';
import { EndpointType } from 'aws-cdk-lib/aws-apigateway';
import { Construct } from 'constructs';
import { ApiGateway } from '@stackspot/cdk-api-gateway';

export class MyStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    new ApiGateway(this, 'MyApiGateway', {
      endpointTypes: [EndpointType.EDGE],
      restApiName: 'MyRestApi',
    });
  }
}

Construct Props

Another Props

ApiKeyProps

KinesisDataStreamIntegrationProps

LambdaIntegrationProps

StageProps

Properties

Methods

addApiKey(props)

public addApiKey(props: ApiKeyProps): ApiKey

Parameters

• props ApiKeyProps

Returns

• ApiKey

Add a API key in AWS API Gateway.

You can use this method to add as many API keys as you like.

addIntegrationKinesisDataStream(props)

public addIntegrationKinesisDataStream(props: KinesisDataStreamIntegrationProps)

Parameters

• props KinesisDataStreamIntegrationProps

Add Kinesis Data Stream integration to the REST API.

addIntegrationLambda(props)

public addIntegrationLambda(props: LambdaIntegrationProps)

Paremeters

• props LambdaIntegrationProps

Add Lambda integration to the REST API.

addStage(props)

public addStage(props: StageProps): Stage

Parameters

• props StageProps

Returns

• Stage

Add a stage to the REST API.

You can use this method to add as many stages as you like.

IAM Least privilege

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "apigateway:DELETE",
        "apigateway:GET",
        "apigateway:PATCH",
        "apigateway:POST",
        "apigateway:PUT",
        "apigateway:UpdateRestApiPolicy",
        "iam:AttachRolePolicy",
        "iam:CreateRole",
        "iam:DeleteRole",
        "iam:DetachRolePolicy",
        "iam:GetRole",
        "iam:PassRole",
        "ssm:GetParameters"
      ],
      "Resource": "*"
    }
  ]
}

Development

Prerequisites

• EditorConfig (Optional)
• Git
• Node.js 17

Setup

cd api-gateway-jsii-component
npm install