View source: R/ecs_operations.R
ecs_create_service | R Documentation |
Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount
, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the update_service
action.
See https://www.paws-r-sdk.com/docs/ecs_create_service/ for full documentation.
ecs_create_service(
cluster = NULL,
serviceName,
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,
enableExecuteCommand = NULL,
serviceConnectConfiguration = NULL,
volumeConfigurations = NULL
)
cluster |
The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed. |
serviceName |
[required] 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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. |
taskDefinition |
The A task definition must be specified if the service uses either the For more information about deployment types, see Amazon ECS deployment types. |
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 uses the rolling update ( If the service uses the If you use the For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's specified here. For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. 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 that's specified here. Services with tasks that use the |
serviceRegistries |
The details of the service discovery registry to associate with this service. For more information, see Service discovery. Each service may be associated with one service registry. Multiple service registries for each service isn't supported. |
desiredCount |
The number of instantiations of the specified task definition to place and keep running in your service. This is required if |
clientToken |
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed. |
launchType |
The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide. The Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide. The The A service can use either a launch type or a capacity provider strategy.
If a |
capacityProviderStrategy |
The capacity provider strategy to use for the service. If a A capacity provider strategy may contain a maximum of 6 capacity providers. |
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 |
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 doesn't use the If your account has already created the Amazon ECS service-linked role,
that role is used for your service unless you specify a role here. The
service-linked role is required if your task definition uses the
If your specified role has a path other than |
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 for each 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 5 strategy rules for each service. |
networkConfiguration |
The network configuration for the service. This parameter is required
for task definitions that use the |
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. 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 If you do not use an Elastic Load Balancing, we recommend that you use
the 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 (about 69 years). 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:
|
deploymentController |
The deployment controller to use for the service. If no deployment
controller is specified, the default value of |
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:
|
enableECSManagedTags |
Specifies whether to turn on 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. When you use Amazon ECS managed tags, you need to set the
|
propagateTags |
Specifies whether to propagate the tags from the task definition to the
task. If no value is specified, the tags aren't propagated. Tags can
only be propagated to the task during task creation. To add tags to a
task after task creation, use the You must set this to a value other than The default is |
enableExecuteCommand |
Determines whether the execute command functionality is turned on for
the service. If |
serviceConnectConfiguration |
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide. |
volumeConfigurations |
The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume. |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.