com.pulumi.awsnative.ecs.kotlin.Service.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.ecs.kotlin
import com.pulumi.awsnative.ecs.kotlin.enums.ServiceLaunchType
import com.pulumi.awsnative.ecs.kotlin.enums.ServicePropagateTags
import com.pulumi.awsnative.ecs.kotlin.enums.ServiceSchedulingStrategy
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceCapacityProviderStrategyItem
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceConnectConfiguration
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceDeploymentConfiguration
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceDeploymentController
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceLoadBalancer
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceNetworkConfiguration
import com.pulumi.awsnative.ecs.kotlin.outputs.ServicePlacementConstraint
import com.pulumi.awsnative.ecs.kotlin.outputs.ServicePlacementStrategy
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceRegistry
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceVolumeConfiguration
import com.pulumi.awsnative.kotlin.outputs.Tag
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import com.pulumi.awsnative.ecs.kotlin.enums.ServiceLaunchType.Companion.toKotlin as serviceLaunchTypeToKotlin
import com.pulumi.awsnative.ecs.kotlin.enums.ServicePropagateTags.Companion.toKotlin as servicePropagateTagsToKotlin
import com.pulumi.awsnative.ecs.kotlin.enums.ServiceSchedulingStrategy.Companion.toKotlin as serviceSchedulingStrategyToKotlin
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceCapacityProviderStrategyItem.Companion.toKotlin as serviceCapacityProviderStrategyItemToKotlin
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceConnectConfiguration.Companion.toKotlin as serviceConnectConfigurationToKotlin
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceDeploymentConfiguration.Companion.toKotlin as serviceDeploymentConfigurationToKotlin
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceDeploymentController.Companion.toKotlin as serviceDeploymentControllerToKotlin
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceLoadBalancer.Companion.toKotlin as serviceLoadBalancerToKotlin
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceNetworkConfiguration.Companion.toKotlin as serviceNetworkConfigurationToKotlin
import com.pulumi.awsnative.ecs.kotlin.outputs.ServicePlacementConstraint.Companion.toKotlin as servicePlacementConstraintToKotlin
import com.pulumi.awsnative.ecs.kotlin.outputs.ServicePlacementStrategy.Companion.toKotlin as servicePlacementStrategyToKotlin
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceRegistry.Companion.toKotlin as serviceRegistryToKotlin
import com.pulumi.awsnative.ecs.kotlin.outputs.ServiceVolumeConfiguration.Companion.toKotlin as serviceVolumeConfigurationToKotlin
import com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin as tagToKotlin
/**
* Builder for [Service].
*/
@PulumiTagMarker
public class ServiceResourceBuilder internal constructor() {
public var name: String? = null
public var args: ServiceArgs = ServiceArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend ServiceArgsBuilder.() -> Unit) {
val builder = ServiceArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Service {
val builtJavaResource = com.pulumi.awsnative.ecs.Service(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Service(builtJavaResource)
}
}
/**
* The ``AWS::ECS::Service`` resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.
* The stack update fails if you change any properties that require replacement and at least one Amazon ECS Service Connect ``ServiceConnectService`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceConnectService`` must have a name that is unique in the namespace.
* Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
*/
public class Service internal constructor(
override val javaResource: com.pulumi.awsnative.ecs.Service,
) : KotlinCustomResource(javaResource, ServiceMapper) {
/**
* The capacity provider strategy to use for the service.
* If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used.
* A capacity provider strategy may contain a maximum of 6 capacity providers.
*/
public val capacityProviderStrategy: Output>?
get() = javaResource.capacityProviderStrategy().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
serviceCapacityProviderStrategyItemToKotlin(args0)
})
})
}).orElse(null)
})
/**
* The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
*/
public val cluster: Output?
get() = javaResource.cluster().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
*/
public val deploymentConfiguration: Output?
get() = javaResource.deploymentConfiguration().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> serviceDeploymentConfigurationToKotlin(args0) })
}).orElse(null)
})
/**
* The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used.
*/
public val deploymentController: Output?
get() = javaResource.deploymentController().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> serviceDeploymentControllerToKotlin(args0) })
}).orElse(null)
})
/**
* The number of instantiations of the specified task definition to place and keep running in your service.
* For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required.
* For existing services, if a desired count is not specified, it is omitted from the operation.
*/
public val desiredCount: Output?
get() = javaResource.desiredCount().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies whether to turn on 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) in the *Amazon Elastic Container Service Developer Guide*.
* When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter.
*/
public val enableEcsManagedTags: Output?
get() = javaResource.enableEcsManagedTags().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service.
*/
public val enableExecuteCommand: Output?
get() = javaResource.enableExecuteCommand().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used.
* If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).
* If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
*/
public val healthCheckGracePeriodSeconds: Output?
get() = javaResource.healthCheckGracePeriodSeconds().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
public val launchType: Output?
get() = javaResource.launchType().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
serviceLaunchTypeToKotlin(args0)
})
}).orElse(null)
})
/**
* A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
public val loadBalancers: Output>?
get() = javaResource.loadBalancers().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
serviceLoadBalancerToKotlin(args0)
})
})
}).orElse(null)
})
/**
* The name of the Amazon ECS service, such as `sample-webapp` .
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
public val networkConfiguration: Output?
get() = javaResource.networkConfiguration().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> serviceNetworkConfigurationToKotlin(args0) })
}).orElse(null)
})
/**
* An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
*/
public val placementConstraints: Output>?
get() = javaResource.placementConstraints().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
servicePlacementConstraintToKotlin(args0)
})
})
}).orElse(null)
})
/**
* The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
*/
public val placementStrategies: Output>?
get() = javaResource.placementStrategies().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
servicePlacementStrategyToKotlin(args0)
})
})
}).orElse(null)
})
/**
* The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
public val platformVersion: Output?
get() = javaResource.platformVersion().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.
* The default is ``NONE``.
*/
public val propagateTags: Output?
get() = javaResource.propagateTags().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> servicePropagateTagsToKotlin(args0) })
}).orElse(null)
})
/**
* The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter.
* If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
* If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.
*/
public val role: Output?
get() = javaResource.role().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).
* There are two service scheduler strategies available:
* + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types.
* + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
* Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy.
*/
public val schedulingStrategy: Output?
get() = javaResource.schedulingStrategy().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> serviceSchedulingStrategyToKotlin(args0) })
}).orElse(null)
})
/**
* Not currently supported in AWS CloudFormation .
*/
public val serviceArn: Output
get() = javaResource.serviceArn().applyValue({ args0 -> args0 })
/**
* The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
* Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
public val serviceConnectConfiguration: Output?
get() = javaResource.serviceConnectConfiguration().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> serviceConnectConfigurationToKotlin(args0) })
}).orElse(null)
})
/**
* The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
* The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster.
*/
public val serviceName: Output?
get() = javaResource.serviceName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
* Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
*/
public val serviceRegistries: Output>?
get() = javaResource.serviceRegistries().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.let({ args0 -> serviceRegistryToKotlin(args0) }) })
}).orElse(null)
})
/**
* The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
* The following basic restrictions apply to tags:
* + Maximum number of tags per resource - 50
* + For each resource, each tag key must be unique, and each tag key can have only one value.
* + Maximum key length - 128 Unicode characters in UTF-8
* + Maximum value length - 256 Unicode characters in UTF-8
* + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
* + Tag keys and values are case-sensitive.
* + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> tagToKotlin(args0) })
})
}).orElse(null)
})
/**
* The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used.
* A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers.
* For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).
*/
public val taskDefinition: Output?
get() = javaResource.taskDefinition().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
*/
public val volumeConfigurations: Output>?
get() = javaResource.volumeConfigurations().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
serviceVolumeConfigurationToKotlin(args0)
})
})
}).orElse(null)
})
}
public object ServiceMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.ecs.Service::class == javaResource::class
override fun map(javaResource: Resource): Service = Service(
javaResource as
com.pulumi.awsnative.ecs.Service,
)
}
/**
* @see [Service].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Service].
*/
public suspend fun service(name: String, block: suspend ServiceResourceBuilder.() -> Unit): Service {
val builder = ServiceResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Service].
* @param name The _unique_ name of the resulting resource.
*/
public fun service(name: String): Service {
val builder = ServiceResourceBuilder()
builder.name(name)
return builder.build()
}