Class ApplicationLoadBalancedCodeDeployedFargateService.Builder
- java.lang.Object
-
- io.github.cdklabs.cdk.ecs.codedeploy.ApplicationLoadBalancedCodeDeployedFargateService.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<ApplicationLoadBalancedCodeDeployedFargateService>
- Enclosing class:
- ApplicationLoadBalancedCodeDeployedFargateService
@Stability(Experimental) public static final class ApplicationLoadBalancedCodeDeployedFargateService.Builder extends Object implements software.amazon.jsii.Builder<ApplicationLoadBalancedCodeDeployedFargateService>
(experimental) A fluent builder forApplicationLoadBalancedCodeDeployedFargateService.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ApplicationLoadBalancedCodeDeployedFargateService.BuilderaccessLogBucket(software.amazon.awscdk.services.s3.IBucket accessLogBucket)(experimental) The bucket to use for access logs from the Application Load Balancer.ApplicationLoadBalancedCodeDeployedFargateService.BuilderaccessLogPrefix(String accessLogPrefix)(experimental) The prefix to use for access logs from the Application Load Balancer.ApplicationLoadBalancedCodeDeployedFargateService.BuilderapiCanarySchedule(software.amazon.awscdk.Duration apiCanarySchedule)(experimental) The frequency for running the api canaries.ApplicationLoadBalancedCodeDeployedFargateService.BuilderapiCanaryThreadCount(Number apiCanaryThreadCount)(experimental) The number of threads to run concurrently for the synthetic test.ApplicationLoadBalancedCodeDeployedFargateService.BuilderapiCanaryTimeout(software.amazon.awscdk.Duration apiCanaryTimeout)(experimental) The threshold for how long a api canary can take to run.ApplicationLoadBalancedCodeDeployedFargateService.BuilderapiTestSteps(List<? extends ApiTestStep> apiTestSteps)(experimental) The steps to run in the canary.ApplicationLoadBalancedCodeDeployedFargateService.BuilderapplicationName(String applicationName)(experimental) The physical, human-readable name of the CodeDeploy Application.ApplicationLoadBalancedCodeDeployedFargateService.BuilderassignPublicIp(Boolean assignPublicIp)Determines whether the service will be assigned a public IP address.ApplicationLoadBalancedCodeDeployedFargateServicebuild()ApplicationLoadBalancedCodeDeployedFargateService.BuildercapacityProviderStrategies(List<? extends software.amazon.awscdk.services.ecs.CapacityProviderStrategy> capacityProviderStrategies)A list of Capacity Provider strategies used to place a service.ApplicationLoadBalancedCodeDeployedFargateService.Buildercertificate(software.amazon.awscdk.services.certificatemanager.ICertificate certificate)Certificate Manager certificate to associate with the load balancer.ApplicationLoadBalancedCodeDeployedFargateService.BuildercircuitBreaker(software.amazon.awscdk.services.ecs.DeploymentCircuitBreaker circuitBreaker)Whether to enable the deployment circuit breaker.ApplicationLoadBalancedCodeDeployedFargateService.BuildercloudMapOptions(software.amazon.awscdk.services.ecs.CloudMapOptions cloudMapOptions)The options for configuring an Amazon ECS service to use service discovery.ApplicationLoadBalancedCodeDeployedFargateService.Buildercluster(software.amazon.awscdk.services.ecs.ICluster cluster)The name of the cluster that hosts the service.ApplicationLoadBalancedCodeDeployedFargateService.Buildercpu(Number cpu)The number of cpu units used by the task.static ApplicationLoadBalancedCodeDeployedFargateService.Buildercreate(software.constructs.Construct scope, String id)ApplicationLoadBalancedCodeDeployedFargateService.BuilderdeploymentConfig(software.amazon.awscdk.services.codedeploy.IEcsDeploymentConfig deploymentConfig)(experimental) The deployment configuration to use for the deployment group.ApplicationLoadBalancedCodeDeployedFargateService.BuilderdeploymentController(software.amazon.awscdk.services.ecs.DeploymentController deploymentController)Specifies which deployment controller to use for the service.ApplicationLoadBalancedCodeDeployedFargateService.BuilderdeploymentGroupName(String deploymentGroupName)(experimental) The physical, human-readable name of the CodeDeploy Deployment Group.ApplicationLoadBalancedCodeDeployedFargateService.BuilderdeploymentTimeout(software.amazon.awscdk.Duration deploymentTimeout)(experimental) The timeout for a CodeDeploy deployment.ApplicationLoadBalancedCodeDeployedFargateService.BuilderderegistrationDelay(software.amazon.awscdk.Duration deregistrationDelay)(experimental) The amount of time for ELB to wait before changing the state of a deregistering target from 'draining' to 'unused'.ApplicationLoadBalancedCodeDeployedFargateService.BuilderdesiredCount(Number desiredCount)The desired number of instantiations of the task definition to keep running on the service.ApplicationLoadBalancedCodeDeployedFargateService.BuilderdomainName(String domainName)The domain name for the service, e.g.ApplicationLoadBalancedCodeDeployedFargateService.BuilderdomainZone(software.amazon.awscdk.services.route53.IHostedZone domainZone)The Route53 hosted zone for the domain, e.g.ApplicationLoadBalancedCodeDeployedFargateService.BuilderenableEcsManagedTags(Boolean enableEcsManagedTags)Specifies whether to enable Amazon ECS managed tags for the tasks within the service.ApplicationLoadBalancedCodeDeployedFargateService.BuilderenableExecuteCommand(Boolean enableExecuteCommand)Whether ECS Exec should be enabled.ApplicationLoadBalancedCodeDeployedFargateService.BuilderephemeralStorageGiB(Number ephemeralStorageGiB)The amount (in GiB) of ephemeral storage to be allocated to the task.ApplicationLoadBalancedCodeDeployedFargateService.BuilderhealthCheck(software.amazon.awscdk.services.ecs.HealthCheck healthCheck)The health check command and associated configuration parameters for the container.ApplicationLoadBalancedCodeDeployedFargateService.BuilderhealthCheckGracePeriod(software.amazon.awscdk.Duration healthCheckGracePeriod)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.ApplicationLoadBalancedCodeDeployedFargateService.Builderhooks(AppSpecHooks hooks)(experimental) Optional lifecycle hooks.ApplicationLoadBalancedCodeDeployedFargateService.BuilderidleTimeout(software.amazon.awscdk.Duration idleTimeout)The load balancer idle timeout, in seconds.ApplicationLoadBalancedCodeDeployedFargateService.BuilderlistenerPort(Number listenerPort)Listener port of the application load balancer that will serve traffic to the service.ApplicationLoadBalancedCodeDeployedFargateService.BuilderloadBalancer(software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancer loadBalancer)The application load balancer that will serve traffic to the service.ApplicationLoadBalancedCodeDeployedFargateService.BuilderloadBalancerName(String loadBalancerName)Name of the load balancer.ApplicationLoadBalancedCodeDeployedFargateService.BuildermaxHealthyPercent(Number maxHealthyPercent)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.ApplicationLoadBalancedCodeDeployedFargateService.BuildermemoryLimitMiB(Number memoryLimitMiB)The amount (in MiB) of memory used by the task.ApplicationLoadBalancedCodeDeployedFargateService.BuilderminHealthyPercent(Number minHealthyPercent)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.ApplicationLoadBalancedCodeDeployedFargateService.BuilderopenListener(Boolean openListener)Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.ApplicationLoadBalancedCodeDeployedFargateService.BuilderplatformVersion(software.amazon.awscdk.services.ecs.FargatePlatformVersion platformVersion)The platform version on which to run your service.ApplicationLoadBalancedCodeDeployedFargateService.BuilderpropagateTags(software.amazon.awscdk.services.ecs.PropagatedTagSource propagateTags)Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.ApplicationLoadBalancedCodeDeployedFargateService.Builderprotocol(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocol protocol)The protocol for connections from clients to the load balancer.ApplicationLoadBalancedCodeDeployedFargateService.BuilderprotocolVersion(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocolVersion protocolVersion)The protocol version to use.ApplicationLoadBalancedCodeDeployedFargateService.BuilderpublicLoadBalancer(Boolean publicLoadBalancer)Determines whether the Load Balancer will be internet-facing.ApplicationLoadBalancedCodeDeployedFargateService.BuilderrecordType(software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceRecordType recordType)Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.ApplicationLoadBalancedCodeDeployedFargateService.BuilderredirectHttp(Boolean redirectHttp)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.ApplicationLoadBalancedCodeDeployedFargateService.BuilderresponseTimeAlarmThreshold(software.amazon.awscdk.Duration responseTimeAlarmThreshold)(experimental) The threshold for response time alarm.ApplicationLoadBalancedCodeDeployedFargateService.BuilderruntimePlatform(software.amazon.awscdk.services.ecs.RuntimePlatform runtimePlatform)The runtime platform of the task definition.ApplicationLoadBalancedCodeDeployedFargateService.BuildersecurityGroups(List<? extends software.amazon.awscdk.services.ec2.ISecurityGroup> securityGroups)The security groups to associate with the service.ApplicationLoadBalancedCodeDeployedFargateService.BuilderserviceName(String serviceName)The name of the service.ApplicationLoadBalancedCodeDeployedFargateService.BuildersslPolicy(software.amazon.awscdk.services.elasticloadbalancingv2.SslPolicy sslPolicy)The security policy that defines which ciphers and protocols are supported by the ALB Listener.ApplicationLoadBalancedCodeDeployedFargateService.BuildertargetHealthCheck(software.amazon.awscdk.services.elasticloadbalancingv2.HealthCheck targetHealthCheck)(experimental) The healthcheck to configure on the Application Load Balancer target groups.ApplicationLoadBalancedCodeDeployedFargateService.BuildertargetProtocol(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocol targetProtocol)The protocol for connections from the load balancer to the ECS tasks.ApplicationLoadBalancedCodeDeployedFargateService.BuildertaskDefinition(software.amazon.awscdk.services.ecs.FargateTaskDefinition taskDefinition)The task definition to use for tasks in the service.ApplicationLoadBalancedCodeDeployedFargateService.BuildertaskImageOptions(software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions taskImageOptions)The properties required to create a new task definition.ApplicationLoadBalancedCodeDeployedFargateService.BuildertaskSubnets(software.amazon.awscdk.services.ec2.SubnetSelection taskSubnets)The subnets to associate with the service.ApplicationLoadBalancedCodeDeployedFargateService.BuilderterminationWaitTime(software.amazon.awscdk.Duration terminationWaitTime)(experimental) The time to wait before terminating the original (blue) task set.ApplicationLoadBalancedCodeDeployedFargateService.BuildertestPort(Number testPort)(experimental) The port to use for test traffic on the listener.ApplicationLoadBalancedCodeDeployedFargateService.Buildervpc(software.amazon.awscdk.services.ec2.IVpc vpc)The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
-
-
-
Method Detail
-
create
@Stability(Experimental) public static ApplicationLoadBalancedCodeDeployedFargateService.Builder create(software.constructs.Construct scope, String id)
- Parameters:
scope- This parameter is required.id- This parameter is required.- Returns:
- a new instance of
ApplicationLoadBalancedCodeDeployedFargateService.Builder.
-
capacityProviderStrategies
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder capacityProviderStrategies(List<? extends software.amazon.awscdk.services.ecs.CapacityProviderStrategy> capacityProviderStrategies)
A list of Capacity Provider strategies used to place a service.Default: - undefined
- Parameters:
capacityProviderStrategies- A list of Capacity Provider strategies used to place a service. This parameter is required.- Returns:
this
-
certificate
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder certificate(software.amazon.awscdk.services.certificatemanager.ICertificate certificate)
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.
- Parameters:
certificate- Certificate Manager certificate to associate with the load balancer. This parameter is required.- Returns:
this
-
circuitBreaker
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder circuitBreaker(software.amazon.awscdk.services.ecs.DeploymentCircuitBreaker circuitBreaker)
Whether to enable the deployment circuit breaker.If this property is defined, circuit breaker will be implicitly enabled.
Default: - disabled
- Parameters:
circuitBreaker- Whether to enable the deployment circuit breaker. This parameter is required.- Returns:
this
-
cloudMapOptions
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder cloudMapOptions(software.amazon.awscdk.services.ecs.CloudMapOptions cloudMapOptions)
The options for configuring an Amazon ECS service to use service discovery.Default: - AWS Cloud Map service discovery is not enabled.
- Parameters:
cloudMapOptions- The options for configuring an Amazon ECS service to use service discovery. This parameter is required.- Returns:
this
-
cluster
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder cluster(software.amazon.awscdk.services.ecs.ICluster cluster)
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.
- Parameters:
cluster- The name of the cluster that hosts the service. This parameter is required.- Returns:
this
-
deploymentController
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder deploymentController(software.amazon.awscdk.services.ecs.DeploymentController deploymentController)
Specifies which deployment controller to use for the service.For more information, see Amazon ECS Deployment Types
Default: - Rolling update (ECS)
- Parameters:
deploymentController- Specifies which deployment controller to use for the service. This parameter is required.- Returns:
this
-
desiredCount
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder desiredCount(Number desiredCount)
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.
- Parameters:
desiredCount- The desired number of instantiations of the task definition to keep running on the service. This parameter is required.- Returns:
this
-
domainName
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder domainName(String domainName)
The domain name for the service, e.g. "api.example.com.".Default: - No domain name.
- Parameters:
domainName- The domain name for the service, e.g. "api.example.com.". This parameter is required.- Returns:
this
-
domainZone
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder domainZone(software.amazon.awscdk.services.route53.IHostedZone domainZone)
The Route53 hosted zone for the domain, e.g. "example.com.".Default: - No Route53 hosted domain zone.
- Parameters:
domainZone- The Route53 hosted zone for the domain, e.g. "example.com.". This parameter is required.- Returns:
this
-
enableEcsManagedTags
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)
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
- Parameters:
enableEcsManagedTags- Specifies whether to enable Amazon ECS managed tags for the tasks within the service. This parameter is required.- Returns:
this
-
enableExecuteCommand
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder enableExecuteCommand(Boolean enableExecuteCommand)
Whether ECS Exec should be enabled.Default: - false
- Parameters:
enableExecuteCommand- Whether ECS Exec should be enabled. This parameter is required.- Returns:
this
-
healthCheckGracePeriod
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder healthCheckGracePeriod(software.amazon.awscdk.Duration healthCheckGracePeriod)
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
- Parameters:
healthCheckGracePeriod- 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. This parameter is required.- Returns:
this
-
idleTimeout
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder idleTimeout(software.amazon.awscdk.Duration idleTimeout)
The load balancer idle timeout, in seconds.Can be between 1 and 4000 seconds
Default: - CloudFormation sets idle timeout to 60 seconds
- Parameters:
idleTimeout- The load balancer idle timeout, in seconds. This parameter is required.- Returns:
this
-
listenerPort
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder listenerPort(Number listenerPort)
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.
- Parameters:
listenerPort- Listener port of the application load balancer that will serve traffic to the service. This parameter is required.- Returns:
this
-
loadBalancer
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder loadBalancer(software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancer loadBalancer)
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.
- Parameters:
loadBalancer- The application load balancer that will serve traffic to the service. This parameter is required.- Returns:
this
-
loadBalancerName
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder loadBalancerName(String loadBalancerName)
Name of the load balancer.Default: - Automatically generated name.
- Parameters:
loadBalancerName- Name of the load balancer. This parameter is required.- Returns:
this
-
maxHealthyPercent
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder maxHealthyPercent(Number maxHealthyPercent)
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
- Parameters:
maxHealthyPercent- 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. This parameter is required.- Returns:
this
-
minHealthyPercent
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder minHealthyPercent(Number minHealthyPercent)
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
- Parameters:
minHealthyPercent- 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. This parameter is required.- Returns:
this
-
openListener
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder openListener(Boolean openListener)
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.
- Parameters:
openListener- Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default. This parameter is required.- Returns:
this
-
propagateTags
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder propagateTags(software.amazon.awscdk.services.ecs.PropagatedTagSource propagateTags)
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
- Parameters:
propagateTags- Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. This parameter is required.- Returns:
this
-
protocol
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder protocol(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocol protocol)
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.
- Parameters:
protocol- The protocol for connections from clients to the load balancer. This parameter is required.- Returns:
this
-
protocolVersion
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder protocolVersion(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocolVersion protocolVersion)
The protocol version to use.Default: ApplicationProtocolVersion.HTTP1
- Parameters:
protocolVersion- The protocol version to use. This parameter is required.- Returns:
this
-
publicLoadBalancer
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder publicLoadBalancer(Boolean publicLoadBalancer)
Determines whether the Load Balancer will be internet-facing.Default: true
- Parameters:
publicLoadBalancer- Determines whether the Load Balancer will be internet-facing. This parameter is required.- Returns:
this
-
recordType
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder recordType(software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceRecordType recordType)
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
- Parameters:
recordType- Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all. This parameter is required.- Returns:
this
-
redirectHttp
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder redirectHttp(Boolean redirectHttp)
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
- Parameters:
redirectHttp- 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. This parameter is required.- Returns:
this
-
serviceName
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder serviceName(String serviceName)
The name of the service.Default: - CloudFormation-generated name.
- Parameters:
serviceName- The name of the service. This parameter is required.- Returns:
this
-
sslPolicy
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder sslPolicy(software.amazon.awscdk.services.elasticloadbalancingv2.SslPolicy sslPolicy)
The security policy that defines which ciphers and protocols are supported by the ALB Listener.Default: - The recommended elastic load balancing security policy
- Parameters:
sslPolicy- The security policy that defines which ciphers and protocols are supported by the ALB Listener. This parameter is required.- Returns:
this
-
targetProtocol
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder targetProtocol(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocol targetProtocol)
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.
- Parameters:
targetProtocol- The protocol for connections from the load balancer to the ECS tasks. This parameter is required.- Returns:
this
-
taskImageOptions
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder taskImageOptions(software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions taskImageOptions)
The properties required to create a new task definition.TaskDefinition or TaskImageOptions must be specified, but not both.
Default: none
- Parameters:
taskImageOptions- The properties required to create a new task definition. This parameter is required.- Returns:
this
-
vpc
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder vpc(software.amazon.awscdk.services.ec2.IVpc 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.
Default: - uses the VPC defined in the cluster or creates a new VPC.
- Parameters:
vpc- The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. This parameter is required.- Returns:
this
-
cpu
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder cpu(Number cpu)
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.
Default: 256
- Parameters:
cpu- The number of cpu units used by the task. This parameter is required.- Returns:
this
-
ephemeralStorageGiB
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder ephemeralStorageGiB(Number ephemeralStorageGiB)
The amount (in GiB) of ephemeral storage to be allocated to the task.The minimum supported value is
21GiB and the maximum supported value is200GiB.Only supported in Fargate platform version 1.4.0 or later.
Default: Undefined, in which case, the task will receive 20GiB ephemeral storage.
- Parameters:
ephemeralStorageGiB- The amount (in GiB) of ephemeral storage to be allocated to the task. This parameter is required.- Returns:
this
-
memoryLimitMiB
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder memoryLimitMiB(Number memoryLimitMiB)
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.
Default: 512
- Parameters:
memoryLimitMiB- The amount (in MiB) of memory used by the task. This parameter is required.- Returns:
this
-
platformVersion
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder platformVersion(software.amazon.awscdk.services.ecs.FargatePlatformVersion platformVersion)
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 in the Amazon Elastic Container Service Developer Guide.
Default: Latest
- Parameters:
platformVersion- The platform version on which to run your service. This parameter is required.- Returns:
this
-
runtimePlatform
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder runtimePlatform(software.amazon.awscdk.services.ecs.RuntimePlatform runtimePlatform)
The runtime platform of the task definition.Default: - If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64
- Parameters:
runtimePlatform- The runtime platform of the task definition. This parameter is required.- Returns:
this
-
taskDefinition
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder taskDefinition(software.amazon.awscdk.services.ecs.FargateTaskDefinition taskDefinition)
The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.[disable-awslint:ref-via-interface]
Default: - none
- Parameters:
taskDefinition- The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. This parameter is required.- Returns:
this
-
assignPublicIp
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder assignPublicIp(Boolean assignPublicIp)
Determines whether the service will be assigned a public IP address.Default: false
- Parameters:
assignPublicIp- Determines whether the service will be assigned a public IP address. This parameter is required.- Returns:
this
-
healthCheck
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder healthCheck(software.amazon.awscdk.services.ecs.HealthCheck healthCheck)
The health check command and associated configuration parameters for the container.Default: - Health check configuration from container.
- Parameters:
healthCheck- The health check command and associated configuration parameters for the container. This parameter is required.- Returns:
this
-
securityGroups
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder securityGroups(List<? extends software.amazon.awscdk.services.ec2.ISecurityGroup> securityGroups)
The security groups to associate with the service.If you do not specify a security group, a new security group is created.
Default: - A new security group is created.
- Parameters:
securityGroups- The security groups to associate with the service. This parameter is required.- Returns:
this
-
taskSubnets
@Stability(Stable) public ApplicationLoadBalancedCodeDeployedFargateService.Builder taskSubnets(software.amazon.awscdk.services.ec2.SubnetSelection taskSubnets)
The subnets to associate with the service.Default: - Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.
- Parameters:
taskSubnets- The subnets to associate with the service. This parameter is required.- Returns:
this
-
accessLogBucket
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder accessLogBucket(software.amazon.awscdk.services.s3.IBucket accessLogBucket)
(experimental) The bucket to use for access logs from the Application Load Balancer.Default: - a new S3 bucket will be created
- Parameters:
accessLogBucket- The bucket to use for access logs from the Application Load Balancer. This parameter is required.- Returns:
this
-
accessLogPrefix
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder accessLogPrefix(String accessLogPrefix)
(experimental) The prefix to use for access logs from the Application Load Balancer.Default: - none
- Parameters:
accessLogPrefix- The prefix to use for access logs from the Application Load Balancer. This parameter is required.- Returns:
this
-
apiCanarySchedule
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder apiCanarySchedule(software.amazon.awscdk.Duration apiCanarySchedule)
(experimental) The frequency for running the api canaries.Default: - 5 minutes
- Parameters:
apiCanarySchedule- The frequency for running the api canaries. This parameter is required.- Returns:
this
-
apiCanaryThreadCount
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder apiCanaryThreadCount(Number apiCanaryThreadCount)
(experimental) The number of threads to run concurrently for the synthetic test.Default: - 20
- Parameters:
apiCanaryThreadCount- The number of threads to run concurrently for the synthetic test. This parameter is required.- Returns:
this
-
apiCanaryTimeout
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder apiCanaryTimeout(software.amazon.awscdk.Duration apiCanaryTimeout)
(experimental) The threshold for how long a api canary can take to run.Default: - no alarm is created for test duration
- Parameters:
apiCanaryTimeout- The threshold for how long a api canary can take to run. This parameter is required.- Returns:
this
-
apiTestSteps
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder apiTestSteps(List<? extends ApiTestStep> apiTestSteps)
(experimental) The steps to run in the canary.Default: - no synthetic test will be created
- Parameters:
apiTestSteps- The steps to run in the canary. This parameter is required.- Returns:
this
-
applicationName
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder applicationName(String applicationName)
(experimental) The physical, human-readable name of the CodeDeploy Application.Default: an auto-generated name will be used
- Parameters:
applicationName- The physical, human-readable name of the CodeDeploy Application. This parameter is required.- Returns:
this
-
deploymentConfig
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder deploymentConfig(software.amazon.awscdk.services.codedeploy.IEcsDeploymentConfig deploymentConfig)
(experimental) The deployment configuration to use for the deployment group.Default: - EcsDeploymentConfig.ALL_AT_ONCE
- Parameters:
deploymentConfig- The deployment configuration to use for the deployment group. This parameter is required.- Returns:
this
-
deploymentGroupName
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder deploymentGroupName(String deploymentGroupName)
(experimental) The physical, human-readable name of the CodeDeploy Deployment Group.Default: An auto-generated name will be used.
- Parameters:
deploymentGroupName- The physical, human-readable name of the CodeDeploy Deployment Group. This parameter is required.- Returns:
this
-
deploymentTimeout
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder deploymentTimeout(software.amazon.awscdk.Duration deploymentTimeout)
(experimental) The timeout for a CodeDeploy deployment.Default: - 60 minutes
- Parameters:
deploymentTimeout- The timeout for a CodeDeploy deployment. This parameter is required.- Returns:
this
-
deregistrationDelay
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder deregistrationDelay(software.amazon.awscdk.Duration deregistrationDelay)
(experimental) The amount of time for ELB to wait before changing the state of a deregistering target from 'draining' to 'unused'.Default: - 300 seconds
- Parameters:
deregistrationDelay- The amount of time for ELB to wait before changing the state of a deregistering target from 'draining' to 'unused'. This parameter is required.- Returns:
this
-
hooks
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder hooks(AppSpecHooks hooks)
(experimental) Optional lifecycle hooks.Default: - no lifecycle hooks
- Parameters:
hooks- Optional lifecycle hooks. This parameter is required.- Returns:
this
-
responseTimeAlarmThreshold
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder responseTimeAlarmThreshold(software.amazon.awscdk.Duration responseTimeAlarmThreshold)
(experimental) The threshold for response time alarm.Default: - no alarm will be created
- Parameters:
responseTimeAlarmThreshold- The threshold for response time alarm. This parameter is required.- Returns:
this
-
targetHealthCheck
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder targetHealthCheck(software.amazon.awscdk.services.elasticloadbalancingv2.HealthCheck targetHealthCheck)
(experimental) The healthcheck to configure on the Application Load Balancer target groups.Default: - no health check is configured
- Parameters:
targetHealthCheck- The healthcheck to configure on the Application Load Balancer target groups. This parameter is required.- Returns:
this
-
terminationWaitTime
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder terminationWaitTime(software.amazon.awscdk.Duration terminationWaitTime)
(experimental) The time to wait before terminating the original (blue) task set.Default: - 10 minutes
- Parameters:
terminationWaitTime- The time to wait before terminating the original (blue) task set. This parameter is required.- Returns:
this
-
testPort
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService.Builder testPort(Number testPort)
(experimental) The port to use for test traffic on the listener.Default: - listenerPort + 1
- Parameters:
testPort- The port to use for test traffic on the listener. This parameter is required.- Returns:
this
-
build
@Stability(Experimental) public ApplicationLoadBalancedCodeDeployedFargateService build()
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<ApplicationLoadBalancedCodeDeployedFargateService>- Returns:
- a newly built instance of
ApplicationLoadBalancedCodeDeployedFargateService.
-
-