tm-cdk-constructs 0.0.13 → 0.0.15

package/API.md

@@ -2,6 +2,238 @@
 
 ## Constructs <a name="Constructs" id="Constructs"></a>
 
+### TmApplicationLoadBalancedFargateService <a name="TmApplicationLoadBalancedFargateService" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService"></a>
+
+#### Initializers <a name="Initializers" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.Initializer"></a>
+
+```typescript
+import { TmApplicationLoadBalancedFargateService } from 'tm-cdk-constructs'
+
+new TmApplicationLoadBalancedFargateService(scope: Construct, id: string, props: TmApplicationLoadBalancedFargateServiceProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.Initializer.parameter.props">props</a></code> | <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps">TmApplicationLoadBalancedFargateServiceProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps">TmApplicationLoadBalancedFargateServiceProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### ~~`isConstruct`~~ <a name="isConstruct" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.isConstruct"></a>
+
+```typescript
+import { TmApplicationLoadBalancedFargateService } from 'tm-cdk-constructs'
+
+TmApplicationLoadBalancedFargateService.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+###### `x`<sup>Required</sup> <a name="x" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_ecs.ICluster</code> | The cluster that hosts the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.listener">listener</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener</code> | The listener for the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.loadBalancer">loadBalancer</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer</code> | The Application Load Balancer for the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.targetGroup">targetGroup</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup</code> | The target group for the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.certificate">certificate</a></code> | <code>aws-cdk-lib.aws_certificatemanager.ICertificate</code> | Certificate Manager certificate to associate with the load balancer. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.internalDesiredCount">internalDesiredCount</a></code> | <code>number</code> | The desired number of instantiations of the task definition to keep running on the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.redirectListener">redirectListener</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener</code> | The redirect listener for the service if redirectHTTP is enabled. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.assignPublicIp">assignPublicIp</a></code> | <code>boolean</code> | Determines whether the service will be assigned a public IP address. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.service">service</a></code> | <code>aws-cdk-lib.aws_ecs.FargateService</code> | The Fargate service in this construct. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.taskDefinition">taskDefinition</a></code> | <code>aws-cdk-lib.aws_ecs.FargateTaskDefinition</code> | The Fargate task definition in this construct. |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `cluster`<sup>Required</sup> <a name="cluster" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.cluster"></a>
+
+```typescript
+public readonly cluster: ICluster;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.ICluster
+
+The cluster that hosts the service.
+
+---
+
+##### `listener`<sup>Required</sup> <a name="listener" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.listener"></a>
+
+```typescript
+public readonly listener: ApplicationListener;
+```
+
+- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener
+
+The listener for the service.
+
+---
+
+##### `loadBalancer`<sup>Required</sup> <a name="loadBalancer" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.loadBalancer"></a>
+
+```typescript
+public readonly loadBalancer: ApplicationLoadBalancer;
+```
+
+- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer
+
+The Application Load Balancer for the service.
+
+---
+
+##### `targetGroup`<sup>Required</sup> <a name="targetGroup" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.targetGroup"></a>
+
+```typescript
+public readonly targetGroup: ApplicationTargetGroup;
+```
+
+- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup
+
+The target group for the service.
+
+---
+
+##### `certificate`<sup>Optional</sup> <a name="certificate" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.certificate"></a>
+
+```typescript
+public readonly certificate: ICertificate;
+```
+
+- *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate
+
+Certificate Manager certificate to associate with the load balancer.
+
+---
+
+##### `internalDesiredCount`<sup>Optional</sup> <a name="internalDesiredCount" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.internalDesiredCount"></a>
+
+```typescript
+public readonly internalDesiredCount: number;
+```
+
+- *Type:* number
+
+The desired number of instantiations of the task definition to keep running on the service.
+
+The default is 1 for all new services and uses the existing services desired count
+when updating an existing service if one is not provided.
+
+---
+
+##### `redirectListener`<sup>Optional</sup> <a name="redirectListener" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.redirectListener"></a>
+
+```typescript
+public readonly redirectListener: ApplicationListener;
+```
+
+- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener
+
+The redirect listener for the service if redirectHTTP is enabled.
+
+---
+
+##### `assignPublicIp`<sup>Required</sup> <a name="assignPublicIp" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.assignPublicIp"></a>
+
+```typescript
+public readonly assignPublicIp: boolean;
+```
+
+- *Type:* boolean
+
+Determines whether the service will be assigned a public IP address.
+
+---
+
+##### `service`<sup>Required</sup> <a name="service" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.service"></a>
+
+```typescript
+public readonly service: FargateService;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.FargateService
+
+The Fargate service in this construct.
+
+---
+
+##### `taskDefinition`<sup>Required</sup> <a name="taskDefinition" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateService.property.taskDefinition"></a>
+
+```typescript
+public readonly taskDefinition: FargateTaskDefinition;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.FargateTaskDefinition
+
+The Fargate task definition in this construct.
+
+---
+
+
 ### TmPipeline <a name="TmPipeline" id="tm-cdk-constructs.TmPipeline"></a>
 
 A CDK construct that creates a CodePipeline.
@@ -1607,6 +1839,723 @@ The default subnet configuration if natGateways specified to be 0.
 
 ## Structs <a name="Structs" id="Structs"></a>
 
+### TmApplicationLoadBalancedFargateServiceProps <a name="TmApplicationLoadBalancedFargateServiceProps" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps"></a>
+
+Represents the configuration for an ecsPatterns.
+
+#### Initializer <a name="Initializer" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.Initializer"></a>
+
+```typescript
+import { TmApplicationLoadBalancedFargateServiceProps } from 'tm-cdk-constructs'
+
+const tmApplicationLoadBalancedFargateServiceProps: TmApplicationLoadBalancedFargateServiceProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.capacityProviderStrategies">capacityProviderStrategies</a></code> | <code>aws-cdk-lib.aws_ecs.CapacityProviderStrategy[]</code> | A list of Capacity Provider strategies used to place a service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.certificate">certificate</a></code> | <code>aws-cdk-lib.aws_certificatemanager.ICertificate</code> | Certificate Manager certificate to associate with the load balancer. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.circuitBreaker">circuitBreaker</a></code> | <code>aws-cdk-lib.aws_ecs.DeploymentCircuitBreaker</code> | Whether to enable the deployment circuit breaker. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.cloudMapOptions">cloudMapOptions</a></code> | <code>aws-cdk-lib.aws_ecs.CloudMapOptions</code> | The options for configuring an Amazon ECS service to use service discovery. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_ecs.ICluster</code> | The name of the cluster that hosts the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.deploymentController">deploymentController</a></code> | <code>aws-cdk-lib.aws_ecs.DeploymentController</code> | Specifies which deployment controller to use for the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.desiredCount">desiredCount</a></code> | <code>number</code> | The desired number of instantiations of the task definition to keep running on the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.domainName">domainName</a></code> | <code>string</code> | The domain name for the service, e.g. "api.example.com.". |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.domainZone">domainZone</a></code> | <code>aws-cdk-lib.aws_route53.IHostedZone</code> | The Route53 hosted zone for the domain, e.g. "example.com.". |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.enableECSManagedTags">enableECSManagedTags</a></code> | <code>boolean</code> | Specifies whether to enable Amazon ECS managed tags for the tasks within the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.enableExecuteCommand">enableExecuteCommand</a></code> | <code>boolean</code> | Whether ECS Exec should be enabled. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.healthCheckGracePeriod">healthCheckGracePeriod</a></code> | <code>aws-cdk-lib.Duration</code> | 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. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.idleTimeout">idleTimeout</a></code> | <code>aws-cdk-lib.Duration</code> | The load balancer idle timeout, in seconds. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.listenerPort">listenerPort</a></code> | <code>number</code> | Listener port of the application load balancer that will serve traffic to the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.loadBalancer">loadBalancer</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer</code> | The application load balancer that will serve traffic to the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.loadBalancerName">loadBalancerName</a></code> | <code>string</code> | Name of the load balancer. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.maxHealthyPercent">maxHealthyPercent</a></code> | <code>number</code> | 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. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.minHealthyPercent">minHealthyPercent</a></code> | <code>number</code> | 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. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.openListener">openListener</a></code> | <code>boolean</code> | Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.propagateTags">propagateTags</a></code> | <code>aws-cdk-lib.aws_ecs.PropagatedTagSource</code> | Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.protocol">protocol</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol</code> | The protocol for connections from clients to the load balancer. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.protocolVersion">protocolVersion</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocolVersion</code> | The protocol version to use. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.publicLoadBalancer">publicLoadBalancer</a></code> | <code>boolean</code> | Determines whether the Load Balancer will be internet-facing. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.recordType">recordType</a></code> | <code>aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedServiceRecordType</code> | Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.redirectHTTP">redirectHTTP</a></code> | <code>boolean</code> | Specifies whether the load balancer should redirect traffic on port 80 to port 443 to support HTTP->HTTPS redirects This is only valid if the protocol of the ALB is HTTPS. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.serviceName">serviceName</a></code> | <code>string</code> | The name of the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.sslPolicy">sslPolicy</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.SslPolicy</code> | The security policy that defines which ciphers and protocols are supported by the ALB Listener. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.targetProtocol">targetProtocol</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol</code> | The protocol for connections from the load balancer to the ECS tasks. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.taskImageOptions">taskImageOptions</a></code> | <code>aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedTaskImageOptions</code> | The properties required to create a new task definition. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.cpu">cpu</a></code> | <code>number</code> | The number of cpu units used by the task. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.ephemeralStorageGiB">ephemeralStorageGiB</a></code> | <code>number</code> | The amount (in GiB) of ephemeral storage to be allocated to the task. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.memoryLimitMiB">memoryLimitMiB</a></code> | <code>number</code> | The amount (in MiB) of memory used by the task. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.platformVersion">platformVersion</a></code> | <code>aws-cdk-lib.aws_ecs.FargatePlatformVersion</code> | The platform version on which to run your service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.runtimePlatform">runtimePlatform</a></code> | <code>aws-cdk-lib.aws_ecs.RuntimePlatform</code> | The runtime platform of the task definition. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.taskDefinition">taskDefinition</a></code> | <code>aws-cdk-lib.aws_ecs.FargateTaskDefinition</code> | The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.assignPublicIp">assignPublicIp</a></code> | <code>boolean</code> | Determines whether the service will be assigned a public IP address. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.healthCheck">healthCheck</a></code> | <code>aws-cdk-lib.aws_ecs.HealthCheck</code> | The health check command and associated configuration parameters for the container. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | The security groups to associate with the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.taskSubnets">taskSubnets</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | The subnets to associate with the service. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.containerPort">containerPort</a></code> | <code>number</code> | The container port. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.customHttpHeaderValue">customHttpHeaderValue</a></code> | <code>string</code> | The custom http header value. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.maxTaskCount">maxTaskCount</a></code> | <code>number</code> | The maximum number of task. |
+| <code><a href="#tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.minTaskCount">minTaskCount</a></code> | <code>number</code> | The minumun number od tasks. |
+
+---
+
+##### `capacityProviderStrategies`<sup>Optional</sup> <a name="capacityProviderStrategies" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.capacityProviderStrategies"></a>
+
+```typescript
+public readonly capacityProviderStrategies: CapacityProviderStrategy[];
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.CapacityProviderStrategy[]
+- *Default:* undefined
+
+A list of Capacity Provider strategies used to place a service.
+
+---
+
+##### `certificate`<sup>Optional</sup> <a name="certificate" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.certificate"></a>
+
+```typescript
+public readonly certificate: ICertificate;
+```
+
+- *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate
+- *Default:* No certificate associated with the load balancer, if using the HTTP protocol. For HTTPS, a DNS-validated certificate will be created for the load balancer's specified domain name if a domain name and domain zone are specified.
+
+Certificate Manager certificate to associate with the load balancer.
+
+Setting this option will set the load balancer protocol to HTTPS.
+
+---
+
+##### `circuitBreaker`<sup>Optional</sup> <a name="circuitBreaker" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.circuitBreaker"></a>
+
+```typescript
+public readonly circuitBreaker: DeploymentCircuitBreaker;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.DeploymentCircuitBreaker
+- *Default:* disabled
+
+Whether to enable the deployment circuit breaker.
+
+If this property is defined, circuit breaker will be implicitly
+enabled.
+
+---
+
+##### `cloudMapOptions`<sup>Optional</sup> <a name="cloudMapOptions" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.cloudMapOptions"></a>
+
+```typescript
+public readonly cloudMapOptions: CloudMapOptions;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.CloudMapOptions
+- *Default:* AWS Cloud Map service discovery is not enabled.
+
+The options for configuring an Amazon ECS service to use service discovery.
+
+---
+
+##### `cluster`<sup>Optional</sup> <a name="cluster" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.cluster"></a>
+
+```typescript
+public readonly cluster: ICluster;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.ICluster
+- *Default:* create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
+
+The name of the cluster that hosts the service.
+
+If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.
+
+---
+
+##### `deploymentController`<sup>Optional</sup> <a name="deploymentController" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.deploymentController"></a>
+
+```typescript
+public readonly deploymentController: DeploymentController;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.DeploymentController
+- *Default:* Rolling update (ECS)
+
+Specifies which deployment controller to use for the service.
+
+For more information, see
+[Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)
+
+---
+
+##### `desiredCount`<sup>Optional</sup> <a name="desiredCount" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.desiredCount"></a>
+
+```typescript
+public readonly desiredCount: number;
+```
+
+- *Type:* number
+- *Default:* The default is 1 for all new services and uses the existing service's desired count when updating an existing service.
+
+The desired number of instantiations of the task definition to keep running on the service.
+
+The minimum value is 1
+
+---
+
+##### `domainName`<sup>Optional</sup> <a name="domainName" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.domainName"></a>
+
+```typescript
+public readonly domainName: string;
+```
+
+- *Type:* string
+- *Default:* No domain name.
+
+The domain name for the service, e.g. "api.example.com.".
+
+---
+
+##### `domainZone`<sup>Optional</sup> <a name="domainZone" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.domainZone"></a>
+
+```typescript
+public readonly domainZone: IHostedZone;
+```
+
+- *Type:* aws-cdk-lib.aws_route53.IHostedZone
+- *Default:* No Route53 hosted domain zone.
+
+The Route53 hosted zone for the domain, e.g. "example.com.".
+
+---
+
+##### `enableECSManagedTags`<sup>Optional</sup> <a name="enableECSManagedTags" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.enableECSManagedTags"></a>
+
+```typescript
+public readonly enableECSManagedTags: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false
+
+Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
+
+For more information, see
+[Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
+
+---
+
+##### `enableExecuteCommand`<sup>Optional</sup> <a name="enableExecuteCommand" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.enableExecuteCommand"></a>
+
+```typescript
+public readonly enableExecuteCommand: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false
+
+Whether ECS Exec should be enabled.
+
+---
+
+##### `healthCheckGracePeriod`<sup>Optional</sup> <a name="healthCheckGracePeriod" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.healthCheckGracePeriod"></a>
+
+```typescript
+public readonly healthCheckGracePeriod: Duration;
+```
+
+- *Type:* aws-cdk-lib.Duration
+- *Default:* defaults to 60 seconds if at least one load balancer is in-use and it is not already set
+
+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.
+
+---
+
+##### `idleTimeout`<sup>Optional</sup> <a name="idleTimeout" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.idleTimeout"></a>
+
+```typescript
+public readonly idleTimeout: Duration;
+```
+
+- *Type:* aws-cdk-lib.Duration
+- *Default:* CloudFormation sets idle timeout to 60 seconds
+
+The load balancer idle timeout, in seconds.
+
+Can be between 1 and 4000 seconds
+
+---
+
+##### `listenerPort`<sup>Optional</sup> <a name="listenerPort" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.listenerPort"></a>
+
+```typescript
+public readonly listenerPort: number;
+```
+
+- *Type:* number
+- *Default:* The default listener port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). A domain name and zone must be also be specified if using HTTPS.
+
+Listener port of the application load balancer that will serve traffic to the service.
+
+---
+
+##### `loadBalancer`<sup>Optional</sup> <a name="loadBalancer" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.loadBalancer"></a>
+
+```typescript
+public readonly loadBalancer: IApplicationLoadBalancer;
+```
+
+- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer
+- *Default:* a new load balancer will be created.
+
+The application load balancer that will serve traffic to the service.
+
+The VPC attribute of a load balancer must be specified for it to be used
+to create a new service with this pattern.
+
+[disable-awslint:ref-via-interface]
+
+---
+
+##### `loadBalancerName`<sup>Optional</sup> <a name="loadBalancerName" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.loadBalancerName"></a>
+
+```typescript
+public readonly loadBalancerName: string;
+```
+
+- *Type:* string
+- *Default:* Automatically generated name.
+
+Name of the load balancer.
+
+---
+
+##### `maxHealthyPercent`<sup>Optional</sup> <a name="maxHealthyPercent" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.maxHealthyPercent"></a>
+
+```typescript
+public readonly maxHealthyPercent: number;
+```
+
+- *Type:* number
+- *Default:* 100 if daemon, otherwise 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`<sup>Optional</sup> <a name="minHealthyPercent" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.minHealthyPercent"></a>
+
+```typescript
+public readonly minHealthyPercent: number;
+```
+
+- *Type:* number
+- *Default:* 0 if daemon, otherwise 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.
+
+---
+
+##### `openListener`<sup>Optional</sup> <a name="openListener" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.openListener"></a>
+
+```typescript
+public readonly openListener: boolean;
+```
+
+- *Type:* boolean
+- *Default:* true -- The security group allows ingress from all IP addresses.
+
+Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.
+
+---
+
+##### `propagateTags`<sup>Optional</sup> <a name="propagateTags" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.propagateTags"></a>
+
+```typescript
+public readonly propagateTags: PropagatedTagSource;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.PropagatedTagSource
+- *Default:* none
+
+Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
+
+Tags can only be propagated to the tasks within the service during service creation.
+
+---
+
+##### `protocol`<sup>Optional</sup> <a name="protocol" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.protocol"></a>
+
+```typescript
+public readonly protocol: ApplicationProtocol;
+```
+
+- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol
+- *Default:* HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.
+
+The protocol for connections from clients to the load balancer.
+
+The load balancer port is determined from the protocol (port 80 for
+HTTP, port 443 for HTTPS).  If HTTPS, either a certificate or domain
+name and domain zone must also be specified.
+
+---
+
+##### `protocolVersion`<sup>Optional</sup> <a name="protocolVersion" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.protocolVersion"></a>
+
+```typescript
+public readonly protocolVersion: ApplicationProtocolVersion;
+```
+
+- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocolVersion
+- *Default:* ApplicationProtocolVersion.HTTP1
+
+The protocol version to use.
+
+---
+
+##### `publicLoadBalancer`<sup>Optional</sup> <a name="publicLoadBalancer" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.publicLoadBalancer"></a>
+
+```typescript
+public readonly publicLoadBalancer: boolean;
+```
+
+- *Type:* boolean
+- *Default:* true
+
+Determines whether the Load Balancer will be internet-facing.
+
+---
+
+##### `recordType`<sup>Optional</sup> <a name="recordType" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.recordType"></a>
+
+```typescript
+public readonly recordType: ApplicationLoadBalancedServiceRecordType;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedServiceRecordType
+- *Default:* ApplicationLoadBalancedServiceRecordType.ALIAS
+
+Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
+
+This is useful if you need to work with DNS systems that do not support alias records.
+
+---
+
+##### `redirectHTTP`<sup>Optional</sup> <a name="redirectHTTP" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.redirectHTTP"></a>
+
+```typescript
+public readonly redirectHTTP: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false
+
+Specifies whether the load balancer should redirect traffic on port 80 to port 443 to support HTTP->HTTPS redirects This is only valid if the protocol of the ALB is HTTPS.
+
+---
+
+##### `serviceName`<sup>Optional</sup> <a name="serviceName" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.serviceName"></a>
+
+```typescript
+public readonly serviceName: string;
+```
+
+- *Type:* string
+- *Default:* CloudFormation-generated name.
+
+The name of the service.
+
+---
+
+##### `sslPolicy`<sup>Optional</sup> <a name="sslPolicy" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.sslPolicy"></a>
+
+```typescript
+public readonly sslPolicy: SslPolicy;
+```
+
+- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.SslPolicy
+- *Default:* The recommended elastic load balancing security policy
+
+The security policy that defines which ciphers and protocols are supported by the ALB Listener.
+
+---
+
+##### `targetProtocol`<sup>Optional</sup> <a name="targetProtocol" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.targetProtocol"></a>
+
+```typescript
+public readonly targetProtocol: ApplicationProtocol;
+```
+
+- *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol
+- *Default:* HTTP.
+
+The protocol for connections from the load balancer to the ECS tasks.
+
+The default target port is determined from the protocol (port 80 for
+HTTP, port 443 for HTTPS).
+
+---
+
+##### `taskImageOptions`<sup>Optional</sup> <a name="taskImageOptions" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.taskImageOptions"></a>
+
+```typescript
+public readonly taskImageOptions: ApplicationLoadBalancedTaskImageOptions;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedTaskImageOptions
+- *Default:* none
+
+The properties required to create a new task definition.
+
+TaskDefinition or TaskImageOptions must be specified, but not both.
+
+---
+
+##### `vpc`<sup>Optional</sup> <a name="vpc" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.vpc"></a>
+
+```typescript
+public readonly vpc: IVpc;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.IVpc
+- *Default:* uses the VPC defined in the cluster or creates a new VPC.
+
+The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
+
+If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.
+
+---
+
+##### `cpu`<sup>Optional</sup> <a name="cpu" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.cpu"></a>
+
+```typescript
+public readonly cpu: number;
+```
+
+- *Type:* number
+- *Default:* 256
+
+The number of cpu units used by the task.
+
+Valid values, which determines your range of valid values for the memory parameter:
+
+256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
+
+512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
+
+1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
+
+2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
+
+4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
+
+8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments
+
+16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments
+
+This default is set in the underlying FargateTaskDefinition construct.
+
+---
+
+##### `ephemeralStorageGiB`<sup>Optional</sup> <a name="ephemeralStorageGiB" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.ephemeralStorageGiB"></a>
+
+```typescript
+public readonly ephemeralStorageGiB: number;
+```
+
+- *Type:* number
+- *Default:* Undefined, in which case, the task will receive 20GiB ephemeral storage.
+
+The amount (in GiB) of ephemeral storage to be allocated to the task.
+
+The minimum supported value is `21` GiB and the maximum supported value is `200` GiB.
+
+Only supported in Fargate platform version 1.4.0 or later.
+
+---
+
+##### `memoryLimitMiB`<sup>Optional</sup> <a name="memoryLimitMiB" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.memoryLimitMiB"></a>
+
+```typescript
+public readonly memoryLimitMiB: number;
+```
+
+- *Type:* number
+- *Default:* 512
+
+The amount (in MiB) of memory used by the task.
+
+This field is required and you must use one of the following values, which determines your range of valid values
+for the cpu parameter:
+
+512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
+
+1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
+
+2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
+
+Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
+
+Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
+
+Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)
+
+Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)
+
+This default is set in the underlying FargateTaskDefinition construct.
+
+---
+
+##### `platformVersion`<sup>Optional</sup> <a name="platformVersion" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.platformVersion"></a>
+
+```typescript
+public readonly platformVersion: FargatePlatformVersion;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.FargatePlatformVersion
+- *Default:* Latest
+
+The platform version on which to run your service.
+
+If one is not specified, the LATEST platform version is used by default. For more information, see
+[AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
+in the Amazon Elastic Container Service Developer Guide.
+
+---
+
+##### `runtimePlatform`<sup>Optional</sup> <a name="runtimePlatform" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.runtimePlatform"></a>
+
+```typescript
+public readonly runtimePlatform: RuntimePlatform;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.RuntimePlatform
+- *Default:* If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64
+
+The runtime platform of the task definition.
+
+---
+
+##### `taskDefinition`<sup>Optional</sup> <a name="taskDefinition" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.taskDefinition"></a>
+
+```typescript
+public readonly taskDefinition: FargateTaskDefinition;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.FargateTaskDefinition
+- *Default:* none
+
+The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
+
+[disable-awslint:ref-via-interface]
+
+---
+
+##### `assignPublicIp`<sup>Optional</sup> <a name="assignPublicIp" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.assignPublicIp"></a>
+
+```typescript
+public readonly assignPublicIp: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false
+
+Determines whether the service will be assigned a public IP address.
+
+---
+
+##### `healthCheck`<sup>Optional</sup> <a name="healthCheck" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.healthCheck"></a>
+
+```typescript
+public readonly healthCheck: HealthCheck;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.HealthCheck
+- *Default:* Health check configuration from container.
+
+The health check command and associated configuration parameters for the container.
+
+---
+
+##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.securityGroups"></a>
+
+```typescript
+public readonly securityGroups: ISecurityGroup[];
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
+- *Default:* A new security group is created.
+
+The security groups to associate with the service.
+
+If you do not specify a security group, a new security group is created.
+
+---
+
+##### `taskSubnets`<sup>Optional</sup> <a name="taskSubnets" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.taskSubnets"></a>
+
+```typescript
+public readonly taskSubnets: SubnetSelection;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.SubnetSelection
+- *Default:* Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.
+
+The subnets to associate with the service.
+
+---
+
+##### `containerPort`<sup>Optional</sup> <a name="containerPort" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.containerPort"></a>
+
+```typescript
+public readonly containerPort: number;
+```
+
+- *Type:* number
+
+The container port.
+
+---
+
+##### `customHttpHeaderValue`<sup>Optional</sup> <a name="customHttpHeaderValue" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.customHttpHeaderValue"></a>
+
+```typescript
+public readonly customHttpHeaderValue: string;
+```
+
+- *Type:* string
+
+The custom http header value.
+
+---
+
+##### `maxTaskCount`<sup>Optional</sup> <a name="maxTaskCount" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.maxTaskCount"></a>
+
+```typescript
+public readonly maxTaskCount: number;
+```
+
+- *Type:* number
+
+The maximum number of task.
+
+---
+
+##### `minTaskCount`<sup>Optional</sup> <a name="minTaskCount" id="tm-cdk-constructs.TmApplicationLoadBalancedFargateServiceProps.property.minTaskCount"></a>
+
+```typescript
+public readonly minTaskCount: number;
+```
+
+- *Type:* number
+
+The minumun number od tasks.
+
+---
+
 ### TmPipelineProps <a name="TmPipelineProps" id="tm-cdk-constructs.TmPipelineProps"></a>
 
 #### Initializer <a name="Initializer" id="tm-cdk-constructs.TmPipelineProps.Initializer"></a>