ecs_create_service {aws.ecx} | R Documentation |
Create Service
Description
Create Service
Usage
ecs_create_service(
cluster = NULL,
serviceName = NULL,
taskDefinition = NULL,
loadBalancers = NULL,
serviceRegistries = NULL,
desiredCount = NULL,
clientToken = NULL,
launchType = NULL,
capacityProviderStrategy = NULL,
platformVersion = NULL,
role = NULL,
deploymentConfiguration = NULL,
placementConstraints = NULL,
placementStrategy = NULL,
networkConfiguration = NULL,
healthCheckGracePeriodSeconds = NULL,
schedulingStrategy = NULL,
deploymentController = NULL,
tags = NULL,
enableECSManagedTags = NULL,
propagateTags = NULL,
simplify = TRUE,
others = list(),
print_on_error = aws_get_print_on_error(),
retry_time = aws_get_retry_time(),
network_timeout = aws_get_network_timeout(),
region = aws_get_region()
)
Arguments
cluster |
Character. The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. |
serviceName |
Character. The name of your service. |
taskDefinition |
Character. The |
loadBalancers |
List. A load balancer object representing the load balancers to use with your service. |
serviceRegistries |
List. The details of the service discovery registries to assign to this service. |
desiredCount |
Integer. The number of instantiations of the specified task definition to place and keep running on your... |
clientToken |
Character. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
launchType |
Character. The launch type on which to run your service. |
capacityProviderStrategy |
List. The capacity provider strategy to use for the service. |
platformVersion |
Character. The platform version that your tasks in the service are running on. |
role |
Character. The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls... |
deploymentConfiguration |
Object. Optional deployment parameters that control how many tasks run during the deployment and the ordering... |
placementConstraints |
List. An array of placement constraint objects to use for tasks in your service. |
placementStrategy |
List. The placement strategy objects to use for tasks in your service. |
networkConfiguration |
Object. The network configuration for the service. |
healthCheckGracePeriodSeconds |
Integer. The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic... |
schedulingStrategy |
Character. The scheduling strategy to use for the service. |
deploymentController |
Object. The deployment controller to use for the service. |
tags |
List. The metadata that you apply to the service to help you categorize and organize them. |
enableECSManagedTags |
Logical. Specifies whether to enable Amazon ECS managed tags for the tasks within the service. |
propagateTags |
Character. Specifies whether to propagate the tags from the task definition or the service to the tasks in the... |
simplify |
Logical. Whether to simplify the result and handle |
others |
Named list. The parameters that are not included in the function parameters and need to be added into the request[optional] |
print_on_error |
Logical. Whether to show an error message when a network error occurs. |
retry_time |
Integer. Number of retries for a REST request when encounter the
network issue. If the request has been sent |
network_timeout |
Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms. |
region |
Character. The region of the AWS service. |
Value
A list object or a character vector
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.
serviceName
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens 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.
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.
A task definition must be specified if the service is using either the
ECS
or CODE_DEPLOY
deployment controllers.
loadBalancers
A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
If the service is using the rolling update (ECS
) deployment controller
and using either an Application Load Balancer or Network Load Balancer,
you must specify one or more target group ARNs to attach to the service.
The service-linked role is required for services that make use of
multiple target groups. For more information, see Using Service-Linked Roles for Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
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 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. The load balancer name parameter must be omitted. 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.
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. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer 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.
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.
desiredCount
The number of instantiations of the specified task definition to place and keep running on your cluster.
This is required if schedulingStrategy
is REPLICA
or is not
specified. If schedulingStrategy
is DAEMON
then this is not
required.
clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
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.
If a launchType
is specified, the capacityProviderStrategy
parameter
must be omitted.
capacityProviderStrategy
The capacity provider strategy to use for the service.
A capacity provider strategy consists of one or more capacity providers
along with the base
and weight
to assign to them. A capacity
provider must be associated with the cluster to be used in a capacity
provider strategy. The PutClusterCapacityProviders API is used to
associate a capacity provider with a cluster. Only capacity providers
with an ACTIVE
or UPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
parameter
must be omitted. If no capacityProviderStrategy
or launchType
is
specified, the defaultCapacityProviderStrategy
for the cluster is
used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or
FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers
are available to all accounts and only need to be associated with a
cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
platformVersion
The platform version that your tasks in the service
are running on. A platform version is specified only for tasks using the
Fargate launch type. If one isn\'t 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.
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 or if the service is configured to use service
discovery, an external deployment controller, multiple target groups, or
Elastic Inference accelerators 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.
deploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
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).
placementStrategy
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
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.
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 used when your service is
configured to use a load balancer. If your service has a load balancer
defined and you don\'t specify a health check grace period value, the
default value of 0
is used.
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 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
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 the service is using theCODE_DEPLOY
orEXTERNAL
deployment controller types. -
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. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints. When you\'re using this strategy, you don\'t 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
orEXTERNAL
deployment controller types don\'t support theDAEMON
scheduling strategy.
deploymentController
The deployment controller to use for the service.
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.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
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.
propagateTags
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. 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.