public static interface CreateServiceRequest.Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateServiceRequest.Builder |
clientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
CreateServiceRequest.Builder |
cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.
|
default CreateServiceRequest.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.
|
CreateServiceRequest.Builder |
deploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of
stopping and starting tasks.
|
default CreateServiceRequest.Builder |
deploymentController(Consumer<DeploymentController.Builder> deploymentController)
The deployment controller to use for the service.
|
CreateServiceRequest.Builder |
deploymentController(DeploymentController deploymentController)
The deployment controller to use for the service.
|
CreateServiceRequest.Builder |
desiredCount(Integer desiredCount)
The number of instantiations of the specified task definition to place and keep running on your cluster.
|
CreateServiceRequest.Builder |
enableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
|
CreateServiceRequest.Builder |
healthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load
Balancing target health checks after a task has first started.
|
CreateServiceRequest.Builder |
launchType(LaunchType launchType)
The launch type on which to run your service.
|
CreateServiceRequest.Builder |
launchType(String launchType)
The launch type on which to run your service.
|
CreateServiceRequest.Builder |
loadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancer to use with your service.
|
CreateServiceRequest.Builder |
loadBalancers(Consumer<LoadBalancer.Builder>... loadBalancers)
A load balancer object representing the load balancer to use with your service.
|
CreateServiceRequest.Builder |
loadBalancers(LoadBalancer... loadBalancers)
A load balancer object representing the load balancer to use with your service.
|
default CreateServiceRequest.Builder |
networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
The network configuration for the service.
|
CreateServiceRequest.Builder |
networkConfiguration(NetworkConfiguration networkConfiguration)
The network configuration for the service.
|
CreateServiceRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateServiceRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateServiceRequest.Builder |
placementConstraints(Collection<PlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks in your service.
|
CreateServiceRequest.Builder |
placementConstraints(Consumer<PlacementConstraint.Builder>... placementConstraints)
An array of placement constraint objects to use for tasks in your service.
|
CreateServiceRequest.Builder |
placementConstraints(PlacementConstraint... placementConstraints)
An array of placement constraint objects to use for tasks in your service.
|
CreateServiceRequest.Builder |
placementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for tasks in your service.
|
CreateServiceRequest.Builder |
placementStrategy(Consumer<PlacementStrategy.Builder>... placementStrategy)
The placement strategy objects to use for tasks in your service.
|
CreateServiceRequest.Builder |
placementStrategy(PlacementStrategy... placementStrategy)
The placement strategy objects to use for tasks in your service.
|
CreateServiceRequest.Builder |
platformVersion(String platformVersion)
The platform version on which your tasks in the service are running.
|
CreateServiceRequest.Builder |
propagateTags(PropagateTags propagateTags)
Specifies whether to propagate the tags from the task definition or the service to the tasks.
|
CreateServiceRequest.Builder |
propagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition or the service to the tasks.
|
CreateServiceRequest.Builder |
role(String role)
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load
balancer on your behalf.
|
CreateServiceRequest.Builder |
schedulingStrategy(SchedulingStrategy schedulingStrategy)
The scheduling strategy to use for the service.
|
CreateServiceRequest.Builder |
schedulingStrategy(String schedulingStrategy)
The scheduling strategy to use for the service.
|
CreateServiceRequest.Builder |
serviceName(String serviceName)
The name of your service.
|
CreateServiceRequest.Builder |
serviceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this service.
|
CreateServiceRequest.Builder |
serviceRegistries(Consumer<ServiceRegistry.Builder>... serviceRegistries)
The details of the service discovery registries to assign to this service.
|
CreateServiceRequest.Builder |
serviceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registries to assign to this service.
|
CreateServiceRequest.Builder |
tags(Collection<Tag> tags)
The metadata that you apply to the service to help you categorize and organize them.
|
CreateServiceRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
The metadata that you apply to the service to help you categorize and organize them.
|
CreateServiceRequest.Builder |
tags(Tag... tags)
The metadata that you apply to the service to help you categorize and organize them.
|
CreateServiceRequest.Builder |
taskDefinition(String taskDefinition)
The
family and revision (family:revision) or full ARN of the task
definition to run in your service. |
buildoverrideConfigurationcopyapplyMutation, buildCreateServiceRequest.Builder cluster(String cluster)
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.
cluster - The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you
do not specify a cluster, the default cluster is assumed.CreateServiceRequest.Builder serviceName(String serviceName)
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
serviceName - The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and
underscores are allowed. Service names must be unique within a cluster, but you can have similarly
named services in multiple clusters within a Region or across multiple Regions.CreateServiceRequest.Builder taskDefinition(String taskDefinition)
The family and revision (family:revision) or full ARN of the task
definition to run in your service. If a revision is not specified, the latest
ACTIVE revision is used.
taskDefinition - The family and revision (family:revision) or full ARN of the
task definition to run in your service. If a revision is not specified, the latest
ACTIVE revision is used.CreateServiceRequest.Builder loadBalancers(Collection<LoadBalancer> loadBalancers)
A load balancer object representing the load balancer to use with your service.
If the service is using the ECS deployment controller, you are limited to one load balancer or
target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use
either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment
group, you specify two target groups (referred to as a targetGroupPair). During a deployment,
AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates
one target group with it, and then associates the other target group with the replacement task set. The load
balancer can also have up to two listeners: a required listener for production traffic and an optional
listener that allows you perform validation tests with Lambda functions before routing production traffic to
it.
After you create a service using the ECS deployment controller, the load balancer name or target
group ARN, container name, and container port specified in the service definition are immutable. If you are
using the CODE_DEPLOY deployment controller, these values can be changed when updating the
service.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch
type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not
supported. Also, when you create any target groups for these services, you must choose ip as the
target type, not instance, because tasks that use the awsvpc network mode are
associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancers - A load balancer object representing the load balancer to use with your service.
If the service is using the ECS deployment controller, you are limited to one load
balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to
use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy
deployment group, you specify two target groups (referred to as a targetGroupPair).
During a deployment, AWS CodeDeploy determines which task set in your service has the status
PRIMARY and associates one target group with it, and then associates the other target
group with the replacement task set. The load balancer can also have up to two listeners: a required
listener for production traffic and an optional listener that allows you perform validation tests with
Lambda functions before routing production traffic to it.
After you create a service using the ECS deployment controller, the load balancer name or
target group ARN, container name, and container port specified in the service definition are
immutable. If you are using the CODE_DEPLOY deployment controller, these values can be
changed when updating the service.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate
launch type) only support Application Load Balancers and Network Load Balancers. Classic Load
Balancers are not supported. Also, when you create any target groups for these services, you must
choose ip as the target type, not instance, because tasks that use the
awsvpc network mode are associated with an elastic network interface, not an Amazon EC2
instance.
CreateServiceRequest.Builder loadBalancers(LoadBalancer... loadBalancers)
A load balancer object representing the load balancer to use with your service.
If the service is using the ECS deployment controller, you are limited to one load balancer or
target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use
either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment
group, you specify two target groups (referred to as a targetGroupPair). During a deployment,
AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates
one target group with it, and then associates the other target group with the replacement task set. The load
balancer can also have up to two listeners: a required listener for production traffic and an optional
listener that allows you perform validation tests with Lambda functions before routing production traffic to
it.
After you create a service using the ECS deployment controller, the load balancer name or target
group ARN, container name, and container port specified in the service definition are immutable. If you are
using the CODE_DEPLOY deployment controller, these values can be changed when updating the
service.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch
type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not
supported. Also, when you create any target groups for these services, you must choose ip as the
target type, not instance, because tasks that use the awsvpc network mode are
associated with an elastic network interface, not an Amazon EC2 instance.
loadBalancers - A load balancer object representing the load balancer to use with your service.
If the service is using the ECS deployment controller, you are limited to one load
balancer or target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to
use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy
deployment group, you specify two target groups (referred to as a targetGroupPair).
During a deployment, AWS CodeDeploy determines which task set in your service has the status
PRIMARY and associates one target group with it, and then associates the other target
group with the replacement task set. The load balancer can also have up to two listeners: a required
listener for production traffic and an optional listener that allows you perform validation tests with
Lambda functions before routing production traffic to it.
After you create a service using the ECS deployment controller, the load balancer name or
target group ARN, container name, and container port specified in the service definition are
immutable. If you are using the CODE_DEPLOY deployment controller, these values can be
changed when updating the service.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate
launch type) only support Application Load Balancers and Network Load Balancers. Classic Load
Balancers are not supported. Also, when you create any target groups for these services, you must
choose ip as the target type, not instance, because tasks that use the
awsvpc network mode are associated with an elastic network interface, not an Amazon EC2
instance.
CreateServiceRequest.Builder loadBalancers(Consumer<LoadBalancer.Builder>... loadBalancers)
A load balancer object representing the load balancer to use with your service.
If the service is using the ECS deployment controller, you are limited to one load balancer or
target group.
If the service is using the CODE_DEPLOY deployment controller, the service is required to use
either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment
group, you specify two target groups (referred to as a targetGroupPair). During a deployment,
AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates
one target group with it, and then associates the other target group with the replacement task set. The load
balancer can also have up to two listeners: a required listener for production traffic and an optional
listener that allows you perform validation tests with Lambda functions before routing production traffic to
it.
After you create a service using the ECS deployment controller, the load balancer name or target
group ARN, container name, and container port specified in the service definition are immutable. If you are
using the CODE_DEPLOY deployment controller, these values can be changed when updating the
service.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch
type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not
supported. Also, when you create any target groups for these services, you must choose ip as the
target type, not instance, because tasks that use the awsvpc network mode are
associated with an elastic network interface, not an Amazon EC2 instance.
List.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #loadBalancers(List) .loadBalancers - a consumer that will call methods on List.Builder #loadBalancers(List) CreateServiceRequest.Builder serviceRegistries(Collection<ServiceRegistry> serviceRegistries)
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
serviceRegistries - The details of the service discovery registries to assign to this service. For more information, see
Service
Discovery. Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
CreateServiceRequest.Builder serviceRegistries(ServiceRegistry... serviceRegistries)
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
serviceRegistries - The details of the service discovery registries to assign to this service. For more information, see
Service
Discovery. Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
CreateServiceRequest.Builder serviceRegistries(Consumer<ServiceRegistry.Builder>... serviceRegistries)
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
List.Builder avoiding
the need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #serviceRegistries(List) .serviceRegistries - a consumer that will call methods on List.Builder #serviceRegistries(List) CreateServiceRequest.Builder desiredCount(Integer desiredCount)
The number of instantiations of the specified task definition to place and keep running on your cluster.
desiredCount - The number of instantiations of the specified task definition to place and keep running on your
cluster.CreateServiceRequest.Builder clientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32
ASCII characters are allowed.CreateServiceRequest.Builder launchType(String launchType)
The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
launchType - The launch type on which to run your service. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.LaunchType,
LaunchTypeCreateServiceRequest.Builder launchType(LaunchType launchType)
The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
launchType - The launch type on which to run your service. For more information, see Amazon ECS Launch
Types in the Amazon Elastic Container Service Developer Guide.LaunchType,
LaunchTypeCreateServiceRequest.Builder platformVersion(String platformVersion)
The platform version on which your tasks in the service are running. A platform version is only specified for
tasks using the Fargate launch type. If one is not specified, the LATEST platform version is
used by default. For more information, see AWS Fargate Platform
Versions in the Amazon Elastic Container Service Developer Guide.
platformVersion - The platform version on which your tasks in the service are running. A platform version is only
specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.CreateServiceRequest.Builder role(String role)
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load
balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service
and your task definition does not use the awsvpc network mode. If you specify the
role parameter, you must also specify a load balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for your
service unless you specify a role here. The service-linked role is required if your task definition uses the
awsvpc network mode, in which case you should not specify a role here. For more information, see
Using
Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /, then you must either specify the full role ARN
(this is recommended) or prefix the role name with the path. For example, if a role with the name
bar has a path of /foo/ then you would specify /foo/bar as the role
name. For more information, see Friendly Names and Paths in the IAM User Guide.
role - The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to
your load balancer on your behalf. This parameter is only permitted if you are using a load balancer
with your service and your task definition does not use the awsvpc network mode. If you
specify the role parameter, you must also specify a load balancer object with the
loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default
for your service unless you specify a role here. The service-linked role is required if your task
definition uses the awsvpc network mode, in which case you should not specify a role
here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer
Guide.
If your specified role has a path other than /, then you must either specify the full
role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the
name bar has a path of /foo/ then you would specify /foo/bar as
the role name. For more information, see Friendly Names and Paths in the IAM User Guide.
CreateServiceRequest.Builder deploymentConfiguration(DeploymentConfiguration deploymentConfiguration)
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
deploymentConfiguration - Optional deployment parameters that control how many tasks run during the deployment and the ordering
of stopping and starting tasks.default CreateServiceRequest.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 that creates an instance of theDeploymentConfiguration.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).deploymentConfiguration - a consumer that will call methods on DeploymentConfiguration.BuilderdeploymentConfiguration(DeploymentConfiguration)CreateServiceRequest.Builder placementConstraints(Collection<PlacementConstraint> placementConstraints)
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
placementConstraints - An array of placement constraint objects to use for tasks in your service. You can specify a maximum
of 10 constraints per task (this limit includes constraints in the task definition and those specified
at runtime).CreateServiceRequest.Builder placementConstraints(PlacementConstraint... placementConstraints)
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
placementConstraints - An array of placement constraint objects to use for tasks in your service. You can specify a maximum
of 10 constraints per task (this limit includes constraints in the task definition and those specified
at runtime).CreateServiceRequest.Builder placementConstraints(Consumer<PlacementConstraint.Builder>... placementConstraints)
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
This is a convenience that creates an instance of theList.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately
and its result is passed to #placementConstraints(List) .placementConstraints - a consumer that will call methods on List.Builder #placementConstraints(List) CreateServiceRequest.Builder placementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
placementStrategy - The placement strategy objects to use for tasks in your service. You can specify a maximum of five
strategy rules per service.CreateServiceRequest.Builder placementStrategy(PlacementStrategy... placementStrategy)
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
placementStrategy - The placement strategy objects to use for tasks in your service. You can specify a maximum of five
strategy rules per service.CreateServiceRequest.Builder placementStrategy(Consumer<PlacementStrategy.Builder>... placementStrategy)
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
This is a convenience that creates an instance of theList.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately
and its result is passed to #placementStrategy(List) .placementStrategy - a consumer that will call methods on List.Builder #placementStrategy(List) CreateServiceRequest.Builder networkConfiguration(NetworkConfiguration networkConfiguration)
The network configuration for the service. This parameter is required for task definitions that use the
awsvpc network mode to receive their own elastic network interface, and it is not supported for
other network modes. For more information, see Task Networking in
the Amazon Elastic Container Service Developer Guide.
networkConfiguration - The network configuration for the service. This parameter is required for task definitions that use
the awsvpc network mode to receive their own elastic network interface, and it is not
supported for other network modes. For more information, see Task
Networking in the Amazon Elastic Container Service Developer Guide.default CreateServiceRequest.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
The network configuration for the service. This parameter is required for task definitions that use the
awsvpc network mode to receive their own elastic network interface, and it is not supported for
other network modes. For more information, see Task Networking in
the Amazon Elastic Container Service Developer Guide.
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).networkConfiguration - a consumer that will call methods on NetworkConfiguration.BuildernetworkConfiguration(NetworkConfiguration)CreateServiceRequest.Builder healthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 7,200 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
healthCheckGracePeriodSeconds - The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic
Load Balancing target health checks after a task has first started. This is only valid if your service
is configured to use a load balancer. If your service's tasks take a while to start and respond to
Elastic Load Balancing health checks, you can specify a health check grace period of up to 7,200
seconds. During that time, the ECS service scheduler ignores health check status. This grace period
can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they
have time to come up.CreateServiceRequest.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. This scheduler strategy is
required if using the CODE_DEPLOY deployment controller.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance
that meets all of the task placement constraints that you specify in your cluster. When you are using this
strategy, there is no need to specify a desired number of tasks, a task placement strategy, or use Service
Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY deploymenet controller do not support the
DAEMON scheduling strategy.
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. This
scheduler strategy is required if using the CODE_DEPLOY deployment controller.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container
instance that meets all of the task placement constraints that you specify in your cluster. When you
are using this strategy, there is no need to specify a desired number of tasks, a task placement
strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY deploymenet controller do not
support the DAEMON scheduling strategy.
SchedulingStrategy,
SchedulingStrategyCreateServiceRequest.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. This scheduler strategy is
required if using the CODE_DEPLOY deployment controller.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance
that meets all of the task placement constraints that you specify in your cluster. When you are using this
strategy, there is no need to specify a desired number of tasks, a task placement strategy, or use Service
Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY deploymenet controller do not support the
DAEMON scheduling strategy.
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. This
scheduler strategy is required if using the CODE_DEPLOY deployment controller.
DAEMON-The daemon scheduling strategy deploys exactly one task on each active container
instance that meets all of the task placement constraints that you specify in your cluster. When you
are using this strategy, there is no need to specify a desired number of tasks, a task placement
strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY deploymenet controller do not
support the DAEMON scheduling strategy.
SchedulingStrategy,
SchedulingStrategyCreateServiceRequest.Builder deploymentController(DeploymentController deploymentController)
The deployment controller to use for the service.
deploymentController - The deployment controller to use for the service.default CreateServiceRequest.Builder deploymentController(Consumer<DeploymentController.Builder> deploymentController)
The deployment controller to use for the service.
This is a convenience that creates an instance of theDeploymentController.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).deploymentController - a consumer that will call methods on DeploymentController.BuilderdeploymentController(DeploymentController)CreateServiceRequest.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, both of which you define. When a service is deleted, the tags are deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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, both of which you define. When a service is deleted, the tags are
deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can
have a maximum length of 256 characters.CreateServiceRequest.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, both of which you define. When a service is deleted, the tags are deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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, both of which you define. When a service is deleted, the tags are
deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can
have a maximum length of 256 characters.CreateServiceRequest.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, both of which you define. When a service is deleted, the tags are deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
This is a convenience that creates an instance of theList.Builder avoiding the need to create
one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateServiceRequest.Builder enableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
enableECSManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more
information, see Tagging Your Amazon
ECS Resources in the Amazon Elastic Container Service Developer Guide.CreateServiceRequest.Builder propagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition or the service to the tasks. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
propagateTags - Specifies whether to propagate the tags from the task definition or the service to the tasks. If no
value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the
service during service creation. To add tags to a task after service creation, use the
TagResource API action.PropagateTags,
PropagateTagsCreateServiceRequest.Builder propagateTags(PropagateTags propagateTags)
Specifies whether to propagate the tags from the task definition or the service to the tasks. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
propagateTags - Specifies whether to propagate the tags from the task definition or the service to the tasks. If no
value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the
service during service creation. To add tags to a task after service creation, use the
TagResource API action.PropagateTags,
PropagateTagsCreateServiceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.CreateServiceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.