io.cloudshiftdev.awscdk.services.ecs.Ec2ServiceProps.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.ecs
import io.cloudshiftdev.awscdk.Duration
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.ec2.ISecurityGroup
import io.cloudshiftdev.awscdk.services.ec2.SubnetSelection
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* The properties for defining a service using the EC2 launch type.
*
* Example:
*
* ```
* Cluster cluster;
* TaskDefinition taskDefinition;
* Vpc vpc;
* Ec2Service service = Ec2Service.Builder.create(this,
* "Service").cluster(cluster).taskDefinition(taskDefinition).build();
* LoadBalancer lb = LoadBalancer.Builder.create(this, "LB").vpc(vpc).build();
* lb.addListener(LoadBalancerListener.builder().externalPort(80).build());
* lb.addTarget(service.loadBalancerTarget(LoadBalancerTargetOptions.builder()
* .containerName("MyContainer")
* .containerPort(80)
* .build()));
* ```
*/
public interface Ec2ServiceProps : BaseServiceOptions {
/**
* Specifies whether the task's elastic network interface receives a public IP address.
*
* If true, each task will receive a public IP address.
*
* This property is only used for tasks that use the awsvpc network mode.
*
* Default: false
*/
public fun assignPublicIp(): Boolean? = unwrap(this).getAssignPublicIp()
/**
* Specifies whether the service will use the daemon scheduling strategy.
*
* If true, the service scheduler deploys exactly one task on each container instance in your
* cluster.
*
* When you are using this strategy, do not specify a desired number of tasks or any task
* placement strategies.
*
* Default: false
*/
public fun daemon(): Boolean? = unwrap(this).getDaemon()
/**
* 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.
*/
public fun placementConstraints(): List =
unwrap(this).getPlacementConstraints()?.map(PlacementConstraint::wrap) ?: emptyList()
/**
* 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.
*/
public fun placementStrategies(): List =
unwrap(this).getPlacementStrategies()?.map(PlacementStrategy::wrap) ?: emptyList()
/**
* The security groups to associate with the service.
*
* If you do not specify a security group, a new security group is created.
*
* This property is only used for tasks that use the awsvpc network mode.
*
* Default: - A new security group is created.
*/
public fun securityGroups(): List =
unwrap(this).getSecurityGroups()?.map(ISecurityGroup::wrap) ?: emptyList()
/**
* The task definition to use for tasks in the service.
*
* [disable-awslint:ref-via-interface]
*/
public fun taskDefinition(): TaskDefinition
/**
* The subnets to associate with the service.
*
* This property is only used for tasks that use the awsvpc network mode.
*
* Default: - Public subnets if `assignPublicIp` is set, otherwise the first available one of
* Private, Isolated, Public, in that order.
*/
public fun vpcSubnets(): SubnetSelection? =
unwrap(this).getVpcSubnets()?.let(SubnetSelection::wrap)
/**
* A builder for [Ec2ServiceProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param assignPublicIp Specifies whether the task's elastic network interface receives a
* public IP address.
* If true, each task will receive a public IP address.
*
* This property is only used for tasks that use the awsvpc network mode.
*/
public fun assignPublicIp(assignPublicIp: Boolean)
/**
* @param capacityProviderStrategies A list of Capacity Provider strategies used to place a
* service.
*/
public
fun capacityProviderStrategies(capacityProviderStrategies: List)
/**
* @param capacityProviderStrategies A list of Capacity Provider strategies used to place a
* service.
*/
public fun capacityProviderStrategies(vararg
capacityProviderStrategies: CapacityProviderStrategy)
/**
* @param circuitBreaker Whether to enable the deployment circuit breaker.
* If this property is defined, circuit breaker will be implicitly
* enabled.
*/
public fun circuitBreaker(circuitBreaker: DeploymentCircuitBreaker)
/**
* @param circuitBreaker Whether to enable the deployment circuit breaker.
* If this property is defined, circuit breaker will be implicitly
* enabled.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("5c03686ac28ce2b85abc9727fbcc7c0d458f7cecddab3ec1ad0ef2ec079a5f40")
public fun circuitBreaker(circuitBreaker: DeploymentCircuitBreaker.Builder.() -> Unit)
/**
* @param cloudMapOptions The options for configuring an Amazon ECS service to use service
* discovery.
*/
public fun cloudMapOptions(cloudMapOptions: CloudMapOptions)
/**
* @param cloudMapOptions The options for configuring an Amazon ECS service to use service
* discovery.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("0817d29f306fcbf29910d222d404a2d542eadff2eb2b022166e53391056ea441")
public fun cloudMapOptions(cloudMapOptions: CloudMapOptions.Builder.() -> Unit)
/**
* @param cluster The name of the cluster that hosts the service.
*/
public fun cluster(cluster: ICluster)
/**
* @param daemon Specifies whether the service will use the daemon scheduling strategy.
* If true, the service scheduler deploys exactly one task on each container instance in your
* cluster.
*
* When you are using this strategy, do not specify a desired number of tasks or any task
* placement strategies.
*/
public fun daemon(daemon: Boolean)
/**
* @param deploymentAlarms The alarm(s) to monitor during deployment, and behavior to apply if
* at least one enters a state of alarm during the deployment or bake time.
*/
public fun deploymentAlarms(deploymentAlarms: DeploymentAlarmConfig)
/**
* @param deploymentAlarms The alarm(s) to monitor during deployment, and behavior to apply if
* at least one enters a state of alarm during the deployment or bake time.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("15d6f89eb3e43b7c177a8b543ec449b91f7eef5dd72cf316ac78399a72ecd9f3")
public fun deploymentAlarms(deploymentAlarms: DeploymentAlarmConfig.Builder.() -> Unit)
/**
* @param deploymentController 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)
*/
public fun deploymentController(deploymentController: DeploymentController)
/**
* @param deploymentController 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)
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("100ca08c27b487c5a2ba421f9c407340f01d258fa552ae0e35cd727dad407947")
public fun deploymentController(deploymentController: DeploymentController.Builder.() -> Unit)
/**
* @param desiredCount The desired number of instantiations of the task definition to keep
* running on the service.
*/
public fun desiredCount(desiredCount: Number)
/**
* @param enableEcsManagedTags 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)
*/
public fun enableEcsManagedTags(enableEcsManagedTags: Boolean)
/**
* @param enableExecuteCommand Whether to enable the ability to execute into a container.
*/
public fun enableExecuteCommand(enableExecuteCommand: Boolean)
/**
* @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)
/**
* @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)
/**
* @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)
/**
* @param 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).
*/
public fun placementConstraints(placementConstraints: List)
/**
* @param 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).
*/
public fun placementConstraints(vararg placementConstraints: PlacementConstraint)
/**
* @param 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).
*/
public fun placementStrategies(placementStrategies: List)
/**
* @param 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).
*/
public fun placementStrategies(vararg placementStrategies: PlacementStrategy)
/**
* @param propagateTags Specifies whether to propagate the tags from the task definition or the
* service to the tasks in the service.
* Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or
* PropagatedTagSource.NONE
*/
public fun propagateTags(propagateTags: PropagatedTagSource)
/**
* @param securityGroups The security groups to associate with the service.
* If you do not specify a security group, a new security group is created.
*
* This property is only used for tasks that use the awsvpc network mode.
*/
public fun securityGroups(securityGroups: List)
/**
* @param securityGroups The security groups to associate with the service.
* If you do not specify a security group, a new security group is created.
*
* This property is only used for tasks that use the awsvpc network mode.
*/
public fun securityGroups(vararg securityGroups: ISecurityGroup)
/**
* @param serviceConnectConfiguration Configuration for Service Connect.
*/
public fun serviceConnectConfiguration(serviceConnectConfiguration: ServiceConnectProps)
/**
* @param serviceConnectConfiguration Configuration for Service Connect.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("b3069f606ea9fb34da6d269e9425562d41852bd1e37f10cd1949afe5bbaa443a")
public
fun serviceConnectConfiguration(serviceConnectConfiguration: ServiceConnectProps.Builder.() -> Unit)
/**
* @param serviceName The name of the service.
*/
public fun serviceName(serviceName: String)
/**
* @param taskDefinition The task definition to use for tasks in the service.
* [disable-awslint:ref-via-interface]
*/
public fun taskDefinition(taskDefinition: TaskDefinition)
/**
* @param taskDefinitionRevision Revision number for the task definition or `latest` to use the
* latest active task revision.
*/
public fun taskDefinitionRevision(taskDefinitionRevision: TaskDefinitionRevision)
/**
* @param volumeConfigurations Configuration details for a volume used by the service.
* This allows you to specify
* details about the EBS volume that can be attched to ECS tasks.
*/
public fun volumeConfigurations(volumeConfigurations: List)
/**
* @param volumeConfigurations Configuration details for a volume used by the service.
* This allows you to specify
* details about the EBS volume that can be attched to ECS tasks.
*/
public fun volumeConfigurations(vararg volumeConfigurations: ServiceManagedVolume)
/**
* @param vpcSubnets The subnets to associate with the service.
* This property is only used for tasks that use the awsvpc network mode.
*/
public fun vpcSubnets(vpcSubnets: SubnetSelection)
/**
* @param vpcSubnets The subnets to associate with the service.
* This property is only used for tasks that use the awsvpc network mode.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("52d45a179f472d22d75219e2ad7befe539e8ca780f75e147ed17bb210d12fe7a")
public fun vpcSubnets(vpcSubnets: SubnetSelection.Builder.() -> Unit)
}
private class BuilderImpl : Builder {
private val cdkBuilder: software.amazon.awscdk.services.ecs.Ec2ServiceProps.Builder =
software.amazon.awscdk.services.ecs.Ec2ServiceProps.builder()
/**
* @param assignPublicIp Specifies whether the task's elastic network interface receives a
* public IP address.
* If true, each task will receive a public IP address.
*
* This property is only used for tasks that use the awsvpc network mode.
*/
override fun assignPublicIp(assignPublicIp: Boolean) {
cdkBuilder.assignPublicIp(assignPublicIp)
}
/**
* @param capacityProviderStrategies A list of Capacity Provider strategies used to place a
* service.
*/
override
fun capacityProviderStrategies(capacityProviderStrategies: List) {
cdkBuilder.capacityProviderStrategies(capacityProviderStrategies.map(CapacityProviderStrategy.Companion::unwrap))
}
/**
* @param capacityProviderStrategies A list of Capacity Provider strategies used to place a
* service.
*/
override fun capacityProviderStrategies(vararg
capacityProviderStrategies: CapacityProviderStrategy): Unit =
capacityProviderStrategies(capacityProviderStrategies.toList())
/**
* @param circuitBreaker Whether to enable the deployment circuit breaker.
* If this property is defined, circuit breaker will be implicitly
* enabled.
*/
override fun circuitBreaker(circuitBreaker: DeploymentCircuitBreaker) {
cdkBuilder.circuitBreaker(circuitBreaker.let(DeploymentCircuitBreaker.Companion::unwrap))
}
/**
* @param circuitBreaker Whether to enable the deployment circuit breaker.
* If this property is defined, circuit breaker will be implicitly
* enabled.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("5c03686ac28ce2b85abc9727fbcc7c0d458f7cecddab3ec1ad0ef2ec079a5f40")
override fun circuitBreaker(circuitBreaker: DeploymentCircuitBreaker.Builder.() -> Unit): Unit =
circuitBreaker(DeploymentCircuitBreaker(circuitBreaker))
/**
* @param cloudMapOptions The options for configuring an Amazon ECS service to use service
* discovery.
*/
override fun cloudMapOptions(cloudMapOptions: CloudMapOptions) {
cdkBuilder.cloudMapOptions(cloudMapOptions.let(CloudMapOptions.Companion::unwrap))
}
/**
* @param cloudMapOptions The options for configuring an Amazon ECS service to use service
* discovery.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("0817d29f306fcbf29910d222d404a2d542eadff2eb2b022166e53391056ea441")
override fun cloudMapOptions(cloudMapOptions: CloudMapOptions.Builder.() -> Unit): Unit =
cloudMapOptions(CloudMapOptions(cloudMapOptions))
/**
* @param cluster The name of the cluster that hosts the service.
*/
override fun cluster(cluster: ICluster) {
cdkBuilder.cluster(cluster.let(ICluster.Companion::unwrap))
}
/**
* @param daemon Specifies whether the service will use the daemon scheduling strategy.
* If true, the service scheduler deploys exactly one task on each container instance in your
* cluster.
*
* When you are using this strategy, do not specify a desired number of tasks or any task
* placement strategies.
*/
override fun daemon(daemon: Boolean) {
cdkBuilder.daemon(daemon)
}
/**
* @param deploymentAlarms The alarm(s) to monitor during deployment, and behavior to apply if
* at least one enters a state of alarm during the deployment or bake time.
*/
override fun deploymentAlarms(deploymentAlarms: DeploymentAlarmConfig) {
cdkBuilder.deploymentAlarms(deploymentAlarms.let(DeploymentAlarmConfig.Companion::unwrap))
}
/**
* @param deploymentAlarms The alarm(s) to monitor during deployment, and behavior to apply if
* at least one enters a state of alarm during the deployment or bake time.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("15d6f89eb3e43b7c177a8b543ec449b91f7eef5dd72cf316ac78399a72ecd9f3")
override fun deploymentAlarms(deploymentAlarms: DeploymentAlarmConfig.Builder.() -> Unit): Unit
= deploymentAlarms(DeploymentAlarmConfig(deploymentAlarms))
/**
* @param deploymentController 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)
*/
override fun deploymentController(deploymentController: DeploymentController) {
cdkBuilder.deploymentController(deploymentController.let(DeploymentController.Companion::unwrap))
}
/**
* @param deploymentController 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)
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("100ca08c27b487c5a2ba421f9c407340f01d258fa552ae0e35cd727dad407947")
override
fun deploymentController(deploymentController: DeploymentController.Builder.() -> Unit):
Unit = deploymentController(DeploymentController(deploymentController))
/**
* @param desiredCount The desired number of instantiations of the task definition to keep
* running on the service.
*/
override fun desiredCount(desiredCount: Number) {
cdkBuilder.desiredCount(desiredCount)
}
/**
* @param enableEcsManagedTags 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)
*/
override fun enableEcsManagedTags(enableEcsManagedTags: Boolean) {
cdkBuilder.enableEcsManagedTags(enableEcsManagedTags)
}
/**
* @param enableExecuteCommand Whether to enable the ability to execute into a container.
*/
override fun enableExecuteCommand(enableExecuteCommand: Boolean) {
cdkBuilder.enableExecuteCommand(enableExecuteCommand)
}
/**
* @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.
*/
override fun healthCheckGracePeriod(healthCheckGracePeriod: Duration) {
cdkBuilder.healthCheckGracePeriod(healthCheckGracePeriod.let(Duration.Companion::unwrap))
}
/**
* @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.
*/
override fun maxHealthyPercent(maxHealthyPercent: Number) {
cdkBuilder.maxHealthyPercent(maxHealthyPercent)
}
/**
* @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.
*/
override fun minHealthyPercent(minHealthyPercent: Number) {
cdkBuilder.minHealthyPercent(minHealthyPercent)
}
/**
* @param 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).
*/
override fun placementConstraints(placementConstraints: List) {
cdkBuilder.placementConstraints(placementConstraints.map(PlacementConstraint.Companion::unwrap))
}
/**
* @param 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).
*/
override fun placementConstraints(vararg placementConstraints: PlacementConstraint): Unit =
placementConstraints(placementConstraints.toList())
/**
* @param 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).
*/
override fun placementStrategies(placementStrategies: List) {
cdkBuilder.placementStrategies(placementStrategies.map(PlacementStrategy.Companion::unwrap))
}
/**
* @param 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).
*/
override fun placementStrategies(vararg placementStrategies: PlacementStrategy): Unit =
placementStrategies(placementStrategies.toList())
/**
* @param propagateTags Specifies whether to propagate the tags from the task definition or the
* service to the tasks in the service.
* Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or
* PropagatedTagSource.NONE
*/
override fun propagateTags(propagateTags: PropagatedTagSource) {
cdkBuilder.propagateTags(propagateTags.let(PropagatedTagSource.Companion::unwrap))
}
/**
* @param securityGroups The security groups to associate with the service.
* If you do not specify a security group, a new security group is created.
*
* This property is only used for tasks that use the awsvpc network mode.
*/
override fun securityGroups(securityGroups: List) {
cdkBuilder.securityGroups(securityGroups.map(ISecurityGroup.Companion::unwrap))
}
/**
* @param securityGroups The security groups to associate with the service.
* If you do not specify a security group, a new security group is created.
*
* This property is only used for tasks that use the awsvpc network mode.
*/
override fun securityGroups(vararg securityGroups: ISecurityGroup): Unit =
securityGroups(securityGroups.toList())
/**
* @param serviceConnectConfiguration Configuration for Service Connect.
*/
override fun serviceConnectConfiguration(serviceConnectConfiguration: ServiceConnectProps) {
cdkBuilder.serviceConnectConfiguration(serviceConnectConfiguration.let(ServiceConnectProps.Companion::unwrap))
}
/**
* @param serviceConnectConfiguration Configuration for Service Connect.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("b3069f606ea9fb34da6d269e9425562d41852bd1e37f10cd1949afe5bbaa443a")
override
fun serviceConnectConfiguration(serviceConnectConfiguration: ServiceConnectProps.Builder.() -> Unit):
Unit = serviceConnectConfiguration(ServiceConnectProps(serviceConnectConfiguration))
/**
* @param serviceName The name of the service.
*/
override fun serviceName(serviceName: String) {
cdkBuilder.serviceName(serviceName)
}
/**
* @param taskDefinition The task definition to use for tasks in the service.
* [disable-awslint:ref-via-interface]
*/
override fun taskDefinition(taskDefinition: TaskDefinition) {
cdkBuilder.taskDefinition(taskDefinition.let(TaskDefinition.Companion::unwrap))
}
/**
* @param taskDefinitionRevision Revision number for the task definition or `latest` to use the
* latest active task revision.
*/
override fun taskDefinitionRevision(taskDefinitionRevision: TaskDefinitionRevision) {
cdkBuilder.taskDefinitionRevision(taskDefinitionRevision.let(TaskDefinitionRevision.Companion::unwrap))
}
/**
* @param volumeConfigurations Configuration details for a volume used by the service.
* This allows you to specify
* details about the EBS volume that can be attched to ECS tasks.
*/
override fun volumeConfigurations(volumeConfigurations: List) {
cdkBuilder.volumeConfigurations(volumeConfigurations.map(ServiceManagedVolume.Companion::unwrap))
}
/**
* @param volumeConfigurations Configuration details for a volume used by the service.
* This allows you to specify
* details about the EBS volume that can be attched to ECS tasks.
*/
override fun volumeConfigurations(vararg volumeConfigurations: ServiceManagedVolume): Unit =
volumeConfigurations(volumeConfigurations.toList())
/**
* @param vpcSubnets The subnets to associate with the service.
* This property is only used for tasks that use the awsvpc network mode.
*/
override fun vpcSubnets(vpcSubnets: SubnetSelection) {
cdkBuilder.vpcSubnets(vpcSubnets.let(SubnetSelection.Companion::unwrap))
}
/**
* @param vpcSubnets The subnets to associate with the service.
* This property is only used for tasks that use the awsvpc network mode.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("52d45a179f472d22d75219e2ad7befe539e8ca780f75e147ed17bb210d12fe7a")
override fun vpcSubnets(vpcSubnets: SubnetSelection.Builder.() -> Unit): Unit =
vpcSubnets(SubnetSelection(vpcSubnets))
public fun build(): software.amazon.awscdk.services.ecs.Ec2ServiceProps = cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.ecs.Ec2ServiceProps,
) : CdkObject(cdkObject),
Ec2ServiceProps {
/**
* Specifies whether the task's elastic network interface receives a public IP address.
*
* If true, each task will receive a public IP address.
*
* This property is only used for tasks that use the awsvpc network mode.
*
* Default: false
*/
override fun assignPublicIp(): Boolean? = unwrap(this).getAssignPublicIp()
/**
* A list of Capacity Provider strategies used to place a service.
*
* Default: - undefined
*/
override fun capacityProviderStrategies(): List =
unwrap(this).getCapacityProviderStrategies()?.map(CapacityProviderStrategy::wrap) ?:
emptyList()
/**
* Whether to enable the deployment circuit breaker.
*
* If this property is defined, circuit breaker will be implicitly
* enabled.
*
* Default: - disabled
*/
override fun circuitBreaker(): DeploymentCircuitBreaker? =
unwrap(this).getCircuitBreaker()?.let(DeploymentCircuitBreaker::wrap)
/**
* The options for configuring an Amazon ECS service to use service discovery.
*
* Default: - AWS Cloud Map service discovery is not enabled.
*/
override fun cloudMapOptions(): CloudMapOptions? =
unwrap(this).getCloudMapOptions()?.let(CloudMapOptions::wrap)
/**
* The name of the cluster that hosts the service.
*/
override fun cluster(): ICluster = unwrap(this).getCluster().let(ICluster::wrap)
/**
* Specifies whether the service will use the daemon scheduling strategy.
*
* If true, the service scheduler deploys exactly one task on each container instance in your
* cluster.
*
* When you are using this strategy, do not specify a desired number of tasks or any task
* placement strategies.
*
* Default: false
*/
override fun daemon(): Boolean? = unwrap(this).getDaemon()
/**
* The alarm(s) to monitor during deployment, and behavior to apply if at least one enters a
* state of alarm during the deployment or bake time.
*
* Default: - No alarms will be monitored during deployment.
*/
override fun deploymentAlarms(): DeploymentAlarmConfig? =
unwrap(this).getDeploymentAlarms()?.let(DeploymentAlarmConfig::wrap)
/**
* 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)
*/
override fun deploymentController(): DeploymentController? =
unwrap(this).getDeploymentController()?.let(DeploymentController::wrap)
/**
* The desired number of instantiations of the task definition to keep running on the service.
*
* Default: - When creating the service, default is 1; when updating the service, default uses
* the current task number.
*/
override fun desiredCount(): Number? = unwrap(this).getDesiredCount()
/**
* 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
*/
override fun enableECSManagedTags(): Boolean? = unwrap(this).getEnableECSManagedTags()
/**
* Whether to enable the ability to execute into a container.
*
* Default: - undefined
*/
override fun enableExecuteCommand(): Boolean? = unwrap(this).getEnableExecuteCommand()
/**
* 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
*/
override fun healthCheckGracePeriod(): Duration? =
unwrap(this).getHealthCheckGracePeriod()?.let(Duration::wrap)
/**
* 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
*/
override fun maxHealthyPercent(): Number? = unwrap(this).getMaxHealthyPercent()
/**
* 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
*/
override fun minHealthyPercent(): Number? = unwrap(this).getMinHealthyPercent()
/**
* 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.
*/
override fun placementConstraints(): List =
unwrap(this).getPlacementConstraints()?.map(PlacementConstraint::wrap) ?: emptyList()
/**
* 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.
*/
override fun placementStrategies(): List =
unwrap(this).getPlacementStrategies()?.map(PlacementStrategy::wrap) ?: emptyList()
/**
* Specifies whether to propagate the tags from the task definition or the service to the tasks
* in the service.
*
* Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or
* PropagatedTagSource.NONE
*
* Default: PropagatedTagSource.NONE
*/
override fun propagateTags(): PropagatedTagSource? =
unwrap(this).getPropagateTags()?.let(PropagatedTagSource::wrap)
/**
* The security groups to associate with the service.
*
* If you do not specify a security group, a new security group is created.
*
* This property is only used for tasks that use the awsvpc network mode.
*
* Default: - A new security group is created.
*/
override fun securityGroups(): List =
unwrap(this).getSecurityGroups()?.map(ISecurityGroup::wrap) ?: emptyList()
/**
* Configuration for Service Connect.
*
* Default: No ports are advertised via Service Connect on this service, and the service
* cannot make requests to other services via Service Connect.
*/
override fun serviceConnectConfiguration(): ServiceConnectProps? =
unwrap(this).getServiceConnectConfiguration()?.let(ServiceConnectProps::wrap)
/**
* The name of the service.
*
* Default: - CloudFormation-generated name.
*/
override fun serviceName(): String? = unwrap(this).getServiceName()
/**
* The task definition to use for tasks in the service.
*
* [disable-awslint:ref-via-interface]
*/
override fun taskDefinition(): TaskDefinition =
unwrap(this).getTaskDefinition().let(TaskDefinition::wrap)
/**
* Revision number for the task definition or `latest` to use the latest active task revision.
*
* Default: - Uses the revision of the passed task definition deployed by CloudFormation
*/
override fun taskDefinitionRevision(): TaskDefinitionRevision? =
unwrap(this).getTaskDefinitionRevision()?.let(TaskDefinitionRevision::wrap)
/**
* Configuration details for a volume used by the service.
*
* This allows you to specify
* details about the EBS volume that can be attched to ECS tasks.
*
* Default: - undefined
*/
override fun volumeConfigurations(): List =
unwrap(this).getVolumeConfigurations()?.map(ServiceManagedVolume::wrap) ?: emptyList()
/**
* The subnets to associate with the service.
*
* This property is only used for tasks that use the awsvpc network mode.
*
* Default: - Public subnets if `assignPublicIp` is set, otherwise the first available one of
* Private, Isolated, Public, in that order.
*/
override fun vpcSubnets(): SubnetSelection? =
unwrap(this).getVpcSubnets()?.let(SubnetSelection::wrap)
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): Ec2ServiceProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.ecs.Ec2ServiceProps):
Ec2ServiceProps = CdkObjectWrappers.wrap(cdkObject) as? Ec2ServiceProps ?:
Wrapper(cdkObject)
internal fun unwrap(wrapped: Ec2ServiceProps):
software.amazon.awscdk.services.ecs.Ec2ServiceProps = (wrapped as CdkObject).cdkObject as
software.amazon.awscdk.services.ecs.Ec2ServiceProps
}
}