Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ecs
  5. TaskSet

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ecs.TaskSet

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    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,
            cluster: Optional[str] = None,
            service: Optional[str] = None,
            task_definition: Optional[str] = None,
            capacity_provider_strategy: Optional[Sequence[TaskSetCapacityProviderStrategyItemArgs]] = None,
            external_id: Optional[str] = None,
            launch_type: Optional[TaskSetLaunchType] = None,
            load_balancers: Optional[Sequence[TaskSetLoadBalancerArgs]] = None,
            network_configuration: Optional[TaskSetNetworkConfigurationArgs] = None,
            platform_version: Optional[str] = None,
            scale: Optional[TaskSetScaleArgs] = None,
            service_registries: Optional[Sequence[TaskSetServiceRegistryArgs]] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native: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.

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TaskSet resource accepts the following input properties:

    Cluster string
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    Service string
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
    TaskDefinition string
    The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
    CapacityProviderStrategy List<Pulumi.AwsNative.Ecs.Inputs.TaskSetCapacityProviderStrategyItem>
    The capacity provider strategy that are associated with the task set.
    ExternalId string
    An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
    LaunchType Pulumi.AwsNative.Ecs.TaskSetLaunchType
    The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide.
    LoadBalancers List<Pulumi.AwsNative.Ecs.Inputs.TaskSetLoadBalancer>
    A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
    NetworkConfiguration Pulumi.AwsNative.Ecs.Inputs.TaskSetNetworkConfiguration
    The network configuration for the task set.
    PlatformVersion string
    The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
    Scale Pulumi.AwsNative.Ecs.Inputs.TaskSetScale
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    ServiceRegistries List<Pulumi.AwsNative.Ecs.Inputs.TaskSetServiceRegistry>
    The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.
    Tags List<Pulumi.AwsNative.Inputs.Tag>

    The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

    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.
    Cluster string
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    Service string
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
    TaskDefinition string
    The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
    CapacityProviderStrategy []TaskSetCapacityProviderStrategyItemArgs
    The capacity provider strategy that are associated with the task set.
    ExternalId string
    An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
    LaunchType TaskSetLaunchType
    The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide.
    LoadBalancers []TaskSetLoadBalancerArgs
    A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
    NetworkConfiguration TaskSetNetworkConfigurationArgs
    The network configuration for the task set.
    PlatformVersion string
    The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
    Scale TaskSetScaleArgs
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    ServiceRegistries []TaskSetServiceRegistryArgs
    The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.
    Tags TagArgs

    The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

    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.
    cluster String
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    service String
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
    taskDefinition String
    The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
    capacityProviderStrategy List<TaskSetCapacityProviderStrategyItem>
    The capacity provider strategy that are associated with the task set.
    externalId String
    An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
    launchType TaskSetLaunchType
    The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide.
    loadBalancers List<TaskSetLoadBalancer>
    A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
    networkConfiguration TaskSetNetworkConfiguration
    The network configuration for the task set.
    platformVersion String
    The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
    scale TaskSetScale
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    serviceRegistries List<TaskSetServiceRegistry>
    The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.
    tags List<Tag>

    The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

    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.
    cluster string
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    service string
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
    taskDefinition string
    The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
    capacityProviderStrategy TaskSetCapacityProviderStrategyItem[]
    The capacity provider strategy that are associated with the task set.
    externalId string
    An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
    launchType TaskSetLaunchType
    The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide.
    loadBalancers TaskSetLoadBalancer[]
    A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
    networkConfiguration TaskSetNetworkConfiguration
    The network configuration for the task set.
    platformVersion string
    The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
    scale TaskSetScale
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    serviceRegistries TaskSetServiceRegistry[]
    The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.
    tags Tag[]

    The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

    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.
    cluster str
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    service str
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
    task_definition str
    The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
    capacity_provider_strategy Sequence[TaskSetCapacityProviderStrategyItemArgs]
    The capacity provider strategy that are associated with the task set.
    external_id str
    An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
    launch_type TaskSetLaunchType
    The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide.
    load_balancers Sequence[TaskSetLoadBalancerArgs]
    A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
    network_configuration TaskSetNetworkConfigurationArgs
    The network configuration for the task set.
    platform_version str
    The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
    scale TaskSetScaleArgs
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    service_registries Sequence[TaskSetServiceRegistryArgs]
    The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.
    tags Sequence[TagArgs]

    The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

    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.
    cluster String
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    service String
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
    taskDefinition String
    The short name or full Amazon Resource Name (ARN) of the task definition for the tasks in the task set to use.
    capacityProviderStrategy List<Property Map>
    The capacity provider strategy that are associated with the task set.
    externalId String
    An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.
    launchType "EC2" | "FARGATE"
    The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide.
    loadBalancers List<Property Map>
    A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
    networkConfiguration Property Map
    The network configuration for the task set.
    platformVersion String
    The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.
    scale Property Map
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    serviceRegistries List<Property Map>
    The details of the service discovery registries to assign to this task set. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html.
    tags List<Property Map>

    The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both.

    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TaskSet resource produces the following output properties:

    AwsId string
    The ID of the task set.
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    The ID of the task set.
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    The ID of the task set.
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    The ID of the task set.
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    The ID of the task set.
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    The ID of the task set.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TaskSetAwsVpcConfiguration, TaskSetAwsVpcConfigurationArgs

    Subnets List<string>
    The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.
    AssignPublicIp Pulumi.AwsNative.Ecs.TaskSetAwsVpcConfigurationAssignPublicIp
    Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.
    SecurityGroups 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. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.
    Subnets []string
    The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.
    AssignPublicIp TaskSetAwsVpcConfigurationAssignPublicIp
    Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.
    SecurityGroups []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. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.
    subnets List<String>
    The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.
    assignPublicIp TaskSetAwsVpcConfigurationAssignPublicIp
    Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.
    securityGroups 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. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.
    subnets string[]
    The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.
    assignPublicIp TaskSetAwsVpcConfigurationAssignPublicIp
    Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.
    securityGroups 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. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.
    subnets Sequence[str]
    The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.
    assign_public_ip TaskSetAwsVpcConfigurationAssignPublicIp
    Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.
    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. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.
    subnets List<String>
    The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.
    assignPublicIp "DISABLED" | "ENABLED"
    Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.
    securityGroups 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. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.

    TaskSetAwsVpcConfigurationAssignPublicIp, TaskSetAwsVpcConfigurationAssignPublicIpArgs

    Disabled
    DISABLED
    Enabled
    ENABLED
    TaskSetAwsVpcConfigurationAssignPublicIpDisabled
    DISABLED
    TaskSetAwsVpcConfigurationAssignPublicIpEnabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    DISABLED
    DISABLED
    ENABLED
    ENABLED
    "DISABLED"
    DISABLED
    "ENABLED"
    ENABLED

    TaskSetCapacityProviderStrategyItem, TaskSetCapacityProviderStrategyItemArgs

    Base int
    The base value designates how many 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. If no value is specified, the default value of 0 is used.
    CapacityProvider string
    The short name of the capacity provider.
    Weight int

    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

    If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0 , any RunTask or CreateService actions using the capacity provider strategy will fail.

    An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that's run using capacityProviderA , four tasks would use capacityProviderB .

    Base int
    The base value designates how many 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. If no value is specified, the default value of 0 is used.
    CapacityProvider string
    The short name of the capacity provider.
    Weight int

    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

    If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0 , any RunTask or CreateService actions using the capacity provider strategy will fail.

    An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that's run using capacityProviderA , four tasks would use capacityProviderB .

    base Integer
    The base value designates how many 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. If no value is specified, the default value of 0 is used.
    capacityProvider String
    The short name of the capacity provider.
    weight Integer

    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

    If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0 , any RunTask or CreateService actions using the capacity provider strategy will fail.

    An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that's run using capacityProviderA , four tasks would use capacityProviderB .

    base number
    The base value designates how many 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. If no value is specified, the default value of 0 is used.
    capacityProvider string
    The short name of the capacity provider.
    weight number

    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

    If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0 , any RunTask or CreateService actions using the capacity provider strategy will fail.

    An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that's run using capacityProviderA , four tasks would use capacityProviderB .

    base int
    The base value designates how many 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. If no value is specified, the default value of 0 is used.
    capacity_provider str
    The short name of the capacity provider.
    weight int

    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

    If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0 , any RunTask or CreateService actions using the capacity provider strategy will fail.

    An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that's run using capacityProviderA , four tasks would use capacityProviderB .

    base Number
    The base value designates how many 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. If no value is specified, the default value of 0 is used.
    capacityProvider String
    The short name of the capacity provider.
    weight Number

    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

    If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0 , any RunTask or CreateService actions using the capacity provider strategy will fail.

    An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that's run using capacityProviderA , four tasks would use capacityProviderB .

    TaskSetLaunchType, TaskSetLaunchTypeArgs

    Ec2
    EC2
    Fargate
    FARGATE
    TaskSetLaunchTypeEc2
    EC2
    TaskSetLaunchTypeFargate
    FARGATE
    Ec2
    EC2
    Fargate
    FARGATE
    Ec2
    EC2
    Fargate
    FARGATE
    EC2
    EC2
    FARGATE
    FARGATE
    "EC2"
    EC2
    "FARGATE"
    FARGATE

    TaskSetLoadBalancer, TaskSetLoadBalancerArgs

    ContainerName string
    The name of the container (as it appears in a container definition) to associate with the load balancer.
    ContainerPort int
    The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
    TargetGroupArn string
    The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
    ContainerName string
    The name of the container (as it appears in a container definition) to associate with the load balancer.
    ContainerPort int
    The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
    TargetGroupArn string
    The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
    containerName String
    The name of the container (as it appears in a container definition) to associate with the load balancer.
    containerPort Integer
    The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
    targetGroupArn String
    The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
    containerName string
    The name of the container (as it appears in a container definition) to associate with the load balancer.
    containerPort number
    The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
    targetGroupArn string
    The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
    container_name str
    The name of the container (as it appears in a container definition) to associate with the load balancer.
    container_port int
    The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
    target_group_arn str
    The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.
    containerName String
    The name of the container (as it appears in a container definition) to associate with the load balancer.
    containerPort Number
    The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
    targetGroupArn String
    The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

    TaskSetNetworkConfiguration, TaskSetNetworkConfigurationArgs

    AwsVpcConfiguration Pulumi.AwsNative.Ecs.Inputs.TaskSetAwsVpcConfiguration

    The VPC subnets and security groups that are associated with a task.

    All specified subnets and security groups must be from the same VPC.

    AwsVpcConfiguration TaskSetAwsVpcConfiguration

    The VPC subnets and security groups that are associated with a task.

    All specified subnets and security groups must be from the same VPC.

    awsVpcConfiguration TaskSetAwsVpcConfiguration

    The VPC subnets and security groups that are associated with a task.

    All specified subnets and security groups must be from the same VPC.

    awsVpcConfiguration TaskSetAwsVpcConfiguration

    The VPC subnets and security groups that are associated with a task.

    All specified subnets and security groups must be from the same VPC.

    aws_vpc_configuration TaskSetAwsVpcConfiguration

    The VPC subnets and security groups that are associated with a task.

    All specified subnets and security groups must be from the same VPC.

    awsVpcConfiguration Property Map

    The VPC subnets and security groups that are associated with a task.

    All specified subnets and security groups must be from the same VPC.

    TaskSetScale, TaskSetScaleArgs

    Unit Pulumi.AwsNative.Ecs.TaskSetScaleUnit
    The unit of measure for the scale value.
    Value double
    The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.
    Unit TaskSetScaleUnit
    The unit of measure for the scale value.
    Value float64
    The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.
    unit TaskSetScaleUnit
    The unit of measure for the scale value.
    value Double
    The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.
    unit TaskSetScaleUnit
    The unit of measure for the scale value.
    value number
    The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.
    unit TaskSetScaleUnit
    The unit of measure for the scale value.
    value float
    The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.
    unit "PERCENT"
    The unit of measure for the scale value.
    value Number
    The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.

    TaskSetScaleUnit, TaskSetScaleUnitArgs

    Percent
    PERCENT
    TaskSetScaleUnitPercent
    PERCENT
    Percent
    PERCENT
    Percent
    PERCENT
    PERCENT
    PERCENT
    "PERCENT"
    PERCENT

    TaskSetServiceRegistry, TaskSetServiceRegistryArgs

    ContainerName string
    The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    ContainerPort int
    The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    Port int
    The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
    RegistryArn string
    The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html
    ContainerName string
    The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    ContainerPort int
    The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    Port int
    The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
    RegistryArn string
    The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html
    containerName String
    The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    containerPort Integer
    The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    port Integer
    The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
    registryArn String
    The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html
    containerName string
    The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    containerPort number
    The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    port number
    The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
    registryArn string
    The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html
    container_name str
    The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    container_port int
    The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    port int
    The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
    registry_arn str
    The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html
    containerName String
    The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    containerPort Number
    The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.
    port Number
    The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.
    registryArn String
    The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native