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. |
scope
Required
- Type: constructs.Construct
id
Required
props
Required
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
sourceContainer
Required
destinationContainer
Required
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.
x
Required
Any object.
Properties
Name | Type | Description |
---|
node | constructs.Node | The tree node. |
node
Required
public readonly node: 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. |
containerPort
Required
public readonly containerPort: number;
id
Required
public readonly id: string;
repository
Required
public readonly repository: Repository;
- Type: aws-cdk-lib.aws_ecr.Repository
softLimit
Required
public readonly softLimit: number;
environment
Optional
public readonly environment: {[ key: string ]: string};
hostname
Optional
public readonly hostname: string;
links
Optional
public readonly links: string[];
secrets
Optional
public readonly secrets: {[ key: string ]: Secret};
ClusterProps
Initializer
import { ClusterProps } from 'maq-ecs-construct'
const clusterProps: ClusterProps = { ... }
Properties
Name | Type | Description |
---|
clusterArn | string | No description. |
clusterName | string | No description. |
clusterArn
Required
public readonly clusterArn: string;
clusterName
Required
public readonly clusterName: 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. |
isSecure
Required
public readonly isSecure: boolean;
listenerArn
Required
public readonly listenerArn: string;
port
Optional
public readonly port: 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. |
desiredCount
Required
public readonly desiredCount: number;
maxCapacity
Required
public readonly maxCapacity: number;
minCapacity
Required
public readonly minCapacity: 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. |
cluster
Required
public readonly cluster: ClusterProps;
containers
Required
public readonly containers: AppContainerProps[];
- Type: AppContainerProps[]
healthCheckPath
Required
public readonly healthCheckPath: string;
loadBalancer
Required
public readonly loadBalancer: LoadBalancerProps;
serviceName
Required
public readonly serviceName: string;
targetGroup
Required
public readonly targetGroup: TargetGroup;
vpc
Required
public readonly vpc: IVpc;
- Type: aws-cdk-lib.aws_ec2.IVpc
executionRole
Optional
public readonly executionRole: Role;
- Type: aws-cdk-lib.aws_iam.Role
scalingCapacity
Optional
public readonly scalingCapacity: ScalingCapacity;
taskRole
Optional
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. |
priority
Required
public readonly priority: number;
hostnames
Optional
public readonly hostnames: string[];
pathPatterns
Optional
public readonly pathPatterns: string[];