API.md

API Reference

Constructs

EcsApp

Initializers

import { EcsApp } from 'cdk-django'

new EcsApp(scope: Construct, id: string, props: EcsAppProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	EcsAppProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: EcsAppProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { EcsApp } from 'cdk-django'

EcsApp.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

EcsBase

Initializers

import { EcsBase } from 'cdk-django'

new EcsBase(scope: Construct, id: string, props: EcsBaseProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	EcsBaseProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: EcsBaseProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { EcsBase } from 'cdk-django'

EcsBase.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
alb	aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer	No description.
albSecurityGroup	aws-cdk-lib.aws_ec2.SecurityGroup	No description.
appSecurityGroup	aws-cdk-lib.aws_ec2.SecurityGroup	No description.
assetsBucket	aws-cdk-lib.aws_s3.Bucket	No description.
databaseInstance	aws-cdk-lib.aws_rds.DatabaseInstance	No description.
domainName	string	No description.
elastiCacheHostname	string	No description.
listener	aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener	No description.
rdsPasswordSecretName	string	No description.
vpc	aws-cdk-lib.aws_ec2.IVpc	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

alb^Required

public readonly alb: ApplicationLoadBalancer;

• Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer

---

albSecurityGroup^Required

public readonly albSecurityGroup: SecurityGroup;

• Type: aws-cdk-lib.aws_ec2.SecurityGroup

---

appSecurityGroup^Required

public readonly appSecurityGroup: SecurityGroup;

• Type: aws-cdk-lib.aws_ec2.SecurityGroup

---

assetsBucket^Required

public readonly assetsBucket: Bucket;

• Type: aws-cdk-lib.aws_s3.Bucket

---

databaseInstance^Required

public readonly databaseInstance: DatabaseInstance;

• Type: aws-cdk-lib.aws_rds.DatabaseInstance

---

domainName^Required

public readonly domainName: string;

• Type: string

---

elastiCacheHostname^Required

public readonly elastiCacheHostname: string;

• Type: string

---

listener^Required

public readonly listener: ApplicationListener;

• Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener

---

rdsPasswordSecretName^Required

public readonly rdsPasswordSecretName: string;

• Type: string

---

vpc^Required

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

---

Structs

EcsAppProps

Initializer

import { EcsAppProps } from 'cdk-django'

const ecsAppProps: EcsAppProps = { ... }

Properties

Name	Type	Description
alb	aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer	No description.
appSecurityGroup	aws-cdk-lib.aws_ec2.ISecurityGroup	No description.
assetsBucket	aws-cdk-lib.aws_s3.Bucket	No description.
baseStackName	string	No description.
companyName	string	No description.
domainName	string	No description.
elastiCacheHost	string	No description.
listener	aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener	No description.
rdsInstance	aws-cdk-lib.aws_rds.DatabaseInstance	No description.
rdsPasswordSecretName	string	No description.
vpc	aws-cdk-lib.aws_ec2.IVpc	No description.

---

alb^Required

public readonly alb: IApplicationLoadBalancer;

• Type: aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer

---

appSecurityGroup^Required

public readonly appSecurityGroup: ISecurityGroup;

• Type: aws-cdk-lib.aws_ec2.ISecurityGroup

---

assetsBucket^Required

public readonly assetsBucket: Bucket;

• Type: aws-cdk-lib.aws_s3.Bucket

---

baseStackName^Required

public readonly baseStackName: string;

• Type: string

---

companyName^Required

public readonly companyName: string;

• Type: string

---

domainName^Required

public readonly domainName: string;

• Type: string

---

elastiCacheHost^Required

public readonly elastiCacheHost: string;

• Type: string

---

listener^Required

public readonly listener: ApplicationListener;

• Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener

---

rdsInstance^Required

public readonly rdsInstance: DatabaseInstance;

• Type: aws-cdk-lib.aws_rds.DatabaseInstance

---

rdsPasswordSecretName^Required

public readonly rdsPasswordSecretName: string;

• Type: string

---

vpc^Required

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

---

EcsBaseProps

Initializer

import { EcsBaseProps } from 'cdk-django'

const ecsBaseProps: EcsBaseProps = { ... }

Properties

Name	Type	Description
certificateArn	string	No description.
domainName	string	No description.

---

certificateArn^Required

public readonly certificateArn: string;

• Type: string

---

domainName^Required

public readonly domainName: string;

• Type: string

---