API.md

API Reference

Classes

Name	Description
DjangoEcs	Configures a Django project using ECS Fargate.
DjangoEks	Configures a Django project using EKS.

Structs

Name	Description
DjangoEcsProps	Options to configure a Django ECS project.
DjangoEksProps	Options to configure a Django EKS project.

class DjangoEcs

Configures a Django project using ECS Fargate.

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

Initializer

new DjangoEcs(scope: Construct, id: string, props: DjangoEcsProps)

• scope (Construct) No description
• id (string) No description
• props (DjangoEcsProps) No description
  • imageDirectory (string) The location of the Dockerfile used to create the main application image.
  • bucketName (string) Name of existing bucket to use for media files. Optional
  • useCeleryBeat (boolean) Used to enable the celery beat service. Default: false
  • vpc (IVpc) The VPC to use for the application. It must contain PUBLIC, PRIVATE and ISOLATED subnets. Optional
  • webCommand (Array) The command used to run the API web service. Optional

Properties

Name	Type	Description
cluster	Cluster
image	ContainerImage
staticFileBucket	Bucket
vpc	IVpc

class DjangoEks

Configures a Django project using EKS.

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

Initializer

new DjangoEks(scope: Construct, id: string, props: DjangoEksProps)

• scope (Construct) No description
• id (string) No description
• props (DjangoEksProps) No description
  • imageDirectory (string) The location of the Dockerfile used to create the main application image.
  • bucketName (string) Name of existing bucket to use for media files. Optional
  • certificateArn (string) Certificate ARN. Optional
  • domainName (string) Domain name for backend (including sub-domain). Optional
  • useCeleryBeat (boolean) Used to enable the celery beat service. Default: false
  • vpc (IVpc) The VPC to use for the application. It must contain PUBLIC, PRIVATE and ISOLATED subnets. Optional
  • webCommand (Array) The command used to run the API web service. Optional

Properties

Name	Type	Description
cluster	Cluster
staticFileBucket	Bucket
vpc	IVpc

struct DjangoEcsProps

Options to configure a Django ECS project.

Name	Type	Description
imageDirectory	string	The location of the Dockerfile used to create the main application image.
bucketName?	string	Name of existing bucket to use for media files. Optional
useCeleryBeat?	boolean	Used to enable the celery beat service. Default: false
vpc?	IVpc	The VPC to use for the application. It must contain PUBLIC, PRIVATE and ISOLATED subnets. Optional
webCommand?	Array	The command used to run the API web service. Optional

struct DjangoEksProps

Options to configure a Django EKS project.

Name	Type	Description
imageDirectory	string	The location of the Dockerfile used to create the main application image.
bucketName?	string	Name of existing bucket to use for media files. Optional
certificateArn?	string	Certificate ARN. Optional
domainName?	string	Domain name for backend (including sub-domain). Optional
useCeleryBeat?	boolean	Used to enable the celery beat service. Default: false
vpc?	IVpc	The VPC to use for the application. It must contain PUBLIC, PRIVATE and ISOLATED subnets. Optional
webCommand?	Array	The command used to run the API web service. Optional