io.cloudshiftdev.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.ecs.patterns
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.ecs.ContainerImage
import io.cloudshiftdev.awscdk.services.ecs.LogDriver
import io.cloudshiftdev.awscdk.services.ecs.Secret
import io.cloudshiftdev.awscdk.services.iam.IRole
import kotlin.Boolean
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Example:
*
* ```
* Cluster cluster;
* ApplicationLoadBalancedFargateService loadBalancedFargateService =
* ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
* .cluster(cluster)
* .memoryLimitMiB(1024)
* .desiredCount(1)
* .cpu(512)
* .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
* .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
* .build())
* .taskSubnets(SubnetSelection.builder()
* .subnets(List.of(Subnet.fromSubnetId(this, "subnet", "VpcISOLATEDSubnet1Subnet80F07FA0")))
* .build())
* .loadBalancerName("application-lb-name")
* .build();
* ```
*/
public interface ApplicationLoadBalancedTaskImageOptions {
/**
* The command that's passed to the container.
*
* If there are multiple arguments, make sure that each argument is a separated string in the
* array.
*
* This parameter maps to `Cmd` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `COMMAND`
* parameter to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `CMD` parameter, see
* https://docs.docker.com/engine/reference/builder/#cmd.
*
* Default: none
*/
public fun command(): List = unwrap(this).getCommand() ?: emptyList()
/**
* The container name value to be specified in the task definition.
*
* Default: - none
*/
public fun containerName(): String? = unwrap(this).getContainerName()
/**
* The port number on the container that is bound to the user-specified or automatically assigned
* host port.
*
* If you are using containers in a task with the awsvpc or host network mode, exposed ports
* should be specified using containerPort.
* If you are using containers in a task with the bridge network mode and you specify a container
* port and not a host port,
* your container automatically receives a host port in the ephemeral port range.
*
* Port mappings that are automatically assigned in this way do not count toward the 100 reserved
* ports limit of a container instance.
*
* For more information, see
* [hostPort](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PortMapping.html#ECS-Type-PortMapping-hostPort).
*
* Default: 80
*/
public fun containerPort(): Number? = unwrap(this).getContainerPort()
/**
* A key/value map of labels to add to the container.
*
* Default: - No labels.
*/
public fun dockerLabels(): Map = unwrap(this).getDockerLabels() ?: emptyMap()
/**
* Flag to indicate whether to enable logging.
*
* Default: true
*/
public fun enableLogging(): Boolean? = unwrap(this).getEnableLogging()
/**
* The entry point that's passed to the container.
*
* This parameter maps to `Entrypoint` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `--entrypoint`
* option to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `ENTRYPOINT` parameter, see
* https://docs.docker.com/engine/reference/builder/#entrypoint.
*
* Default: none
*/
public fun entryPoint(): List = unwrap(this).getEntryPoint() ?: emptyList()
/**
* The environment variables to pass to the container.
*
* Default: - No environment variables.
*/
public fun environment(): Map = unwrap(this).getEnvironment() ?: emptyMap()
/**
* The name of the task execution IAM role that grants the Amazon ECS container agent permission
* to call AWS APIs on your behalf.
*
* Default: - No value
*/
public fun executionRole(): IRole? = unwrap(this).getExecutionRole()?.let(IRole::wrap)
/**
* The name of a family that this task definition is registered to.
*
* A family groups multiple versions of a task definition.
*
* Default: - Automatically generated name.
*/
public fun family(): String? = unwrap(this).getFamily()
/**
* The image used to start a container.
*
* Image or taskDefinition must be specified, not both.
*
* Default: - none
*/
public fun image(): ContainerImage
/**
* The log driver to use.
*
* Default: - AwsLogDriver if enableLogging is true
*/
public fun logDriver(): LogDriver? = unwrap(this).getLogDriver()?.let(LogDriver::wrap)
/**
* The secret to expose to the container as an environment variable.
*
* Default: - No secret environment variables.
*/
public fun secrets(): Map =
unwrap(this).getSecrets()?.mapValues{Secret.wrap(it.value)} ?: emptyMap()
/**
* The name of the task IAM role that grants containers in the task permission to call AWS APIs on
* your behalf.
*
* Default: - A task role is automatically created for you.
*/
public fun taskRole(): IRole? = unwrap(this).getTaskRole()?.let(IRole::wrap)
/**
* A builder for [ApplicationLoadBalancedTaskImageOptions]
*/
@CdkDslMarker
public interface Builder {
/**
* @param command The command that's passed to the container.
* If there are multiple arguments, make sure that each argument is a separated string in the
* array.
*
* This parameter maps to `Cmd` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `COMMAND`
* parameter to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `CMD` parameter, see
* https://docs.docker.com/engine/reference/builder/#cmd.
*/
public fun command(command: List)
/**
* @param command The command that's passed to the container.
* If there are multiple arguments, make sure that each argument is a separated string in the
* array.
*
* This parameter maps to `Cmd` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `COMMAND`
* parameter to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `CMD` parameter, see
* https://docs.docker.com/engine/reference/builder/#cmd.
*/
public fun command(vararg command: String)
/**
* @param containerName The container name value to be specified in the task definition.
*/
public fun containerName(containerName: String)
/**
* @param containerPort The port number on the container that is bound to the user-specified or
* automatically assigned host port.
* If you are using containers in a task with the awsvpc or host network mode, exposed ports
* should be specified using containerPort.
* If you are using containers in a task with the bridge network mode and you specify a
* container port and not a host port,
* your container automatically receives a host port in the ephemeral port range.
*
* Port mappings that are automatically assigned in this way do not count toward the 100
* reserved ports limit of a container instance.
*
* For more information, see
* [hostPort](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PortMapping.html#ECS-Type-PortMapping-hostPort).
*/
public fun containerPort(containerPort: Number)
/**
* @param dockerLabels A key/value map of labels to add to the container.
*/
public fun dockerLabels(dockerLabels: Map)
/**
* @param enableLogging Flag to indicate whether to enable logging.
*/
public fun enableLogging(enableLogging: Boolean)
/**
* @param entryPoint The entry point that's passed to the container.
* This parameter maps to `Entrypoint` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `--entrypoint`
* option to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `ENTRYPOINT` parameter, see
* https://docs.docker.com/engine/reference/builder/#entrypoint.
*/
public fun entryPoint(entryPoint: List)
/**
* @param entryPoint The entry point that's passed to the container.
* This parameter maps to `Entrypoint` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `--entrypoint`
* option to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `ENTRYPOINT` parameter, see
* https://docs.docker.com/engine/reference/builder/#entrypoint.
*/
public fun entryPoint(vararg entryPoint: String)
/**
* @param environment The environment variables to pass to the container.
*/
public fun environment(environment: Map)
/**
* @param executionRole The name of the task execution IAM role that grants the Amazon ECS
* container agent permission to call AWS APIs on your behalf.
*/
public fun executionRole(executionRole: IRole)
/**
* @param family The name of a family that this task definition is registered to.
* A family groups multiple versions of a task definition.
*/
public fun family(family: String)
/**
* @param image The image used to start a container.
* Image or taskDefinition must be specified, not both.
*/
public fun image(image: ContainerImage)
/**
* @param logDriver The log driver to use.
*/
public fun logDriver(logDriver: LogDriver)
/**
* @param secrets The secret to expose to the container as an environment variable.
*/
public fun secrets(secrets: Map)
/**
* @param taskRole The name of the task IAM role that grants containers in the task permission
* to call AWS APIs on your behalf.
*/
public fun taskRole(taskRole: IRole)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions.Builder
=
software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions.builder()
/**
* @param command The command that's passed to the container.
* If there are multiple arguments, make sure that each argument is a separated string in the
* array.
*
* This parameter maps to `Cmd` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `COMMAND`
* parameter to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `CMD` parameter, see
* https://docs.docker.com/engine/reference/builder/#cmd.
*/
override fun command(command: List) {
cdkBuilder.command(command)
}
/**
* @param command The command that's passed to the container.
* If there are multiple arguments, make sure that each argument is a separated string in the
* array.
*
* This parameter maps to `Cmd` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `COMMAND`
* parameter to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `CMD` parameter, see
* https://docs.docker.com/engine/reference/builder/#cmd.
*/
override fun command(vararg command: String): Unit = command(command.toList())
/**
* @param containerName The container name value to be specified in the task definition.
*/
override fun containerName(containerName: String) {
cdkBuilder.containerName(containerName)
}
/**
* @param containerPort The port number on the container that is bound to the user-specified or
* automatically assigned host port.
* If you are using containers in a task with the awsvpc or host network mode, exposed ports
* should be specified using containerPort.
* If you are using containers in a task with the bridge network mode and you specify a
* container port and not a host port,
* your container automatically receives a host port in the ephemeral port range.
*
* Port mappings that are automatically assigned in this way do not count toward the 100
* reserved ports limit of a container instance.
*
* For more information, see
* [hostPort](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PortMapping.html#ECS-Type-PortMapping-hostPort).
*/
override fun containerPort(containerPort: Number) {
cdkBuilder.containerPort(containerPort)
}
/**
* @param dockerLabels A key/value map of labels to add to the container.
*/
override fun dockerLabels(dockerLabels: Map) {
cdkBuilder.dockerLabels(dockerLabels)
}
/**
* @param enableLogging Flag to indicate whether to enable logging.
*/
override fun enableLogging(enableLogging: Boolean) {
cdkBuilder.enableLogging(enableLogging)
}
/**
* @param entryPoint The entry point that's passed to the container.
* This parameter maps to `Entrypoint` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `--entrypoint`
* option to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `ENTRYPOINT` parameter, see
* https://docs.docker.com/engine/reference/builder/#entrypoint.
*/
override fun entryPoint(entryPoint: List) {
cdkBuilder.entryPoint(entryPoint)
}
/**
* @param entryPoint The entry point that's passed to the container.
* This parameter maps to `Entrypoint` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `--entrypoint`
* option to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `ENTRYPOINT` parameter, see
* https://docs.docker.com/engine/reference/builder/#entrypoint.
*/
override fun entryPoint(vararg entryPoint: String): Unit = entryPoint(entryPoint.toList())
/**
* @param environment The environment variables to pass to the container.
*/
override fun environment(environment: Map) {
cdkBuilder.environment(environment)
}
/**
* @param executionRole The name of the task execution IAM role that grants the Amazon ECS
* container agent permission to call AWS APIs on your behalf.
*/
override fun executionRole(executionRole: IRole) {
cdkBuilder.executionRole(executionRole.let(IRole.Companion::unwrap))
}
/**
* @param family The name of a family that this task definition is registered to.
* A family groups multiple versions of a task definition.
*/
override fun family(family: String) {
cdkBuilder.family(family)
}
/**
* @param image The image used to start a container.
* Image or taskDefinition must be specified, not both.
*/
override fun image(image: ContainerImage) {
cdkBuilder.image(image.let(ContainerImage.Companion::unwrap))
}
/**
* @param logDriver The log driver to use.
*/
override fun logDriver(logDriver: LogDriver) {
cdkBuilder.logDriver(logDriver.let(LogDriver.Companion::unwrap))
}
/**
* @param secrets The secret to expose to the container as an environment variable.
*/
override fun secrets(secrets: Map) {
cdkBuilder.secrets(secrets.mapValues{Secret.unwrap(it.value)})
}
/**
* @param taskRole The name of the task IAM role that grants containers in the task permission
* to call AWS APIs on your behalf.
*/
override fun taskRole(taskRole: IRole) {
cdkBuilder.taskRole(taskRole.let(IRole.Companion::unwrap))
}
public fun build():
software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions,
) : CdkObject(cdkObject),
ApplicationLoadBalancedTaskImageOptions {
/**
* The command that's passed to the container.
*
* If there are multiple arguments, make sure that each argument is a separated string in the
* array.
*
* This parameter maps to `Cmd` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `COMMAND`
* parameter to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `CMD` parameter, see
* https://docs.docker.com/engine/reference/builder/#cmd.
*
* Default: none
*/
override fun command(): List = unwrap(this).getCommand() ?: emptyList()
/**
* The container name value to be specified in the task definition.
*
* Default: - none
*/
override fun containerName(): String? = unwrap(this).getContainerName()
/**
* The port number on the container that is bound to the user-specified or automatically
* assigned host port.
*
* If you are using containers in a task with the awsvpc or host network mode, exposed ports
* should be specified using containerPort.
* If you are using containers in a task with the bridge network mode and you specify a
* container port and not a host port,
* your container automatically receives a host port in the ephemeral port range.
*
* Port mappings that are automatically assigned in this way do not count toward the 100
* reserved ports limit of a container instance.
*
* For more information, see
* [hostPort](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PortMapping.html#ECS-Type-PortMapping-hostPort).
*
* Default: 80
*/
override fun containerPort(): Number? = unwrap(this).getContainerPort()
/**
* A key/value map of labels to add to the container.
*
* Default: - No labels.
*/
override fun dockerLabels(): Map = unwrap(this).getDockerLabels() ?: emptyMap()
/**
* Flag to indicate whether to enable logging.
*
* Default: true
*/
override fun enableLogging(): Boolean? = unwrap(this).getEnableLogging()
/**
* The entry point that's passed to the container.
*
* This parameter maps to `Entrypoint` in the [Create a
* container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section
* of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `--entrypoint`
* option to
* [docker run](https://docs.docker.com/engine/reference/commandline/run/).
*
* For more information about the Docker `ENTRYPOINT` parameter, see
* https://docs.docker.com/engine/reference/builder/#entrypoint.
*
* Default: none
*/
override fun entryPoint(): List = unwrap(this).getEntryPoint() ?: emptyList()
/**
* The environment variables to pass to the container.
*
* Default: - No environment variables.
*/
override fun environment(): Map = unwrap(this).getEnvironment() ?: emptyMap()
/**
* The name of the task execution IAM role that grants the Amazon ECS container agent permission
* to call AWS APIs on your behalf.
*
* Default: - No value
*/
override fun executionRole(): IRole? = unwrap(this).getExecutionRole()?.let(IRole::wrap)
/**
* The name of a family that this task definition is registered to.
*
* A family groups multiple versions of a task definition.
*
* Default: - Automatically generated name.
*/
override fun family(): String? = unwrap(this).getFamily()
/**
* The image used to start a container.
*
* Image or taskDefinition must be specified, not both.
*
* Default: - none
*/
override fun image(): ContainerImage = unwrap(this).getImage().let(ContainerImage::wrap)
/**
* The log driver to use.
*
* Default: - AwsLogDriver if enableLogging is true
*/
override fun logDriver(): LogDriver? = unwrap(this).getLogDriver()?.let(LogDriver::wrap)
/**
* The secret to expose to the container as an environment variable.
*
* Default: - No secret environment variables.
*/
override fun secrets(): Map =
unwrap(this).getSecrets()?.mapValues{Secret.wrap(it.value)} ?: emptyMap()
/**
* The name of the task IAM role that grants containers in the task permission to call AWS APIs
* on your behalf.
*
* Default: - A task role is automatically created for you.
*/
override fun taskRole(): IRole? = unwrap(this).getTaskRole()?.let(IRole::wrap)
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}):
ApplicationLoadBalancedTaskImageOptions {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions):
ApplicationLoadBalancedTaskImageOptions = CdkObjectWrappers.wrap(cdkObject) as?
ApplicationLoadBalancedTaskImageOptions ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: ApplicationLoadBalancedTaskImageOptions):
software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions =
(wrapped as CdkObject).cdkObject as
software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy