Package software.amazon.awssdk.services.ecs.model

Interface CreateTaskSetRequest.Builder

    • Method Detail

      • service

        CreateTaskSetRequest.Builder service​(String service)

        The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

        Parameters:
        service - The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cluster

        CreateTaskSetRequest.Builder cluster​(String cluster)

        The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

        Parameters:
        cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • externalId

        CreateTaskSetRequest.Builder externalId​(String externalId)

        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 Cloud Map attribute set to the provided value.

        Parameters:
        externalId - 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 Cloud Map attribute set to the provided value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • taskDefinition

        CreateTaskSetRequest.Builder taskDefinition​(String taskDefinition)

        The task definition for the tasks in the task set to use. If a revision isn't specified, the latest ACTIVE revision is used.

        Parameters:
        taskDefinition - The task definition for the tasks in the task set to use. If a revision isn't specified, the latest ACTIVE revision is used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • networkConfiguration

        CreateTaskSetRequest.Builder networkConfiguration​(NetworkConfiguration networkConfiguration)

        An object representing the network configuration for a task set.

        Parameters:
        networkConfiguration - An object representing the network configuration for a task set.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • loadBalancers

        CreateTaskSetRequest.Builder loadBalancers​(Collection<LoadBalancer> loadBalancers)

        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.

        Parameters:
        loadBalancers - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • loadBalancers

        CreateTaskSetRequest.Builder loadBalancers​(LoadBalancer... loadBalancers)

        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.

        Parameters:
        loadBalancers - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • loadBalancers

        CreateTaskSetRequest.Builder loadBalancers​(Consumer<LoadBalancer.Builder>... loadBalancers)

        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.

        This is a convenience method that creates an instance of the LoadBalancer.Builder avoiding the need to create one manually via LoadBalancer.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #loadBalancers(List).

        Parameters:
        loadBalancers - a consumer that will call methods on LoadBalancer.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #loadBalancers(java.util.Collection)

      • serviceRegistries

        CreateTaskSetRequest.Builder serviceRegistries​(Collection<ServiceRegistry> serviceRegistries)

        The details of the service discovery registries to assign to this task set. For more information, see Service discovery.

        Parameters:
        serviceRegistries - The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceRegistries

        CreateTaskSetRequest.Builder serviceRegistries​(ServiceRegistry... serviceRegistries)

        The details of the service discovery registries to assign to this task set. For more information, see Service discovery.

        Parameters:
        serviceRegistries - The details of the service discovery registries to assign to this task set. For more information, see Service discovery.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • launchType

        CreateTaskSetRequest.Builder launchType​(String launchType)

        The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

        If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

        Parameters:
        launchType - The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

        If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LaunchType, LaunchType

      • launchType

        CreateTaskSetRequest.Builder launchType​(LaunchType launchType)

        The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

        If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

        Parameters:
        launchType - The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

        If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LaunchType, LaunchType

      • capacityProviderStrategy

        CreateTaskSetRequest.Builder capacityProviderStrategy​(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)

        The capacity provider strategy to use for the task set.

        A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

        If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

        The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

        Parameters:
        capacityProviderStrategy - The capacity provider strategy to use for the task set.

        A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

        If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

        The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • capacityProviderStrategy

        CreateTaskSetRequest.Builder capacityProviderStrategy​(CapacityProviderStrategyItem... capacityProviderStrategy)

        The capacity provider strategy to use for the task set.

        A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

        If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

        The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

        Parameters:
        capacityProviderStrategy - The capacity provider strategy to use for the task set.

        A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

        If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

        The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • capacityProviderStrategy

        CreateTaskSetRequest.Builder capacityProviderStrategy​(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)

        The capacity provider strategy to use for the task set.

        A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

        If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

        If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

        To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

        The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

        This is a convenience method that creates an instance of the CapacityProviderStrategyItem.Builder avoiding the need to create one manually via CapacityProviderStrategyItem.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #capacityProviderStrategy(List).

        Parameters:
        capacityProviderStrategy - a consumer that will call methods on CapacityProviderStrategyItem.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #capacityProviderStrategy(java.util.Collection)

      • platformVersion

        CreateTaskSetRequest.Builder platformVersion​(String platformVersion)

        The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.

        Parameters:
        platformVersion - The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scale

        CreateTaskSetRequest.Builder scale​(Scale scale)

        A floating-point percentage of the desired number of tasks to place and keep running in the task set.

        Parameters:
        scale - A floating-point percentage of the desired number of tasks to place and keep running in the task set.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

        CreateTaskSetRequest.Builder clientToken​(String clientToken)

        An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

        Parameters:
        clientToken - An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateTaskSetRequest.Builder tags​(Collection<Tag> tags)

        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. When a service is deleted, the tags are deleted.

        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 Amazon Web Services 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.

        Parameters:
        tags - 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. When a service is deleted, the tags are deleted.

        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 Amazon Web Services 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateTaskSetRequest.Builder tags​(Tag... tags)

        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. When a service is deleted, the tags are deleted.

        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 Amazon Web Services 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.

        Parameters:
        tags - 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. When a service is deleted, the tags are deleted.

        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 Amazon Web Services 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateTaskSetRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        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. When a service is deleted, the tags are deleted.

        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 Amazon Web Services 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.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)