# API Reference
## Constructs
### BaseFargateService
#### Initializers
```typescript
import { BaseFargateService } from 'cdk-fargate-patterns'
new BaseFargateService(scope: Construct, id: string, props: BaseFargateServiceProps)
```
##### `scope`Required
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-fargate-patterns.BaseFargateServiceProps`](#cdk-fargate-patterns.BaseFargateServiceProps)
---
#### Properties
##### `service`Required
```typescript
public readonly service: FargateService[];
```
- *Type:* [`@aws-cdk/aws-ecs.FargateService`](#@aws-cdk/aws-ecs.FargateService)[]
The service(s) created from the task(s).
---
##### `vpc`Required
```typescript
public readonly vpc: IVpc;
```
- *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc)
The VPC.
---
### Database
Represents the database instance or database cluster.
#### Initializers
```typescript
import { Database } from 'cdk-fargate-patterns'
new Database(scope: Construct, id: string, props: DatabaseProps)
```
##### `scope`Required
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-fargate-patterns.DatabaseProps`](#cdk-fargate-patterns.DatabaseProps)
---
#### Properties
##### `clusterEndpointHostname`Required
```typescript
public readonly clusterEndpointHostname: string;
```
- *Type:* `string`
---
##### `clusterIdentifier`Required
```typescript
public readonly clusterIdentifier: string;
```
- *Type:* `string`
---
##### `connections`Required
```typescript
public readonly connections: Connections;
```
- *Type:* [`@aws-cdk/aws-ec2.Connections`](#@aws-cdk/aws-ec2.Connections)
---
##### `secret`Required
```typescript
public readonly secret: ISecret;
```
- *Type:* [`@aws-cdk/aws-secretsmanager.ISecret`](#@aws-cdk/aws-secretsmanager.ISecret)
---
##### `vpc`Required
```typescript
public readonly vpc: IVpc;
```
- *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc)
---
### DualAlbFargateService
#### Initializers
```typescript
import { DualAlbFargateService } from 'cdk-fargate-patterns'
new DualAlbFargateService(scope: Construct, id: string, props: DualAlbFargateServiceProps)
```
##### `scope`Required
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-fargate-patterns.DualAlbFargateServiceProps`](#cdk-fargate-patterns.DualAlbFargateServiceProps)
---
#### Properties
##### `externalAlb`Optional
```typescript
public readonly externalAlb: ApplicationLoadBalancer;
```
- *Type:* [`@aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancer`](#@aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancer)
The external ALB.
---
##### `internalAlb`Optional
```typescript
public readonly internalAlb: ApplicationLoadBalancer;
```
- *Type:* [`@aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancer`](#@aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancer)
The internal ALB.
---
### DualNlbFargateService
#### Initializers
```typescript
import { DualNlbFargateService } from 'cdk-fargate-patterns'
new DualNlbFargateService(scope: Construct, id: string, props: DualNlbFargateServiceProps)
```
##### `scope`Required
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-fargate-patterns.DualNlbFargateServiceProps`](#cdk-fargate-patterns.DualNlbFargateServiceProps)
---
#### Properties
##### `externalNlb`Optional
```typescript
public readonly externalNlb: NetworkLoadBalancer;
```
- *Type:* [`@aws-cdk/aws-elasticloadbalancingv2.NetworkLoadBalancer`](#@aws-cdk/aws-elasticloadbalancingv2.NetworkLoadBalancer)
The external Nlb.
---
##### `internalNlb`Optional
```typescript
public readonly internalNlb: NetworkLoadBalancer;
```
- *Type:* [`@aws-cdk/aws-elasticloadbalancingv2.NetworkLoadBalancer`](#@aws-cdk/aws-elasticloadbalancingv2.NetworkLoadBalancer)
The internal Nlb.
---
### Laravel
Represents the Laravel service.
#### Initializers
```typescript
import { Laravel } from 'cdk-fargate-patterns'
new Laravel(scope: Construct, id: string, props: LaravelProps)
```
##### `scope`Required
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-fargate-patterns.LaravelProps`](#cdk-fargate-patterns.LaravelProps)
---
#### Properties
##### `svc`Required
```typescript
public readonly svc: DualAlbFargateService;
```
- *Type:* [`cdk-fargate-patterns.DualAlbFargateService`](#cdk-fargate-patterns.DualAlbFargateService)
---
##### `vpc`Required
```typescript
public readonly vpc: IVpc;
```
- *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc)
---
##### `db`Optional
```typescript
public readonly db: Database;
```
- *Type:* [`cdk-fargate-patterns.Database`](#cdk-fargate-patterns.Database)
---
### WordPress
#### Initializers
```typescript
import { WordPress } from 'cdk-fargate-patterns'
new WordPress(scope: Construct, id: string, props?: WordPressProps)
```
##### `scope`Required
- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Optional
- *Type:* [`cdk-fargate-patterns.WordPressProps`](#cdk-fargate-patterns.WordPressProps)
---
#### Properties
##### `svc`Required
```typescript
public readonly svc: DualAlbFargateService;
```
- *Type:* [`cdk-fargate-patterns.DualAlbFargateService`](#cdk-fargate-patterns.DualAlbFargateService)
---
##### `vpc`Required
```typescript
public readonly vpc: IVpc;
```
- *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc)
---
##### `db`Optional
```typescript
public readonly db: Database;
```
- *Type:* [`cdk-fargate-patterns.Database`](#cdk-fargate-patterns.Database)
---
## Structs
### BaseFargateServiceProps
#### Initializer
```typescript
import { BaseFargateServiceProps } from 'cdk-fargate-patterns'
const baseFargateServiceProps: BaseFargateServiceProps = { ... }
```
##### `tasks`Required
```typescript
public readonly tasks: FargateTaskProps[];
```
- *Type:* [`cdk-fargate-patterns.FargateTaskProps`](#cdk-fargate-patterns.FargateTaskProps)[]
---
##### `circuitBreaker`Optional
```typescript
public readonly circuitBreaker: boolean;
```
- *Type:* `boolean`
- *Default:* true
Enable the ECS service circuit breaker.
> - https://aws.amazon.com/tw/blogs/containers/announcing-amazon-ecs-deployment-circuit-breaker/
---
##### `cluster`Optional
```typescript
public readonly cluster: ICluster;
```
- *Type:* [`@aws-cdk/aws-ecs.ICluster`](#@aws-cdk/aws-ecs.ICluster)
- *Default:* create a new ECS Cluster.
Use existing ECS Cluster.
---
##### `clusterProps`Optional
```typescript
public readonly clusterProps: ClusterProps;
```
- *Type:* [`@aws-cdk/aws-ecs.ClusterProps`](#@aws-cdk/aws-ecs.ClusterProps)
- *Default:* Create vpc and enable Fargate Capacity Providers.
The properties used to define an ECS cluster.
---
##### `enableExecuteCommand`Optional
```typescript
public readonly enableExecuteCommand: boolean;
```
- *Type:* `boolean`
- *Default:* false
Whether to enable ECS Exec support.
> https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html
---
##### `route53Ops`Optional
```typescript
public readonly route53Ops: Route53Options;
```
- *Type:* [`cdk-fargate-patterns.Route53Options`](#cdk-fargate-patterns.Route53Options)
---
##### `spot`Optional
```typescript
public readonly spot: boolean;
```
- *Type:* `boolean`
- *Default:* false
create a FARGATE_SPOT only cluster.
---
##### `spotTerminationHandler`Optional
```typescript
public readonly spotTerminationHandler: boolean;
```
- *Type:* `boolean`
- *Default:* true
Enable the fargate spot termination handler.
> https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html#fargate-capacity-providers-termination
---
##### `vpc`Optional
```typescript
public readonly vpc: IVpc;
```
- *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc)
---
##### `vpcSubnets`Optional
```typescript
public readonly vpcSubnets: SubnetSelection;
```
- *Type:* [`@aws-cdk/aws-ec2.SubnetSelection`](#@aws-cdk/aws-ec2.SubnetSelection)
- *Default:* {
subnetType: ec2.SubnetType.PRIVATE,
}
The subnets to associate with the service.
---
### DatabaseCofig
Database configuration.
#### Initializer
```typescript
import { DatabaseCofig } from 'cdk-fargate-patterns'
const databaseCofig: DatabaseCofig = { ... }
```
##### `connections`Required
```typescript
public readonly connections: Connections;
```
- *Type:* [`@aws-cdk/aws-ec2.Connections`](#@aws-cdk/aws-ec2.Connections)
The database connnections.
---
##### `endpoint`Required
```typescript
public readonly endpoint: string;
```
- *Type:* `string`
The endpoint address for the database.
---
##### `identifier`Required
```typescript
public readonly identifier: string;
```
- *Type:* `string`
The databasae identifier.
---
##### `secret`Required
```typescript
public readonly secret: ISecret;
```
- *Type:* [`@aws-cdk/aws-secretsmanager.ISecret`](#@aws-cdk/aws-secretsmanager.ISecret)
The database secret.
---
### DatabaseProps
#### Initializer
```typescript
import { DatabaseProps } from 'cdk-fargate-patterns'
const databaseProps: DatabaseProps = { ... }
```
##### `vpc`Required
```typescript
public readonly vpc: IVpc;
```
- *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc)
The VPC for the database.
---
##### `allowFrom`Optional
```typescript
public readonly allowFrom: IConnectable;
```
- *Type:* [`@aws-cdk/aws-ec2.IConnectable`](#@aws-cdk/aws-ec2.IConnectable)
- *Default:* the whole VPC CIDR
Allow database connection.
---
##### `auroraServerless`Optional
```typescript
public readonly auroraServerless: boolean;
```
- *Type:* `boolean`
- *Default:* false
enable aurora serverless.
---
##### `backupRetention`Optional
```typescript
public readonly backupRetention: Duration;
```
- *Type:* [`@aws-cdk/core.Duration`](#@aws-cdk/core.Duration)
- *Default:* 7 days
database backup retension.
---
##### `clusterEngine`Optional
```typescript
public readonly clusterEngine: IClusterEngine;
```
- *Type:* [`@aws-cdk/aws-rds.IClusterEngine`](#@aws-cdk/aws-rds.IClusterEngine)
- *Default:* rds.AuroraMysqlEngineVersion.VER_2_09_1
The database cluster engine.
---
##### `databaseSubnets`Optional
```typescript
public readonly databaseSubnets: SubnetSelection;
```
- *Type:* [`@aws-cdk/aws-ec2.SubnetSelection`](#@aws-cdk/aws-ec2.SubnetSelection)
VPC subnets for database.
---
##### `defaultDatabaseName`Optional
```typescript
public readonly defaultDatabaseName: string;
```
- *Type:* `string`
- *Default:* do not create any default database
Default database name to create.
---
##### `instanceEngine`Optional
```typescript
public readonly instanceEngine: IInstanceEngine;
```
- *Type:* [`@aws-cdk/aws-rds.IInstanceEngine`](#@aws-cdk/aws-rds.IInstanceEngine)
- *Default:* MySQL 8.0.21
The database instance engine.
---
##### `instanceType`Optional
```typescript
public readonly instanceType: InstanceType;
```
- *Type:* [`@aws-cdk/aws-ec2.InstanceType`](#@aws-cdk/aws-ec2.InstanceType)
- *Default:* r5.large
The database instance type.
---
##### `singleDbInstance`Optional
```typescript
public readonly singleDbInstance: boolean;
```
- *Type:* `boolean`
- *Default:* false
Whether to use single RDS instance rather than RDS cluster.
Not recommended for production.
---
### DualAlbFargateServiceProps
#### Initializer
```typescript
import { DualAlbFargateServiceProps } from 'cdk-fargate-patterns'
const dualAlbFargateServiceProps: DualAlbFargateServiceProps = { ... }
```
##### `tasks`Required
```typescript
public readonly tasks: FargateTaskProps[];
```
- *Type:* [`cdk-fargate-patterns.FargateTaskProps`](#cdk-fargate-patterns.FargateTaskProps)[]
---
##### `circuitBreaker`Optional
```typescript
public readonly circuitBreaker: boolean;
```
- *Type:* `boolean`
- *Default:* true
Enable the ECS service circuit breaker.
> - https://aws.amazon.com/tw/blogs/containers/announcing-amazon-ecs-deployment-circuit-breaker/
---
##### `cluster`Optional
```typescript
public readonly cluster: ICluster;
```
- *Type:* [`@aws-cdk/aws-ecs.ICluster`](#@aws-cdk/aws-ecs.ICluster)
- *Default:* create a new ECS Cluster.
Use existing ECS Cluster.
---
##### `clusterProps`Optional
```typescript
public readonly clusterProps: ClusterProps;
```
- *Type:* [`@aws-cdk/aws-ecs.ClusterProps`](#@aws-cdk/aws-ecs.ClusterProps)
- *Default:* Create vpc and enable Fargate Capacity Providers.
The properties used to define an ECS cluster.
---
##### `enableExecuteCommand`Optional
```typescript
public readonly enableExecuteCommand: boolean;
```
- *Type:* `boolean`
- *Default:* false
Whether to enable ECS Exec support.
> https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html
---
##### `route53Ops`Optional
```typescript
public readonly route53Ops: Route53Options;
```
- *Type:* [`cdk-fargate-patterns.Route53Options`](#cdk-fargate-patterns.Route53Options)
---
##### `spot`Optional
```typescript
public readonly spot: boolean;
```
- *Type:* `boolean`
- *Default:* false
create a FARGATE_SPOT only cluster.
---
##### `spotTerminationHandler`Optional
```typescript
public readonly spotTerminationHandler: boolean;
```
- *Type:* `boolean`
- *Default:* true
Enable the fargate spot termination handler.
> https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html#fargate-capacity-providers-termination
---
##### `vpc`Optional
```typescript
public readonly vpc: IVpc;
```
- *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc)
---
##### `vpcSubnets`Optional
```typescript
public readonly vpcSubnets: SubnetSelection;
```
- *Type:* [`@aws-cdk/aws-ec2.SubnetSelection`](#@aws-cdk/aws-ec2.SubnetSelection)
- *Default:* {
subnetType: ec2.SubnetType.PRIVATE,
}
The subnets to associate with the service.
---
##### `externalAlbIdleTimeout`Optional
```typescript
public readonly externalAlbIdleTimeout: Duration;
```
- *Type:* [`@aws-cdk/core.Duration`](#@aws-cdk/core.Duration)
- *Default:* 60.
The external load balancer idle timeout, in seconds.
---
##### `internalAlbIdleTimeout`Optional
```typescript
public readonly internalAlbIdleTimeout: Duration;
```
- *Type:* [`@aws-cdk/core.Duration`](#@aws-cdk/core.Duration)
- *Default:* 60.
The internal load balancer idle timeout, in seconds.
---
### DualNlbFargateServiceProps
#### Initializer
```typescript
import { DualNlbFargateServiceProps } from 'cdk-fargate-patterns'
const dualNlbFargateServiceProps: DualNlbFargateServiceProps = { ... }
```
##### `tasks`Required
```typescript
public readonly tasks: FargateTaskProps[];
```
- *Type:* [`cdk-fargate-patterns.FargateTaskProps`](#cdk-fargate-patterns.FargateTaskProps)[]
---
##### `circuitBreaker`Optional
```typescript
public readonly circuitBreaker: boolean;
```
- *Type:* `boolean`
- *Default:* true
Enable the ECS service circuit breaker.
> - https://aws.amazon.com/tw/blogs/containers/announcing-amazon-ecs-deployment-circuit-breaker/
---
##### `cluster`Optional
```typescript
public readonly cluster: ICluster;
```
- *Type:* [`@aws-cdk/aws-ecs.ICluster`](#@aws-cdk/aws-ecs.ICluster)
- *Default:* create a new ECS Cluster.
Use existing ECS Cluster.
---
##### `clusterProps`Optional
```typescript
public readonly clusterProps: ClusterProps;
```
- *Type:* [`@aws-cdk/aws-ecs.ClusterProps`](#@aws-cdk/aws-ecs.ClusterProps)
- *Default:* Create vpc and enable Fargate Capacity Providers.
The properties used to define an ECS cluster.
---
##### `enableExecuteCommand`Optional
```typescript
public readonly enableExecuteCommand: boolean;
```
- *Type:* `boolean`
- *Default:* false
Whether to enable ECS Exec support.
> https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html
---
##### `route53Ops`Optional
```typescript
public readonly route53Ops: Route53Options;
```
- *Type:* [`cdk-fargate-patterns.Route53Options`](#cdk-fargate-patterns.Route53Options)
---
##### `spot`Optional
```typescript
public readonly spot: boolean;
```
- *Type:* `boolean`
- *Default:* false
create a FARGATE_SPOT only cluster.
---
##### `spotTerminationHandler`Optional
```typescript
public readonly spotTerminationHandler: boolean;
```
- *Type:* `boolean`
- *Default:* true
Enable the fargate spot termination handler.
> https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html#fargate-capacity-providers-termination
---
##### `vpc`Optional
```typescript
public readonly vpc: IVpc;
```
- *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc)
---
##### `vpcSubnets`Optional
```typescript
public readonly vpcSubnets: SubnetSelection;
```
- *Type:* [`@aws-cdk/aws-ec2.SubnetSelection`](#@aws-cdk/aws-ec2.SubnetSelection)
- *Default:* {
subnetType: ec2.SubnetType.PRIVATE,
}
The subnets to associate with the service.
---
### FargateTaskProps
Task properties for the Fargate.
#### Initializer
```typescript
import { FargateTaskProps } from 'cdk-fargate-patterns'
const fargateTaskProps: FargateTaskProps = { ... }
```
##### `task`Required
```typescript
public readonly task: FargateTaskDefinition;
```
- *Type:* [`@aws-cdk/aws-ecs.FargateTaskDefinition`](#@aws-cdk/aws-ecs.FargateTaskDefinition)
---
##### `capacityProviderStrategy`Optional
```typescript
public readonly capacityProviderStrategy: CapacityProviderStrategy[];
```
- *Type:* [`@aws-cdk/aws-ecs.CapacityProviderStrategy`](#@aws-cdk/aws-ecs.CapacityProviderStrategy)[]
Customized capacity provider strategy.
---
##### `desiredCount`Optional
```typescript
public readonly desiredCount: number;
```
- *Type:* `number`
- *Default:* 1
desired number of tasks for the service.
---
##### `external`Optional
```typescript
public readonly external: LoadBalancerAccessibility;
```
- *Type:* [`cdk-fargate-patterns.LoadBalancerAccessibility`](#cdk-fargate-patterns.LoadBalancerAccessibility)
- *Default:* no external listener
The external ELB listener.
---
##### `healthCheck`Optional
```typescript
public readonly healthCheck: HealthCheck;
```
- *Type:* [`@aws-cdk/aws-elasticloadbalancingv2.HealthCheck`](#@aws-cdk/aws-elasticloadbalancingv2.HealthCheck)
health check from elbv2 target group.
---
##### `healthCheckGracePeriod`Optional
```typescript
public readonly healthCheckGracePeriod: Duration;
```
- *Type:* [`@aws-cdk/core.Duration`](#@aws-cdk/core.Duration)
- *Default:* cdk.Duration.seconds(60),
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
---
##### `internal`Optional
```typescript
public readonly internal: LoadBalancerAccessibility;
```
- *Type:* [`cdk-fargate-patterns.LoadBalancerAccessibility`](#cdk-fargate-patterns.LoadBalancerAccessibility)
- *Default:* no internal listener
The internal ELB listener.
---
##### `maxHealthyPercent`Optional
```typescript
public readonly maxHealthyPercent: number;
```
- *Type:* `number`
- *Default:* 200
The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
---
##### `minHealthyPercent`Optional
```typescript
public readonly minHealthyPercent: number;
```
- *Type:* `number`
- *Default:* 50
The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
---
##### `protocol`Optional
```typescript
public readonly protocol: Protocol;
```
- *Type:* [`@aws-cdk/aws-elasticloadbalancingv2.Protocol`](#@aws-cdk/aws-elasticloadbalancingv2.Protocol)
- *Default:* TCP
The target group protocol for NLB.
For ALB, this option will be ignored and always set to HTTP.
---
##### `protocolVersion`Optional
```typescript
public readonly protocolVersion: ApplicationProtocolVersion;
```
- *Type:* [`@aws-cdk/aws-elasticloadbalancingv2.ApplicationProtocolVersion`](#@aws-cdk/aws-elasticloadbalancingv2.ApplicationProtocolVersion)
The protocol version to use.
---
##### `scalingPolicy`Optional
```typescript
public readonly scalingPolicy: ServiceScalingPolicy;
```
- *Type:* [`cdk-fargate-patterns.ServiceScalingPolicy`](#cdk-fargate-patterns.ServiceScalingPolicy)
- *Default:* { maxCapacity: 10, targetCpuUtilization: 50, requestsPerTarget: 1000 }
service autoscaling policy.
---
##### `serviceName`Optional
```typescript
public readonly serviceName: string;
```
- *Type:* `string`
- *Default:* auto-generated
The serviceName.
---
### LaravelProps
#### Initializer
```typescript
import { LaravelProps } from 'cdk-fargate-patterns'
const laravelProps: LaravelProps = { ... }
```
##### `code`Required
```typescript
public readonly code: string;
```
- *Type:* `string`
The local path to the Laravel code base.
---
##### `loadbalancer`Required
```typescript
public readonly loadbalancer: LoadBalancerAccessibility;
```
- *Type:* [`cdk-fargate-patterns.LoadBalancerAccessibility`](#cdk-fargate-patterns.LoadBalancerAccessibility)
The loadbalancer accessibility for the service.
---
##### `auroraServerless`Optional
```typescript
public readonly auroraServerless: boolean;
```
- *Type:* `boolean`
- *Default:* false
Whether to use aurora serverless.
When enabled, the `databaseInstanceType` and
`engine` will be ignored. The `rds.DatabaseClusterEngine.AURORA_MYSQL` will be used as
the default cluster engine instead.
---
##### `backupRetention`Optional
```typescript
public readonly backupRetention: Duration;
```
- *Type:* [`@aws-cdk/core.Duration`](#@aws-cdk/core.Duration)
- *Default:* 7 days
database backup retension.
---
##### `clusterEngine`Optional
```typescript
public readonly clusterEngine: IClusterEngine;
```
- *Type:* [`@aws-cdk/aws-rds.IClusterEngine`](#@aws-cdk/aws-rds.IClusterEngine)
- *Default:* rds.AuroraMysqlEngineVersion.VER_2_09_1
The database cluster engine.
---
##### `containerPort`Optional
```typescript
public readonly containerPort: number;
```
- *Type:* `number`
- *Default:* 80
The Laravel container port.
---
##### `databaseInstanceType`Optional
```typescript
public readonly databaseInstanceType: InstanceType;
```
- *Type:* [`@aws-cdk/aws-ec2.InstanceType`](#@aws-cdk/aws-ec2.InstanceType)
- *Default:* r5.large
Database instance type.
---
##### `databaseSubnets`Optional
```typescript
public readonly databaseSubnets: SubnetSelection;
```
- *Type:* [`@aws-cdk/aws-ec2.SubnetSelection`](#@aws-cdk/aws-ec2.SubnetSelection)
- *Default:* VPC isolated subnets
VPC subnets for database.
---
##### `defaultDatabaseName`Optional
```typescript
public readonly defaultDatabaseName: string;
```
- *Type:* `string`
The default database name to create.
---
##### `efsFileSystem`Optional
```typescript
public readonly efsFileSystem: FileSystemProps;
```
- *Type:* [`@aws-cdk/aws-efs.FileSystemProps`](#@aws-cdk/aws-efs.FileSystemProps)
Options to create the EFS FileSystem.
---
##### `enableExecuteCommand`Optional
```typescript
public readonly enableExecuteCommand: boolean;
```
- *Type:* `boolean`
enable ECS Exec.
---
##### `instanceEngine`Optional
```typescript
public readonly instanceEngine: IInstanceEngine;
```
- *Type:* [`@aws-cdk/aws-rds.IInstanceEngine`](#@aws-cdk/aws-rds.IInstanceEngine)
- *Default:* MySQL 8.0.21
The database instance engine.
---
##### `serviceProps`Optional
```typescript
public readonly serviceProps: FargateTaskProps;
```
- *Type:* [`cdk-fargate-patterns.FargateTaskProps`](#cdk-fargate-patterns.FargateTaskProps)
task options for the Laravel fargate service.
---
##### `singleDbInstance`Optional
```typescript
public readonly singleDbInstance: boolean;
```
- *Type:* `boolean`
- *Default:* false
Whether to use single RDS instance rather than RDS cluster.
Not recommended for production.
---
##### `spot`Optional
```typescript
public readonly spot: boolean;
```
- *Type:* `boolean`
enable fargate spot.
---
##### `vpc`Optional
```typescript
public readonly vpc: IVpc;
```
- *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc)
---
### LoadBalancerAccessibility
The load balancer accessibility.
#### Initializer
```typescript
import { LoadBalancerAccessibility } from 'cdk-fargate-patterns'
const loadBalancerAccessibility: LoadBalancerAccessibility = { ... }
```
##### `port`Required
```typescript
public readonly port: number;
```
- *Type:* `number`
The port of the listener.
---
##### `certificate`Optional
```typescript
public readonly certificate: ICertificate[];
```
- *Type:* [`@aws-cdk/aws-certificatemanager.ICertificate`](#@aws-cdk/aws-certificatemanager.ICertificate)[]
- *Default:* no certificate(HTTP only)
The ACM certificate for the HTTPS listener.
---
##### `forwardConditions`Optional
```typescript
public readonly forwardConditions: ListenerCondition[];
```
- *Type:* [`@aws-cdk/aws-elasticloadbalancingv2.ListenerCondition`](#@aws-cdk/aws-elasticloadbalancingv2.ListenerCondition)[]
- *Default:* no forward conditions.
Listener forward conditions.
---
### Route53Options
#### Initializer
```typescript
import { Route53Options } from 'cdk-fargate-patterns'
const route53Options: Route53Options = { ... }
```
##### `enableLoadBalancerAlias`Optional
```typescript
public readonly enableLoadBalancerAlias: boolean;
```
- *Type:* `boolean`
- *Default:* true
Whether to configure the ALIAS for the LB.
---
##### `externalElbRecordName`Optional
```typescript
public readonly externalElbRecordName: string;
```
- *Type:* `string`
- *Default:* external
the external ELB record name.
---
##### `internalElbRecordName`Optional
```typescript
public readonly internalElbRecordName: string;
```
- *Type:* `string`
- *Default:* internal
the internal ELB record name.
---
##### `zoneName`Optional
```typescript
public readonly zoneName: string;
```
- *Type:* `string`
- *Default:* svc.local
private zone name.
---
### ServiceScalingPolicy
#### Initializer
```typescript
import { ServiceScalingPolicy } from 'cdk-fargate-patterns'
const serviceScalingPolicy: ServiceScalingPolicy = { ... }
```
##### `maxCapacity`Optional
```typescript
public readonly maxCapacity: number;
```
- *Type:* `number`
- *Default:* 10
max capacity for the service autoscaling.
---
##### `requestPerTarget`Optional
```typescript
public readonly requestPerTarget: number;
```
- *Type:* `number`
- *Default:* 1000
request per target.
---
##### `targetCpuUtilization`Optional
```typescript
public readonly targetCpuUtilization: number;
```
- *Type:* `number`
- *Default:* 50
target cpu utilization.
---
### WordPressProps
#### Initializer
```typescript
import { WordPressProps } from 'cdk-fargate-patterns'
const wordPressProps: WordPressProps = { ... }
```
##### `auroraServerless`Optional
```typescript
public readonly auroraServerless: boolean;
```
- *Type:* `boolean`
- *Default:* false
Whether to use aurora serverless.
When enabled, the `databaseInstanceType` and
`engine` will be ignored. The `rds.DatabaseClusterEngine.AURORA_MYSQL` will be used as
the default cluster engine instead.
---
##### `backupRetention`Optional
```typescript
public readonly backupRetention: Duration;
```
- *Type:* [`@aws-cdk/core.Duration`](#@aws-cdk/core.Duration)
- *Default:* 7 days
database backup retension.
---
##### `clusterEngine`Optional
```typescript
public readonly clusterEngine: IClusterEngine;
```
- *Type:* [`@aws-cdk/aws-rds.IClusterEngine`](#@aws-cdk/aws-rds.IClusterEngine)
- *Default:* rds.AuroraMysqlEngineVersion.VER_2_09_1
The database cluster engine.
---
##### `databaseInstanceType`Optional
```typescript
public readonly databaseInstanceType: InstanceType;
```
- *Type:* [`@aws-cdk/aws-ec2.InstanceType`](#@aws-cdk/aws-ec2.InstanceType)
- *Default:* r5.large
Database instance type.
---
##### `databaseSubnets`Optional
```typescript
public readonly databaseSubnets: SubnetSelection;
```
- *Type:* [`@aws-cdk/aws-ec2.SubnetSelection`](#@aws-cdk/aws-ec2.SubnetSelection)
- *Default:* VPC isolated subnets
VPC subnets for database.
---
##### `enableExecuteCommand`Optional
```typescript
public readonly enableExecuteCommand: boolean;
```
- *Type:* `boolean`
enable ECS Exec.
---
##### `instanceEngine`Optional
```typescript
public readonly instanceEngine: IInstanceEngine;
```
- *Type:* [`@aws-cdk/aws-rds.IInstanceEngine`](#@aws-cdk/aws-rds.IInstanceEngine)
- *Default:* MySQL 8.0.21
The database instance engine.
---
##### `serviceProps`Optional
```typescript
public readonly serviceProps: FargateTaskProps;
```
- *Type:* [`cdk-fargate-patterns.FargateTaskProps`](#cdk-fargate-patterns.FargateTaskProps)
task options for the WordPress fargate service.
---
##### `singleDbInstance`Optional
```typescript
public readonly singleDbInstance: boolean;
```
- *Type:* `boolean`
- *Default:* false
Whether to use single RDS instance rather than RDS cluster.
Not recommended for production.
---
##### `spot`Optional
```typescript
public readonly spot: boolean;
```
- *Type:* `boolean`
enable fargate spot.
---
##### `vpc`Optional
```typescript
public readonly vpc: IVpc;
```
- *Type:* [`@aws-cdk/aws-ec2.IVpc`](#@aws-cdk/aws-ec2.IVpc)
---