Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package cloudshift.awscdk.dsl.services.ecs.patterns
import cloudshift.awscdk.common.CdkDslMarker
import cloudshift.awscdk.dsl.services.ecs.CapacityProviderStrategyDsl
import cloudshift.awscdk.dsl.services.ecs.CloudMapOptionsDsl
import cloudshift.awscdk.dsl.services.ecs.DeploymentCircuitBreakerDsl
import cloudshift.awscdk.dsl.services.ecs.DeploymentControllerDsl
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.Collection
import kotlin.collections.MutableList
import software.amazon.awscdk.Duration
import software.amazon.awscdk.services.ec2.IVpc
import software.amazon.awscdk.services.ecs.CapacityProviderStrategy
import software.amazon.awscdk.services.ecs.CloudMapOptions
import software.amazon.awscdk.services.ecs.DeploymentCircuitBreaker
import software.amazon.awscdk.services.ecs.DeploymentController
import software.amazon.awscdk.services.ecs.Ec2TaskDefinition
import software.amazon.awscdk.services.ecs.ICluster
import software.amazon.awscdk.services.ecs.PlacementConstraint
import software.amazon.awscdk.services.ecs.PlacementStrategy
import software.amazon.awscdk.services.ecs.PropagatedTagSource
import software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedEc2Service
import software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedServiceRecordType
import software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedTaskImageOptions
import software.amazon.awscdk.services.elasticloadbalancingv2.INetworkLoadBalancer
import software.amazon.awscdk.services.route53.IHostedZone
import software.constructs.Construct
/**
* An EC2 service running on an ECS cluster fronted by a network load balancer.
*
* Example:
*
* ```
* Cluster cluster;
* NetworkLoadBalancedEc2Service loadBalancedEcsService =
* NetworkLoadBalancedEc2Service.Builder.create(this, "Service")
* .cluster(cluster)
* .memoryLimitMiB(1024)
* .taskImageOptions(NetworkLoadBalancedTaskImageOptions.builder()
* .image(ContainerImage.fromRegistry("test"))
* .environment(Map.of(
* "TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value",
* "TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value"))
* .build())
* .desiredCount(2)
* .build();
* ```
*/
@CdkDslMarker
public class NetworkLoadBalancedEc2ServiceDsl(
scope: Construct,
id: String,
) {
private val cdkBuilder: NetworkLoadBalancedEc2Service.Builder =
NetworkLoadBalancedEc2Service.Builder.create(scope, id)
private val _capacityProviderStrategies: MutableList = mutableListOf()
private val _placementConstraints: MutableList = mutableListOf()
private val _placementStrategies: MutableList = mutableListOf()
/**
* A list of Capacity Provider strategies used to place a service.
*
* Default: - undefined
*
* @param capacityProviderStrategies A list of Capacity Provider strategies used to place a
* service.
*/
public
fun capacityProviderStrategies(capacityProviderStrategies: CapacityProviderStrategyDsl.() -> Unit) {
_capacityProviderStrategies.add(CapacityProviderStrategyDsl().apply(capacityProviderStrategies).build())
}
/**
* A list of Capacity Provider strategies used to place a service.
*
* Default: - undefined
*
* @param capacityProviderStrategies A list of Capacity Provider strategies used to place a
* service.
*/
public
fun capacityProviderStrategies(capacityProviderStrategies: Collection) {
_capacityProviderStrategies.addAll(capacityProviderStrategies)
}
/**
* Whether to enable the deployment circuit breaker.
*
* If this property is defined, circuit breaker will be implicitly
* enabled.
*
* Default: - disabled
*
* @param circuitBreaker Whether to enable the deployment circuit breaker.
*/
public fun circuitBreaker(circuitBreaker: DeploymentCircuitBreakerDsl.() -> Unit = {}) {
val builder = DeploymentCircuitBreakerDsl()
builder.apply(circuitBreaker)
cdkBuilder.circuitBreaker(builder.build())
}
/**
* Whether to enable the deployment circuit breaker.
*
* If this property is defined, circuit breaker will be implicitly
* enabled.
*
* Default: - disabled
*
* @param circuitBreaker Whether to enable the deployment circuit breaker.
*/
public fun circuitBreaker(circuitBreaker: DeploymentCircuitBreaker) {
cdkBuilder.circuitBreaker(circuitBreaker)
}
/**
* The options for configuring an Amazon ECS service to use service discovery.
*
* Default: - AWS Cloud Map service discovery is not enabled.
*
* @param cloudMapOptions The options for configuring an Amazon ECS service to use service
* discovery.
*/
public fun cloudMapOptions(cloudMapOptions: CloudMapOptionsDsl.() -> Unit = {}) {
val builder = CloudMapOptionsDsl()
builder.apply(cloudMapOptions)
cdkBuilder.cloudMapOptions(builder.build())
}
/**
* The options for configuring an Amazon ECS service to use service discovery.
*
* Default: - AWS Cloud Map service discovery is not enabled.
*
* @param cloudMapOptions The options for configuring an Amazon ECS service to use service
* discovery.
*/
public fun cloudMapOptions(cloudMapOptions: CloudMapOptions) {
cdkBuilder.cloudMapOptions(cloudMapOptions)
}
/**
* 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.
*
* @param cluster The name of the cluster that hosts the service.
*/
public fun cluster(cluster: ICluster) {
cdkBuilder.cluster(cluster)
}
/**
* 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
*
* This default is set in the underlying FargateTaskDefinition construct.
*
* Default: none
*
* @param cpu The number of cpu units used by the task.
*/
public fun cpu(cpu: Number) {
cdkBuilder.cpu(cpu)
}
/**
* Specifies which deployment controller to use for the service.
*
* For more information, see
* [Amazon ECS Deployment
* Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)
*
* Default: - Rolling update (ECS)
*
* @param deploymentController Specifies which deployment controller to use for the service.
*/
public fun deploymentController(deploymentController: DeploymentControllerDsl.() -> Unit = {}) {
val builder = DeploymentControllerDsl()
builder.apply(deploymentController)
cdkBuilder.deploymentController(builder.build())
}
/**
* Specifies which deployment controller to use for the service.
*
* For more information, see
* [Amazon ECS Deployment
* Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)
*
* Default: - Rolling update (ECS)
*
* @param deploymentController Specifies which deployment controller to use for the service.
*/
public fun deploymentController(deploymentController: DeploymentController) {
cdkBuilder.deploymentController(deploymentController)
}
/**
* The desired number of instantiations of the task definition to keep running on the service.
*
* The minimum value is 1
*
* Default: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1;
* if true, the default is 1 for all new services and uses the existing services desired count
* when updating an existing service.
*
* @param desiredCount The desired number of instantiations of the task definition to keep running
* on the service.
*/
public fun desiredCount(desiredCount: Number) {
cdkBuilder.desiredCount(desiredCount)
}
/**
* The domain name for the service, e.g. "api.example.com.".
*
* Default: - No domain name.
*
* @param domainName The domain name for the service, e.g. "api.example.com.".
*/
public fun domainName(domainName: String) {
cdkBuilder.domainName(domainName)
}
/**
* The Route53 hosted zone for the domain, e.g. "example.com.".
*
* Default: - No Route53 hosted domain zone.
*
* @param domainZone The Route53 hosted zone for the domain, e.g. "example.com.".
*/
public fun domainZone(domainZone: IHostedZone) {
cdkBuilder.domainZone(domainZone)
}
/**
* Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
*
* For more information, see
* [Tagging Your Amazon ECS
* Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
*
* Default: false
*
* @param enableEcsManagedTags Specifies whether to enable Amazon ECS managed tags for the tasks
* within the service.
*/
public fun enableEcsManagedTags(enableEcsManagedTags: Boolean) {
cdkBuilder.enableEcsManagedTags(enableEcsManagedTags)
}
/**
* Whether ECS Exec should be enabled.
*
* Default: - false
*
* @param enableExecuteCommand Whether ECS Exec should be enabled.
*/
public fun enableExecuteCommand(enableExecuteCommand: Boolean) {
cdkBuilder.enableExecuteCommand(enableExecuteCommand)
}
/**
* 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
*
* @param 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.
*/
public fun healthCheckGracePeriod(healthCheckGracePeriod: Duration) {
cdkBuilder.healthCheckGracePeriod(healthCheckGracePeriod)
}
/**
* Listener port of the network load balancer that will serve traffic to the service.
*
* Default: 80
*
* @param listenerPort Listener port of the network load balancer that will serve traffic to the
* service.
*/
public fun listenerPort(listenerPort: Number) {
cdkBuilder.listenerPort(listenerPort)
}
/**
* The network load balancer that will serve traffic to the service.
*
* If the load balancer has been imported, the vpc attribute must be specified
* in the call to fromNetworkLoadBalancerAttributes().
*
* [disable-awslint:ref-via-interface]
*
* Default: - a new load balancer will be created.
*
* @param loadBalancer The network load balancer that will serve traffic to the service.
*/
public fun loadBalancer(loadBalancer: INetworkLoadBalancer) {
cdkBuilder.loadBalancer(loadBalancer)
}
/**
* 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
*
* @param 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.
*/
public fun maxHealthyPercent(maxHealthyPercent: Number) {
cdkBuilder.maxHealthyPercent(maxHealthyPercent)
}
/**
* The hard limit (in MiB) of memory to present to the container.
*
* If your container attempts to exceed the allocated memory, the container
* is terminated.
*
* At least one of memoryLimitMiB and memoryReservationMiB is required.
*
* Default: - No memory limit.
*
* @param memoryLimitMiB The hard limit (in MiB) of memory to present to the container.
*/
public fun memoryLimitMiB(memoryLimitMiB: Number) {
cdkBuilder.memoryLimitMiB(memoryLimitMiB)
}
/**
* The soft limit (in MiB) of memory to reserve for the container.
*
* When system memory is under contention, Docker attempts to keep the
* container memory within the limit. If the container requires more memory,
* it can consume up to the value specified by the Memory property or all of
* the available memory on the container instance—whichever comes first.
*
* At least one of memoryLimitMiB and memoryReservationMiB is required.
*
* Default: - No memory reserved.
*
* @param memoryReservationMiB The soft limit (in MiB) of memory to reserve for the container.
*/
public fun memoryReservationMiB(memoryReservationMiB: Number) {
cdkBuilder.memoryReservationMiB(memoryReservationMiB)
}
/**
* 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
*
* @param 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.
*/
public fun minHealthyPercent(minHealthyPercent: Number) {
cdkBuilder.minHealthyPercent(minHealthyPercent)
}
/**
* The placement constraints to use for tasks in the service.
*
* For more information, see
* [Amazon ECS Task Placement
* Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).
*
* Default: - No constraints.
*
* @param placementConstraints The placement constraints to use for tasks in the service.
*/
public fun placementConstraints(vararg placementConstraints: PlacementConstraint) {
_placementConstraints.addAll(listOf(*placementConstraints))
}
/**
* The placement constraints to use for tasks in the service.
*
* For more information, see
* [Amazon ECS Task Placement
* Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).
*
* Default: - No constraints.
*
* @param placementConstraints The placement constraints to use for tasks in the service.
*/
public fun placementConstraints(placementConstraints: Collection) {
_placementConstraints.addAll(placementConstraints)
}
/**
* The placement strategies to use for tasks in the service.
*
* For more information, see
* [Amazon ECS Task Placement
* Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).
*
* Default: - No strategies.
*
* @param placementStrategies The placement strategies to use for tasks in the service.
*/
public fun placementStrategies(vararg placementStrategies: PlacementStrategy) {
_placementStrategies.addAll(listOf(*placementStrategies))
}
/**
* The placement strategies to use for tasks in the service.
*
* For more information, see
* [Amazon ECS Task Placement
* Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).
*
* Default: - No strategies.
*
* @param placementStrategies The placement strategies to use for tasks in the service.
*/
public fun placementStrategies(placementStrategies: Collection) {
_placementStrategies.addAll(placementStrategies)
}
/**
* 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
*
* @param propagateTags Specifies whether to propagate the tags from the task definition or the
* service to the tasks in the service.
*/
public fun propagateTags(propagateTags: PropagatedTagSource) {
cdkBuilder.propagateTags(propagateTags)
}
/**
* Determines whether the Load Balancer will be internet-facing.
*
* Default: true
*
* @param publicLoadBalancer Determines whether the Load Balancer will be internet-facing.
*/
public fun publicLoadBalancer(publicLoadBalancer: Boolean) {
cdkBuilder.publicLoadBalancer(publicLoadBalancer)
}
/**
* 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: NetworkLoadBalancedServiceRecordType.ALIAS
*
* @param recordType Specifies whether the Route53 record should be a CNAME, an A record using the
* Alias feature or no record at all.
*/
public fun recordType(recordType: NetworkLoadBalancedServiceRecordType) {
cdkBuilder.recordType(recordType)
}
/**
* The name of the service.
*
* Default: - CloudFormation-generated name.
*
* @param serviceName The name of the service.
*/
public fun serviceName(serviceName: String) {
cdkBuilder.serviceName(serviceName)
}
/**
* 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
*
* @param taskDefinition The task definition to use for tasks in the service. TaskDefinition or
* TaskImageOptions must be specified, but not both..
*/
public fun taskDefinition(taskDefinition: Ec2TaskDefinition) {
cdkBuilder.taskDefinition(taskDefinition)
}
/**
* The properties required to create a new task definition.
*
* One of taskImageOptions or taskDefinition must be specified.
*
* Default: - none
*
* @param taskImageOptions The properties required to create a new task definition.
*/
public fun taskImageOptions(taskImageOptions: NetworkLoadBalancedTaskImageOptionsDsl.() -> Unit =
{}) {
val builder = NetworkLoadBalancedTaskImageOptionsDsl()
builder.apply(taskImageOptions)
cdkBuilder.taskImageOptions(builder.build())
}
/**
* The properties required to create a new task definition.
*
* One of taskImageOptions or taskDefinition must be specified.
*
* Default: - none
*
* @param taskImageOptions The properties required to create a new task definition.
*/
public fun taskImageOptions(taskImageOptions: NetworkLoadBalancedTaskImageOptions) {
cdkBuilder.taskImageOptions(taskImageOptions)
}
/**
* 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.
*
* @param vpc The VPC where the container instances will be launched or the elastic network
* interfaces (ENIs) will be deployed.
*/
public fun vpc(vpc: IVpc) {
cdkBuilder.vpc(vpc)
}
public fun build(): NetworkLoadBalancedEc2Service {
if(_capacityProviderStrategies.isNotEmpty())
cdkBuilder.capacityProviderStrategies(_capacityProviderStrategies)
if(_placementConstraints.isNotEmpty()) cdkBuilder.placementConstraints(_placementConstraints)
if(_placementStrategies.isNotEmpty()) cdkBuilder.placementStrategies(_placementStrategies)
return cdkBuilder.build()
}
}
