Package-level declarations

Types

Link copied to clipboard
class CapacityProvider : KotlinCustomResource

Resource Type definition for AWS::ECS::CapacityProvider.

Link copied to clipboard
data class CapacityProviderArgs(val autoScalingGroupProvider: Output<CapacityProviderAutoScalingGroupProviderArgs>? = null, val name: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<CapacityProviderArgs>

Resource Type definition for AWS::ECS::CapacityProvider.

Link copied to clipboard
object CapacityProviderMapper : ResourceMapper<CapacityProvider>
Link copied to clipboard
class Cluster : KotlinCustomResource

The `AWS::ECS::Cluster` resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.

Link copied to clipboard
data class ClusterArgs(val capacityProviders: Output<List<String>>? = null, val clusterName: Output<String>? = null, val clusterSettings: Output<List<ClusterSettingsArgs>>? = null, val configuration: Output<ClusterConfigurationArgs>? = null, val defaultCapacityProviderStrategy: Output<List<ClusterCapacityProviderStrategyItemArgs>>? = null, val serviceConnectDefaults: Output<ClusterServiceConnectDefaultsArgs>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<ClusterArgs>

The `AWS::ECS::Cluster` resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.

Link copied to clipboard
Link copied to clipboard
class ClusterCapacityProviderAssociations : KotlinCustomResource

Associate a set of ECS Capacity Providers with a specified ECS Cluster

Link copied to clipboard
data class ClusterCapacityProviderAssociationsArgs(val capacityProviders: Output<List<Either<ClusterCapacityProviderAssociationsCapacityProvider, String>>>? = null, val cluster: Output<String>? = null, val defaultCapacityProviderStrategy: Output<List<ClusterCapacityProviderAssociationsCapacityProviderStrategyArgs>>? = null) : ConvertibleToJava<ClusterCapacityProviderAssociationsArgs>

Associate a set of ECS Capacity Providers with a specified ECS Cluster

Link copied to clipboard
object ClusterMapper : ResourceMapper<Cluster>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class PrimaryTaskSet : KotlinCustomResource

A pseudo-resource that manages which of your ECS task sets is primary.

Link copied to clipboard
data class PrimaryTaskSetArgs(val cluster: Output<String>? = null, val service: Output<String>? = null, val taskSetId: Output<String>? = null) : ConvertibleToJava<PrimaryTaskSetArgs>

A pseudo-resource that manages which of your ECS task sets is primary.

Link copied to clipboard
Link copied to clipboard
object PrimaryTaskSetMapper : ResourceMapper<PrimaryTaskSet>
Link copied to clipboard
class Service : KotlinCustomResource

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 ECS Service Connect `ServiceConnectConfiguration` property the 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.

Link copied to clipboard
data class ServiceArgs(val capacityProviderStrategy: Output<List<ServiceCapacityProviderStrategyItemArgs>>? = null, val cluster: Output<String>? = null, val deploymentConfiguration: Output<ServiceDeploymentConfigurationArgs>? = null, val deploymentController: Output<ServiceDeploymentControllerArgs>? = null, val desiredCount: Output<Int>? = null, val enableEcsManagedTags: Output<Boolean>? = null, val enableExecuteCommand: Output<Boolean>? = null, val healthCheckGracePeriodSeconds: Output<Int>? = null, val launchType: Output<ServiceLaunchType>? = null, val loadBalancers: Output<List<ServiceLoadBalancerArgs>>? = null, val networkConfiguration: Output<ServiceNetworkConfigurationArgs>? = null, val placementConstraints: Output<List<ServicePlacementConstraintArgs>>? = null, val placementStrategies: Output<List<ServicePlacementStrategyArgs>>? = null, val platformVersion: Output<String>? = null, val propagateTags: Output<ServicePropagateTags>? = null, val role: Output<String>? = null, val schedulingStrategy: Output<ServiceSchedulingStrategy>? = null, val serviceConnectConfiguration: Output<ServiceConnectConfigurationArgs>? = null, val serviceName: Output<String>? = null, val serviceRegistries: Output<List<ServiceRegistryArgs>>? = null, val tags: Output<List<TagArgs>>? = null, val taskDefinition: Output<String>? = null, val volumeConfigurations: Output<List<ServiceVolumeConfigurationArgs>>? = null) : ConvertibleToJava<ServiceArgs>

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 ECS Service Connect `ServiceConnectConfiguration` property the 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.

Link copied to clipboard
Link copied to clipboard
object ServiceMapper : ResourceMapper<Service>
Link copied to clipboard
Link copied to clipboard
class TaskDefinition : KotlinCustomResource

Registers a new task definition from the supplied `family` and `containerDefinitions`. Optionally, you can add data volumes to your containers with the `volumes` parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide. You can specify a role for your task with the `taskRoleArn` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the `networkMode` parameter. If you specify the `awsvpc` network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide. In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information, see Signature Version 4 Signing Process in the General Reference. You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the or one of the SDKs to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.

Link copied to clipboard
data class TaskDefinitionArgs(val containerDefinitions: Output<List<TaskDefinitionContainerDefinitionArgs>>? = null, val cpu: Output<String>? = null, val ephemeralStorage: Output<TaskDefinitionEphemeralStorageArgs>? = null, val executionRoleArn: Output<String>? = null, val family: Output<String>? = null, val inferenceAccelerators: Output<List<TaskDefinitionInferenceAcceleratorArgs>>? = null, val ipcMode: Output<String>? = null, val memory: Output<String>? = null, val networkMode: Output<String>? = null, val pidMode: Output<String>? = null, val placementConstraints: Output<List<TaskDefinitionPlacementConstraintArgs>>? = null, val proxyConfiguration: Output<TaskDefinitionProxyConfigurationArgs>? = null, val requiresCompatibilities: Output<List<String>>? = null, val runtimePlatform: Output<TaskDefinitionRuntimePlatformArgs>? = null, val tags: Output<List<TagArgs>>? = null, val taskRoleArn: Output<String>? = null, val volumes: Output<List<TaskDefinitionVolumeArgs>>? = null) : ConvertibleToJava<TaskDefinitionArgs>

Registers a new task definition from the supplied `family` and `containerDefinitions`. Optionally, you can add data volumes to your containers with the `volumes` parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide. You can specify a role for your task with the `taskRoleArn` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide. You can specify a Docker networking mode for the containers in your task definition with the `networkMode` parameter. If you specify the `awsvpc` network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide. In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information, see Signature Version 4 Signing Process in the General Reference. You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the or one of the SDKs to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.

Link copied to clipboard
Link copied to clipboard
object TaskDefinitionMapper : ResourceMapper<TaskDefinition>
Link copied to clipboard
class TaskSet : KotlinCustomResource

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide.

Link copied to clipboard
data class TaskSetArgs(val cluster: Output<String>? = null, val externalId: Output<String>? = null, val launchType: Output<TaskSetLaunchType>? = null, val loadBalancers: Output<List<TaskSetLoadBalancerArgs>>? = null, val networkConfiguration: Output<TaskSetNetworkConfigurationArgs>? = null, val platformVersion: Output<String>? = null, val scale: Output<TaskSetScaleArgs>? = null, val service: Output<String>? = null, val serviceRegistries: Output<List<TaskSetServiceRegistryArgs>>? = null, val tags: Output<List<TagArgs>>? = null, val taskDefinition: Output<String>? = null) : ConvertibleToJava<TaskSetArgs>

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.htmlin the Amazon Elastic Container Service Developer Guide.

Link copied to clipboard
Link copied to clipboard
object TaskSetMapper : ResourceMapper<TaskSet>
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
fun cluster(name: String): Cluster
suspend fun cluster(name: String, block: suspend ClusterResourceBuilder.() -> Unit): Cluster
Link copied to clipboard
Link copied to clipboard
fun service(name: String): Service
suspend fun service(name: String, block: suspend ServiceResourceBuilder.() -> Unit): Service
Link copied to clipboard
Link copied to clipboard
fun taskSet(name: String): TaskSet
suspend fun taskSet(name: String, block: suspend TaskSetResourceBuilder.() -> Unit): TaskSet