API Reference

Constructs

MAQService

Initializers

import { MAQService } from 'maq-ecs-construct'

new MAQService(scope: Construct, id: string, props: ServiceProps)

| Name | Type | Description | | --- | --- | --- | | scope | constructs.Construct | No description. | | id | string | No description. | | props | ServiceProps | No description. |

scopeRequired

• Type: constructs.Construct

idRequired

• Type: string

propsRequired

• Type: ServiceProps

Methods

| Name | Description | | --- | --- | | toString | Returns a string representation of this construct. | | addLink | No description. |

toString

public toString(): string

Returns a string representation of this construct.

addLink

public addLink(sourceContainer: string, destinationContainer: string): void

sourceContainerRequired

• Type: string

destinationContainerRequired

• Type: string

Static Functions

| Name | Description | | --- | --- | | isConstruct | Checks if x is a construct. |

~~isConstruct~~

import { MAQService } from 'maq-ecs-construct'

MAQService.isConstruct(x: any)

Checks if x is a construct.

xRequired

• Type: any

Any object.

Properties

| Name | Type | Description | | --- | --- | --- | | node | constructs.Node | The tree node. |

nodeRequired

public readonly node: Node;

• Type: constructs.Node

The tree node.

Structs

AppContainerProps

Initializer

import { AppContainerProps } from 'maq-ecs-construct'

const appContainerProps: AppContainerProps = { ... }

Properties

| Name | Type | Description | | --- | --- | --- | | containerPort | number | No description. | | id | string | No description. | | repository | aws-cdk-lib.aws_ecr.Repository | No description. | | softLimit | number | No description. | | environment | {[ key: string ]: string} | No description. | | hostname | string | No description. | | links | string[] | No description. | | secrets | {[ key: string ]: aws-cdk-lib.aws_ecs.Secret} | No description. |

containerPortRequired

public readonly containerPort: number;

• Type: number

idRequired

public readonly id: string;

• Type: string

repositoryRequired

public readonly repository: Repository;

• Type: aws-cdk-lib.aws_ecr.Repository

softLimitRequired

public readonly softLimit: number;

• Type: number

environmentOptional

public readonly environment: {[ key: string ]: string};

• Type: {[ key: string ]: string}

hostnameOptional

public readonly hostname: string;

• Type: string

linksOptional

public readonly links: string[];

• Type: string[]

secretsOptional

public readonly secrets: {[ key: string ]: Secret};

• Type: {[ key: string ]: aws-cdk-lib.aws_ecs.Secret}

ClusterProps

Initializer

import { ClusterProps } from 'maq-ecs-construct'

const clusterProps: ClusterProps = { ... }

Properties

| Name | Type | Description | | --- | --- | --- | | clusterArn | string | No description. | | clusterName | string | No description. |

clusterArnRequired

public readonly clusterArn: string;

• Type: string

clusterNameRequired

public readonly clusterName: string;

• Type: string

LoadBalancerProps

Initializer

import { LoadBalancerProps } from 'maq-ecs-construct'

const loadBalancerProps: LoadBalancerProps = { ... }

Properties

| Name | Type | Description | | --- | --- | --- | | isSecure | boolean | No description. | | listenerArn | string | No description. | | port | number | No description. |

isSecureRequired

public readonly isSecure: boolean;

• Type: boolean

listenerArnRequired

public readonly listenerArn: string;

• Type: string

portOptional

public readonly port: number;

• Type: number

ScalingCapacity

Initializer

import { ScalingCapacity } from 'maq-ecs-construct'

const scalingCapacity: ScalingCapacity = { ... }

Properties

| Name | Type | Description | | --- | --- | --- | | desiredCount | number | No description. | | maxCapacity | number | No description. | | minCapacity | number | No description. |

desiredCountRequired

public readonly desiredCount: number;

• Type: number

maxCapacityRequired

public readonly maxCapacity: number;

• Type: number

minCapacityRequired

public readonly minCapacity: number;

• Type: number

ServiceProps

Initializer

import { ServiceProps } from 'maq-ecs-construct'

const serviceProps: ServiceProps = { ... }

Properties

| Name | Type | Description | | --- | --- | --- | | cluster | ClusterProps | No description. | | containers | AppContainerProps[] | No description. | | healthCheckPath | string | No description. | | loadBalancer | LoadBalancerProps | No description. | | serviceName | string | No description. | | targetGroup | TargetGroup | No description. | | vpc | aws-cdk-lib.aws_ec2.IVpc | No description. | | executionRole | aws-cdk-lib.aws_iam.Role | No description. | | scalingCapacity | ScalingCapacity | No description. | | taskRole | aws-cdk-lib.aws_iam.Role | No description. |

clusterRequired

public readonly cluster: ClusterProps;

• Type: ClusterProps

containersRequired

public readonly containers: AppContainerProps[];

• Type: AppContainerProps[]

healthCheckPathRequired

public readonly healthCheckPath: string;

• Type: string

loadBalancerRequired

public readonly loadBalancer: LoadBalancerProps;

• Type: LoadBalancerProps

serviceNameRequired

public readonly serviceName: string;

• Type: string

targetGroupRequired

public readonly targetGroup: TargetGroup;

• Type: TargetGroup

vpcRequired

public readonly vpc: IVpc;

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

executionRoleOptional

public readonly executionRole: Role;

• Type: aws-cdk-lib.aws_iam.Role

scalingCapacityOptional

public readonly scalingCapacity: ScalingCapacity;

• Type: ScalingCapacity

taskRoleOptional

public readonly taskRole: Role;

• Type: aws-cdk-lib.aws_iam.Role

TargetGroup

Initializer

import { TargetGroup } from 'maq-ecs-construct'

const targetGroup: TargetGroup = { ... }

Properties

| Name | Type | Description | | --- | --- | --- | | priority | number | No description. | | hostnames | string[] | No description. | | pathPatterns | string[] | No description. |

priorityRequired

public readonly priority: number;

• Type: number

hostnamesOptional

public readonly hostnames: string[];

• Type: string[]

pathPatternsOptional

public readonly pathPatterns: string[];

• Type: string[]