1. Packages
  2. AWS Native
  3. API Docs
  4. ecs
  5. getTaskSet

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

aws-native.ecs.getTaskSet

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

    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.

    Using getTaskSet

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTaskSet(args: GetTaskSetArgs, opts?: InvokeOptions): Promise<GetTaskSetResult>
    function getTaskSetOutput(args: GetTaskSetOutputArgs, opts?: InvokeOptions): Output<GetTaskSetResult>
    def get_task_set(cluster: Optional[str] = None,
                     id: Optional[str] = None,
                     service: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetTaskSetResult
    def get_task_set_output(cluster: Optional[pulumi.Input[str]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     service: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetTaskSetResult]
    func LookupTaskSet(ctx *Context, args *LookupTaskSetArgs, opts ...InvokeOption) (*LookupTaskSetResult, error)
    func LookupTaskSetOutput(ctx *Context, args *LookupTaskSetOutputArgs, opts ...InvokeOption) LookupTaskSetResultOutput

    > Note: This function is named LookupTaskSet in the Go SDK.

    public static class GetTaskSet 
    {
        public static Task<GetTaskSetResult> InvokeAsync(GetTaskSetArgs args, InvokeOptions? opts = null)
        public static Output<GetTaskSetResult> Invoke(GetTaskSetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTaskSetResult> getTaskSet(GetTaskSetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:ecs:getTaskSet
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Cluster string
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    Id string
    The ID of the task set.
    Service string
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
    Cluster string
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    Id string
    The ID of the task set.
    Service string
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
    cluster String
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    id String
    The ID of the task set.
    service String
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
    cluster string
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    id string
    The ID of the task set.
    service string
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
    cluster str
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    id str
    The ID of the task set.
    service str
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
    cluster String
    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
    id String
    The ID of the task set.
    service String
    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

    getTaskSet Result

    The following output properties are available:

    Id string
    The ID of the task set.
    Scale Pulumi.AwsNative.Ecs.Outputs.TaskSetScale
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    Tags List<Pulumi.AwsNative.Outputs.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.
    Id string
    The ID of the task set.
    Scale TaskSetScale
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    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.
    id String
    The ID of the task set.
    scale TaskSetScale
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    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.
    id string
    The ID of the task set.
    scale TaskSetScale
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    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.
    id str
    The ID of the task set.
    scale TaskSetScale
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    tags Sequence[root_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.
    id String
    The ID of the task set.
    scale Property Map
    A floating-point percentage of the desired number of tasks to place and keep running in the task set.
    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.

    Supporting Types

    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 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

    TaskSetScale

    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

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi