io.cloudshiftdev.awscdk.services.ecs.ExternalService.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.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.applicationautoscaling.EnableScalingProps
import io.cloudshiftdev.awscdk.services.ec2.ISecurityGroup
import io.cloudshiftdev.awscdk.services.elasticloadbalancingv2.IApplicationTargetGroup
import io.cloudshiftdev.awscdk.services.elasticloadbalancingv2.LoadBalancerTargetProps
import io.cloudshiftdev.awscdk.services.servicediscovery.Service
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* This creates a service using the External launch type on an ECS cluster.
*
* Example:
*
* ```
* Cluster cluster;
* TaskDefinition taskDefinition;
* ExternalService service = ExternalService.Builder.create(this, "Service")
* .cluster(cluster)
* .taskDefinition(taskDefinition)
* .desiredCount(5)
* .build();
* ```
*/
public open class ExternalService(
cdkObject: software.amazon.awscdk.services.ecs.ExternalService,
) : BaseService(cdkObject),
IExternalService {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: ExternalServiceProps,
) :
this(software.amazon.awscdk.services.ecs.ExternalService(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(ExternalServiceProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: ExternalServiceProps.Builder.() -> Unit,
) : this(scope, id, ExternalServiceProps(props)
)
/**
* Overriden method to throw error as `associateCloudMapService` is not supported for external
* service.
*
* @param _options
*/
public override fun associateCloudMapService(options: AssociateCloudMapServiceOptions) {
unwrap(this).associateCloudMapService(options.let(AssociateCloudMapServiceOptions.Companion::unwrap))
}
/**
* Overriden method to throw error as `associateCloudMapService` is not supported for external
* service.
*
* @param _options
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("9efdde89b809884516ab0c4bd40829d6167d5f1d27bdea442fed263281456fdd")
public override
fun associateCloudMapService(options: AssociateCloudMapServiceOptions.Builder.() -> Unit):
Unit = associateCloudMapService(AssociateCloudMapServiceOptions(options))
/**
* Overriden method to throw error as `attachToApplicationTargetGroup` is not supported for
* external service.
*
* @param _targetGroup
*/
public override fun attachToApplicationTargetGroup(targetGroup: IApplicationTargetGroup):
LoadBalancerTargetProps =
unwrap(this).attachToApplicationTargetGroup(targetGroup.let(IApplicationTargetGroup.Companion::unwrap)).let(LoadBalancerTargetProps::wrap)
/**
* Overriden method to throw error as `autoScaleTaskCount` is not supported for external service.
*
* @param _props
*/
public override fun autoScaleTaskCount(props: EnableScalingProps): ScalableTaskCount =
unwrap(this).autoScaleTaskCount(props.let(EnableScalingProps.Companion::unwrap)).let(ScalableTaskCount::wrap)
/**
* Overriden method to throw error as `autoScaleTaskCount` is not supported for external service.
*
* @param _props
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("0163fbd7c68d4e9af9f18b4ef7de232b93ee41c4e9599b548a4b01bab6ca323c")
public override fun autoScaleTaskCount(props: EnableScalingProps.Builder.() -> Unit):
ScalableTaskCount = autoScaleTaskCount(EnableScalingProps(props))
/**
* Overriden method to throw error as `enableCloudMap` is not supported for external service.
*
* @param _options
*/
public override fun enableCloudMap(options: CloudMapOptions): Service =
unwrap(this).enableCloudMap(options.let(CloudMapOptions.Companion::unwrap)).let(Service::wrap)
/**
* Overriden method to throw error as `enableCloudMap` is not supported for external service.
*
* @param _options
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("2eb98c16499f233304e458ef17b6e5c9df09e38dbe3c56301d0f41038fbab0cc")
public override fun enableCloudMap(options: CloudMapOptions.Builder.() -> Unit): Service =
enableCloudMap(CloudMapOptions(options))
/**
* Overriden method to throw error as `loadBalancerTarget` is not supported for external service.
*
* @param _options
*/
public override fun loadBalancerTarget(options: LoadBalancerTargetOptions): IEcsLoadBalancerTarget
=
unwrap(this).loadBalancerTarget(options.let(LoadBalancerTargetOptions.Companion::unwrap)).let(IEcsLoadBalancerTarget::wrap)
/**
* Overriden method to throw error as `loadBalancerTarget` is not supported for external service.
*
* @param _options
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("5c1f6de1e98dab0564840813319e438b96687e7140defdd69ba7bee4103a780f")
public override fun loadBalancerTarget(options: LoadBalancerTargetOptions.Builder.() -> Unit):
IEcsLoadBalancerTarget = loadBalancerTarget(LoadBalancerTargetOptions(options))
/**
* Overriden method to throw error as `registerLoadBalancerTargets` is not supported for external
* service.
*
* @param _targets
*/
public override fun registerLoadBalancerTargets(vararg targets: EcsTarget) {
unwrap(this).registerLoadBalancerTargets(*targets.map{CdkObjectWrappers.unwrap(it) as
software.amazon.awscdk.services.ecs.EcsTarget}.toTypedArray())
}
/**
* Overriden method to throw error as `registerLoadBalancerTargets` is not supported for external
* service.
*
* @param _targets
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("3682e9eed91689cc4ed6f8310140605bef4e35e0fda59587fde4c2fc019cfaa6")
public override fun registerLoadBalancerTargets(targets: EcsTarget.Builder.() -> Unit): Unit =
registerLoadBalancerTargets(EcsTarget(targets))
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.ecs.ExternalService].
*/
@CdkDslMarker
public interface Builder {
/**
* 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: List)
/**
* 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(vararg
capacityProviderStrategies: CapacityProviderStrategy)
/**
* 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)
/**
* 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.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("0e00f0c2be59f79f24a63fa2cecbd3f84adbf5a8773e5e1ef11183e2ef35802c")
public fun circuitBreaker(circuitBreaker: DeploymentCircuitBreaker.Builder.() -> Unit)
/**
* 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)
/**
* 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.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("e1bc3f4abf94a6c9ea5baf49213d4948feac1118cae7022f621965a879e7d36a")
public fun cloudMapOptions(cloudMapOptions: CloudMapOptions.Builder.() -> Unit)
/**
* The name of the cluster that hosts the service.
*
* @param cluster The name of the cluster that hosts the service.
*/
public fun cluster(cluster: ICluster)
/**
* 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.
*
* @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)
/**
* 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.
*
* @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("a9e7cbde8b2f51bf4837bd89ab7ce60476410d7c5b1f596ed1553c33bd546156")
public fun deploymentAlarms(deploymentAlarms: DeploymentAlarmConfig.Builder.() -> Unit)
/**
* 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)
/**
* 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.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("132283714c7dbffdd9b210c5eaa509f1a7e5dbce833291b4af8ace91975b6ecb")
public fun deploymentController(deploymentController: DeploymentController.Builder.() -> Unit)
/**
* 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.
*
* @param desiredCount The desired number of instantiations of the task definition to keep
* running on the service.
*/
public fun desiredCount(desiredCount: Number)
/**
* 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)
/**
* Whether to enable the ability to execute into a container.
*
* Default: - undefined
*
* @param enableExecuteCommand Whether to enable the ability to execute into a container.
*/
public fun enableExecuteCommand(enableExecuteCommand: Boolean)
/**
* 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)
/**
* 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)
/**
* 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)
/**
* 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
*
* @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)
/**
* 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.
*
* @param securityGroups The security groups to associate with the service.
*/
public fun securityGroups(securityGroups: List)
/**
* 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.
*
* @param securityGroups The security groups to associate with the service.
*/
public fun securityGroups(vararg securityGroups: ISecurityGroup)
/**
* 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.
*
* @param serviceConnectConfiguration Configuration for Service Connect.
*/
public fun serviceConnectConfiguration(serviceConnectConfiguration: ServiceConnectProps)
/**
* 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.
*
* @param serviceConnectConfiguration Configuration for Service Connect.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("a34fbb39ed4eb18a677fea97b1604d0dd5c8962f8ce8117ae1165531a572f345")
public
fun serviceConnectConfiguration(serviceConnectConfiguration: ServiceConnectProps.Builder.() -> Unit)
/**
* The name of the service.
*
* Default: - CloudFormation-generated name.
*
* @param serviceName The name of the service.
*/
public fun serviceName(serviceName: String)
/**
* The task definition to use for tasks in the service.
*
* [disable-awslint:ref-via-interface]
*
* @param taskDefinition The task definition to use for tasks in the service.
*/
public fun taskDefinition(taskDefinition: TaskDefinition)
/**
* 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
*
* @param taskDefinitionRevision Revision number for the task definition or `latest` to use the
* latest active task revision.
*/
public fun taskDefinitionRevision(taskDefinitionRevision: TaskDefinitionRevision)
/**
* 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
*
* @param volumeConfigurations Configuration details for a volume used by the service.
*/
public fun volumeConfigurations(volumeConfigurations: List)
/**
* 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
*
* @param volumeConfigurations Configuration details for a volume used by the service.
*/
public fun volumeConfigurations(vararg volumeConfigurations: ServiceManagedVolume)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.ecs.ExternalService.Builder =
software.amazon.awscdk.services.ecs.ExternalService.Builder.create(scope, id)
/**
* 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.
*/
override
fun capacityProviderStrategies(capacityProviderStrategies: List) {
cdkBuilder.capacityProviderStrategies(capacityProviderStrategies.map(CapacityProviderStrategy.Companion::unwrap))
}
/**
* 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.
*/
override fun capacityProviderStrategies(vararg
capacityProviderStrategies: CapacityProviderStrategy): Unit =
capacityProviderStrategies(capacityProviderStrategies.toList())
/**
* 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.
*/
override fun circuitBreaker(circuitBreaker: DeploymentCircuitBreaker) {
cdkBuilder.circuitBreaker(circuitBreaker.let(DeploymentCircuitBreaker.Companion::unwrap))
}
/**
* 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.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("0e00f0c2be59f79f24a63fa2cecbd3f84adbf5a8773e5e1ef11183e2ef35802c")
override fun circuitBreaker(circuitBreaker: DeploymentCircuitBreaker.Builder.() -> Unit): Unit =
circuitBreaker(DeploymentCircuitBreaker(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.
*/
override fun cloudMapOptions(cloudMapOptions: CloudMapOptions) {
cdkBuilder.cloudMapOptions(cloudMapOptions.let(CloudMapOptions.Companion::unwrap))
}
/**
* 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.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("e1bc3f4abf94a6c9ea5baf49213d4948feac1118cae7022f621965a879e7d36a")
override fun cloudMapOptions(cloudMapOptions: CloudMapOptions.Builder.() -> Unit): Unit =
cloudMapOptions(CloudMapOptions(cloudMapOptions))
/**
* The name of the cluster that hosts the service.
*
* @param cluster The name of the cluster that hosts the service.
*/
override fun cluster(cluster: ICluster) {
cdkBuilder.cluster(cluster.let(ICluster.Companion::unwrap))
}
/**
* 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.
*
* @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))
}
/**
* 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.
*
* @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("a9e7cbde8b2f51bf4837bd89ab7ce60476410d7c5b1f596ed1553c33bd546156")
override fun deploymentAlarms(deploymentAlarms: DeploymentAlarmConfig.Builder.() -> Unit): Unit
= deploymentAlarms(DeploymentAlarmConfig(deploymentAlarms))
/**
* 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.
*/
override fun deploymentController(deploymentController: DeploymentController) {
cdkBuilder.deploymentController(deploymentController.let(DeploymentController.Companion::unwrap))
}
/**
* 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.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("132283714c7dbffdd9b210c5eaa509f1a7e5dbce833291b4af8ace91975b6ecb")
override
fun deploymentController(deploymentController: DeploymentController.Builder.() -> Unit):
Unit = deploymentController(DeploymentController(deploymentController))
/**
* 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.
*
* @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)
}
/**
* 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.
*/
override fun enableEcsManagedTags(enableEcsManagedTags: Boolean) {
cdkBuilder.enableEcsManagedTags(enableEcsManagedTags)
}
/**
* Whether to enable the ability to execute into a container.
*
* Default: - undefined
*
* @param enableExecuteCommand Whether to enable the ability to execute into a container.
*/
override 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.
*/
override fun healthCheckGracePeriod(healthCheckGracePeriod: Duration) {
cdkBuilder.healthCheckGracePeriod(healthCheckGracePeriod.let(Duration.Companion::unwrap))
}
/**
* 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.
*/
override fun maxHealthyPercent(maxHealthyPercent: Number) {
cdkBuilder.maxHealthyPercent(maxHealthyPercent)
}
/**
* 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.
*/
override fun minHealthyPercent(minHealthyPercent: Number) {
cdkBuilder.minHealthyPercent(minHealthyPercent)
}
/**
* 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
*
* @param propagateTags Specifies whether to propagate the tags from the task definition or the
* service to the tasks in the service.
*/
override fun propagateTags(propagateTags: PropagatedTagSource) {
cdkBuilder.propagateTags(propagateTags.let(PropagatedTagSource.Companion::unwrap))
}
/**
* 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.
*
* @param securityGroups The security groups to associate with the service.
*/
override fun securityGroups(securityGroups: List) {
cdkBuilder.securityGroups(securityGroups.map(ISecurityGroup.Companion::unwrap))
}
/**
* 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.
*
* @param securityGroups The security groups to associate with the service.
*/
override fun securityGroups(vararg securityGroups: ISecurityGroup): Unit =
securityGroups(securityGroups.toList())
/**
* 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.
*
* @param serviceConnectConfiguration Configuration for Service Connect.
*/
override fun serviceConnectConfiguration(serviceConnectConfiguration: ServiceConnectProps) {
cdkBuilder.serviceConnectConfiguration(serviceConnectConfiguration.let(ServiceConnectProps.Companion::unwrap))
}
/**
* 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.
*
* @param serviceConnectConfiguration Configuration for Service Connect.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("a34fbb39ed4eb18a677fea97b1604d0dd5c8962f8ce8117ae1165531a572f345")
override
fun serviceConnectConfiguration(serviceConnectConfiguration: ServiceConnectProps.Builder.() -> Unit):
Unit = serviceConnectConfiguration(ServiceConnectProps(serviceConnectConfiguration))
/**
* The name of the service.
*
* Default: - CloudFormation-generated name.
*
* @param serviceName The name of the service.
*/
override fun serviceName(serviceName: String) {
cdkBuilder.serviceName(serviceName)
}
/**
* The task definition to use for tasks in the service.
*
* [disable-awslint:ref-via-interface]
*
* @param taskDefinition The task definition to use for tasks in the service.
*/
override fun taskDefinition(taskDefinition: TaskDefinition) {
cdkBuilder.taskDefinition(taskDefinition.let(TaskDefinition.Companion::unwrap))
}
/**
* 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
*
* @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))
}
/**
* 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
*
* @param volumeConfigurations Configuration details for a volume used by the service.
*/
override fun volumeConfigurations(volumeConfigurations: List) {
cdkBuilder.volumeConfigurations(volumeConfigurations.map(ServiceManagedVolume.Companion::unwrap))
}
/**
* 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
*
* @param volumeConfigurations Configuration details for a volume used by the service.
*/
override fun volumeConfigurations(vararg volumeConfigurations: ServiceManagedVolume): Unit =
volumeConfigurations(volumeConfigurations.toList())
public fun build(): software.amazon.awscdk.services.ecs.ExternalService = cdkBuilder.build()
}
public companion object {
public fun fromExternalServiceArn(
scope: CloudshiftdevConstructsConstruct,
id: String,
externalServiceArn: String,
): IExternalService =
software.amazon.awscdk.services.ecs.ExternalService.fromExternalServiceArn(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, externalServiceArn).let(IExternalService::wrap)
public fun fromExternalServiceAttributes(
scope: CloudshiftdevConstructsConstruct,
id: String,
attrs: ExternalServiceAttributes,
): IBaseService =
software.amazon.awscdk.services.ecs.ExternalService.fromExternalServiceAttributes(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, attrs.let(ExternalServiceAttributes.Companion::unwrap)).let(IBaseService::wrap)
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("9c821c053693b374d19971efb06539e7456849cba31705ede4c6c0f7fb4674de")
public fun fromExternalServiceAttributes(
scope: CloudshiftdevConstructsConstruct,
id: String,
attrs: ExternalServiceAttributes.Builder.() -> Unit,
): IBaseService = fromExternalServiceAttributes(scope, id, ExternalServiceAttributes(attrs))
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): ExternalService {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return ExternalService(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.ecs.ExternalService):
ExternalService = ExternalService(cdkObject)
internal fun unwrap(wrapped: ExternalService):
software.amazon.awscdk.services.ecs.ExternalService = wrapped.cdkObject as
software.amazon.awscdk.services.ecs.ExternalService
}
}