Package io.github.cdklabs.cdk.ecs.codedeploy

Class ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder

java.lang.Object

io.github.cdklabs.cdk.ecs.codedeploy.ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApplicationLoadBalancedCodeDeployedFargateServiceProps>

Enclosing interface:

ApplicationLoadBalancedCodeDeployedFargateServiceProps

@Stability(Experimental)
public static final class ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder
extends Object
implements software.amazon.jsii.Builder<ApplicationLoadBalancedCodeDeployedFargateServiceProps>

A builder for ApplicationLoadBalancedCodeDeployedFargateServiceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	accessLogBucket(software.amazon.awscdk.services.s3.IBucket accessLogBucket)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getAccessLogBucket()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	accessLogPrefix(String accessLogPrefix)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getAccessLogPrefix()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	apiCanarySchedule(software.amazon.awscdk.Duration apiCanarySchedule)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getApiCanarySchedule()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	apiCanaryThreadCount(Number apiCanaryThreadCount)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getApiCanaryThreadCount()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	apiCanaryTimeout(software.amazon.awscdk.Duration apiCanaryTimeout)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getApiCanaryTimeout()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	apiTestSteps(List<? extends ApiTestStep> apiTestSteps)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getApiTestSteps()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	applicationName(String applicationName)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getApplicationName()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	assignPublicIp(Boolean assignPublicIp)	Sets the value of ApplicationLoadBalancedFargateServiceProps.getAssignPublicIp()
ApplicationLoadBalancedCodeDeployedFargateServiceProps	build()	Builds the configured instance.
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	capacityProviderStrategies(List<? extends software.amazon.awscdk.services.ecs.CapacityProviderStrategy> capacityProviderStrategies)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCapacityProviderStrategies()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	certificate(software.amazon.awscdk.services.certificatemanager.ICertificate certificate)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCertificate()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	circuitBreaker(software.amazon.awscdk.services.ecs.DeploymentCircuitBreaker circuitBreaker)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCircuitBreaker()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	cloudMapOptions(software.amazon.awscdk.services.ecs.CloudMapOptions cloudMapOptions)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCloudMapOptions()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	cluster(software.amazon.awscdk.services.ecs.ICluster cluster)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getCluster()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	cpu(Number cpu)	Sets the value of FargateServiceBaseProps.getCpu()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	deploymentConfig(software.amazon.awscdk.services.codedeploy.IEcsDeploymentConfig deploymentConfig)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getDeploymentConfig()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	deploymentController(software.amazon.awscdk.services.ecs.DeploymentController deploymentController)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDeploymentController()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	deploymentGroupName(String deploymentGroupName)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getDeploymentGroupName()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	deploymentTimeout(software.amazon.awscdk.Duration deploymentTimeout)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getDeploymentTimeout()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	deregistrationDelay(software.amazon.awscdk.Duration deregistrationDelay)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getDeregistrationDelay()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	desiredCount(Number desiredCount)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDesiredCount()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	domainName(String domainName)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDomainName()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	domainZone(software.amazon.awscdk.services.route53.IHostedZone domainZone)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getDomainZone()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps#getEnableEcsManagedTags
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getEnableExecuteCommand()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	ephemeralStorageGiB(Number ephemeralStorageGiB)	Sets the value of FargateServiceBaseProps.getEphemeralStorageGiB()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	healthCheck(software.amazon.awscdk.services.ecs.HealthCheck healthCheck)	Sets the value of ApplicationLoadBalancedFargateServiceProps.getHealthCheck()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	healthCheckGracePeriod(software.amazon.awscdk.Duration healthCheckGracePeriod)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getHealthCheckGracePeriod()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	hooks(AppSpecHooks hooks)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getHooks()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	idleTimeout(software.amazon.awscdk.Duration idleTimeout)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getIdleTimeout()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	listenerPort(Number listenerPort)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getListenerPort()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	loadBalancer(software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancer loadBalancer)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancer()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	loadBalancerName(String loadBalancerName)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancerName()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	maxHealthyPercent(Number maxHealthyPercent)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getMaxHealthyPercent()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	memoryLimitMiB(Number memoryLimitMiB)	Sets the value of FargateServiceBaseProps.getMemoryLimitMiB()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	minHealthyPercent(Number minHealthyPercent)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getMinHealthyPercent()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	openListener(Boolean openListener)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getOpenListener()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	platformVersion(software.amazon.awscdk.services.ecs.FargatePlatformVersion platformVersion)	Sets the value of FargateServiceBaseProps.getPlatformVersion()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	propagateTags(software.amazon.awscdk.services.ecs.PropagatedTagSource propagateTags)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getPropagateTags()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	protocol(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocol protocol)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocol()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	protocolVersion(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocolVersion protocolVersion)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocolVersion()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	publicLoadBalancer(Boolean publicLoadBalancer)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getPublicLoadBalancer()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	recordType(software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceRecordType recordType)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getRecordType()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	redirectHttp(Boolean redirectHttp)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps#getRedirectHttp
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	responseTimeAlarmThreshold(software.amazon.awscdk.Duration responseTimeAlarmThreshold)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getResponseTimeAlarmThreshold()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	runtimePlatform(software.amazon.awscdk.services.ecs.RuntimePlatform runtimePlatform)	Sets the value of FargateServiceBaseProps.getRuntimePlatform()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	securityGroups(List<? extends software.amazon.awscdk.services.ec2.ISecurityGroup> securityGroups)	Sets the value of ApplicationLoadBalancedFargateServiceProps.getSecurityGroups()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	serviceName(String serviceName)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getServiceName()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	sslPolicy(software.amazon.awscdk.services.elasticloadbalancingv2.SslPolicy sslPolicy)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getSslPolicy()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	targetHealthCheck(software.amazon.awscdk.services.elasticloadbalancingv2.HealthCheck targetHealthCheck)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getTargetHealthCheck()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	targetProtocol(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocol targetProtocol)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getTargetProtocol()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	taskDefinition(software.amazon.awscdk.services.ecs.FargateTaskDefinition taskDefinition)	Sets the value of FargateServiceBaseProps.getTaskDefinition()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	taskImageOptions(software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions taskImageOptions)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getTaskImageOptions()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	taskSubnets(software.amazon.awscdk.services.ec2.SubnetSelection taskSubnets)	Sets the value of ApplicationLoadBalancedFargateServiceProps.getTaskSubnets()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	terminationWaitTime(software.amazon.awscdk.Duration terminationWaitTime)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getTerminationWaitTime()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	testPort(Number testPort)	Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getTestPort()
ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder	vpc(software.amazon.awscdk.services.ec2.IVpc vpc)	Sets the value of ApplicationLoadBalancedServiceBaseProps.getVpc()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

accessLogBucket

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder accessLogBucket(software.amazon.awscdk.services.s3.IBucket accessLogBucket)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getAccessLogBucket()

Parameters:

accessLogBucket - The bucket to use for access logs from the Application Load Balancer.

Returns:

this

accessLogPrefix

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder accessLogPrefix(String accessLogPrefix)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getAccessLogPrefix()

Parameters:

accessLogPrefix - The prefix to use for access logs from the Application Load Balancer.

Returns:

this

apiCanarySchedule

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder apiCanarySchedule(software.amazon.awscdk.Duration apiCanarySchedule)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getApiCanarySchedule()

Parameters:

apiCanarySchedule - The frequency for running the api canaries.

Returns:

this

apiCanaryThreadCount

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder apiCanaryThreadCount(Number apiCanaryThreadCount)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getApiCanaryThreadCount()

Parameters:

apiCanaryThreadCount - The number of threads to run concurrently for the synthetic test.

Returns:

this

apiCanaryTimeout

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder apiCanaryTimeout(software.amazon.awscdk.Duration apiCanaryTimeout)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getApiCanaryTimeout()

Parameters:

apiCanaryTimeout - The threshold for how long a api canary can take to run.

Returns:

this

apiTestSteps

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder apiTestSteps(List<? extends ApiTestStep> apiTestSteps)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getApiTestSteps()

Parameters:

apiTestSteps - The steps to run in the canary.

Returns:

this

applicationName

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder applicationName(String applicationName)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getApplicationName()

Parameters:

applicationName - The physical, human-readable name of the CodeDeploy Application.

Returns:

this

deploymentConfig

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder deploymentConfig(software.amazon.awscdk.services.codedeploy.IEcsDeploymentConfig deploymentConfig)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getDeploymentConfig()

Parameters:

deploymentConfig - The deployment configuration to use for the deployment group.

Returns:

this

deploymentGroupName

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder deploymentGroupName(String deploymentGroupName)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getDeploymentGroupName()

Parameters:

deploymentGroupName - The physical, human-readable name of the CodeDeploy Deployment Group.

Returns:

this

deploymentTimeout

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder deploymentTimeout(software.amazon.awscdk.Duration deploymentTimeout)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getDeploymentTimeout()

Parameters:

deploymentTimeout - The timeout for a CodeDeploy deployment.

Returns:

this

deregistrationDelay

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder deregistrationDelay(software.amazon.awscdk.Duration deregistrationDelay)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getDeregistrationDelay()

Parameters:

deregistrationDelay - The amount of time for ELB to wait before changing the state of a deregistering target from 'draining' to 'unused'.

Returns:

this

hooks

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder hooks(AppSpecHooks hooks)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getHooks()

Parameters:

hooks - Optional lifecycle hooks.

Returns:

this

responseTimeAlarmThreshold

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder responseTimeAlarmThreshold(software.amazon.awscdk.Duration responseTimeAlarmThreshold)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getResponseTimeAlarmThreshold()

Parameters:

responseTimeAlarmThreshold - The threshold for response time alarm.

Returns:

this

targetHealthCheck

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder targetHealthCheck(software.amazon.awscdk.services.elasticloadbalancingv2.HealthCheck targetHealthCheck)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getTargetHealthCheck()

Parameters:

targetHealthCheck - The healthcheck to configure on the Application Load Balancer target groups.

Returns:

this

terminationWaitTime

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder terminationWaitTime(software.amazon.awscdk.Duration terminationWaitTime)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getTerminationWaitTime()

Parameters:

terminationWaitTime - The time to wait before terminating the original (blue) task set.

Returns:

this

testPort

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder testPort(Number testPort)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps.getTestPort()

Parameters:

testPort - The port to use for test traffic on the listener.

Returns:

this

assignPublicIp

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder assignPublicIp(Boolean assignPublicIp)

Sets the value of ApplicationLoadBalancedFargateServiceProps.getAssignPublicIp()

Parameters:

assignPublicIp - Determines whether the service will be assigned a public IP address.

Returns:

this

healthCheck

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder healthCheck(software.amazon.awscdk.services.ecs.HealthCheck healthCheck)

Sets the value of ApplicationLoadBalancedFargateServiceProps.getHealthCheck()

Parameters:

healthCheck - The health check command and associated configuration parameters for the container.

Returns:

this

securityGroups

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder securityGroups(List<? extends software.amazon.awscdk.services.ec2.ISecurityGroup> securityGroups)

Sets the value of ApplicationLoadBalancedFargateServiceProps.getSecurityGroups()

Parameters:

securityGroups - The security groups to associate with the service. If you do not specify a security group, a new security group is created.

Returns:

this

taskSubnets

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder taskSubnets(software.amazon.awscdk.services.ec2.SubnetSelection taskSubnets)

Sets the value of ApplicationLoadBalancedFargateServiceProps.getTaskSubnets()

Parameters:

taskSubnets - The subnets to associate with the service.

Returns:

this

capacityProviderStrategies

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder capacityProviderStrategies(List<? extends software.amazon.awscdk.services.ecs.CapacityProviderStrategy> capacityProviderStrategies)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getCapacityProviderStrategies()

Parameters:

capacityProviderStrategies - A list of Capacity Provider strategies used to place a service.

Returns:

this

certificate

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder certificate(software.amazon.awscdk.services.certificatemanager.ICertificate certificate)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getCertificate()

Parameters:

certificate - Certificate Manager certificate to associate with the load balancer. Setting this option will set the load balancer protocol to HTTPS.

Returns:

this

circuitBreaker

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder circuitBreaker(software.amazon.awscdk.services.ecs.DeploymentCircuitBreaker circuitBreaker)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getCircuitBreaker()

Parameters:

circuitBreaker - Whether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled.

Returns:

this

cloudMapOptions

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder cloudMapOptions(software.amazon.awscdk.services.ecs.CloudMapOptions cloudMapOptions)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getCloudMapOptions()

Parameters:

cloudMapOptions - The options for configuring an Amazon ECS service to use service discovery.

Returns:

this

cluster

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder cluster(software.amazon.awscdk.services.ecs.ICluster cluster)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getCluster()

Parameters:

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.

Returns:

this

deploymentController

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder deploymentController(software.amazon.awscdk.services.ecs.DeploymentController deploymentController)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getDeploymentController()

Parameters:

deploymentController - Specifies which deployment controller to use for the service. For more information, see Amazon ECS Deployment Types

Returns:

this

desiredCount

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder desiredCount(Number desiredCount)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getDesiredCount()

Parameters:

desiredCount - The desired number of instantiations of the task definition to keep running on the service. The minimum value is 1

Returns:

this

domainName

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder domainName(String domainName)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getDomainName()

Parameters:

domainName - The domain name for the service, e.g. "api.example.com.".

Returns:

this

domainZone

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder domainZone(software.amazon.awscdk.services.route53.IHostedZone domainZone)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getDomainZone()

Parameters:

domainZone - The Route53 hosted zone for the domain, e.g. "example.com.".

Returns:

this

enableEcsManagedTags

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps#getEnableEcsManagedTags

Parameters:

enableEcsManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources

Returns:

this

enableExecuteCommand

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder enableExecuteCommand(Boolean enableExecuteCommand)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether ECS Exec should be enabled.

Returns:

this

healthCheckGracePeriod

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder healthCheckGracePeriod(software.amazon.awscdk.Duration healthCheckGracePeriod)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getHealthCheckGracePeriod()

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.

Returns:

this

idleTimeout

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder idleTimeout(software.amazon.awscdk.Duration idleTimeout)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getIdleTimeout()

Parameters:

idleTimeout - The load balancer idle timeout, in seconds. Can be between 1 and 4000 seconds

Returns:

this

listenerPort

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder listenerPort(Number listenerPort)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getListenerPort()

Parameters:

listenerPort - Listener port of the application load balancer that will serve traffic to the service.

Returns:

this

loadBalancer

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder loadBalancer(software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancer loadBalancer)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancer()

Parameters:

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]

Returns:

this

loadBalancerName

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder loadBalancerName(String loadBalancerName)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getLoadBalancerName()

Parameters:

loadBalancerName - Name of the load balancer.

Returns:

this

maxHealthyPercent

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder maxHealthyPercent(Number maxHealthyPercent)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getMaxHealthyPercent()

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.

Returns:

this

minHealthyPercent

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder minHealthyPercent(Number minHealthyPercent)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getMinHealthyPercent()

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.

Returns:

this

openListener

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder openListener(Boolean openListener)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getOpenListener()

Parameters:

openListener - Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.

Returns:

this

propagateTags

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder propagateTags(software.amazon.awscdk.services.ecs.PropagatedTagSource propagateTags)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getPropagateTags()

Parameters:

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.

Returns:

this

protocol

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder protocol(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocol protocol)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocol()

Parameters:

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.

Returns:

this

protocolVersion

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder protocolVersion(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocolVersion protocolVersion)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getProtocolVersion()

Parameters:

protocolVersion - The protocol version to use.

Returns:

this

publicLoadBalancer

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder publicLoadBalancer(Boolean publicLoadBalancer)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getPublicLoadBalancer()

Parameters:

publicLoadBalancer - Determines whether the Load Balancer will be internet-facing.

Returns:

this

recordType

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder recordType(software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceRecordType recordType)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getRecordType()

Parameters:

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.

Returns:

this

redirectHttp

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder redirectHttp(Boolean redirectHttp)

Sets the value of ApplicationLoadBalancedCodeDeployedFargateServiceProps#getRedirectHttp

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.

Returns:

this

serviceName

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder serviceName(String serviceName)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getServiceName()

Parameters:

serviceName - The name of the service.

Returns:

this

sslPolicy

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder sslPolicy(software.amazon.awscdk.services.elasticloadbalancingv2.SslPolicy sslPolicy)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getSslPolicy()

Parameters:

sslPolicy - The security policy that defines which ciphers and protocols are supported by the ALB Listener.

Returns:

this

targetProtocol

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder targetProtocol(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocol targetProtocol)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getTargetProtocol()

Parameters:

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).

Returns:

this

taskImageOptions

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder taskImageOptions(software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions taskImageOptions)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getTaskImageOptions()

Parameters:

taskImageOptions - The properties required to create a new task definition. TaskDefinition or TaskImageOptions must be specified, but not both.

Returns:

this

vpc

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder vpc(software.amazon.awscdk.services.ec2.IVpc vpc)

Sets the value of ApplicationLoadBalancedServiceBaseProps.getVpc()

Parameters:

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.

Returns:

this

cpu

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder cpu(Number cpu)

Sets the value of FargateServiceBaseProps.getCpu()

Parameters:

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.

Returns:

this

ephemeralStorageGiB

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder ephemeralStorageGiB(Number ephemeralStorageGiB)

Sets the value of FargateServiceBaseProps.getEphemeralStorageGiB()

Parameters:

ephemeralStorageGiB - 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.

Returns:

this

memoryLimitMiB

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder memoryLimitMiB(Number memoryLimitMiB)

Sets the value of FargateServiceBaseProps.getMemoryLimitMiB()

Parameters:

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.

Returns:

this

platformVersion

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder platformVersion(software.amazon.awscdk.services.ecs.FargatePlatformVersion platformVersion)

Sets the value of FargateServiceBaseProps.getPlatformVersion()

Parameters:

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.

Returns:

this

runtimePlatform

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder runtimePlatform(software.amazon.awscdk.services.ecs.RuntimePlatform runtimePlatform)

Sets the value of FargateServiceBaseProps.getRuntimePlatform()

Parameters:

runtimePlatform - The runtime platform of the task definition.

Returns:

this

taskDefinition

@Stability(Stable)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder taskDefinition(software.amazon.awscdk.services.ecs.FargateTaskDefinition taskDefinition)

Sets the value of FargateServiceBaseProps.getTaskDefinition()

Parameters:

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]

Returns:

this

build

@Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateServiceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ApplicationLoadBalancedCodeDeployedFargateServiceProps>

Returns:

a new instance of ApplicationLoadBalancedCodeDeployedFargateServiceProps

Throws:

NullPointerException - if any required attribute was not provided