aws.ecs.TaskSet
Explore with Pulumi AI
Provides an ECS task set - effectively a task that is expected to run until an error occurs or a user terminates it (typically a webserver or a database).
See ECS Task Set section in AWS developer guide.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ecs.TaskSet("example", {
service: exampleAwsEcsService.id,
cluster: exampleAwsEcsCluster.id,
taskDefinition: exampleAwsEcsTaskDefinition.arn,
loadBalancers: [{
targetGroupArn: exampleAwsLbTargetGroup.arn,
containerName: "mongo",
containerPort: 8080,
}],
});
import pulumi
import pulumi_aws as aws
example = aws.ecs.TaskSet("example",
service=example_aws_ecs_service["id"],
cluster=example_aws_ecs_cluster["id"],
task_definition=example_aws_ecs_task_definition["arn"],
load_balancers=[{
"target_group_arn": example_aws_lb_target_group["arn"],
"container_name": "mongo",
"container_port": 8080,
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ecs.NewTaskSet(ctx, "example", &ecs.TaskSetArgs{
Service: pulumi.Any(exampleAwsEcsService.Id),
Cluster: pulumi.Any(exampleAwsEcsCluster.Id),
TaskDefinition: pulumi.Any(exampleAwsEcsTaskDefinition.Arn),
LoadBalancers: ecs.TaskSetLoadBalancerArray{
&ecs.TaskSetLoadBalancerArgs{
TargetGroupArn: pulumi.Any(exampleAwsLbTargetGroup.Arn),
ContainerName: pulumi.String("mongo"),
ContainerPort: pulumi.Int(8080),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ecs.TaskSet("example", new()
{
Service = exampleAwsEcsService.Id,
Cluster = exampleAwsEcsCluster.Id,
TaskDefinition = exampleAwsEcsTaskDefinition.Arn,
LoadBalancers = new[]
{
new Aws.Ecs.Inputs.TaskSetLoadBalancerArgs
{
TargetGroupArn = exampleAwsLbTargetGroup.Arn,
ContainerName = "mongo",
ContainerPort = 8080,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ecs.TaskSet;
import com.pulumi.aws.ecs.TaskSetArgs;
import com.pulumi.aws.ecs.inputs.TaskSetLoadBalancerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new TaskSet("example", TaskSetArgs.builder()
.service(exampleAwsEcsService.id())
.cluster(exampleAwsEcsCluster.id())
.taskDefinition(exampleAwsEcsTaskDefinition.arn())
.loadBalancers(TaskSetLoadBalancerArgs.builder()
.targetGroupArn(exampleAwsLbTargetGroup.arn())
.containerName("mongo")
.containerPort(8080)
.build())
.build());
}
}
resources:
example:
type: aws:ecs:TaskSet
properties:
service: ${exampleAwsEcsService.id}
cluster: ${exampleAwsEcsCluster.id}
taskDefinition: ${exampleAwsEcsTaskDefinition.arn}
loadBalancers:
- targetGroupArn: ${exampleAwsLbTargetGroup.arn}
containerName: mongo
containerPort: 8080
Ignoring Changes to Scale
You can utilize the generic resource lifecycle configuration block with ignore_changes
to create an ECS service with an initial count of running instances, then ignore any changes to that count caused externally (e.g. Application Autoscaling).
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ecs.TaskSet("example", {scale: {
value: 50,
}});
import pulumi
import pulumi_aws as aws
example = aws.ecs.TaskSet("example", scale={
"value": 50,
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ecs.NewTaskSet(ctx, "example", &ecs.TaskSetArgs{
Scale: &ecs.TaskSetScaleArgs{
Value: pulumi.Float64(50),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ecs.TaskSet("example", new()
{
Scale = new Aws.Ecs.Inputs.TaskSetScaleArgs
{
Value = 50,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ecs.TaskSet;
import com.pulumi.aws.ecs.TaskSetArgs;
import com.pulumi.aws.ecs.inputs.TaskSetScaleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new TaskSet("example", TaskSetArgs.builder()
.scale(TaskSetScaleArgs.builder()
.value(50)
.build())
.build());
}
}
resources:
example:
type: aws:ecs:TaskSet
properties:
scale:
value: 50
Create TaskSet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TaskSet(name: string, args: TaskSetArgs, opts?: CustomResourceOptions);
@overload
def TaskSet(resource_name: str,
args: TaskSetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TaskSet(resource_name: str,
opts: Optional[ResourceOptions] = None,
service: Optional[str] = None,
cluster: Optional[str] = None,
task_definition: Optional[str] = None,
force_delete: Optional[bool] = None,
launch_type: Optional[str] = None,
load_balancers: Optional[Sequence[TaskSetLoadBalancerArgs]] = None,
network_configuration: Optional[TaskSetNetworkConfigurationArgs] = None,
platform_version: Optional[str] = None,
scale: Optional[TaskSetScaleArgs] = None,
capacity_provider_strategies: Optional[Sequence[TaskSetCapacityProviderStrategyArgs]] = None,
service_registries: Optional[TaskSetServiceRegistriesArgs] = None,
tags: Optional[Mapping[str, str]] = None,
external_id: Optional[str] = None,
wait_until_stable: Optional[bool] = None,
wait_until_stable_timeout: Optional[str] = None)
func NewTaskSet(ctx *Context, name string, args TaskSetArgs, opts ...ResourceOption) (*TaskSet, error)
public TaskSet(string name, TaskSetArgs args, CustomResourceOptions? opts = null)
public TaskSet(String name, TaskSetArgs args)
public TaskSet(String name, TaskSetArgs args, CustomResourceOptions options)
type: aws:ecs:TaskSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args TaskSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TaskSetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TaskSetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TaskSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TaskSetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var taskSetResource = new Aws.Ecs.TaskSet("taskSetResource", new()
{
Service = "string",
Cluster = "string",
TaskDefinition = "string",
ForceDelete = false,
LaunchType = "string",
LoadBalancers = new[]
{
new Aws.Ecs.Inputs.TaskSetLoadBalancerArgs
{
ContainerName = "string",
ContainerPort = 0,
LoadBalancerName = "string",
TargetGroupArn = "string",
},
},
NetworkConfiguration = new Aws.Ecs.Inputs.TaskSetNetworkConfigurationArgs
{
Subnets = new[]
{
"string",
},
AssignPublicIp = false,
SecurityGroups = new[]
{
"string",
},
},
PlatformVersion = "string",
Scale = new Aws.Ecs.Inputs.TaskSetScaleArgs
{
Unit = "string",
Value = 0,
},
CapacityProviderStrategies = new[]
{
new Aws.Ecs.Inputs.TaskSetCapacityProviderStrategyArgs
{
CapacityProvider = "string",
Weight = 0,
Base = 0,
},
},
ServiceRegistries = new Aws.Ecs.Inputs.TaskSetServiceRegistriesArgs
{
RegistryArn = "string",
ContainerName = "string",
ContainerPort = 0,
Port = 0,
},
Tags =
{
{ "string", "string" },
},
ExternalId = "string",
WaitUntilStable = false,
WaitUntilStableTimeout = "string",
});
example, err := ecs.NewTaskSet(ctx, "taskSetResource", &ecs.TaskSetArgs{
Service: pulumi.String("string"),
Cluster: pulumi.String("string"),
TaskDefinition: pulumi.String("string"),
ForceDelete: pulumi.Bool(false),
LaunchType: pulumi.String("string"),
LoadBalancers: ecs.TaskSetLoadBalancerArray{
&ecs.TaskSetLoadBalancerArgs{
ContainerName: pulumi.String("string"),
ContainerPort: pulumi.Int(0),
LoadBalancerName: pulumi.String("string"),
TargetGroupArn: pulumi.String("string"),
},
},
NetworkConfiguration: &ecs.TaskSetNetworkConfigurationArgs{
Subnets: pulumi.StringArray{
pulumi.String("string"),
},
AssignPublicIp: pulumi.Bool(false),
SecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
},
PlatformVersion: pulumi.String("string"),
Scale: &ecs.TaskSetScaleArgs{
Unit: pulumi.String("string"),
Value: pulumi.Float64(0),
},
CapacityProviderStrategies: ecs.TaskSetCapacityProviderStrategyArray{
&ecs.TaskSetCapacityProviderStrategyArgs{
CapacityProvider: pulumi.String("string"),
Weight: pulumi.Int(0),
Base: pulumi.Int(0),
},
},
ServiceRegistries: &ecs.TaskSetServiceRegistriesArgs{
RegistryArn: pulumi.String("string"),
ContainerName: pulumi.String("string"),
ContainerPort: pulumi.Int(0),
Port: pulumi.Int(0),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ExternalId: pulumi.String("string"),
WaitUntilStable: pulumi.Bool(false),
WaitUntilStableTimeout: pulumi.String("string"),
})
var taskSetResource = new TaskSet("taskSetResource", TaskSetArgs.builder()
.service("string")
.cluster("string")
.taskDefinition("string")
.forceDelete(false)
.launchType("string")
.loadBalancers(TaskSetLoadBalancerArgs.builder()
.containerName("string")
.containerPort(0)
.loadBalancerName("string")
.targetGroupArn("string")
.build())
.networkConfiguration(TaskSetNetworkConfigurationArgs.builder()
.subnets("string")
.assignPublicIp(false)
.securityGroups("string")
.build())
.platformVersion("string")
.scale(TaskSetScaleArgs.builder()
.unit("string")
.value(0)
.build())
.capacityProviderStrategies(TaskSetCapacityProviderStrategyArgs.builder()
.capacityProvider("string")
.weight(0)
.base(0)
.build())
.serviceRegistries(TaskSetServiceRegistriesArgs.builder()
.registryArn("string")
.containerName("string")
.containerPort(0)
.port(0)
.build())
.tags(Map.of("string", "string"))
.externalId("string")
.waitUntilStable(false)
.waitUntilStableTimeout("string")
.build());
task_set_resource = aws.ecs.TaskSet("taskSetResource",
service="string",
cluster="string",
task_definition="string",
force_delete=False,
launch_type="string",
load_balancers=[{
"containerName": "string",
"containerPort": 0,
"loadBalancerName": "string",
"targetGroupArn": "string",
}],
network_configuration={
"subnets": ["string"],
"assignPublicIp": False,
"securityGroups": ["string"],
},
platform_version="string",
scale={
"unit": "string",
"value": 0,
},
capacity_provider_strategies=[{
"capacityProvider": "string",
"weight": 0,
"base": 0,
}],
service_registries={
"registryArn": "string",
"containerName": "string",
"containerPort": 0,
"port": 0,
},
tags={
"string": "string",
},
external_id="string",
wait_until_stable=False,
wait_until_stable_timeout="string")
const taskSetResource = new aws.ecs.TaskSet("taskSetResource", {
service: "string",
cluster: "string",
taskDefinition: "string",
forceDelete: false,
launchType: "string",
loadBalancers: [{
containerName: "string",
containerPort: 0,
loadBalancerName: "string",
targetGroupArn: "string",
}],
networkConfiguration: {
subnets: ["string"],
assignPublicIp: false,
securityGroups: ["string"],
},
platformVersion: "string",
scale: {
unit: "string",
value: 0,
},
capacityProviderStrategies: [{
capacityProvider: "string",
weight: 0,
base: 0,
}],
serviceRegistries: {
registryArn: "string",
containerName: "string",
containerPort: 0,
port: 0,
},
tags: {
string: "string",
},
externalId: "string",
waitUntilStable: false,
waitUntilStableTimeout: "string",
});
type: aws:ecs:TaskSet
properties:
capacityProviderStrategies:
- base: 0
capacityProvider: string
weight: 0
cluster: string
externalId: string
forceDelete: false
launchType: string
loadBalancers:
- containerName: string
containerPort: 0
loadBalancerName: string
targetGroupArn: string
networkConfiguration:
assignPublicIp: false
securityGroups:
- string
subnets:
- string
platformVersion: string
scale:
unit: string
value: 0
service: string
serviceRegistries:
containerName: string
containerPort: 0
port: 0
registryArn: string
tags:
string: string
taskDefinition: string
waitUntilStable: false
waitUntilStableTimeout: string
TaskSet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The TaskSet resource accepts the following input properties:
- Cluster string
- The short name or ARN of the cluster that hosts the service to create the task set in.
- Service string
- The short name or ARN of the ECS service.
- Task
Definition string The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- Capacity
Provider List<TaskStrategies Set Capacity Provider Strategy> - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- External
Id string - The external ID associated with the task set.
- Force
Delete bool - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- Launch
Type string - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - Load
Balancers List<TaskSet Load Balancer> - Details on load balancers that are used with a task set. Detailed below.
- Network
Configuration TaskSet Network Configuration - 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. Detailed below. - Platform
Version string - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - Scale
Task
Set Scale - A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- Service
Registries TaskSet Service Registries - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - Dictionary<string, string>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - Wait
Until boolStable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - Wait
Until stringStable Timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
- Cluster string
- The short name or ARN of the cluster that hosts the service to create the task set in.
- Service string
- The short name or ARN of the ECS service.
- Task
Definition string The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- Capacity
Provider []TaskStrategies Set Capacity Provider Strategy Args - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- External
Id string - The external ID associated with the task set.
- Force
Delete bool - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- Launch
Type string - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - Load
Balancers []TaskSet Load Balancer Args - Details on load balancers that are used with a task set. Detailed below.
- Network
Configuration TaskSet Network Configuration Args - 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. Detailed below. - Platform
Version string - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - Scale
Task
Set Scale Args - A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- Service
Registries TaskSet Service Registries Args - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - map[string]string
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - Wait
Until boolStable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - Wait
Until stringStable Timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
- cluster String
- The short name or ARN of the cluster that hosts the service to create the task set in.
- service String
- The short name or ARN of the ECS service.
- task
Definition String The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- capacity
Provider List<TaskStrategies Set Capacity Provider Strategy> - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- external
Id String - The external ID associated with the task set.
- force
Delete Boolean - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- launch
Type String - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - load
Balancers List<TaskSet Load Balancer> - Details on load balancers that are used with a task set. Detailed below.
- network
Configuration TaskSet Network Configuration - 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. Detailed below. - platform
Version String - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - scale
Task
Set Scale - A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- service
Registries TaskSet Service Registries - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - Map<String,String>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - wait
Until BooleanStable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - wait
Until StringStable Timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
- cluster string
- The short name or ARN of the cluster that hosts the service to create the task set in.
- service string
- The short name or ARN of the ECS service.
- task
Definition string The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- capacity
Provider TaskStrategies Set Capacity Provider Strategy[] - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- external
Id string - The external ID associated with the task set.
- force
Delete boolean - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- launch
Type string - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - load
Balancers TaskSet Load Balancer[] - Details on load balancers that are used with a task set. Detailed below.
- network
Configuration TaskSet Network Configuration - 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. Detailed below. - platform
Version string - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - scale
Task
Set Scale - A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- service
Registries TaskSet Service Registries - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - {[key: string]: string}
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - wait
Until booleanStable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - wait
Until stringStable Timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
- cluster str
- The short name or ARN of the cluster that hosts the service to create the task set in.
- service str
- The short name or ARN of the ECS service.
- task_
definition str The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- capacity_
provider_ Sequence[Taskstrategies Set Capacity Provider Strategy Args] - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- external_
id str - The external ID associated with the task set.
- force_
delete bool - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- launch_
type str - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - load_
balancers Sequence[TaskSet Load Balancer Args] - Details on load balancers that are used with a task set. Detailed below.
- network_
configuration TaskSet Network Configuration Args - 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. Detailed below. - platform_
version str - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - scale
Task
Set Scale Args - A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- service_
registries TaskSet Service Registries Args - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - Mapping[str, str]
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - wait_
until_ boolstable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - wait_
until_ strstable_ timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
- cluster String
- The short name or ARN of the cluster that hosts the service to create the task set in.
- service String
- The short name or ARN of the ECS service.
- task
Definition String The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- capacity
Provider List<Property Map>Strategies - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- external
Id String - The external ID associated with the task set.
- force
Delete Boolean - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- launch
Type String - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - load
Balancers List<Property Map> - Details on load balancers that are used with a task set. Detailed below.
- network
Configuration Property Map - 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. Detailed below. - platform
Version String - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - scale Property Map
- A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- service
Registries Property Map - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - Map<String>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - wait
Until BooleanStable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - wait
Until StringStable Timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
Outputs
All input properties are implicitly available as output properties. Additionally, the TaskSet resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) that identifies the task set.
- Id string
- The provider-assigned unique ID for this managed resource.
- Stability
Status string - The stability status. This indicates whether the task set has reached a steady state.
- Status string
- The status of the task set.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Task
Set stringId - The ID of the task set.
- Arn string
- The Amazon Resource Name (ARN) that identifies the task set.
- Id string
- The provider-assigned unique ID for this managed resource.
- Stability
Status string - The stability status. This indicates whether the task set has reached a steady state.
- Status string
- The status of the task set.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Task
Set stringId - The ID of the task set.
- arn String
- The Amazon Resource Name (ARN) that identifies the task set.
- id String
- The provider-assigned unique ID for this managed resource.
- stability
Status String - The stability status. This indicates whether the task set has reached a steady state.
- status String
- The status of the task set.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - task
Set StringId - The ID of the task set.
- arn string
- The Amazon Resource Name (ARN) that identifies the task set.
- id string
- The provider-assigned unique ID for this managed resource.
- stability
Status string - The stability status. This indicates whether the task set has reached a steady state.
- status string
- The status of the task set.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - task
Set stringId - The ID of the task set.
- arn str
- The Amazon Resource Name (ARN) that identifies the task set.
- id str
- The provider-assigned unique ID for this managed resource.
- stability_
status str - The stability status. This indicates whether the task set has reached a steady state.
- status str
- The status of the task set.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - task_
set_ strid - The ID of the task set.
- arn String
- The Amazon Resource Name (ARN) that identifies the task set.
- id String
- The provider-assigned unique ID for this managed resource.
- stability
Status String - The stability status. This indicates whether the task set has reached a steady state.
- status String
- The status of the task set.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - task
Set StringId - The ID of the task set.
Look up Existing TaskSet Resource
Get an existing TaskSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TaskSetState, opts?: CustomResourceOptions): TaskSet
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
capacity_provider_strategies: Optional[Sequence[TaskSetCapacityProviderStrategyArgs]] = None,
cluster: Optional[str] = None,
external_id: Optional[str] = None,
force_delete: Optional[bool] = None,
launch_type: Optional[str] = None,
load_balancers: Optional[Sequence[TaskSetLoadBalancerArgs]] = None,
network_configuration: Optional[TaskSetNetworkConfigurationArgs] = None,
platform_version: Optional[str] = None,
scale: Optional[TaskSetScaleArgs] = None,
service: Optional[str] = None,
service_registries: Optional[TaskSetServiceRegistriesArgs] = None,
stability_status: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
task_definition: Optional[str] = None,
task_set_id: Optional[str] = None,
wait_until_stable: Optional[bool] = None,
wait_until_stable_timeout: Optional[str] = None) -> TaskSet
func GetTaskSet(ctx *Context, name string, id IDInput, state *TaskSetState, opts ...ResourceOption) (*TaskSet, error)
public static TaskSet Get(string name, Input<string> id, TaskSetState? state, CustomResourceOptions? opts = null)
public static TaskSet get(String name, Output<String> id, TaskSetState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The Amazon Resource Name (ARN) that identifies the task set.
- Capacity
Provider List<TaskStrategies Set Capacity Provider Strategy> - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- Cluster string
- The short name or ARN of the cluster that hosts the service to create the task set in.
- External
Id string - The external ID associated with the task set.
- Force
Delete bool - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- Launch
Type string - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - Load
Balancers List<TaskSet Load Balancer> - Details on load balancers that are used with a task set. Detailed below.
- Network
Configuration TaskSet Network Configuration - 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. Detailed below. - Platform
Version string - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - Scale
Task
Set Scale - A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- Service string
- The short name or ARN of the ECS service.
- Service
Registries TaskSet Service Registries - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - Stability
Status string - The stability status. This indicates whether the task set has reached a steady state.
- Status string
- The status of the task set.
- Dictionary<string, string>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Task
Definition string The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- Task
Set stringId - The ID of the task set.
- Wait
Until boolStable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - Wait
Until stringStable Timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
- Arn string
- The Amazon Resource Name (ARN) that identifies the task set.
- Capacity
Provider []TaskStrategies Set Capacity Provider Strategy Args - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- Cluster string
- The short name or ARN of the cluster that hosts the service to create the task set in.
- External
Id string - The external ID associated with the task set.
- Force
Delete bool - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- Launch
Type string - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - Load
Balancers []TaskSet Load Balancer Args - Details on load balancers that are used with a task set. Detailed below.
- Network
Configuration TaskSet Network Configuration Args - 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. Detailed below. - Platform
Version string - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - Scale
Task
Set Scale Args - A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- Service string
- The short name or ARN of the ECS service.
- Service
Registries TaskSet Service Registries Args - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - Stability
Status string - The stability status. This indicates whether the task set has reached a steady state.
- Status string
- The status of the task set.
- map[string]string
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Task
Definition string The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- Task
Set stringId - The ID of the task set.
- Wait
Until boolStable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - Wait
Until stringStable Timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
- arn String
- The Amazon Resource Name (ARN) that identifies the task set.
- capacity
Provider List<TaskStrategies Set Capacity Provider Strategy> - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- cluster String
- The short name or ARN of the cluster that hosts the service to create the task set in.
- external
Id String - The external ID associated with the task set.
- force
Delete Boolean - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- launch
Type String - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - load
Balancers List<TaskSet Load Balancer> - Details on load balancers that are used with a task set. Detailed below.
- network
Configuration TaskSet Network Configuration - 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. Detailed below. - platform
Version String - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - scale
Task
Set Scale - A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- service String
- The short name or ARN of the ECS service.
- service
Registries TaskSet Service Registries - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - stability
Status String - The stability status. This indicates whether the task set has reached a steady state.
- status String
- The status of the task set.
- Map<String,String>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - task
Definition String The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- task
Set StringId - The ID of the task set.
- wait
Until BooleanStable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - wait
Until StringStable Timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
- arn string
- The Amazon Resource Name (ARN) that identifies the task set.
- capacity
Provider TaskStrategies Set Capacity Provider Strategy[] - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- cluster string
- The short name or ARN of the cluster that hosts the service to create the task set in.
- external
Id string - The external ID associated with the task set.
- force
Delete boolean - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- launch
Type string - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - load
Balancers TaskSet Load Balancer[] - Details on load balancers that are used with a task set. Detailed below.
- network
Configuration TaskSet Network Configuration - 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. Detailed below. - platform
Version string - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - scale
Task
Set Scale - A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- service string
- The short name or ARN of the ECS service.
- service
Registries TaskSet Service Registries - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - stability
Status string - The stability status. This indicates whether the task set has reached a steady state.
- status string
- The status of the task set.
- {[key: string]: string}
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - task
Definition string The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- task
Set stringId - The ID of the task set.
- wait
Until booleanStable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - wait
Until stringStable Timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
- arn str
- The Amazon Resource Name (ARN) that identifies the task set.
- capacity_
provider_ Sequence[Taskstrategies Set Capacity Provider Strategy Args] - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- cluster str
- The short name or ARN of the cluster that hosts the service to create the task set in.
- external_
id str - The external ID associated with the task set.
- force_
delete bool - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- launch_
type str - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - load_
balancers Sequence[TaskSet Load Balancer Args] - Details on load balancers that are used with a task set. Detailed below.
- network_
configuration TaskSet Network Configuration Args - 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. Detailed below. - platform_
version str - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - scale
Task
Set Scale Args - A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- service str
- The short name or ARN of the ECS service.
- service_
registries TaskSet Service Registries Args - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - stability_
status str - The stability status. This indicates whether the task set has reached a steady state.
- status str
- The status of the task set.
- Mapping[str, str]
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - task_
definition str The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- task_
set_ strid - The ID of the task set.
- wait_
until_ boolstable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - wait_
until_ strstable_ timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
- arn String
- The Amazon Resource Name (ARN) that identifies the task set.
- capacity
Provider List<Property Map>Strategies - The capacity provider strategy to use for the service. Can be one or more. Defined below.
- cluster String
- The short name or ARN of the cluster that hosts the service to create the task set in.
- external
Id String - The external ID associated with the task set.
- force
Delete Boolean - Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, the provider drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling.
- launch
Type String - The launch type on which to run your service. The valid values are
EC2
,FARGATE
, andEXTERNAL
. Defaults toEC2
. - load
Balancers List<Property Map> - Details on load balancers that are used with a task set. Detailed below.
- network
Configuration Property Map - 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. Detailed below. - platform
Version String - The platform version on which to run your service. Only applicable for
launch_type
set toFARGATE
. Defaults toLATEST
. More information about Fargate platform versions can be found in the AWS ECS User Guide. - scale Property Map
- A floating-point percentage of the desired number of tasks to place and keep running in the task set. Detailed below.
- service String
- The short name or ARN of the ECS service.
- service
Registries Property Map - The service discovery registries for the service. The maximum number of
service_registries
blocks is1
. Detailed below. - stability
Status String - The stability status. This indicates whether the task set has reached a steady state.
- status String
- The status of the task set.
- Map<String>
- A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backups
to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - task
Definition String The family and revision (
family:revision
) or full ARN of the task definition that you want to run in your service.The following arguments are optional:
- task
Set StringId - The ID of the task set.
- wait
Until BooleanStable - Whether the provider should wait until the task set has reached
STEADY_STATE
. - wait
Until StringStable Timeout - Wait timeout for task set to reach
STEADY_STATE
. Valid time units includens
,us
(orµs
),ms
,s
,m
, andh
. Default10m
.
Supporting Types
TaskSetCapacityProviderStrategy, TaskSetCapacityProviderStrategyArgs
- Capacity
Provider string - The short name or full Amazon Resource Name (ARN) of the capacity provider.
- Weight int
- The relative percentage of the total number of launched tasks that should use the specified capacity provider.
- Base int
- The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
- Capacity
Provider string - The short name or full Amazon Resource Name (ARN) of the capacity provider.
- Weight int
- The relative percentage of the total number of launched tasks that should use the specified capacity provider.
- Base int
- The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
- capacity
Provider String - The short name or full Amazon Resource Name (ARN) of the capacity provider.
- weight Integer
- The relative percentage of the total number of launched tasks that should use the specified capacity provider.
- base Integer
- The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
- capacity
Provider string - The short name or full Amazon Resource Name (ARN) of the capacity provider.
- weight number
- The relative percentage of the total number of launched tasks that should use the specified capacity provider.
- base number
- The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
- capacity_
provider str - The short name or full Amazon Resource Name (ARN) of the capacity provider.
- weight int
- The relative percentage of the total number of launched tasks that should use the specified capacity provider.
- base int
- The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
- capacity
Provider String - The short name or full Amazon Resource Name (ARN) of the capacity provider.
- weight Number
- The relative percentage of the total number of launched tasks that should use the specified capacity provider.
- base Number
- The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
TaskSetLoadBalancer, TaskSetLoadBalancerArgs
- Container
Name string - The name of the container to associate with the load balancer (as it appears in a container definition).
- Container
Port int The port on the container to associate with the load balancer. Defaults to
0
if not specified.Note: Specifying multiple
load_balancer
configurations is still not supported by AWS for ECS task set.- Load
Balancer stringName - The name of the ELB (Classic) to associate with the service.
- Target
Group stringArn - The ARN of the Load Balancer target group to associate with the service.
- Container
Name string - The name of the container to associate with the load balancer (as it appears in a container definition).
- Container
Port int The port on the container to associate with the load balancer. Defaults to
0
if not specified.Note: Specifying multiple
load_balancer
configurations is still not supported by AWS for ECS task set.- Load
Balancer stringName - The name of the ELB (Classic) to associate with the service.
- Target
Group stringArn - The ARN of the Load Balancer target group to associate with the service.
- container
Name String - The name of the container to associate with the load balancer (as it appears in a container definition).
- container
Port Integer The port on the container to associate with the load balancer. Defaults to
0
if not specified.Note: Specifying multiple
load_balancer
configurations is still not supported by AWS for ECS task set.- load
Balancer StringName - The name of the ELB (Classic) to associate with the service.
- target
Group StringArn - The ARN of the Load Balancer target group to associate with the service.
- container
Name string - The name of the container to associate with the load balancer (as it appears in a container definition).
- container
Port number The port on the container to associate with the load balancer. Defaults to
0
if not specified.Note: Specifying multiple
load_balancer
configurations is still not supported by AWS for ECS task set.- load
Balancer stringName - The name of the ELB (Classic) to associate with the service.
- target
Group stringArn - The ARN of the Load Balancer target group to associate with the service.
- container_
name str - The name of the container to associate with the load balancer (as it appears in a container definition).
- container_
port int The port on the container to associate with the load balancer. Defaults to
0
if not specified.Note: Specifying multiple
load_balancer
configurations is still not supported by AWS for ECS task set.- load_
balancer_ strname - The name of the ELB (Classic) to associate with the service.
- target_
group_ strarn - The ARN of the Load Balancer target group to associate with the service.
- container
Name String - The name of the container to associate with the load balancer (as it appears in a container definition).
- container
Port Number The port on the container to associate with the load balancer. Defaults to
0
if not specified.Note: Specifying multiple
load_balancer
configurations is still not supported by AWS for ECS task set.- load
Balancer StringName - The name of the ELB (Classic) to associate with the service.
- target
Group StringArn - The ARN of the Load Balancer target group to associate with the service.
TaskSetNetworkConfiguration, TaskSetNetworkConfigurationArgs
- Subnets List<string>
- The subnets associated with the task or service. Maximum of 16.
- Assign
Public boolIp Whether to assign a public IP address to the ENI (
FARGATE
launch type only). Valid values aretrue
orfalse
. Defaultfalse
.For more information, see Task Networking.
- Security
Groups List<string> - The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. Maximum of 5.
- Subnets []string
- The subnets associated with the task or service. Maximum of 16.
- Assign
Public boolIp Whether to assign a public IP address to the ENI (
FARGATE
launch type only). Valid values aretrue
orfalse
. Defaultfalse
.For more information, see Task Networking.
- Security
Groups []string - The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. Maximum of 5.
- subnets List<String>
- The subnets associated with the task or service. Maximum of 16.
- assign
Public BooleanIp Whether to assign a public IP address to the ENI (
FARGATE
launch type only). Valid values aretrue
orfalse
. Defaultfalse
.For more information, see Task Networking.
- security
Groups List<String> - The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. Maximum of 5.
- subnets string[]
- The subnets associated with the task or service. Maximum of 16.
- assign
Public booleanIp Whether to assign a public IP address to the ENI (
FARGATE
launch type only). Valid values aretrue
orfalse
. Defaultfalse
.For more information, see Task Networking.
- security
Groups string[] - The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. Maximum of 5.
- subnets Sequence[str]
- The subnets associated with the task or service. Maximum of 16.
- assign_
public_ boolip Whether to assign a public IP address to the ENI (
FARGATE
launch type only). Valid values aretrue
orfalse
. Defaultfalse
.For more information, see Task Networking.
- security_
groups Sequence[str] - The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. Maximum of 5.
- subnets List<String>
- The subnets associated with the task or service. Maximum of 16.
- assign
Public BooleanIp Whether to assign a public IP address to the ENI (
FARGATE
launch type only). Valid values aretrue
orfalse
. Defaultfalse
.For more information, see Task Networking.
- security
Groups List<String> - The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. Maximum of 5.
TaskSetScale, TaskSetScaleArgs
TaskSetServiceRegistries, TaskSetServiceRegistriesArgs
- Registry
Arn string - The ARN of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service(
aws.servicediscovery.Service
resource). For more information, see Service. - Container
Name string - The container name value, already specified in the task definition, to be used for your service discovery service.
- Container
Port int - The port value, already specified in the task definition, to be used for your service discovery service.
- Port int
- The port value used if your Service Discovery service specified an SRV record.
- Registry
Arn string - The ARN of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service(
aws.servicediscovery.Service
resource). For more information, see Service. - Container
Name string - The container name value, already specified in the task definition, to be used for your service discovery service.
- Container
Port int - The port value, already specified in the task definition, to be used for your service discovery service.
- Port int
- The port value used if your Service Discovery service specified an SRV record.
- registry
Arn String - The ARN of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service(
aws.servicediscovery.Service
resource). For more information, see Service. - container
Name String - The container name value, already specified in the task definition, to be used for your service discovery service.
- container
Port Integer - The port value, already specified in the task definition, to be used for your service discovery service.
- port Integer
- The port value used if your Service Discovery service specified an SRV record.
- registry
Arn string - The ARN of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service(
aws.servicediscovery.Service
resource). For more information, see Service. - container
Name string - The container name value, already specified in the task definition, to be used for your service discovery service.
- container
Port number - The port value, already specified in the task definition, to be used for your service discovery service.
- port number
- The port value used if your Service Discovery service specified an SRV record.
- registry_
arn str - The ARN of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service(
aws.servicediscovery.Service
resource). For more information, see Service. - container_
name str - The container name value, already specified in the task definition, to be used for your service discovery service.
- container_
port int - The port value, already specified in the task definition, to be used for your service discovery service.
- port int
- The port value used if your Service Discovery service specified an SRV record.
- registry
Arn String - The ARN of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service(
aws.servicediscovery.Service
resource). For more information, see Service. - container
Name String - The container name value, already specified in the task definition, to be used for your service discovery service.
- container
Port Number - The port value, already specified in the task definition, to be used for your service discovery service.
- port Number
- The port value used if your Service Discovery service specified an SRV record.
Import
Using pulumi import
, import ECS Task Sets using the task_set_id
, service
, and cluster
separated by commas (,
). For example:
$ pulumi import aws:ecs/taskSet:TaskSet example ecs-svc/7177320696926227436,arn:aws:ecs:us-west-2:123456789101:service/example/example-1234567890,arn:aws:ecs:us-west-2:123456789101:cluster/example
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.