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

Interface Service.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Service.Builder,Service>, SdkBuilder<Service.Builder,Service>, SdkPojo
Enclosing class:
Service
public static interface Service.Builder extends SdkPojo, CopyableBuilder<Service.Builder,Service>

  • Method Details

    • serviceArn

      Service.Builder serviceArn(String serviceArn)

      The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

      Parameters:
      serviceArn - The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceName

      Service.Builder serviceName(String serviceName)

      The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.

      Parameters:
      serviceName - The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterArn

      Service.Builder clusterArn(String clusterArn)

      The Amazon Resource Name (ARN) of the cluster that hosts the service.

      Parameters:
      clusterArn - The Amazon Resource Name (ARN) of the cluster that hosts the service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loadBalancers

      Service.Builder loadBalancers(Collection<LoadBalancer> loadBalancers)

      A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

      Parameters:
      loadBalancers - A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loadBalancers

      Service.Builder loadBalancers(LoadBalancer... loadBalancers)

      A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

      Parameters:
      loadBalancers - A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loadBalancers

      Service.Builder loadBalancers(Consumer<LoadBalancer.Builder>... loadBalancers)

      A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

      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<LoadBalancer>).

      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:

    • serviceRegistries

      Service.Builder serviceRegistries(Collection<ServiceRegistry> serviceRegistries)

      The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

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

    • serviceRegistries

      Service.Builder serviceRegistries(ServiceRegistry... serviceRegistries)

      The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

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

    • serviceRegistries

      Service.Builder serviceRegistries(Consumer<ServiceRegistry.Builder>... serviceRegistries)

      The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serviceRegistries(List<ServiceRegistry>).

      Parameters:
      serviceRegistries - a consumer that will call methods on ServiceRegistry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Service.Builder status(String status)

      The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

      Parameters:
      status - The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • desiredCount

      Service.Builder desiredCount(Integer desiredCount)

      The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

      Parameters:
      desiredCount - The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runningCount

      Service.Builder runningCount(Integer runningCount)

      The number of tasks in the cluster that are in the RUNNING state.

      Parameters:
      runningCount - The number of tasks in the cluster that are in the RUNNING state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pendingCount

      Service.Builder pendingCount(Integer pendingCount)

      The number of tasks in the cluster that are in the PENDING state.

      Parameters:
      pendingCount - The number of tasks in the cluster that are in the PENDING state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchType

      Service.Builder launchType(String launchType)

      The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.

      Parameters:
      launchType - The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • launchType

      Service.Builder launchType(LaunchType launchType)

      The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.

      Parameters:
      launchType - The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capacityProviderStrategy

      Service.Builder capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)

      The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

      Parameters:
      capacityProviderStrategy - The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityProviderStrategy

      Service.Builder capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)

      The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

      Parameters:
      capacityProviderStrategy - The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityProviderStrategy

      Service.Builder capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)

      The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

      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<CapacityProviderStrategyItem>).

      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:

    • platformVersion

      Service.Builder platformVersion(String platformVersion)

      The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      platformVersion - The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platformFamily

      Service.Builder platformFamily(String platformFamily)

      The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.

      All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX).

      Parameters:
      platformFamily - The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.

      All tasks that run as part of this service must use the same platformFamily value as the service (for example, LINUX).

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

    • taskDefinition

      Service.Builder taskDefinition(String taskDefinition)

      The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

      Parameters:
      taskDefinition - The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentConfiguration

      Service.Builder deploymentConfiguration(DeploymentConfiguration deploymentConfiguration)

      Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

      Parameters:
      deploymentConfiguration - Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentConfiguration

      default Service.Builder deploymentConfiguration(Consumer<DeploymentConfiguration.Builder> deploymentConfiguration)

      Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deploymentConfiguration(DeploymentConfiguration).

      Parameters:
      deploymentConfiguration - a consumer that will call methods on DeploymentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • taskSets

      Service.Builder taskSets(Collection<TaskSet> taskSets)

      Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

      Parameters:
      taskSets - Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskSets

      Service.Builder taskSets(TaskSet... taskSets)

      Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

      Parameters:
      taskSets - Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskSets

      Service.Builder taskSets(Consumer<TaskSet.Builder>... taskSets)

      Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taskSets(List<TaskSet>).

      Parameters:
      taskSets - a consumer that will call methods on TaskSet.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deployments

      Service.Builder deployments(Collection<Deployment> deployments)

      The current state of deployments for the service.

      Parameters:
      deployments - The current state of deployments for the service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deployments

      Service.Builder deployments(Deployment... deployments)

      The current state of deployments for the service.

      Parameters:
      deployments - The current state of deployments for the service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deployments

      Service.Builder deployments(Consumer<Deployment.Builder>... deployments)

      The current state of deployments for the service.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deployments(List<Deployment>).

      Parameters:
      deployments - a consumer that will call methods on Deployment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      Service.Builder roleArn(String roleArn)

      The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

      Parameters:
      roleArn - The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • events

      Service.Builder events(Collection<ServiceEvent> events)

      The event stream for your service. A maximum of 100 of the latest events are displayed.

      Parameters:
      events - The event stream for your service. A maximum of 100 of the latest events are displayed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • events

      Service.Builder events(ServiceEvent... events)

      The event stream for your service. A maximum of 100 of the latest events are displayed.

      Parameters:
      events - The event stream for your service. A maximum of 100 of the latest events are displayed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • events

      Service.Builder events(Consumer<ServiceEvent.Builder>... events)

      The event stream for your service. A maximum of 100 of the latest events are displayed.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to events(List<ServiceEvent>).

      Parameters:
      events - a consumer that will call methods on ServiceEvent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      Service.Builder createdAt(Instant createdAt)

      The Unix timestamp for the time when the service was created.

      Parameters:
      createdAt - The Unix timestamp for the time when the service was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementConstraints

      Service.Builder placementConstraints(Collection<PlacementConstraint> placementConstraints)

      The placement constraints for the tasks in the service.

      Parameters:
      placementConstraints - The placement constraints for the tasks in the service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementConstraints

      Service.Builder placementConstraints(PlacementConstraint... placementConstraints)

      The placement constraints for the tasks in the service.

      Parameters:
      placementConstraints - The placement constraints for the tasks in the service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementConstraints

      Service.Builder placementConstraints(Consumer<PlacementConstraint.Builder>... placementConstraints)

      The placement constraints for the tasks in the service.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to placementConstraints(List<PlacementConstraint>).

      Parameters:
      placementConstraints - a consumer that will call methods on PlacementConstraint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • placementStrategy

      Service.Builder placementStrategy(Collection<PlacementStrategy> placementStrategy)

      The placement strategy that determines how tasks for the service are placed.

      Parameters:
      placementStrategy - The placement strategy that determines how tasks for the service are placed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementStrategy

      Service.Builder placementStrategy(PlacementStrategy... placementStrategy)

      The placement strategy that determines how tasks for the service are placed.

      Parameters:
      placementStrategy - The placement strategy that determines how tasks for the service are placed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementStrategy

      Service.Builder placementStrategy(Consumer<PlacementStrategy.Builder>... placementStrategy)

      The placement strategy that determines how tasks for the service are placed.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to placementStrategy(List<PlacementStrategy>).

      Parameters:
      placementStrategy - a consumer that will call methods on PlacementStrategy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • networkConfiguration

      Service.Builder networkConfiguration(NetworkConfiguration networkConfiguration)

      The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

      Parameters:
      networkConfiguration - The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkConfiguration

      default Service.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)

      The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkConfiguration(NetworkConfiguration).

      Parameters:
      networkConfiguration - a consumer that will call methods on NetworkConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • healthCheckGracePeriodSeconds

      Service.Builder healthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)

      The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

      Parameters:
      healthCheckGracePeriodSeconds - The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedulingStrategy

      Service.Builder schedulingStrategy(String schedulingStrategy)

      The scheduling strategy to use for the service. For more information, see Services.

      There are two service scheduler strategies available.

      • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.

      • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.

        Fargate tasks don't support the DAEMON scheduling strategy.

      Parameters:
      schedulingStrategy - The scheduling strategy to use for the service. For more information, see Services.

      There are two service scheduler strategies available.

      • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.

      • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.

        Fargate tasks don't support the DAEMON scheduling strategy.

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

    • schedulingStrategy

      Service.Builder schedulingStrategy(SchedulingStrategy schedulingStrategy)

      The scheduling strategy to use for the service. For more information, see Services.

      There are two service scheduler strategies available.

      • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.

      • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.

        Fargate tasks don't support the DAEMON scheduling strategy.

      Parameters:
      schedulingStrategy - The scheduling strategy to use for the service. For more information, see Services.

      There are two service scheduler strategies available.

      • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.

      • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.

        Fargate tasks don't support the DAEMON scheduling strategy.

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

    • deploymentController

      Service.Builder deploymentController(DeploymentController deploymentController)

      The deployment controller type the service is using.

      Parameters:
      deploymentController - The deployment controller type the service is using.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deploymentController

      default Service.Builder deploymentController(Consumer<DeploymentController.Builder> deploymentController)

      The deployment controller type the service is using.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deploymentController(DeploymentController).

      Parameters:
      deploymentController - a consumer that will call methods on DeploymentController.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      Service.Builder tags(Collection<Tag> tags)

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

      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 service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.

      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

      Service.Builder tags(Tag... tags)

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

      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 service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.

      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

      Service.Builder tags(Consumer<Tag.Builder>... tags)

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

      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<Tag>).

      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:

    • createdBy

      Service.Builder createdBy(String createdBy)

      The principal that created the service.

      Parameters:
      createdBy - The principal that created the service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableECSManagedTags

      Service.Builder enableECSManagedTags(Boolean enableECSManagedTags)

      Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      enableECSManagedTags - Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • propagateTags

      Service.Builder propagateTags(String propagateTags)

      Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

      Parameters:
      propagateTags - Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • propagateTags

      Service.Builder propagateTags(PropagateTags propagateTags)

      Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

      Parameters:
      propagateTags - Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enableExecuteCommand

      Service.Builder enableExecuteCommand(Boolean enableExecuteCommand)

      Determines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.

      Parameters:
      enableExecuteCommand - Determines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.