ApplicationLoadBalancedServiceBaseProps Struct
The properties for the base ApplicationLoadBalancedEc2Service or ApplicationLoadBalancedFargateService service.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_certificatemanager as certificatemanager } from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_ecs_patterns as ecs_patterns } from 'aws-cdk-lib';
import { aws_elasticloadbalancingv2 as elbv2 } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_route53 as route53 } from 'aws-cdk-lib';
import { aws_servicediscovery as servicediscovery } from 'aws-cdk-lib';
declare const applicationLoadBalancer: elbv2.ApplicationLoadBalancer;
declare const certificate: certificatemanager.Certificate;
declare const cluster: ecs.Cluster;
declare const containerDefinition: ecs.ContainerDefinition;
declare const containerImage: ecs.ContainerImage;
declare const hostedZone: route53.HostedZone;
declare const logDriver: ecs.LogDriver;
declare const namespace: servicediscovery.INamespace;
declare const role: iam.Role;
declare const secret: ecs.Secret;
declare const vpc: ec2.Vpc;
const applicationLoadBalancedServiceBaseProps: ecs_patterns.ApplicationLoadBalancedServiceBaseProps = {
capacityProviderStrategies: [{
capacityProvider: 'capacityProvider',
// the properties below are optional
base: 123,
weight: 123,
}],
certificate: certificate,
circuitBreaker: {
enable: false,
rollback: false,
},
cloudMapOptions: {
cloudMapNamespace: namespace,
container: containerDefinition,
containerPort: 123,
dnsRecordType: servicediscovery.DnsRecordType.A,
dnsTtl: cdk.Duration.minutes(30),
failureThreshold: 123,
name: 'name',
},
cluster: cluster,
deploymentController: {
type: ecs.DeploymentControllerType.ECS,
},
desiredCount: 123,
domainName: 'domainName',
domainZone: hostedZone,
enableECSManagedTags: false,
enableExecuteCommand: false,
healthCheckGracePeriod: cdk.Duration.minutes(30),
idleTimeout: cdk.Duration.minutes(30),
ipAddressType: elbv2.IpAddressType.IPV4,
listenerPort: 123,
loadBalancer: applicationLoadBalancer,
loadBalancerName: 'loadBalancerName',
maxHealthyPercent: 123,
minHealthyPercent: 123,
openListener: false,
propagateTags: ecs.PropagatedTagSource.SERVICE,
protocol: elbv2.ApplicationProtocol.HTTP,
protocolVersion: elbv2.ApplicationProtocolVersion.GRPC,
publicLoadBalancer: false,
recordType: ecs_patterns.ApplicationLoadBalancedServiceRecordType.ALIAS,
redirectHTTP: false,
serviceName: 'serviceName',
sslPolicy: elbv2.SslPolicy.RECOMMENDED_TLS,
targetProtocol: elbv2.ApplicationProtocol.HTTP,
taskImageOptions: {
image: containerImage,
// the properties below are optional
command: ['command'],
containerName: 'containerName',
containerPort: 123,
dockerLabels: {
dockerLabelsKey: 'dockerLabels',
},
enableLogging: false,
entryPoint: ['entryPoint'],
environment: {
environmentKey: 'environment',
},
executionRole: role,
family: 'family',
logDriver: logDriver,
secrets: {
secretsKey: secret,
},
taskRole: role,
},
vpc: vpc,
};
Properties
capacityProviderStrategiesCapacityProviderStrategy[]capacity_provider_strategiestyping.List[CapacityProviderStrategy]capacityProviderStrategiesList<CapacityProviderStrategy>CapacityProviderStrategiesCapacityProviderStrategy[]CapacityProviderStrategies*[]CapacityProviderStrategy= undefined#A list of Capacity Provider strategies used to place a service.
certificateICertificatecertificateICertificatecertificateICertificateCertificateICertificateCertificateICertificate= No certificate associated with t…#Certificate Manager certificate to associate with the load balancer.
Setting this option will set the load balancer protocol to HTTPS.
default
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.
circuitBreakerDeploymentCircuitBreakercircuit_breakerDeploymentCircuitBreakercircuitBreakerDeploymentCircuitBreakerCircuitBreakerDeploymentCircuitBreakerCircuitBreakerDeploymentCircuitBreaker= disabled#Whether to enable the deployment circuit breaker.
If this property is defined, circuit breaker will be implicitly enabled.
cloudMapOptionsCloudMapOptionscloud_map_optionsCloudMapOptionscloudMapOptionsCloudMapOptionsCloudMapOptionsCloudMapOptionsCloudMapOptionsCloudMapOptions= AWS Cloud Map service discovery …#The options for configuring an Amazon ECS service to use service discovery.
default
Default: AWS Cloud Map service discovery is not enabled.
clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterICluster= create a new cluster; if both cl…#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.
default
Default: create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
deploymentControllerDeploymentControllerdeployment_controllerDeploymentControllerdeploymentControllerDeploymentControllerDeploymentControllerDeploymentControllerDeploymentControllerDeploymentController= Rolling update (ECS)#Specifies which deployment controller to use for the service.
For more information, see Amazon ECS Deployment Types
desiredCountnumberdesired_countint | floatdesiredCountNumberDesiredCountdoubleDesiredCount*float64= The default is 1 for all new ser…#The desired number of instantiations of the task definition to keep running on the service.
The minimum value is 1
default
Default: The default is 1 for all new services and uses the existing service's desired count when updating an existing service.
The domain name for the service, e.g. "api.example.com.".
domainZoneIHostedZonedomain_zoneIHostedZonedomainZoneIHostedZoneDomainZoneIHostedZoneDomainZoneIHostedZone= No Route53 hosted domain zone.#The Route53 hosted zone for the domain, e.g. "example.com.".
enableECSManagedTagsbooleanenable_ecs_managed_tagsboolenableECSManagedTagsBooleanEnableECSManagedTagsboolEnableECSManagedTags*bool= false#Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
For more information, see Tagging Your Amazon ECS Resources
enableExecuteCommandbooleanenable_execute_commandboolenableExecuteCommandBooleanEnableExecuteCommandboolEnableExecuteCommand*bool= false#Whether ECS Exec should be enabled.
healthCheckGracePeriodDurationhealth_check_grace_periodDurationhealthCheckGracePeriodDurationHealthCheckGracePeriodDurationHealthCheckGracePeriodDuration= defaults to 60 seconds if at lea…#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.
default
Default: defaults to 60 seconds if at least one load balancer is in-use and it is not already set
idleTimeoutDurationidle_timeoutDurationidleTimeoutDurationIdleTimeoutDurationIdleTimeoutDuration= CloudFormation sets idle timeout…#The load balancer idle timeout, in seconds.
Can be between 1 and 4000 seconds
default
Default: CloudFormation sets idle timeout to 60 seconds
ipAddressTypeIpAddressTypeip_address_typeIpAddressTypeipAddressTypeIpAddressTypeIpAddressTypeIpAddressTypeIpAddressTypeIpAddressType= IpAddressType.IPV4#The type of IP address to use.
listenerPortnumberlistener_portint | floatlistenerPortNumberListenerPortdoubleListenerPort*float64= The default listener port is det…#Listener port of the application load balancer that will serve traffic to the service.
default
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.
loadBalancerIApplicationLoadBalancerload_balancerIApplicationLoadBalancerloadBalancerIApplicationLoadBalancerLoadBalancerIApplicationLoadBalancerLoadBalancerIApplicationLoadBalancer= a new load balancer will be crea…#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]
default
Default: a new load balancer will be created.
loadBalancerNamestringload_balancer_namestrloadBalancerNameStringLoadBalancerNamestringLoadBalancerName*string= Automatically generated name.#Name of the load balancer.
maxHealthyPercentnumbermax_healthy_percentint | floatmaxHealthyPercentNumberMaxHealthyPercentdoubleMaxHealthyPercent*float64= 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.
minHealthyPercentnumbermin_healthy_percentint | floatminHealthyPercentNumberMinHealthyPercentdoubleMinHealthyPercent*float64= 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.
openListenerbooleanopen_listenerboolopenListenerBooleanOpenListenerboolOpenListener*bool= true -- The security group allow…#Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.
default
Default: true -- The security group allows ingress from all IP addresses.
propagateTagsPropagatedTagSourcepropagate_tagsPropagatedTagSourcepropagateTagsPropagatedTagSourcePropagateTagsPropagatedTagSourcePropagateTagsPropagatedTagSource= 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.
protocolApplicationProtocolprotocolApplicationProtocolprotocolApplicationProtocolProtocolApplicationProtocolProtocolApplicationProtocol= HTTP. If a certificate is specif…#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.
default
Default: HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.
protocolVersionApplicationProtocolVersionprotocol_versionApplicationProtocolVersionprotocolVersionApplicationProtocolVersionProtocolVersionApplicationProtocolVersionProtocolVersionApplicationProtocolVersion= ApplicationProtocolVersion.HTTP1#The protocol version to use.
publicLoadBalancerbooleanpublic_load_balancerboolpublicLoadBalancerBooleanPublicLoadBalancerboolPublicLoadBalancer*bool= true#Determines whether the Load Balancer will be internet-facing.
recordTypeApplicationLoadBalancedServiceRecordTyperecord_typeApplicationLoadBalancedServiceRecordTyperecordTypeApplicationLoadBalancedServiceRecordTypeRecordTypeApplicationLoadBalancedServiceRecordTypeRecordTypeApplicationLoadBalancedServiceRecordType= ApplicationLoadBalancedServiceRe…#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.
default
Default: ApplicationLoadBalancedServiceRecordType.ALIAS
Specifies whether the load balancer should redirect traffic on port 80 to the {@link listenerPort} to support HTTP->HTTPS redirects.
This is only valid if the protocol of the ALB is HTTPS.
serviceNamestringservice_namestrserviceNameStringServiceNamestringServiceName*string= CloudFormation-generated name.#The name of the service.
sslPolicySslPolicyssl_policySslPolicysslPolicySslPolicySslPolicySslPolicySslPolicySslPolicy= The recommended elastic load bal…#The security policy that defines which ciphers and protocols are supported by the ALB Listener.
default
Default: The recommended elastic load balancing security policy
targetProtocolApplicationProtocoltarget_protocolApplicationProtocoltargetProtocolApplicationProtocolTargetProtocolApplicationProtocolTargetProtocolApplicationProtocol= 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).
taskImageOptionsApplicationLoadBalancedTaskImageOptionstask_image_optionsApplicationLoadBalancedTaskImageOptionstaskImageOptionsApplicationLoadBalancedTaskImageOptionsTaskImageOptionsApplicationLoadBalancedTaskImageOptionsTaskImageOptionsApplicationLoadBalancedTaskImageOptions= none#The properties required to create a new task definition.
TaskDefinition or TaskImageOptions must be specified, but not both.
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.
default
Default: uses the VPC defined in the cluster or creates a new VPC.