public static interface CreateServiceRequest.Builder extends EcsRequest.Builder, CopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>
Modifier and Type | Method and Description |
---|---|
CreateServiceRequest.Builder |
clientToken(String clientToken)
Unique, case-sensitive identifier 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.
|
CreateServiceRequest.Builder |
desiredCount(Integer desiredCount)
The number of instantiations of the specified task definition to place and keep running on your cluster.
|
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 |
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 |
serviceName(String serviceName)
The name of your service.
|
CreateServiceRequest.Builder |
taskDefinition(String taskDefinition)
The
family and revision (family:revision ) or full Amazon Resource Name
(ARN) of the task definition to run in your service. |
build
overrideConfiguration
copy
applyMutation, build
CreateServiceRequest.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 Amazon Resource Name
(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 Amazon
Resource Name (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. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.
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.
loadBalancers
- A load balancer object representing the load balancer to use with your service. Currently, you are
limited to one load balancer or target group per service. After you create a service, the load
balancer name or target group ARN, container name, and container port specified in the service
definition are immutable.
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.
CreateServiceRequest.Builder loadBalancers(LoadBalancer... loadBalancers)
A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.
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.
loadBalancers
- A load balancer object representing the load balancer to use with your service. Currently, you are
limited to one load balancer or target group per service. After you create a service, the load
balancer name or target group ARN, container name, and container port specified in the service
definition are immutable.
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.
CreateServiceRequest.Builder loadBalancers(Consumer<LoadBalancer.Builder>... loadBalancers)
A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.
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.
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 #loadBalancers(List)
.loadBalancers
- a consumer that will call methods on List.Builder
#loadBalancers(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 you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
clientToken
- Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII
characters are allowed.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 EC2 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 EC2 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.Builder
deploymentConfiguration(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 run time).
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 run time).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 run time).
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 run time).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 run time).
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 5 strategy rules per service.
placementStrategy
- The placement strategy objects to use for tasks in your service. You can specify a maximum of 5
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 5 strategy rules per service.
placementStrategy
- The placement strategy objects to use for tasks in your service. You can specify a maximum of 5
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 5 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 EC2 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 EC2 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 EC2 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.Builder
networkConfiguration(NetworkConfiguration)
CreateServiceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CreateServiceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.