Package software.amazon.awscdk.services.ecs.patterns

Interface ApplicationLoadBalancedServiceBaseProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
ApplicationLoadBalancedEc2ServiceProps, ApplicationLoadBalancedFargateServiceProps
All Known Implementing Classes:
ApplicationLoadBalancedEc2ServiceProps.Jsii$Proxy, ApplicationLoadBalancedFargateServiceProps.Jsii$Proxy, ApplicationLoadBalancedServiceBaseProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:01.221Z") @Stability(Stable) public interface ApplicationLoadBalancedServiceBaseProps extends software.amazon.jsii.JsiiSerializable
The properties for the base ApplicationLoadBalancedEc2Service or ApplicationLoadBalancedFargateService service.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.certificatemanager.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.services.ecs.patterns.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.route53.*;
 import software.amazon.awscdk.services.servicediscovery.*;
 ApplicationLoadBalancer applicationLoadBalancer;
 Certificate certificate;
 Cluster cluster;
 ContainerDefinition containerDefinition;
 ContainerImage containerImage;
 HostedZone hostedZone;
 LogDriver logDriver;
 INamespace namespace;
 Role role;
 Secret secret;
 Vpc vpc;
 ApplicationLoadBalancedServiceBaseProps applicationLoadBalancedServiceBaseProps = ApplicationLoadBalancedServiceBaseProps.builder()
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider("capacityProvider")
                 // the properties below are optional
                 .base(123)
                 .weight(123)
                 .build()))
         .certificate(certificate)
         .circuitBreaker(DeploymentCircuitBreaker.builder()
                 .enable(false)
                 .rollback(false)
                 .build())
         .cloudMapOptions(CloudMapOptions.builder()
                 .cloudMapNamespace(namespace)
                 .container(containerDefinition)
                 .containerPort(123)
                 .dnsRecordType(DnsRecordType.A)
                 .dnsTtl(Duration.minutes(30))
                 .failureThreshold(123)
                 .name("name")
                 .build())
         .cluster(cluster)
         .deploymentController(DeploymentController.builder()
                 .type(DeploymentControllerType.ECS)
                 .build())
         .desiredCount(123)
         .domainName("domainName")
         .domainZone(hostedZone)
         .enableECSManagedTags(false)
         .enableExecuteCommand(false)
         .healthCheckGracePeriod(Duration.minutes(30))
         .idleTimeout(Duration.minutes(30))
         .ipAddressType(IpAddressType.IPV4)
         .listenerPort(123)
         .loadBalancer(applicationLoadBalancer)
         .loadBalancerName("loadBalancerName")
         .maxHealthyPercent(123)
         .minHealthyPercent(123)
         .openListener(false)
         .propagateTags(PropagatedTagSource.SERVICE)
         .protocol(ApplicationProtocol.HTTP)
         .protocolVersion(ApplicationProtocolVersion.GRPC)
         .publicLoadBalancer(false)
         .recordType(ApplicationLoadBalancedServiceRecordType.ALIAS)
         .redirectHTTP(false)
         .serviceName("serviceName")
         .sslPolicy(SslPolicy.RECOMMENDED_TLS)
         .targetProtocol(ApplicationProtocol.HTTP)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(containerImage)
                 // the properties below are optional
                 .command(List.of("command"))
                 .containerName("containerName")
                 .containerPort(123)
                 .dockerLabels(Map.of(
                         "dockerLabelsKey", "dockerLabels"))
                 .enableLogging(false)
                 .entryPoint(List.of("entryPoint"))
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .executionRole(role)
                 .family("family")
                 .logDriver(logDriver)
                 .secrets(Map.of(
                         "secretsKey", secret))
                 .taskRole(role)
                 .build())
         .vpc(vpc)
         .build();

  • Method Details

    • getCapacityProviderStrategies

      @Stability(Stable) @Nullable default List<CapacityProviderStrategy> getCapacityProviderStrategies()
      A list of Capacity Provider strategies used to place a service.

      Default: - undefined

    • getCertificate

      @Stability(Stable) @Nullable default ICertificate getCertificate()
      Certificate Manager certificate to associate with the load balancer.

      Setting this option will set the load balancer protocol to HTTPS.

      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.

    • getCircuitBreaker

      @Stability(Stable) @Nullable default DeploymentCircuitBreaker getCircuitBreaker()
      Whether to enable the deployment circuit breaker.

      If this property is defined, circuit breaker will be implicitly enabled.

      Default: - disabled

    • getCloudMapOptions

      @Stability(Stable) @Nullable default CloudMapOptions getCloudMapOptions()
      The options for configuring an Amazon ECS service to use service discovery.

      Default: - AWS Cloud Map service discovery is not enabled.

    • getCluster

      @Stability(Stable) @Nullable default ICluster getCluster()
      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: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

    • getDeploymentController

      @Stability(Stable) @Nullable default DeploymentController getDeploymentController()
      Specifies which deployment controller to use for the service.

      For more information, see Amazon ECS Deployment Types

      Default: - Rolling update (ECS)

    • getDesiredCount

      @Stability(Stable) @Nullable default Number getDesiredCount()
      The desired number of instantiations of the task definition to keep running on the service.

      The minimum value is 1

      Default: - The default is 1 for all new services and uses the existing service's desired count when updating an existing service.

    • getDomainName

      @Stability(Stable) @Nullable default String getDomainName()
      The domain name for the service, e.g. "api.example.com.".

      Default: - No domain name.

    • getDomainZone

      @Stability(Stable) @Nullable default IHostedZone getDomainZone()
      The Route53 hosted zone for the domain, e.g. "example.com.".

      Default: - No Route53 hosted domain zone.

    • getEnableECSManagedTags

      @Stability(Stable) @Nullable default Boolean getEnableECSManagedTags()
      Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

      For more information, see Tagging Your Amazon ECS Resources

      Default: false

    • getEnableExecuteCommand

      @Stability(Stable) @Nullable default Boolean getEnableExecuteCommand()
      Whether ECS Exec should be enabled.

      Default: - false

    • getHealthCheckGracePeriod

      @Stability(Stable) @Nullable default Duration getHealthCheckGracePeriod()
      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: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set

    • getIdleTimeout

      @Stability(Stable) @Nullable default Duration getIdleTimeout()
      The load balancer idle timeout, in seconds.

      Can be between 1 and 4000 seconds

      Default: - CloudFormation sets idle timeout to 60 seconds

    • getIpAddressType

      @Stability(Stable) @Nullable default IpAddressType getIpAddressType()
      The type of IP address to use.

      Default: - IpAddressType.IPV4

    • getListenerPort

      @Stability(Stable) @Nullable default Number getListenerPort()
      Listener port of the application load balancer that will serve traffic to the service.

      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.

    • getLoadBalancer

      @Stability(Stable) @Nullable default IApplicationLoadBalancer getLoadBalancer()
      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: - a new load balancer will be created.

    • getLoadBalancerName

      @Stability(Stable) @Nullable default String getLoadBalancerName()
      Name of the load balancer.

      Default: - Automatically generated name.

    • getMaxHealthyPercent

      @Stability(Stable) @Nullable default Number getMaxHealthyPercent()
      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.

      Default: - 100 if daemon, otherwise 200

    • getMinHealthyPercent

      @Stability(Stable) @Nullable default Number getMinHealthyPercent()
      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.

      Default: - 0 if daemon, otherwise 50

    • getOpenListener

      @Stability(Stable) @Nullable default Boolean getOpenListener()
      Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.

      Default: true -- The security group allows ingress from all IP addresses.

    • getPropagateTags

      @Stability(Stable) @Nullable default PropagatedTagSource getPropagateTags()
      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.

      Default: - none

    • getProtocol

      @Stability(Stable) @Nullable default ApplicationProtocol getProtocol()
      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: HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.

    • getProtocolVersion

      @Stability(Stable) @Nullable default ApplicationProtocolVersion getProtocolVersion()
      The protocol version to use.

      Default: ApplicationProtocolVersion.HTTP1

    • getPublicLoadBalancer

      @Stability(Stable) @Nullable default Boolean getPublicLoadBalancer()
      Determines whether the Load Balancer will be internet-facing.

      Default: true

    • getRecordType

      @Stability(Stable) @Nullable default ApplicationLoadBalancedServiceRecordType getRecordType()
      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: ApplicationLoadBalancedServiceRecordType.ALIAS

    • getRedirectHTTP

      @Stability(Stable) @Nullable default Boolean getRedirectHTTP()
      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.

      Default: false

    • getServiceName

      @Stability(Stable) @Nullable default String getServiceName()
      The name of the service.

      Default: - CloudFormation-generated name.

    • getSslPolicy

      @Stability(Stable) @Nullable default SslPolicy getSslPolicy()
      The security policy that defines which ciphers and protocols are supported by the ALB Listener.

      Default: - The recommended elastic load balancing security policy

    • getTargetProtocol

      @Stability(Stable) @Nullable default ApplicationProtocol getTargetProtocol()
      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).

      Default: HTTP.

    • getTaskImageOptions

      @Stability(Stable) @Nullable default ApplicationLoadBalancedTaskImageOptions getTaskImageOptions()
      The properties required to create a new task definition.

      TaskDefinition or TaskImageOptions must be specified, but not both.

      Default: none

    • getVpc

      @Stability(Stable) @Nullable default IVpc getVpc()
      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: - uses the VPC defined in the cluster or creates a new VPC.

    • builder

      @Stability(Stable) static ApplicationLoadBalancedServiceBaseProps.Builder builder()
      Returns:
      a ApplicationLoadBalancedServiceBaseProps.Builder of ApplicationLoadBalancedServiceBaseProps