Skip to content

Latest commit

 

History

History
110 lines (63 loc) · 4.36 KB

API.md

File metadata and controls

110 lines (63 loc) · 4.36 KB
Raw

API Reference

Classes

Name Description
Apisix The Apisix construct.

Structs

Name Description
ApisixProps construct properties for Apisix.
WebServiceOptions options for createWebService.

class Apisix

The Apisix construct.

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new Apisix(scope: Construct, id: string, props?: ApisixProps)
  • scope (Construct) No description
  • id (string) No description
  • props (ApisixProps) No description
    • apisixContainer (ContainerImage) container for APISIX API service. Default: public.ecr.aws/d7p2r8s3/apisix
    • cluster (ICluster) Amazon ECS cluster. Default: create a new cluster
    • dashboardContainer (ContainerImage) container for the dashboard. Default: public.ecr.aws/d7p2r8s3/apisix-dashboard
    • efsFilesystem (IFileSystem) Amazon EFS filesystem for etcd data persistence. Default: ceate a new filesystem
    • etcdContainer (ContainerImage) container for the etcd. Default: public.ecr.aws/eks-distro/etcd-io/etcd:v3.4.14-eks-1-18-1
    • vpc (IVpc) Vpc for the APISIX. Default: create a new VPC or use existing one

Properties

Name Type Description
cluster ICluster
envVar Map<string, string>
vpc IVpc

Methods

createWebService(id, options)

Create a basic web service on AWS Fargate.

createWebService(id: string, options: WebServiceOptions): NetworkLoadBalancedFargateService
  • id (string) No description
  • options (WebServiceOptions) No description
    • environment (Map<string, string>) No description Optional
    • image (RepositoryImage) No description Optional
    • port (number) No description Optional

Returns:

struct ApisixProps

construct properties for Apisix.

Name Type Description
apisixContainer? ContainerImage container for APISIX API service.
Default: public.ecr.aws/d7p2r8s3/apisix
cluster? ICluster Amazon ECS cluster.
Default: create a new cluster
dashboardContainer? ContainerImage container for the dashboard.
Default: public.ecr.aws/d7p2r8s3/apisix-dashboard
efsFilesystem? IFileSystem Amazon EFS filesystem for etcd data persistence.
Default: ceate a new filesystem
etcdContainer? ContainerImage container for the etcd.
Default: public.ecr.aws/eks-distro/etcd-io/etcd:v3.4.14-eks-1-18-1
vpc? IVpc Vpc for the APISIX.
Default: create a new VPC or use existing one

struct WebServiceOptions

options for createWebService.

Name Type Description
environment? Map<string, string> Optional
image? RepositoryImage Optional
port? number Optional